Apache_Hadoop_YARN_API_2.8.2.xml 705 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988
  1. <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
  2. <!-- Generated by the JDiff Javadoc doclet -->
  3. <!-- (http://www.jdiff.org) -->
  4. <!-- on Wed Nov 01 16:17:55 PDT 2017 -->
  5. <api
  6. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  7. xsi:noNamespaceSchemaLocation='api.xsd'
  8. name="Apache Hadoop YARN API 2.8.2"
  9. jdversion="1.0.9">
  10. <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /home/arsuresh/stuff/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-annotations.jar:/home/arsuresh/stuff/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/jdiff.jar -verbose -classpath /home/arsuresh/stuff/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/classes:/home/arsuresh/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/home/arsuresh/.m2/repository/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/home/arsuresh/.m2/repository/com/google/code/findbugs/jsr305/3.0.0/jsr305-3.0.0.jar:/home/arsuresh/.m2/repository/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/home/arsuresh/.m2/repository/org/apache/hadoop/hadoop-common/2.8.2/hadoop-common-2.8.2.jar:/home/arsuresh/.m2/repository/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/home/arsuresh/.m2/repository/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/home/arsuresh/.m2/repository/xmlenc/xmlenc/0.52/xmlenc-0.52.jar:/home/arsuresh/.m2/repository/org/apache/httpcomponents/httpclient/4.5.2/httpclient-4.5.2.jar:/home/arsuresh/.m2/repository/org/apache/httpcomponents/httpcore/4.4.4/httpcore-4.4.4.jar:/home/arsuresh/.m2/repository/commons-codec/commons-codec/1.4/commons-codec-1.4.jar:/home/arsuresh/.m2/repository/commons-io/commons-io/2.4/commons-io-2.4.jar:/home/arsuresh/.m2/repository/commons-net/commons-net/3.1/commons-net-3.1.jar:/home/arsuresh/.m2/repository/commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar:/home/arsuresh/.m2/repository/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar:/home/arsuresh/.m2/repository/org/mortbay/jetty/jetty/6.1.26/jetty-6.1.26.jar:/home/arsuresh/.m2/repository/org/mortbay/jetty/jetty-util/6.1.26/jetty-util-6.1.26.jar:/home/arsuresh/.m2/repository/org/mortbay/jetty/jetty-sslengine/6.1.26/jetty-sslengine-6.1.26.jar:/home/arsuresh/.m2/repository/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/home/arsuresh/.m2/repository/com/sun/jersey/jersey-core/1.9/jersey-core-1.9.jar:/home/arsuresh/.m2/repository/com/sun/jersey/jersey-json/1.9/jersey-json-1.9.jar:/home/arsuresh/.m2/repository/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/home/arsuresh/.m2/repository/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/home/arsuresh/.m2/repository/javax/xml/bind/jaxb-api/2.2.2/jaxb-api-2.2.2.jar:/home/arsuresh/.m2/repository/javax/xml/stream/stax-api/1.0-2/stax-api-1.0-2.jar:/home/arsuresh/.m2/repository/javax/activation/activation/1.1/activation-1.1.jar:/home/arsuresh/.m2/repository/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/home/arsuresh/.m2/repository/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/home/arsuresh/.m2/repository/com/sun/jersey/jersey-server/1.9/jersey-server-1.9.jar:/home/arsuresh/.m2/repository/asm/asm/3.2/asm-3.2.jar:/home/arsuresh/.m2/repository/log4j/log4j/1.2.17/log4j-1.2.17.jar:/home/arsuresh/.m2/repository/net/java/dev/jets3t/jets3t/0.9.0/jets3t-0.9.0.jar:/home/arsuresh/.m2/repository/com/jamesmurty/utils/java-xmlbuilder/0.4/java-xmlbuilder-0.4.jar:/home/arsuresh/.m2/repository/commons-configuration/commons-configuration/1.6/commons-configuration-1.6.jar:/home/arsuresh/.m2/repository/commons-digester/commons-digester/1.8/commons-digester-1.8.jar:/home/arsuresh/.m2/repository/commons-beanutils/commons-beanutils/1.7.0/commons-beanutils-1.7.0.jar:/home/arsuresh/.m2/repository/commons-beanutils/commons-beanutils-core/1.8.0/commons-beanutils-core-1.8.0.jar:/home/arsuresh/.m2/repository/org/slf4j/slf4j-api/1.7.10/slf4j-api-1.7.10.jar:/home/arsuresh/.m2/repository/org/slf4j/slf4j-log4j12/1.7.10/slf4j-log4j12-1.7.10.jar:/home/arsuresh/.m2/repository/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/home/arsuresh/.m2/repository/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/home/arsuresh/.m2/repository/org/apache/avro/avro/1.7.4/avro-1.7.4.jar:/home/arsuresh/.m2/repository/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/home/arsuresh/.m2/repository/org/xerial/snappy/snappy-java/1.0.4.1/snappy-java-1.0.4.1.jar:/home/arsuresh/.m2/repository/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/home/arsuresh/.m2/repository/org/apache/hadoop/hadoop-auth/2.8.2/hadoop-auth-2.8.2.jar:/home/arsuresh/.m2/repository/com/nimbusds/nimbus-jose-jwt/3.9/nimbus-jose-jwt-3.9.jar:/home/arsuresh/.m2/repository/net/jcip/jcip-annotations/1.0/jcip-annotations-1.0.jar:/home/arsuresh/.m2/repository/net/minidev/json-smart/1.1.1/json-smart-1.1.1.jar:/home/arsuresh/.m2/repository/org/apache/directory/server/apacheds-kerberos-codec/2.0.0-M15/apacheds-kerberos-codec-2.0.0-M15.jar:/home/arsuresh/.m2/repository/org/apache/directory/server/apacheds-i18n/2.0.0-M15/apacheds-i18n-2.0.0-M15.jar:/home/arsuresh/.m2/repository/org/apache/directory/api/api-asn1-api/1.0.0-M20/api-asn1-api-1.0.0-M20.jar:/home/arsuresh/.m2/repository/org/apache/directory/api/api-util/1.0.0-M20/api-util-1.0.0-M20.jar:/home/arsuresh/.m2/repository/org/apache/curator/curator-framework/2.7.1/curator-framework-2.7.1.jar:/home/arsuresh/.m2/repository/com/jcraft/jsch/0.1.54/jsch-0.1.54.jar:/home/arsuresh/.m2/repository/org/apache/curator/curator-client/2.7.1/curator-client-2.7.1.jar:/home/arsuresh/.m2/repository/org/apache/curator/curator-recipes/2.7.1/curator-recipes-2.7.1.jar:/home/arsuresh/.m2/repository/org/apache/htrace/htrace-core4/4.0.1-incubating/htrace-core4-4.0.1-incubating.jar:/home/arsuresh/.m2/repository/org/apache/zookeeper/zookeeper/3.4.6/zookeeper-3.4.6.jar:/home/arsuresh/.m2/repository/io/netty/netty/3.6.2.Final/netty-3.6.2.Final.jar:/home/arsuresh/.m2/repository/org/apache/commons/commons-compress/1.4.1/commons-compress-1.4.1.jar:/home/arsuresh/.m2/repository/org/tukaani/xz/1.0/xz-1.0.jar:/home/arsuresh/.m2/repository/org/apache/hadoop/hadoop-annotations/2.8.2/hadoop-annotations-2.8.2.jar:/usr/lib/jvm/java-8-oracle/lib/tools.jar:/home/arsuresh/.m2/repository/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar -sourcepath /home/arsuresh/stuff/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /home/arsuresh/stuff/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-annotations.jar:/home/arsuresh/stuff/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/jdiff.jar -apidir /home/arsuresh/stuff/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/jdiff/xml -apiname Apache Hadoop YARN API 2.8.2 -->
  11. <package name="org.apache.hadoop.yarn.api">
  12. <!-- start interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
  13. <interface name="ApplicationClientProtocol" abstract="true"
  14. static="false" final="false" visibility="public"
  15. deprecated="not deprecated">
  16. <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
  17. <method name="getNewApplication" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse"
  18. abstract="true" native="false" synchronized="false"
  19. static="false" final="false" visibility="public"
  20. deprecated="not deprecated">
  21. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"/>
  22. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  23. <exception name="IOException" type="java.io.IOException"/>
  24. <doc>
  25. <![CDATA[<p>The interface used by clients to obtain a new {@link ApplicationId} for
  26. submitting new applications.</p>
  27. <p>The <code>ResourceManager</code> responds with a new, monotonically
  28. increasing, {@link ApplicationId} which is used by the client to submit
  29. a new application.</p>
  30. <p>The <code>ResourceManager</code> also responds with details such
  31. as maximum resource capabilities in the cluster as specified in
  32. {@link GetNewApplicationResponse}.</p>
  33. @param request request to get a new <code>ApplicationId</code>
  34. @return response containing the new <code>ApplicationId</code> to be used
  35. to submit an application
  36. @throws YarnException
  37. @throws IOException
  38. @see #submitApplication(SubmitApplicationRequest)]]>
  39. </doc>
  40. </method>
  41. <method name="submitApplication" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse"
  42. abstract="true" native="false" synchronized="false"
  43. static="false" final="false" visibility="public"
  44. deprecated="not deprecated">
  45. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"/>
  46. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  47. <exception name="IOException" type="java.io.IOException"/>
  48. <doc>
  49. <![CDATA[<p>The interface used by clients to submit a new application to the
  50. <code>ResourceManager.</code></p>
  51. <p>The client is required to provide details such as queue,
  52. {@link Resource} required to run the <code>ApplicationMaster</code>,
  53. the equivalent of {@link ContainerLaunchContext} for launching
  54. the <code>ApplicationMaster</code> etc. via the
  55. {@link SubmitApplicationRequest}.</p>
  56. <p>Currently the <code>ResourceManager</code> sends an immediate (empty)
  57. {@link SubmitApplicationResponse} on accepting the submission and throws
  58. an exception if it rejects the submission. However, this call needs to be
  59. followed by {@link #getApplicationReport(GetApplicationReportRequest)}
  60. to make sure that the application gets properly submitted - obtaining a
  61. {@link SubmitApplicationResponse} from ResourceManager doesn't guarantee
  62. that RM 'remembers' this application beyond failover or restart. If RM
  63. failover or RM restart happens before ResourceManager saves the
  64. application's state successfully, the subsequent
  65. {@link #getApplicationReport(GetApplicationReportRequest)} will throw
  66. a {@link ApplicationNotFoundException}. The Clients need to re-submit
  67. the application with the same {@link ApplicationSubmissionContext} when
  68. it encounters the {@link ApplicationNotFoundException} on the
  69. {@link #getApplicationReport(GetApplicationReportRequest)} call.</p>
  70. <p>During the submission process, it checks whether the application
  71. already exists. If the application exists, it will simply return
  72. SubmitApplicationResponse</p>
  73. <p> In secure mode,the <code>ResourceManager</code> verifies access to
  74. queues etc. before accepting the application submission.</p>
  75. @param request request to submit a new application
  76. @return (empty) response on accepting the submission
  77. @throws YarnException
  78. @throws IOException
  79. @see #getNewApplication(GetNewApplicationRequest)]]>
  80. </doc>
  81. </method>
  82. <method name="failApplicationAttempt" return="org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptResponse"
  83. abstract="true" native="false" synchronized="false"
  84. static="false" final="false" visibility="public"
  85. deprecated="not deprecated">
  86. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest"/>
  87. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  88. <exception name="IOException" type="java.io.IOException"/>
  89. <doc>
  90. <![CDATA[<p>The interface used by clients to request the
  91. <code>ResourceManager</code> to fail an application attempt.</p>
  92. <p>The client, via {@link FailApplicationAttemptRequest} provides the
  93. {@link ApplicationAttemptId} of the attempt to be failed.</p>
  94. <p> In secure mode,the <code>ResourceManager</code> verifies access to the
  95. application, queue etc. before failing the attempt.</p>
  96. <p>Currently, the <code>ResourceManager</code> returns an empty response
  97. on success and throws an exception on rejecting the request.</p>
  98. @param request request to fail an attempt
  99. @return <code>ResourceManager</code> returns an empty response
  100. on success and throws an exception on rejecting the request
  101. @throws YarnException
  102. @throws IOException
  103. @see #getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  104. </doc>
  105. </method>
  106. <method name="forceKillApplication" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse"
  107. abstract="true" native="false" synchronized="false"
  108. static="false" final="false" visibility="public"
  109. deprecated="not deprecated">
  110. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"/>
  111. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  112. <exception name="IOException" type="java.io.IOException"/>
  113. <doc>
  114. <![CDATA[<p>The interface used by clients to request the
  115. <code>ResourceManager</code> to abort submitted application.</p>
  116. <p>The client, via {@link KillApplicationRequest} provides the
  117. {@link ApplicationId} of the application to be aborted.</p>
  118. <p> In secure mode,the <code>ResourceManager</code> verifies access to the
  119. application, queue etc. before terminating the application.</p>
  120. <p>Currently, the <code>ResourceManager</code> returns an empty response
  121. on success and throws an exception on rejecting the request.</p>
  122. @param request request to abort a submitted application
  123. @return <code>ResourceManager</code> returns an empty response
  124. on success and throws an exception on rejecting the request
  125. @throws YarnException
  126. @throws IOException
  127. @see #getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  128. </doc>
  129. </method>
  130. <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse"
  131. abstract="true" native="false" synchronized="false"
  132. static="false" final="false" visibility="public"
  133. deprecated="not deprecated">
  134. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"/>
  135. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  136. <exception name="IOException" type="java.io.IOException"/>
  137. <doc>
  138. <![CDATA[<p>The interface used by clients to get metrics about the cluster from
  139. the <code>ResourceManager</code>.</p>
  140. <p>The <code>ResourceManager</code> responds with a
  141. {@link GetClusterMetricsResponse} which includes the
  142. {@link YarnClusterMetrics} with details such as number of current
  143. nodes in the cluster.</p>
  144. @param request request for cluster metrics
  145. @return cluster metrics
  146. @throws YarnException
  147. @throws IOException]]>
  148. </doc>
  149. </method>
  150. <method name="getClusterNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse"
  151. abstract="true" native="false" synchronized="false"
  152. static="false" final="false" visibility="public"
  153. deprecated="not deprecated">
  154. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"/>
  155. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  156. <exception name="IOException" type="java.io.IOException"/>
  157. <doc>
  158. <![CDATA[<p>The interface used by clients to get a report of all nodes
  159. in the cluster from the <code>ResourceManager</code>.</p>
  160. <p>The <code>ResourceManager</code> responds with a
  161. {@link GetClusterNodesResponse} which includes the
  162. {@link NodeReport} for all the nodes in the cluster.</p>
  163. @param request request for report on all nodes
  164. @return report on all nodes
  165. @throws YarnException
  166. @throws IOException]]>
  167. </doc>
  168. </method>
  169. <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse"
  170. abstract="true" native="false" synchronized="false"
  171. static="false" final="false" visibility="public"
  172. deprecated="not deprecated">
  173. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"/>
  174. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  175. <exception name="IOException" type="java.io.IOException"/>
  176. <doc>
  177. <![CDATA[<p>The interface used by clients to get information about <em>queues</em>
  178. from the <code>ResourceManager</code>.</p>
  179. <p>The client, via {@link GetQueueInfoRequest}, can ask for details such
  180. as used/total resources, child queues, running applications etc.</p>
  181. <p> In secure mode,the <code>ResourceManager</code> verifies access before
  182. providing the information.</p>
  183. @param request request to get queue information
  184. @return queue information
  185. @throws YarnException
  186. @throws IOException]]>
  187. </doc>
  188. </method>
  189. <method name="getQueueUserAcls" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse"
  190. abstract="true" native="false" synchronized="false"
  191. static="false" final="false" visibility="public"
  192. deprecated="not deprecated">
  193. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"/>
  194. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  195. <exception name="IOException" type="java.io.IOException"/>
  196. <doc>
  197. <![CDATA[<p>The interface used by clients to get information about <em>queue
  198. acls</em> for <em>current user</em> from the <code>ResourceManager</code>.
  199. </p>
  200. <p>The <code>ResourceManager</code> responds with queue acls for all
  201. existing queues.</p>
  202. @param request request to get queue acls for <em>current user</em>
  203. @return queue acls for <em>current user</em>
  204. @throws YarnException
  205. @throws IOException]]>
  206. </doc>
  207. </method>
  208. <method name="moveApplicationAcrossQueues" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse"
  209. abstract="true" native="false" synchronized="false"
  210. static="false" final="false" visibility="public"
  211. deprecated="not deprecated">
  212. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"/>
  213. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  214. <exception name="IOException" type="java.io.IOException"/>
  215. <doc>
  216. <![CDATA[Move an application to a new queue.
  217. @param request the application ID and the target queue
  218. @return an empty response
  219. @throws YarnException
  220. @throws IOException]]>
  221. </doc>
  222. </method>
  223. <method name="getNewReservation" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse"
  224. abstract="true" native="false" synchronized="false"
  225. static="false" final="false" visibility="public"
  226. deprecated="not deprecated">
  227. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest"/>
  228. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  229. <exception name="IOException" type="java.io.IOException"/>
  230. <doc>
  231. <![CDATA[<p>The interface used by clients to obtain a new {@link ReservationId} for
  232. submitting new reservations.</p>
  233. <p>The <code>ResourceManager</code> responds with a new, unique,
  234. {@link ReservationId} which is used by the client to submit
  235. a new reservation.</p>
  236. @param request to get a new <code>ReservationId</code>
  237. @return response containing the new <code>ReservationId</code> to be used
  238. to submit a new reservation
  239. @throws YarnException if the reservation system is not enabled.
  240. @throws IOException on IO failures.
  241. @see #submitReservation(ReservationSubmissionRequest)]]>
  242. </doc>
  243. </method>
  244. <method name="submitReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse"
  245. abstract="true" native="false" synchronized="false"
  246. static="false" final="false" visibility="public"
  247. deprecated="not deprecated">
  248. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"/>
  249. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  250. <exception name="IOException" type="java.io.IOException"/>
  251. <doc>
  252. <![CDATA[<p>
  253. The interface used by clients to submit a new reservation to the
  254. {@code ResourceManager}.
  255. </p>
  256. <p>
  257. The client packages all details of its request in a
  258. {@link ReservationSubmissionRequest} object. This contains information
  259. about the amount of capacity, temporal constraints, and concurrency needs.
  260. Furthermore, the reservation might be composed of multiple stages, with
  261. ordering dependencies among them.
  262. </p>
  263. <p>
  264. In order to respond, a new admission control component in the
  265. {@code ResourceManager} performs an analysis of the resources that have
  266. been committed over the period of time the user is requesting, verify that
  267. the user requests can be fulfilled, and that it respect a sharing policy
  268. (e.g., {@code CapacityOverTimePolicy}). Once it has positively determined
  269. that the ReservationSubmissionRequest is satisfiable the
  270. {@code ResourceManager} answers with a
  271. {@link ReservationSubmissionResponse} that include a non-null
  272. {@link ReservationId}. Upon failure to find a valid allocation the response
  273. is an exception with the reason.
  274. On application submission the client can use this {@link ReservationId} to
  275. obtain access to the reserved resources.
  276. </p>
  277. <p>
  278. The system guarantees that during the time-range specified by the user, the
  279. reservationID will be corresponding to a valid reservation. The amount of
  280. capacity dedicated to such queue can vary overtime, depending of the
  281. allocation that has been determined. But it is guaranteed to satisfy all
  282. the constraint expressed by the user in the
  283. {@link ReservationSubmissionRequest}.
  284. </p>
  285. @param request the request to submit a new Reservation
  286. @return response the {@link ReservationId} on accepting the submission
  287. @throws YarnException if the request is invalid or reservation cannot be
  288. created successfully
  289. @throws IOException]]>
  290. </doc>
  291. </method>
  292. <method name="updateReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse"
  293. abstract="true" native="false" synchronized="false"
  294. static="false" final="false" visibility="public"
  295. deprecated="not deprecated">
  296. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"/>
  297. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  298. <exception name="IOException" type="java.io.IOException"/>
  299. <doc>
  300. <![CDATA[<p>
  301. The interface used by clients to update an existing Reservation. This is
  302. referred to as a re-negotiation process, in which a user that has
  303. previously submitted a Reservation.
  304. </p>
  305. <p>
  306. The allocation is attempted by virtually substituting all previous
  307. allocations related to this Reservation with new ones, that satisfy the new
  308. {@link ReservationUpdateRequest}. Upon success the previous allocation is
  309. substituted by the new one, and on failure (i.e., if the system cannot find
  310. a valid allocation for the updated request), the previous allocation
  311. remains valid.
  312. The {@link ReservationId} is not changed, and applications currently
  313. running within this reservation will automatically receive the resources
  314. based on the new allocation.
  315. </p>
  316. @param request to update an existing Reservation (the ReservationRequest
  317. should refer to an existing valid {@link ReservationId})
  318. @return response empty on successfully updating the existing reservation
  319. @throws YarnException if the request is invalid or reservation cannot be
  320. updated successfully
  321. @throws IOException]]>
  322. </doc>
  323. </method>
  324. <method name="deleteReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse"
  325. abstract="true" native="false" synchronized="false"
  326. static="false" final="false" visibility="public"
  327. deprecated="not deprecated">
  328. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"/>
  329. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  330. <exception name="IOException" type="java.io.IOException"/>
  331. <doc>
  332. <![CDATA[<p>
  333. The interface used by clients to remove an existing Reservation.
  334. Upon deletion of a reservation applications running with this reservation,
  335. are automatically downgraded to normal jobs running without any dedicated
  336. reservation.
  337. </p>
  338. @param request to remove an existing Reservation (the ReservationRequest
  339. should refer to an existing valid {@link ReservationId})
  340. @return response empty on successfully deleting the existing reservation
  341. @throws YarnException if the request is invalid or reservation cannot be
  342. deleted successfully
  343. @throws IOException]]>
  344. </doc>
  345. </method>
  346. <method name="listReservations" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse"
  347. abstract="true" native="false" synchronized="false"
  348. static="false" final="false" visibility="public"
  349. deprecated="not deprecated">
  350. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"/>
  351. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  352. <exception name="IOException" type="java.io.IOException"/>
  353. <doc>
  354. <![CDATA[<p>
  355. The interface used by clients to get the list of reservations in a plan.
  356. The reservationId will be used to search for reservations to list if it is
  357. provided. Otherwise, it will select active reservations within the
  358. startTime and endTime (inclusive).
  359. </p>
  360. @param request to list reservations in a plan. Contains fields to select
  361. String queue, ReservationId reservationId, long startTime,
  362. long endTime, and a bool includeReservationAllocations.
  363. queue: Required. Cannot be null or empty. Refers to the
  364. reservable queue in the scheduler that was selected when
  365. creating a reservation submission
  366. {@link ReservationSubmissionRequest}.
  367. reservationId: Optional. If provided, other fields will
  368. be ignored.
  369. startTime: Optional. If provided, only reservations that
  370. end after the startTime will be selected. This defaults
  371. to 0 if an invalid number is used.
  372. endTime: Optional. If provided, only reservations that
  373. start on or before endTime will be selected. This defaults
  374. to Long.MAX_VALUE if an invalid number is used.
  375. includeReservationAllocations: Optional. Flag that
  376. determines whether the entire reservation allocations are
  377. to be returned. Reservation allocations are subject to
  378. change in the event of re-planning as described by
  379. {@code ReservationDefinition}.
  380. @return response that contains information about reservations that are
  381. being searched for.
  382. @throws YarnException if the request is invalid
  383. @throws IOException on IO failures]]>
  384. </doc>
  385. </method>
  386. <method name="getNodeToLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse"
  387. abstract="true" native="false" synchronized="false"
  388. static="false" final="false" visibility="public"
  389. deprecated="not deprecated">
  390. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest"/>
  391. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  392. <exception name="IOException" type="java.io.IOException"/>
  393. <doc>
  394. <![CDATA[<p>
  395. The interface used by client to get node to labels mappings in existing cluster
  396. </p>
  397. @param request
  398. @return node to labels mappings
  399. @throws YarnException
  400. @throws IOException]]>
  401. </doc>
  402. </method>
  403. <method name="getLabelsToNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesResponse"
  404. abstract="true" native="false" synchronized="false"
  405. static="false" final="false" visibility="public"
  406. deprecated="not deprecated">
  407. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest"/>
  408. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  409. <exception name="IOException" type="java.io.IOException"/>
  410. <doc>
  411. <![CDATA[<p>
  412. The interface used by client to get labels to nodes mappings
  413. in existing cluster
  414. </p>
  415. @param request
  416. @return labels to nodes mappings
  417. @throws YarnException
  418. @throws IOException]]>
  419. </doc>
  420. </method>
  421. <method name="getClusterNodeLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  422. abstract="true" native="false" synchronized="false"
  423. static="false" final="false" visibility="public"
  424. deprecated="not deprecated">
  425. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"/>
  426. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  427. <exception name="IOException" type="java.io.IOException"/>
  428. <doc>
  429. <![CDATA[<p>
  430. The interface used by client to get node labels in the cluster
  431. </p>
  432. @param request to get node labels collection of this cluster
  433. @return node labels collection of this cluster
  434. @throws YarnException
  435. @throws IOException]]>
  436. </doc>
  437. </method>
  438. <method name="updateApplicationPriority" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse"
  439. abstract="true" native="false" synchronized="false"
  440. static="false" final="false" visibility="public"
  441. deprecated="not deprecated">
  442. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest"/>
  443. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  444. <exception name="IOException" type="java.io.IOException"/>
  445. <doc>
  446. <![CDATA[<p>
  447. The interface used by client to set priority of an application.
  448. </p>
  449. @param request to set priority of an application
  450. @return an empty response
  451. @throws YarnException
  452. @throws IOException]]>
  453. </doc>
  454. </method>
  455. <method name="signalToContainer" return="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse"
  456. abstract="true" native="false" synchronized="false"
  457. static="false" final="false" visibility="public"
  458. deprecated="not deprecated">
  459. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest"/>
  460. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  461. <exception name="IOException" type="java.io.IOException"/>
  462. <doc>
  463. <![CDATA[<p>The interface used by clients to request the
  464. <code>ResourceManager</code> to signal a container. For example,
  465. the client can send command OUTPUT_THREAD_DUMP to dump threads of the
  466. container.</p>
  467. <p>The client, via {@link SignalContainerRequest} provides the
  468. id of the container and the signal command. </p>
  469. <p> In secure mode,the <code>ResourceManager</code> verifies access to the
  470. application before signaling the container.
  471. The user needs to have <code>MODIFY_APP</code> permission.</p>
  472. <p>Currently, the <code>ResourceManager</code> returns an empty response
  473. on success and throws an exception on rejecting the request.</p>
  474. @param request request to signal a container
  475. @return <code>ResourceManager</code> returns an empty response
  476. on success and throws an exception on rejecting the request
  477. @throws YarnException
  478. @throws IOException]]>
  479. </doc>
  480. </method>
  481. <doc>
  482. <![CDATA[<p>The protocol between clients and the <code>ResourceManager</code>
  483. to submit/abort jobs and to get information on applications, cluster metrics,
  484. nodes, queues and ACLs.</p>]]>
  485. </doc>
  486. </interface>
  487. <!-- end interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
  488. <!-- start interface org.apache.hadoop.yarn.api.ApplicationConstants -->
  489. <interface name="ApplicationConstants" abstract="true"
  490. static="false" final="false" visibility="public"
  491. deprecated="not deprecated">
  492. <field name="APP_SUBMIT_TIME_ENV" type="java.lang.String"
  493. transient="false" volatile="false"
  494. static="true" final="true" visibility="public"
  495. deprecated="not deprecated">
  496. <doc>
  497. <![CDATA[The environment variable for APP_SUBMIT_TIME. Set in AppMaster environment
  498. only]]>
  499. </doc>
  500. </field>
  501. <field name="CONTAINER_TOKEN_FILE_ENV_NAME" type="java.lang.String"
  502. transient="false" volatile="false"
  503. static="true" final="true" visibility="public"
  504. deprecated="not deprecated">
  505. <doc>
  506. <![CDATA[The cache file into which container token is written]]>
  507. </doc>
  508. </field>
  509. <field name="APPLICATION_WEB_PROXY_BASE_ENV" type="java.lang.String"
  510. transient="false" volatile="false"
  511. static="true" final="true" visibility="public"
  512. deprecated="not deprecated">
  513. <doc>
  514. <![CDATA[The environmental variable for APPLICATION_WEB_PROXY_BASE. Set in
  515. ApplicationMaster's environment only. This states that for all non-relative
  516. web URLs in the app masters web UI what base should they have.]]>
  517. </doc>
  518. </field>
  519. <field name="LOG_DIR_EXPANSION_VAR" type="java.lang.String"
  520. transient="false" volatile="false"
  521. static="true" final="true" visibility="public"
  522. deprecated="not deprecated">
  523. <doc>
  524. <![CDATA[The temporary environmental variable for container log directory. This
  525. should be replaced by real container log directory on container launch.]]>
  526. </doc>
  527. </field>
  528. <field name="CLASS_PATH_SEPARATOR" type="java.lang.String"
  529. transient="false" volatile="false"
  530. static="true" final="true" visibility="public"
  531. deprecated="not deprecated">
  532. <doc>
  533. <![CDATA[This constant is used to construct class path and it will be replaced with
  534. real class path separator(':' for Linux and ';' for Windows) by
  535. NodeManager on container launch. User has to use this constant to construct
  536. class path if user wants cross-platform practice i.e. submit an application
  537. from a Windows client to a Linux/Unix server or vice versa.]]>
  538. </doc>
  539. </field>
  540. <field name="PARAMETER_EXPANSION_LEFT" type="java.lang.String"
  541. transient="false" volatile="false"
  542. static="true" final="true" visibility="public"
  543. deprecated="not deprecated">
  544. <doc>
  545. <![CDATA[The following two constants are used to expand parameter and it will be
  546. replaced with real parameter expansion marker ('%' for Windows and '$' for
  547. Linux) by NodeManager on container launch. For example: {{VAR}} will be
  548. replaced as $VAR on Linux, and %VAR% on Windows. User has to use this
  549. constant to construct class path if user wants cross-platform practice i.e.
  550. submit an application from a Windows client to a Linux/Unix server or vice
  551. versa.]]>
  552. </doc>
  553. </field>
  554. <field name="PARAMETER_EXPANSION_RIGHT" type="java.lang.String"
  555. transient="false" volatile="false"
  556. static="true" final="true" visibility="public"
  557. deprecated="not deprecated">
  558. <doc>
  559. <![CDATA[User has to use this constant to construct class path if user wants
  560. cross-platform practice i.e. submit an application from a Windows client to
  561. a Linux/Unix server or vice versa.]]>
  562. </doc>
  563. </field>
  564. <field name="STDERR" type="java.lang.String"
  565. transient="false" volatile="false"
  566. static="true" final="true" visibility="public"
  567. deprecated="not deprecated">
  568. </field>
  569. <field name="STDOUT" type="java.lang.String"
  570. transient="false" volatile="false"
  571. static="true" final="true" visibility="public"
  572. deprecated="not deprecated">
  573. </field>
  574. <field name="MAX_APP_ATTEMPTS_ENV" type="java.lang.String"
  575. transient="false" volatile="false"
  576. static="true" final="true" visibility="public"
  577. deprecated="not deprecated">
  578. <doc>
  579. <![CDATA[The environment variable for MAX_APP_ATTEMPTS. Set in AppMaster environment
  580. only]]>
  581. </doc>
  582. </field>
  583. <doc>
  584. <![CDATA[This is the API for the applications comprising of constants that YARN sets
  585. up for the applications and the containers.
  586. TODO: Investigate the semantics and security of each cross-boundary refs.]]>
  587. </doc>
  588. </interface>
  589. <!-- end interface org.apache.hadoop.yarn.api.ApplicationConstants -->
  590. <!-- start interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
  591. <interface name="ApplicationHistoryProtocol" abstract="true"
  592. static="false" final="false" visibility="public"
  593. deprecated="not deprecated">
  594. <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
  595. <doc>
  596. <![CDATA[<p>
  597. The protocol between clients and the <code>ApplicationHistoryServer</code> to
  598. get the information of completed applications etc.
  599. </p>]]>
  600. </doc>
  601. </interface>
  602. <!-- end interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
  603. <!-- start interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
  604. <interface name="ApplicationMasterProtocol" abstract="true"
  605. static="false" final="false" visibility="public"
  606. deprecated="not deprecated">
  607. <method name="registerApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse"
  608. abstract="true" native="false" synchronized="false"
  609. static="false" final="false" visibility="public"
  610. deprecated="not deprecated">
  611. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"/>
  612. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  613. <exception name="IOException" type="java.io.IOException"/>
  614. <doc>
  615. <![CDATA[<p>
  616. The interface used by a new <code>ApplicationMaster</code> to register with
  617. the <code>ResourceManager</code>.
  618. </p>
  619. <p>
  620. The <code>ApplicationMaster</code> needs to provide details such as RPC
  621. Port, HTTP tracking url etc. as specified in
  622. {@link RegisterApplicationMasterRequest}.
  623. </p>
  624. <p>
  625. The <code>ResourceManager</code> responds with critical details such as
  626. maximum resource capabilities in the cluster as specified in
  627. {@link RegisterApplicationMasterResponse}.
  628. </p>
  629. @param request
  630. registration request
  631. @return registration respose
  632. @throws YarnException
  633. @throws IOException
  634. @throws InvalidApplicationMasterRequestException
  635. The exception is thrown when an ApplicationMaster tries to
  636. register more then once.
  637. @see RegisterApplicationMasterRequest
  638. @see RegisterApplicationMasterResponse]]>
  639. </doc>
  640. </method>
  641. <method name="finishApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse"
  642. abstract="true" native="false" synchronized="false"
  643. static="false" final="false" visibility="public"
  644. deprecated="not deprecated">
  645. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"/>
  646. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  647. <exception name="IOException" type="java.io.IOException"/>
  648. <doc>
  649. <![CDATA[<p>The interface used by an <code>ApplicationMaster</code> to notify the
  650. <code>ResourceManager</code> about its completion (success or failed).</p>
  651. <p>The <code>ApplicationMaster</code> has to provide details such as
  652. final state, diagnostics (in case of failures) etc. as specified in
  653. {@link FinishApplicationMasterRequest}.</p>
  654. <p>The <code>ResourceManager</code> responds with
  655. {@link FinishApplicationMasterResponse}.</p>
  656. @param request completion request
  657. @return completion response
  658. @throws YarnException
  659. @throws IOException
  660. @see FinishApplicationMasterRequest
  661. @see FinishApplicationMasterResponse]]>
  662. </doc>
  663. </method>
  664. <method name="allocate" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  665. abstract="true" native="false" synchronized="false"
  666. static="false" final="false" visibility="public"
  667. deprecated="not deprecated">
  668. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"/>
  669. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  670. <exception name="IOException" type="java.io.IOException"/>
  671. <doc>
  672. <![CDATA[<p>
  673. The main interface between an <code>ApplicationMaster</code> and the
  674. <code>ResourceManager</code>.
  675. </p>
  676. <p>
  677. The <code>ApplicationMaster</code> uses this interface to provide a list of
  678. {@link ResourceRequest} and returns unused {@link Container} allocated to
  679. it via {@link AllocateRequest}. Optionally, the
  680. <code>ApplicationMaster</code> can also <em>blacklist</em> resources which
  681. it doesn't want to use.
  682. </p>
  683. <p>
  684. This also doubles up as a <em>heartbeat</em> to let the
  685. <code>ResourceManager</code> know that the <code>ApplicationMaster</code>
  686. is alive. Thus, applications should periodically make this call to be kept
  687. alive. The frequency depends on
  688. {@link YarnConfiguration#RM_AM_EXPIRY_INTERVAL_MS} which defaults to
  689. {@link YarnConfiguration#DEFAULT_RM_AM_EXPIRY_INTERVAL_MS}.
  690. </p>
  691. <p>
  692. The <code>ResourceManager</code> responds with list of allocated
  693. {@link Container}, status of completed containers and headroom information
  694. for the application.
  695. </p>
  696. <p>
  697. The <code>ApplicationMaster</code> can use the available headroom
  698. (resources) to decide how to utilized allocated resources and make informed
  699. decisions about future resource requests.
  700. </p>
  701. @param request
  702. allocation request
  703. @return allocation response
  704. @throws YarnException
  705. @throws IOException
  706. @throws InvalidApplicationMasterRequestException
  707. This exception is thrown when an ApplicationMaster calls allocate
  708. without registering first.
  709. @throws InvalidResourceBlacklistRequestException
  710. This exception is thrown when an application provides an invalid
  711. specification for blacklist of resources.
  712. @throws InvalidResourceRequestException
  713. This exception is thrown when a {@link ResourceRequest} is out of
  714. the range of the configured lower and upper limits on the
  715. resources.
  716. @see AllocateRequest
  717. @see AllocateResponse]]>
  718. </doc>
  719. </method>
  720. <doc>
  721. <![CDATA[<p>The protocol between a live instance of <code>ApplicationMaster</code>
  722. and the <code>ResourceManager</code>.</p>
  723. <p>This is used by the <code>ApplicationMaster</code> to register/unregister
  724. and to request and obtain resources in the cluster from the
  725. <code>ResourceManager</code>.</p>]]>
  726. </doc>
  727. </interface>
  728. <!-- end interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
  729. <!-- start interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
  730. <interface name="ClientSCMProtocol" abstract="true"
  731. static="false" final="false" visibility="public"
  732. deprecated="not deprecated">
  733. <method name="use" return="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse"
  734. abstract="true" native="false" synchronized="false"
  735. static="false" final="false" visibility="public"
  736. deprecated="not deprecated">
  737. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest"/>
  738. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  739. <exception name="IOException" type="java.io.IOException"/>
  740. <doc>
  741. <![CDATA[<p>
  742. The interface used by clients to claim a resource with the
  743. <code>SharedCacheManager.</code> The client uses a checksum to identify the
  744. resource and an {@link ApplicationId} to identify which application will be
  745. using the resource.
  746. </p>
  747. <p>
  748. The <code>SharedCacheManager</code> responds with whether or not the
  749. resource exists in the cache. If the resource exists, a <code>Path</code>
  750. to the resource in the shared cache is returned. If the resource does not
  751. exist, the response is empty.
  752. </p>
  753. @param request request to claim a resource in the shared cache
  754. @return response indicating if the resource is already in the cache
  755. @throws YarnException
  756. @throws IOException]]>
  757. </doc>
  758. </method>
  759. <method name="release" return="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse"
  760. abstract="true" native="false" synchronized="false"
  761. static="false" final="false" visibility="public"
  762. deprecated="not deprecated">
  763. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest"/>
  764. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  765. <exception name="IOException" type="java.io.IOException"/>
  766. <doc>
  767. <![CDATA[<p>
  768. The interface used by clients to release a resource with the
  769. <code>SharedCacheManager.</code> This method is called once an application
  770. is no longer using a claimed resource in the shared cache. The client uses
  771. a checksum to identify the resource and an {@link ApplicationId} to
  772. identify which application is releasing the resource.
  773. </p>
  774. <p>
  775. Note: This method is an optimization and the client is not required to call
  776. it for correctness.
  777. </p>
  778. <p>
  779. Currently the <code>SharedCacheManager</code> sends an empty response.
  780. </p>
  781. @param request request to release a resource in the shared cache
  782. @return (empty) response on releasing the resource
  783. @throws YarnException
  784. @throws IOException]]>
  785. </doc>
  786. </method>
  787. <doc>
  788. <![CDATA[<p>
  789. The protocol between clients and the <code>SharedCacheManager</code> to claim
  790. and release resources in the shared cache.
  791. </p>]]>
  792. </doc>
  793. </interface>
  794. <!-- end interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
  795. <!-- start interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
  796. <interface name="ContainerManagementProtocol" abstract="true"
  797. static="false" final="false" visibility="public"
  798. deprecated="not deprecated">
  799. <method name="startContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse"
  800. abstract="true" native="false" synchronized="false"
  801. static="false" final="false" visibility="public"
  802. deprecated="not deprecated">
  803. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"/>
  804. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  805. <exception name="IOException" type="java.io.IOException"/>
  806. <doc>
  807. <![CDATA[<p>
  808. The <code>ApplicationMaster</code> provides a list of
  809. {@link StartContainerRequest}s to a <code>NodeManager</code> to
  810. <em>start</em> {@link Container}s allocated to it using this interface.
  811. </p>
  812. <p>
  813. The <code>ApplicationMaster</code> has to provide details such as allocated
  814. resource capability, security tokens (if enabled), command to be executed
  815. to start the container, environment for the process, necessary
  816. binaries/jar/shared-objects etc. via the {@link ContainerLaunchContext} in
  817. the {@link StartContainerRequest}.
  818. </p>
  819. <p>
  820. The <code>NodeManager</code> sends a response via
  821. {@link StartContainersResponse} which includes a list of
  822. {@link Container}s of successfully launched {@link Container}s, a
  823. containerId-to-exception map for each failed {@link StartContainerRequest} in
  824. which the exception indicates errors from per container and a
  825. allServicesMetaData map between the names of auxiliary services and their
  826. corresponding meta-data. Note: None-container-specific exceptions will
  827. still be thrown by the API method itself.
  828. </p>
  829. <p>
  830. The <code>ApplicationMaster</code> can use
  831. {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
  832. statuses of the to-be-launched or launched containers.
  833. </p>
  834. @param request
  835. request to start a list of containers
  836. @return response including conatinerIds of all successfully launched
  837. containers, a containerId-to-exception map for failed requests and
  838. a allServicesMetaData map.
  839. @throws YarnException
  840. @throws IOException
  841. @throws NMNotYetReadyException
  842. This exception is thrown when NM starts from scratch but has not
  843. yet connected with RM.]]>
  844. </doc>
  845. </method>
  846. <method name="stopContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse"
  847. abstract="true" native="false" synchronized="false"
  848. static="false" final="false" visibility="public"
  849. deprecated="not deprecated">
  850. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"/>
  851. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  852. <exception name="IOException" type="java.io.IOException"/>
  853. <doc>
  854. <![CDATA[<p>
  855. The <code>ApplicationMaster</code> requests a <code>NodeManager</code> to
  856. <em>stop</em> a list of {@link Container}s allocated to it using this
  857. interface.
  858. </p>
  859. <p>
  860. The <code>ApplicationMaster</code> sends a {@link StopContainersRequest}
  861. which includes the {@link ContainerId}s of the containers to be stopped.
  862. </p>
  863. <p>
  864. The <code>NodeManager</code> sends a response via
  865. {@link StopContainersResponse} which includes a list of {@link ContainerId}
  866. s of successfully stopped containers, a containerId-to-exception map for
  867. each failed request in which the exception indicates errors from per
  868. container. Note: None-container-specific exceptions will still be thrown by
  869. the API method itself. <code>ApplicationMaster</code> can use
  870. {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
  871. statuses of the containers.
  872. </p>
  873. @param request
  874. request to stop a list of containers
  875. @return response which includes a list of containerIds of successfully
  876. stopped containers, a containerId-to-exception map for failed
  877. requests.
  878. @throws YarnException
  879. @throws IOException]]>
  880. </doc>
  881. </method>
  882. <method name="getContainerStatuses" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse"
  883. abstract="true" native="false" synchronized="false"
  884. static="false" final="false" visibility="public"
  885. deprecated="not deprecated">
  886. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"/>
  887. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  888. <exception name="IOException" type="java.io.IOException"/>
  889. <doc>
  890. <![CDATA[<p>
  891. The API used by the <code>ApplicationMaster</code> to request for current
  892. statuses of <code>Container</code>s from the <code>NodeManager</code>.
  893. </p>
  894. <p>
  895. The <code>ApplicationMaster</code> sends a
  896. {@link GetContainerStatusesRequest} which includes the {@link ContainerId}s
  897. of all containers whose statuses are needed.
  898. </p>
  899. <p>
  900. The <code>NodeManager</code> responds with
  901. {@link GetContainerStatusesResponse} which includes a list of
  902. {@link ContainerStatus} of the successfully queried containers and a
  903. containerId-to-exception map for each failed request in which the exception
  904. indicates errors from per container. Note: None-container-specific
  905. exceptions will still be thrown by the API method itself.
  906. </p>
  907. @param request
  908. request to get <code>ContainerStatus</code>es of containers with
  909. the specified <code>ContainerId</code>s
  910. @return response containing the list of <code>ContainerStatus</code> of the
  911. successfully queried containers and a containerId-to-exception map
  912. for failed requests.
  913. @throws YarnException
  914. @throws IOException]]>
  915. </doc>
  916. </method>
  917. <method name="increaseContainersResource" return="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse"
  918. abstract="true" native="false" synchronized="false"
  919. static="false" final="false" visibility="public"
  920. deprecated="not deprecated">
  921. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest"/>
  922. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  923. <exception name="IOException" type="java.io.IOException"/>
  924. <doc>
  925. <![CDATA[<p>
  926. The API used by the <code>ApplicationMaster</code> to request for
  927. resource increase of running containers on the <code>NodeManager</code>.
  928. </p>
  929. @param request
  930. request to increase resource of a list of containers
  931. @return response which includes a list of containerIds of containers
  932. whose resource has been successfully increased and a
  933. containerId-to-exception map for failed requests.
  934. @throws YarnException
  935. @throws IOException]]>
  936. </doc>
  937. </method>
  938. <method name="signalToContainer" return="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse"
  939. abstract="true" native="false" synchronized="false"
  940. static="false" final="false" visibility="public"
  941. deprecated="not deprecated">
  942. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest"/>
  943. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  944. <exception name="IOException" type="java.io.IOException"/>
  945. </method>
  946. <doc>
  947. <![CDATA[<p>The protocol between an <code>ApplicationMaster</code> and a
  948. <code>NodeManager</code> to start/stop and increase resource of containers
  949. and to get status of running containers.</p>
  950. <p>If security is enabled the <code>NodeManager</code> verifies that the
  951. <code>ApplicationMaster</code> has truly been allocated the container
  952. by the <code>ResourceManager</code> and also verifies all interactions such
  953. as stopping the container or obtaining status information for the container.
  954. </p>]]>
  955. </doc>
  956. </interface>
  957. <!-- end interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
  958. </package>
  959. <package name="org.apache.hadoop.yarn.api.protocolrecords">
  960. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
  961. <class name="AllocateRequest" extends="java.lang.Object"
  962. abstract="true"
  963. static="false" final="false" visibility="public"
  964. deprecated="not deprecated">
  965. <constructor name="AllocateRequest"
  966. static="false" final="false" visibility="public"
  967. deprecated="not deprecated">
  968. </constructor>
  969. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  970. abstract="false" native="false" synchronized="false"
  971. static="true" final="false" visibility="public"
  972. deprecated="not deprecated">
  973. <param name="responseID" type="int"/>
  974. <param name="appProgress" type="float"/>
  975. <param name="resourceAsk" type="java.util.List"/>
  976. <param name="containersToBeReleased" type="java.util.List"/>
  977. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  978. </method>
  979. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  980. abstract="false" native="false" synchronized="false"
  981. static="true" final="false" visibility="public"
  982. deprecated="not deprecated">
  983. <param name="responseID" type="int"/>
  984. <param name="appProgress" type="float"/>
  985. <param name="resourceAsk" type="java.util.List"/>
  986. <param name="containersToBeReleased" type="java.util.List"/>
  987. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  988. <param name="increaseRequests" type="java.util.List"/>
  989. <doc>
  990. <![CDATA[Use {@link AllocateRequest#newInstance(int, float, List, List,
  991. ResourceBlacklistRequest, List)} instead
  992. @param responseID responseId
  993. @param appProgress appProgress
  994. @param resourceAsk resourceAsk
  995. @param containersToBeReleased containersToBeReleased
  996. @param resourceBlacklistRequest resourceBlacklistRequest
  997. @param increaseRequests increaseRequests
  998. @return AllocateRequest]]>
  999. </doc>
  1000. </method>
  1001. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1002. abstract="false" native="false" synchronized="false"
  1003. static="true" final="false" visibility="public"
  1004. deprecated="not deprecated">
  1005. <param name="responseID" type="int"/>
  1006. <param name="appProgress" type="float"/>
  1007. <param name="resourceAsk" type="java.util.List"/>
  1008. <param name="containersToBeReleased" type="java.util.List"/>
  1009. <param name="updateRequests" type="java.util.List"/>
  1010. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1011. </method>
  1012. <method name="getResponseId" return="int"
  1013. abstract="true" native="false" synchronized="false"
  1014. static="false" final="false" visibility="public"
  1015. deprecated="not deprecated">
  1016. <doc>
  1017. <![CDATA[Get the <em>response id</em> used to track duplicate responses.
  1018. @return <em>response id</em>]]>
  1019. </doc>
  1020. </method>
  1021. <method name="setResponseId"
  1022. abstract="true" native="false" synchronized="false"
  1023. static="false" final="false" visibility="public"
  1024. deprecated="not deprecated">
  1025. <param name="id" type="int"/>
  1026. <doc>
  1027. <![CDATA[Set the <em>response id</em> used to track duplicate responses.
  1028. @param id <em>response id</em>]]>
  1029. </doc>
  1030. </method>
  1031. <method name="getProgress" return="float"
  1032. abstract="true" native="false" synchronized="false"
  1033. static="false" final="false" visibility="public"
  1034. deprecated="not deprecated">
  1035. <doc>
  1036. <![CDATA[Get the <em>current progress</em> of application.
  1037. @return <em>current progress</em> of application]]>
  1038. </doc>
  1039. </method>
  1040. <method name="setProgress"
  1041. abstract="true" native="false" synchronized="false"
  1042. static="false" final="false" visibility="public"
  1043. deprecated="not deprecated">
  1044. <param name="progress" type="float"/>
  1045. <doc>
  1046. <![CDATA[Set the <em>current progress</em> of application
  1047. @param progress <em>current progress</em> of application]]>
  1048. </doc>
  1049. </method>
  1050. <method name="getAskList" return="java.util.List"
  1051. abstract="true" native="false" synchronized="false"
  1052. static="false" final="false" visibility="public"
  1053. deprecated="not deprecated">
  1054. <doc>
  1055. <![CDATA[Get the list of <code>ResourceRequest</code> to update the
  1056. <code>ResourceManager</code> about the application's resource requirements.
  1057. @return the list of <code>ResourceRequest</code>
  1058. @see ResourceRequest]]>
  1059. </doc>
  1060. </method>
  1061. <method name="setAskList"
  1062. abstract="true" native="false" synchronized="false"
  1063. static="false" final="false" visibility="public"
  1064. deprecated="not deprecated">
  1065. <param name="resourceRequests" type="java.util.List"/>
  1066. <doc>
  1067. <![CDATA[Set list of <code>ResourceRequest</code> to update the
  1068. <code>ResourceManager</code> about the application's resource requirements.
  1069. @param resourceRequests list of <code>ResourceRequest</code> to update the
  1070. <code>ResourceManager</code> about the application's
  1071. resource requirements
  1072. @see ResourceRequest]]>
  1073. </doc>
  1074. </method>
  1075. <method name="getReleaseList" return="java.util.List"
  1076. abstract="true" native="false" synchronized="false"
  1077. static="false" final="false" visibility="public"
  1078. deprecated="not deprecated">
  1079. <doc>
  1080. <![CDATA[Get the list of <code>ContainerId</code> of containers being
  1081. released by the <code>ApplicationMaster</code>.
  1082. @return list of <code>ContainerId</code> of containers being
  1083. released by the <code>ApplicationMaster</code>]]>
  1084. </doc>
  1085. </method>
  1086. <method name="setReleaseList"
  1087. abstract="true" native="false" synchronized="false"
  1088. static="false" final="false" visibility="public"
  1089. deprecated="not deprecated">
  1090. <param name="releaseContainers" type="java.util.List"/>
  1091. <doc>
  1092. <![CDATA[Set the list of <code>ContainerId</code> of containers being
  1093. released by the <code>ApplicationMaster</code>
  1094. @param releaseContainers list of <code>ContainerId</code> of
  1095. containers being released by the
  1096. <code>ApplicationMaster</code>]]>
  1097. </doc>
  1098. </method>
  1099. <method name="getResourceBlacklistRequest" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
  1100. abstract="true" native="false" synchronized="false"
  1101. static="false" final="false" visibility="public"
  1102. deprecated="not deprecated">
  1103. <doc>
  1104. <![CDATA[Get the <code>ResourceBlacklistRequest</code> being sent by the
  1105. <code>ApplicationMaster</code>.
  1106. @return the <code>ResourceBlacklistRequest</code> being sent by the
  1107. <code>ApplicationMaster</code>
  1108. @see ResourceBlacklistRequest]]>
  1109. </doc>
  1110. </method>
  1111. <method name="setResourceBlacklistRequest"
  1112. abstract="true" native="false" synchronized="false"
  1113. static="false" final="false" visibility="public"
  1114. deprecated="not deprecated">
  1115. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1116. <doc>
  1117. <![CDATA[Set the <code>ResourceBlacklistRequest</code> to inform the
  1118. <code>ResourceManager</code> about the blacklist additions and removals
  1119. per the <code>ApplicationMaster</code>.
  1120. @param resourceBlacklistRequest the <code>ResourceBlacklistRequest</code>
  1121. to inform the <code>ResourceManager</code> about
  1122. the blacklist additions and removals
  1123. per the <code>ApplicationMaster</code>
  1124. @see ResourceBlacklistRequest]]>
  1125. </doc>
  1126. </method>
  1127. <method name="getIncreaseRequests" return="java.util.List"
  1128. abstract="true" native="false" synchronized="false"
  1129. static="false" final="false" visibility="public"
  1130. deprecated="not deprecated">
  1131. <doc>
  1132. <![CDATA[Use {@link AllocateRequest#getUpdateRequests()} instead
  1133. @return ContainerResourceIncreaseRequests]]>
  1134. </doc>
  1135. </method>
  1136. <method name="setIncreaseRequests"
  1137. abstract="true" native="false" synchronized="false"
  1138. static="false" final="false" visibility="public"
  1139. deprecated="not deprecated">
  1140. <param name="increaseRequests" type="java.util.List"/>
  1141. <doc>
  1142. <![CDATA[Use {@link AllocateRequest#setUpdateRequests(List)} instead
  1143. @param increaseRequests increaseRequests]]>
  1144. </doc>
  1145. </method>
  1146. <method name="getUpdateRequests" return="java.util.List"
  1147. abstract="true" native="false" synchronized="false"
  1148. static="false" final="false" visibility="public"
  1149. deprecated="not deprecated">
  1150. <doc>
  1151. <![CDATA[Get the list of container update requests being sent by the
  1152. <code>ApplicationMaster</code>.
  1153. @return list of {@link UpdateContainerRequest}
  1154. being sent by the
  1155. <code>ApplicationMaster</code>.]]>
  1156. </doc>
  1157. </method>
  1158. <method name="setUpdateRequests"
  1159. abstract="true" native="false" synchronized="false"
  1160. static="false" final="false" visibility="public"
  1161. deprecated="not deprecated">
  1162. <param name="updateRequests" type="java.util.List"/>
  1163. <doc>
  1164. <![CDATA[Set the list of container update requests to inform the
  1165. <code>ResourceManager</code> about the containers that need to be
  1166. updated.
  1167. @param updateRequests list of <code>UpdateContainerRequest</code> for
  1168. containers to be updated]]>
  1169. </doc>
  1170. </method>
  1171. <doc>
  1172. <![CDATA[<p>The core request sent by the <code>ApplicationMaster</code> to the
  1173. <code>ResourceManager</code> to obtain resources in the cluster.</p>
  1174. <p>The request includes:
  1175. <ul>
  1176. <li>A response id to track duplicate responses.</li>
  1177. <li>Progress information.</li>
  1178. <li>
  1179. A list of {@link ResourceRequest} to inform the
  1180. <code>ResourceManager</code> about the application's
  1181. resource requirements.
  1182. </li>
  1183. <li>
  1184. A list of unused {@link Container} which are being returned.
  1185. </li>
  1186. <li>
  1187. A list of {@link UpdateContainerRequest} to inform
  1188. the <code>ResourceManager</code> about the change in
  1189. requirements of running containers.
  1190. </li>
  1191. </ul>
  1192. @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
  1193. </doc>
  1194. </class>
  1195. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
  1196. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
  1197. <class name="AllocateResponse" extends="java.lang.Object"
  1198. abstract="true"
  1199. static="false" final="false" visibility="public"
  1200. deprecated="not deprecated">
  1201. <constructor name="AllocateResponse"
  1202. static="false" final="false" visibility="public"
  1203. deprecated="not deprecated">
  1204. </constructor>
  1205. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1206. abstract="false" native="false" synchronized="false"
  1207. static="true" final="false" visibility="public"
  1208. deprecated="not deprecated">
  1209. <param name="responseId" type="int"/>
  1210. <param name="completedContainers" type="java.util.List"/>
  1211. <param name="allocatedContainers" type="java.util.List"/>
  1212. <param name="updatedNodes" type="java.util.List"/>
  1213. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1214. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1215. <param name="numClusterNodes" type="int"/>
  1216. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1217. <param name="nmTokens" type="java.util.List"/>
  1218. </method>
  1219. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1220. abstract="false" native="false" synchronized="false"
  1221. static="true" final="false" visibility="public"
  1222. deprecated="not deprecated">
  1223. <param name="responseId" type="int"/>
  1224. <param name="completedContainers" type="java.util.List"/>
  1225. <param name="allocatedContainers" type="java.util.List"/>
  1226. <param name="updatedNodes" type="java.util.List"/>
  1227. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1228. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1229. <param name="numClusterNodes" type="int"/>
  1230. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1231. <param name="nmTokens" type="java.util.List"/>
  1232. <param name="increasedContainers" type="java.util.List"/>
  1233. <param name="decreasedContainers" type="java.util.List"/>
  1234. <doc>
  1235. <![CDATA[Use {@link AllocateResponse#newInstance(int, List, List, List, Resource,
  1236. AMCommand, int, PreemptionMessage, List, Token, List)} instead
  1237. @param responseId responseId
  1238. @param completedContainers completedContainers
  1239. @param allocatedContainers allocatedContainers
  1240. @param updatedNodes updatedNodes
  1241. @param availResources availResources
  1242. @param command command
  1243. @param numClusterNodes numClusterNodes
  1244. @param preempt preempt
  1245. @param nmTokens nmTokens
  1246. @param increasedContainers increasedContainers
  1247. @param decreasedContainers decreasedContainers
  1248. @return AllocateResponse]]>
  1249. </doc>
  1250. </method>
  1251. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1252. abstract="false" native="false" synchronized="false"
  1253. static="true" final="false" visibility="public"
  1254. deprecated="not deprecated">
  1255. <param name="responseId" type="int"/>
  1256. <param name="completedContainers" type="java.util.List"/>
  1257. <param name="allocatedContainers" type="java.util.List"/>
  1258. <param name="updatedNodes" type="java.util.List"/>
  1259. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1260. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1261. <param name="numClusterNodes" type="int"/>
  1262. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1263. <param name="nmTokens" type="java.util.List"/>
  1264. <param name="updatedContainers" type="java.util.List"/>
  1265. </method>
  1266. <method name="getAMCommand" return="org.apache.hadoop.yarn.api.records.AMCommand"
  1267. abstract="true" native="false" synchronized="false"
  1268. static="false" final="false" visibility="public"
  1269. deprecated="not deprecated">
  1270. <doc>
  1271. <![CDATA[If the <code>ResourceManager</code> needs the
  1272. <code>ApplicationMaster</code> to take some action then it will send an
  1273. AMCommand to the <code>ApplicationMaster</code>. See <code>AMCommand</code>
  1274. for details on commands and actions for them.
  1275. @return <code>AMCommand</code> if the <code>ApplicationMaster</code> should
  1276. take action, <code>null</code> otherwise
  1277. @see AMCommand]]>
  1278. </doc>
  1279. </method>
  1280. <method name="getResponseId" return="int"
  1281. abstract="true" native="false" synchronized="false"
  1282. static="false" final="false" visibility="public"
  1283. deprecated="not deprecated">
  1284. <doc>
  1285. <![CDATA[Get the <em>last response id</em>.
  1286. @return <em>last response id</em>]]>
  1287. </doc>
  1288. </method>
  1289. <method name="getAllocatedContainers" return="java.util.List"
  1290. abstract="true" native="false" synchronized="false"
  1291. static="false" final="false" visibility="public"
  1292. deprecated="not deprecated">
  1293. <doc>
  1294. <![CDATA[Get the list of <em>newly allocated</em> <code>Container</code> by the
  1295. <code>ResourceManager</code>.
  1296. @return list of <em>newly allocated</em> <code>Container</code>]]>
  1297. </doc>
  1298. </method>
  1299. <method name="getAvailableResources" return="org.apache.hadoop.yarn.api.records.Resource"
  1300. abstract="true" native="false" synchronized="false"
  1301. static="false" final="false" visibility="public"
  1302. deprecated="not deprecated">
  1303. <doc>
  1304. <![CDATA[Get the <em>available headroom</em> for resources in the cluster for the
  1305. application.
  1306. @return limit of available headroom for resources in the cluster for the
  1307. application]]>
  1308. </doc>
  1309. </method>
  1310. <method name="getCompletedContainersStatuses" return="java.util.List"
  1311. abstract="true" native="false" synchronized="false"
  1312. static="false" final="false" visibility="public"
  1313. deprecated="not deprecated">
  1314. <doc>
  1315. <![CDATA[Get the list of <em>completed containers' statuses</em>.
  1316. @return the list of <em>completed containers' statuses</em>]]>
  1317. </doc>
  1318. </method>
  1319. <method name="getUpdatedNodes" return="java.util.List"
  1320. abstract="true" native="false" synchronized="false"
  1321. static="false" final="false" visibility="public"
  1322. deprecated="not deprecated">
  1323. <doc>
  1324. <![CDATA[Get the list of <em>updated <code>NodeReport</code>s</em>. Updates could
  1325. be changes in health, availability etc of the nodes.
  1326. @return The delta of updated nodes since the last response]]>
  1327. </doc>
  1328. </method>
  1329. <method name="getNumClusterNodes" return="int"
  1330. abstract="true" native="false" synchronized="false"
  1331. static="false" final="false" visibility="public"
  1332. deprecated="not deprecated">
  1333. <doc>
  1334. <![CDATA[Get the number of hosts available on the cluster.
  1335. @return the available host count.]]>
  1336. </doc>
  1337. </method>
  1338. <method name="getPreemptionMessage" return="org.apache.hadoop.yarn.api.records.PreemptionMessage"
  1339. abstract="true" native="false" synchronized="false"
  1340. static="false" final="false" visibility="public"
  1341. deprecated="not deprecated">
  1342. <doc>
  1343. <![CDATA[Get the description of containers owned by the AM, but requested back by
  1344. the cluster. Note that the RM may have an inconsistent view of the
  1345. resources owned by the AM. These messages are advisory, and the AM may
  1346. elect to ignore them.
  1347. <p>
  1348. The message is a snapshot of the resources the RM wants back from the AM.
  1349. While demand persists, the RM will repeat its request; applications should
  1350. not interpret each message as a request for <em>additional</em>
  1351. resources on top of previous messages. Resources requested consistently
  1352. over some duration may be forcibly killed by the RM.
  1353. @return A specification of the resources to reclaim from this AM.]]>
  1354. </doc>
  1355. </method>
  1356. <method name="getNMTokens" return="java.util.List"
  1357. abstract="true" native="false" synchronized="false"
  1358. static="false" final="false" visibility="public"
  1359. deprecated="not deprecated">
  1360. <doc>
  1361. <![CDATA[Get the list of NMTokens required for communicating with NM. New NMTokens
  1362. issued only if
  1363. <p>
  1364. 1) AM is receiving first container on underlying NodeManager.<br>
  1365. OR<br>
  1366. 2) NMToken master key rolled over in ResourceManager and AM is getting new
  1367. container on the same underlying NodeManager.
  1368. <p>
  1369. AM will receive one NMToken per NM irrespective of the number of containers
  1370. issued on same NM. AM is expected to store these tokens until issued a
  1371. new token for the same NM.]]>
  1372. </doc>
  1373. </method>
  1374. <method name="getUpdatedContainers" return="java.util.List"
  1375. abstract="true" native="false" synchronized="false"
  1376. static="false" final="false" visibility="public"
  1377. deprecated="not deprecated">
  1378. <doc>
  1379. <![CDATA[Get the list of newly updated containers by
  1380. <code>ResourceManager</code>.]]>
  1381. </doc>
  1382. </method>
  1383. <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
  1384. abstract="true" native="false" synchronized="false"
  1385. static="false" final="false" visibility="public"
  1386. deprecated="not deprecated">
  1387. <doc>
  1388. <![CDATA[The AMRMToken that belong to this attempt
  1389. @return The AMRMToken that belong to this attempt]]>
  1390. </doc>
  1391. </method>
  1392. <method name="getApplicationPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  1393. abstract="true" native="false" synchronized="false"
  1394. static="false" final="false" visibility="public"
  1395. deprecated="not deprecated">
  1396. <doc>
  1397. <![CDATA[Priority of the application
  1398. @return get application priority]]>
  1399. </doc>
  1400. </method>
  1401. <method name="getUpdateErrors" return="java.util.List"
  1402. abstract="false" native="false" synchronized="false"
  1403. static="false" final="false" visibility="public"
  1404. deprecated="not deprecated">
  1405. <doc>
  1406. <![CDATA[Get the list of container update errors to inform the
  1407. Application Master about the container updates that could not be
  1408. satisfied due to error.
  1409. @return List of Update Container Errors.]]>
  1410. </doc>
  1411. </method>
  1412. <method name="setUpdateErrors"
  1413. abstract="false" native="false" synchronized="false"
  1414. static="false" final="false" visibility="public"
  1415. deprecated="not deprecated">
  1416. <param name="updateErrors" type="java.util.List"/>
  1417. <doc>
  1418. <![CDATA[Set the list of container update errors to inform the
  1419. Application Master about the container updates that could not be
  1420. satisfied due to error.
  1421. @param updateErrors list of <code>UpdateContainerError</code> for
  1422. containers updates requests that were in error]]>
  1423. </doc>
  1424. </method>
  1425. <method name="getIncreasedContainers" return="java.util.List"
  1426. abstract="true" native="false" synchronized="false"
  1427. static="false" final="false" visibility="public"
  1428. deprecated="not deprecated">
  1429. <doc>
  1430. <![CDATA[Use {@link AllocateResponse#getUpdatedContainers()} instead
  1431. @return null]]>
  1432. </doc>
  1433. </method>
  1434. <method name="getDecreasedContainers" return="java.util.List"
  1435. abstract="true" native="false" synchronized="false"
  1436. static="false" final="false" visibility="public"
  1437. deprecated="not deprecated">
  1438. <doc>
  1439. <![CDATA[Use {@link AllocateResponse#getUpdatedContainers()} instead
  1440. @return null]]>
  1441. </doc>
  1442. </method>
  1443. <doc>
  1444. <![CDATA[The response sent by the <code>ResourceManager</code> the
  1445. <code>ApplicationMaster</code> during resource negotiation.
  1446. <p>
  1447. The response, includes:
  1448. <ul>
  1449. <li>Response ID to track duplicate responses.</li>
  1450. <li>
  1451. An AMCommand sent by ResourceManager to let the
  1452. {@code ApplicationMaster} take some actions (resync, shutdown etc.).
  1453. </li>
  1454. <li>A list of newly allocated {@link Container}.</li>
  1455. <li>A list of completed {@link Container}s' statuses.</li>
  1456. <li>
  1457. The available headroom for resources in the cluster for the
  1458. application.
  1459. </li>
  1460. <li>A list of nodes whose status has been updated.</li>
  1461. <li>The number of available nodes in a cluster.</li>
  1462. <li>A description of resources requested back by the cluster</li>
  1463. <li>AMRMToken, if AMRMToken has been rolled over</li>
  1464. <li>
  1465. A list of {@link Container} representing the containers
  1466. whose resource has been increased.
  1467. </li>
  1468. <li>
  1469. A list of {@link Container} representing the containers
  1470. whose resource has been decreased.
  1471. </li>
  1472. </ul>
  1473. @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
  1474. </doc>
  1475. </class>
  1476. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
  1477. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
  1478. <class name="ApplicationsRequestScope" extends="java.lang.Enum"
  1479. abstract="false"
  1480. static="false" final="true" visibility="public"
  1481. deprecated="not deprecated">
  1482. <method name="values" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope[]"
  1483. abstract="false" native="false" synchronized="false"
  1484. static="true" final="false" visibility="public"
  1485. deprecated="not deprecated">
  1486. </method>
  1487. <method name="valueOf" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"
  1488. abstract="false" native="false" synchronized="false"
  1489. static="true" final="false" visibility="public"
  1490. deprecated="not deprecated">
  1491. <param name="name" type="java.lang.String"/>
  1492. </method>
  1493. <doc>
  1494. <![CDATA[Enumeration that controls the scope of applications fetched]]>
  1495. </doc>
  1496. </class>
  1497. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
  1498. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest -->
  1499. <class name="FailApplicationAttemptRequest" extends="java.lang.Object"
  1500. abstract="true"
  1501. static="false" final="false" visibility="public"
  1502. deprecated="not deprecated">
  1503. <constructor name="FailApplicationAttemptRequest"
  1504. static="false" final="false" visibility="public"
  1505. deprecated="not deprecated">
  1506. </constructor>
  1507. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest"
  1508. abstract="false" native="false" synchronized="false"
  1509. static="true" final="false" visibility="public"
  1510. deprecated="not deprecated">
  1511. <param name="attemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1512. </method>
  1513. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  1514. abstract="true" native="false" synchronized="false"
  1515. static="false" final="false" visibility="public"
  1516. deprecated="not deprecated">
  1517. <doc>
  1518. <![CDATA[Get the <code>ApplicationAttemptId</code> of the attempt to be failed.
  1519. @return <code>ApplicationAttemptId</code> of the attempt.]]>
  1520. </doc>
  1521. </method>
  1522. <method name="setApplicationAttemptId"
  1523. abstract="true" native="false" synchronized="false"
  1524. static="false" final="false" visibility="public"
  1525. deprecated="not deprecated">
  1526. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1527. </method>
  1528. <doc>
  1529. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  1530. to fail an application attempt.</p>
  1531. <p>The request includes the {@link ApplicationAttemptId} of the attempt to
  1532. be failed.</p>
  1533. @see ApplicationClientProtocol#failApplicationAttempt(FailApplicationAttemptRequest)]]>
  1534. </doc>
  1535. </class>
  1536. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest -->
  1537. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptResponse -->
  1538. <class name="FailApplicationAttemptResponse" extends="java.lang.Object"
  1539. abstract="true"
  1540. static="false" final="false" visibility="public"
  1541. deprecated="not deprecated">
  1542. <constructor name="FailApplicationAttemptResponse"
  1543. static="false" final="false" visibility="public"
  1544. deprecated="not deprecated">
  1545. </constructor>
  1546. <doc>
  1547. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client
  1548. failing an application attempt.</p>
  1549. <p>Currently it's empty.</p>
  1550. @see ApplicationClientProtocol#failApplicationAttempt(FailApplicationAttemptRequest)]]>
  1551. </doc>
  1552. </class>
  1553. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptResponse -->
  1554. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
  1555. <class name="FinishApplicationMasterRequest" extends="java.lang.Object"
  1556. abstract="true"
  1557. static="false" final="false" visibility="public"
  1558. deprecated="not deprecated">
  1559. <constructor name="FinishApplicationMasterRequest"
  1560. static="false" final="false" visibility="public"
  1561. deprecated="not deprecated">
  1562. </constructor>
  1563. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"
  1564. abstract="false" native="false" synchronized="false"
  1565. static="true" final="false" visibility="public"
  1566. deprecated="not deprecated">
  1567. <param name="finalAppStatus" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
  1568. <param name="diagnostics" type="java.lang.String"/>
  1569. <param name="url" type="java.lang.String"/>
  1570. </method>
  1571. <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  1572. abstract="true" native="false" synchronized="false"
  1573. static="false" final="false" visibility="public"
  1574. deprecated="not deprecated">
  1575. <doc>
  1576. <![CDATA[Get <em>final state</em> of the <code>ApplicationMaster</code>.
  1577. @return <em>final state</em> of the <code>ApplicationMaster</code>]]>
  1578. </doc>
  1579. </method>
  1580. <method name="setFinalApplicationStatus"
  1581. abstract="true" native="false" synchronized="false"
  1582. static="false" final="false" visibility="public"
  1583. deprecated="not deprecated">
  1584. <param name="finalState" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
  1585. <doc>
  1586. <![CDATA[Set the <em>final state</em> of the <code>ApplicationMaster</code>
  1587. @param finalState <em>final state</em> of the <code>ApplicationMaster</code>]]>
  1588. </doc>
  1589. </method>
  1590. <method name="getDiagnostics" return="java.lang.String"
  1591. abstract="true" native="false" synchronized="false"
  1592. static="false" final="false" visibility="public"
  1593. deprecated="not deprecated">
  1594. <doc>
  1595. <![CDATA[Get <em>diagnostic information</em> on application failure.
  1596. @return <em>diagnostic information</em> on application failure]]>
  1597. </doc>
  1598. </method>
  1599. <method name="setDiagnostics"
  1600. abstract="true" native="false" synchronized="false"
  1601. static="false" final="false" visibility="public"
  1602. deprecated="not deprecated">
  1603. <param name="diagnostics" type="java.lang.String"/>
  1604. <doc>
  1605. <![CDATA[Set <em>diagnostic information</em> on application failure.
  1606. @param diagnostics <em>diagnostic information</em> on application failure]]>
  1607. </doc>
  1608. </method>
  1609. <method name="getTrackingUrl" return="java.lang.String"
  1610. abstract="true" native="false" synchronized="false"
  1611. static="false" final="false" visibility="public"
  1612. deprecated="not deprecated">
  1613. <doc>
  1614. <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
  1615. This url if contains scheme then that will be used by resource manager
  1616. web application proxy otherwise it will default to http.
  1617. @return <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  1618. </doc>
  1619. </method>
  1620. <method name="setTrackingUrl"
  1621. abstract="true" native="false" synchronized="false"
  1622. static="false" final="false" visibility="public"
  1623. deprecated="not deprecated">
  1624. <param name="url" type="java.lang.String"/>
  1625. <doc>
  1626. <![CDATA[Set the <em>final tracking URL</em>for the <code>ApplicationMaster</code>.
  1627. This is the web-URL to which ResourceManager or web-application proxy will
  1628. redirect client/users once the application is finished and the
  1629. <code>ApplicationMaster</code> is gone.
  1630. <p>
  1631. If the passed url has a scheme then that will be used by the
  1632. ResourceManager and web-application proxy, otherwise the scheme will
  1633. default to http.
  1634. </p>
  1635. <p>
  1636. Empty, null, "N/A" strings are all valid besides a real URL. In case an url
  1637. isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
  1638. <p>
  1639. @param url
  1640. <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  1641. </doc>
  1642. </method>
  1643. <doc>
  1644. <![CDATA[The finalization request sent by the {@code ApplicationMaster} to
  1645. inform the {@code ResourceManager} about its completion.
  1646. <p>
  1647. The final request includes details such:
  1648. <ul>
  1649. <li>Final state of the {@code ApplicationMaster}</li>
  1650. <li>
  1651. Diagnostic information in case of failure of the
  1652. {@code ApplicationMaster}
  1653. </li>
  1654. <li>Tracking URL</li>
  1655. </ul>
  1656. @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
  1657. </doc>
  1658. </class>
  1659. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
  1660. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
  1661. <class name="FinishApplicationMasterResponse" extends="java.lang.Object"
  1662. abstract="true"
  1663. static="false" final="false" visibility="public"
  1664. deprecated="not deprecated">
  1665. <constructor name="FinishApplicationMasterResponse"
  1666. static="false" final="false" visibility="public"
  1667. deprecated="not deprecated">
  1668. </constructor>
  1669. <method name="getIsUnregistered" return="boolean"
  1670. abstract="true" native="false" synchronized="false"
  1671. static="false" final="false" visibility="public"
  1672. deprecated="not deprecated">
  1673. <doc>
  1674. <![CDATA[Get the flag which indicates that the application has successfully
  1675. unregistered with the RM and the application can safely stop.]]>
  1676. </doc>
  1677. </method>
  1678. <doc>
  1679. <![CDATA[The response sent by the <code>ResourceManager</code> to a
  1680. <code>ApplicationMaster</code> on it's completion.
  1681. <p>
  1682. The response, includes:
  1683. <ul>
  1684. <li>A flag which indicates that the application has successfully unregistered
  1685. with the RM and the application can safely stop.</li>
  1686. </ul>
  1687. <p>
  1688. Note: The flag indicates whether the application has successfully
  1689. unregistered and is safe to stop. The application may stop after the flag is
  1690. true. If the application stops before the flag is true then the RM may retry
  1691. the application.
  1692. @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
  1693. </doc>
  1694. </class>
  1695. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
  1696. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
  1697. <class name="GetApplicationAttemptReportRequest" extends="java.lang.Object"
  1698. abstract="true"
  1699. static="false" final="false" visibility="public"
  1700. deprecated="not deprecated">
  1701. <constructor name="GetApplicationAttemptReportRequest"
  1702. static="false" final="false" visibility="public"
  1703. deprecated="not deprecated">
  1704. </constructor>
  1705. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"
  1706. abstract="false" native="false" synchronized="false"
  1707. static="true" final="false" visibility="public"
  1708. deprecated="not deprecated">
  1709. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1710. </method>
  1711. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  1712. abstract="true" native="false" synchronized="false"
  1713. static="false" final="false" visibility="public"
  1714. deprecated="not deprecated">
  1715. <doc>
  1716. <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
  1717. @return <code>ApplicationAttemptId</code> of an application attempt]]>
  1718. </doc>
  1719. </method>
  1720. <method name="setApplicationAttemptId"
  1721. abstract="true" native="false" synchronized="false"
  1722. static="false" final="false" visibility="public"
  1723. deprecated="not deprecated">
  1724. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1725. <doc>
  1726. <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
  1727. @param applicationAttemptId
  1728. <code>ApplicationAttemptId</code> of an application attempt]]>
  1729. </doc>
  1730. </method>
  1731. <doc>
  1732. <![CDATA[<p>
  1733. The request sent by a client to the <code>ResourceManager</code> to get an
  1734. {@link ApplicationAttemptReport} for an application attempt.
  1735. </p>
  1736. <p>
  1737. The request should include the {@link ApplicationAttemptId} of the
  1738. application attempt.
  1739. </p>
  1740. @see ApplicationAttemptReport
  1741. @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
  1742. </doc>
  1743. </class>
  1744. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
  1745. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
  1746. <class name="GetApplicationAttemptReportResponse" extends="java.lang.Object"
  1747. abstract="true"
  1748. static="false" final="false" visibility="public"
  1749. deprecated="not deprecated">
  1750. <constructor name="GetApplicationAttemptReportResponse"
  1751. static="false" final="false" visibility="public"
  1752. deprecated="not deprecated">
  1753. </constructor>
  1754. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
  1755. abstract="false" native="false" synchronized="false"
  1756. static="true" final="false" visibility="public"
  1757. deprecated="not deprecated">
  1758. <param name="ApplicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
  1759. </method>
  1760. <method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
  1761. abstract="true" native="false" synchronized="false"
  1762. static="false" final="false" visibility="public"
  1763. deprecated="not deprecated">
  1764. <doc>
  1765. <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
  1766. @return <code>ApplicationAttemptReport</code> for the application attempt]]>
  1767. </doc>
  1768. </method>
  1769. <method name="setApplicationAttemptReport"
  1770. abstract="true" native="false" synchronized="false"
  1771. static="false" final="false" visibility="public"
  1772. deprecated="not deprecated">
  1773. <param name="applicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
  1774. <doc>
  1775. <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
  1776. @param applicationAttemptReport
  1777. <code>ApplicationAttemptReport</code> for the application attempt]]>
  1778. </doc>
  1779. </method>
  1780. <doc>
  1781. <![CDATA[<p>
  1782. The response sent by the <code>ResourceManager</code> to a client requesting
  1783. an application attempt report.
  1784. </p>
  1785. <p>
  1786. The response includes an {@link ApplicationAttemptReport} which has the
  1787. details about the particular application attempt
  1788. </p>
  1789. @see ApplicationAttemptReport
  1790. @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
  1791. </doc>
  1792. </class>
  1793. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
  1794. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
  1795. <class name="GetApplicationAttemptsRequest" extends="java.lang.Object"
  1796. abstract="true"
  1797. static="false" final="false" visibility="public"
  1798. deprecated="not deprecated">
  1799. <constructor name="GetApplicationAttemptsRequest"
  1800. static="false" final="false" visibility="public"
  1801. deprecated="not deprecated">
  1802. </constructor>
  1803. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"
  1804. abstract="false" native="false" synchronized="false"
  1805. static="true" final="false" visibility="public"
  1806. deprecated="not deprecated">
  1807. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1808. </method>
  1809. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  1810. abstract="true" native="false" synchronized="false"
  1811. static="false" final="false" visibility="public"
  1812. deprecated="not deprecated">
  1813. <doc>
  1814. <![CDATA[Get the <code>ApplicationId</code> of an application
  1815. @return <code>ApplicationId</code> of an application]]>
  1816. </doc>
  1817. </method>
  1818. <method name="setApplicationId"
  1819. abstract="true" native="false" synchronized="false"
  1820. static="false" final="false" visibility="public"
  1821. deprecated="not deprecated">
  1822. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1823. <doc>
  1824. <![CDATA[Set the <code>ApplicationId</code> of an application
  1825. @param applicationId
  1826. <code>ApplicationId</code> of an application]]>
  1827. </doc>
  1828. </method>
  1829. <doc>
  1830. <![CDATA[<p>
  1831. The request from clients to get a list of application attempt reports of an
  1832. application from the <code>ResourceManager</code>.
  1833. </p>
  1834. @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
  1835. </doc>
  1836. </class>
  1837. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
  1838. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
  1839. <class name="GetApplicationAttemptsResponse" extends="java.lang.Object"
  1840. abstract="true"
  1841. static="false" final="false" visibility="public"
  1842. deprecated="not deprecated">
  1843. <constructor name="GetApplicationAttemptsResponse"
  1844. static="false" final="false" visibility="public"
  1845. deprecated="not deprecated">
  1846. </constructor>
  1847. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
  1848. abstract="false" native="false" synchronized="false"
  1849. static="true" final="false" visibility="public"
  1850. deprecated="not deprecated">
  1851. <param name="applicationAttempts" type="java.util.List"/>
  1852. </method>
  1853. <method name="getApplicationAttemptList" return="java.util.List"
  1854. abstract="true" native="false" synchronized="false"
  1855. static="false" final="false" visibility="public"
  1856. deprecated="not deprecated">
  1857. <doc>
  1858. <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
  1859. @return a list of <code>ApplicationReport</code> of an application]]>
  1860. </doc>
  1861. </method>
  1862. <method name="setApplicationAttemptList"
  1863. abstract="true" native="false" synchronized="false"
  1864. static="false" final="false" visibility="public"
  1865. deprecated="not deprecated">
  1866. <param name="applicationAttempts" type="java.util.List"/>
  1867. <doc>
  1868. <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
  1869. @param applicationAttempts
  1870. a list of <code>ApplicationReport</code> of an application]]>
  1871. </doc>
  1872. </method>
  1873. <doc>
  1874. <![CDATA[<p>
  1875. The response sent by the <code>ResourceManager</code> to a client requesting
  1876. a list of {@link ApplicationAttemptReport} for application attempts.
  1877. </p>
  1878. <p>
  1879. The <code>ApplicationAttemptReport</code> for each application includes the
  1880. details of an application attempt.
  1881. </p>
  1882. @see ApplicationAttemptReport
  1883. @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
  1884. </doc>
  1885. </class>
  1886. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
  1887. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
  1888. <class name="GetApplicationReportRequest" extends="java.lang.Object"
  1889. abstract="true"
  1890. static="false" final="false" visibility="public"
  1891. deprecated="not deprecated">
  1892. <constructor name="GetApplicationReportRequest"
  1893. static="false" final="false" visibility="public"
  1894. deprecated="not deprecated">
  1895. </constructor>
  1896. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"
  1897. abstract="false" native="false" synchronized="false"
  1898. static="true" final="false" visibility="public"
  1899. deprecated="not deprecated">
  1900. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1901. </method>
  1902. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  1903. abstract="true" native="false" synchronized="false"
  1904. static="false" final="false" visibility="public"
  1905. deprecated="not deprecated">
  1906. <doc>
  1907. <![CDATA[Get the <code>ApplicationId</code> of the application.
  1908. @return <code>ApplicationId</code> of the application]]>
  1909. </doc>
  1910. </method>
  1911. <method name="setApplicationId"
  1912. abstract="true" native="false" synchronized="false"
  1913. static="false" final="false" visibility="public"
  1914. deprecated="not deprecated">
  1915. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1916. <doc>
  1917. <![CDATA[Set the <code>ApplicationId</code> of the application
  1918. @param applicationId <code>ApplicationId</code> of the application]]>
  1919. </doc>
  1920. </method>
  1921. <doc>
  1922. <![CDATA[<p>The request sent by a client to the <code>ResourceManager</code> to
  1923. get an {@link ApplicationReport} for an application.</p>
  1924. <p>The request should include the {@link ApplicationId} of the
  1925. application.</p>
  1926. @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)
  1927. @see ApplicationReport]]>
  1928. </doc>
  1929. </class>
  1930. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
  1931. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
  1932. <class name="GetApplicationReportResponse" extends="java.lang.Object"
  1933. abstract="true"
  1934. static="false" final="false" visibility="public"
  1935. deprecated="not deprecated">
  1936. <constructor name="GetApplicationReportResponse"
  1937. static="false" final="false" visibility="public"
  1938. deprecated="not deprecated">
  1939. </constructor>
  1940. <method name="getApplicationReport" return="org.apache.hadoop.yarn.api.records.ApplicationReport"
  1941. abstract="true" native="false" synchronized="false"
  1942. static="false" final="false" visibility="public"
  1943. deprecated="not deprecated">
  1944. <doc>
  1945. <![CDATA[Get the <code>ApplicationReport</code> for the application.
  1946. @return <code>ApplicationReport</code> for the application]]>
  1947. </doc>
  1948. </method>
  1949. <doc>
  1950. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  1951. requesting an application report.</p>
  1952. <p>The response includes an {@link ApplicationReport} which has details such
  1953. as user, queue, name, host on which the <code>ApplicationMaster</code> is
  1954. running, RPC port, tracking URL, diagnostics, start time etc.</p>
  1955. @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)]]>
  1956. </doc>
  1957. </class>
  1958. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
  1959. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
  1960. <class name="GetApplicationsRequest" extends="java.lang.Object"
  1961. abstract="true"
  1962. static="false" final="false" visibility="public"
  1963. deprecated="not deprecated">
  1964. <constructor name="GetApplicationsRequest"
  1965. static="false" final="false" visibility="public"
  1966. deprecated="not deprecated">
  1967. </constructor>
  1968. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  1969. abstract="false" native="false" synchronized="false"
  1970. static="true" final="false" visibility="public"
  1971. deprecated="not deprecated">
  1972. </method>
  1973. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  1974. abstract="false" native="false" synchronized="false"
  1975. static="true" final="false" visibility="public"
  1976. deprecated="not deprecated">
  1977. <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
  1978. <param name="users" type="java.util.Set"/>
  1979. <param name="queues" type="java.util.Set"/>
  1980. <param name="applicationTypes" type="java.util.Set"/>
  1981. <param name="applicationTags" type="java.util.Set"/>
  1982. <param name="applicationStates" type="java.util.EnumSet"/>
  1983. <param name="startRange" type="org.apache.commons.lang.math.LongRange"/>
  1984. <param name="finishRange" type="org.apache.commons.lang.math.LongRange"/>
  1985. <param name="limit" type="java.lang.Long"/>
  1986. <doc>
  1987. <![CDATA[<p>
  1988. The request from clients to get a report of Applications matching the
  1989. giving application types in the cluster from the
  1990. <code>ResourceManager</code>.
  1991. </p>
  1992. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  1993. <p>Setting any of the parameters to null, would just disable that
  1994. filter</p>
  1995. @param scope {@link ApplicationsRequestScope} to filter by
  1996. @param users list of users to filter by
  1997. @param queues list of scheduler queues to filter by
  1998. @param applicationTypes types of applications
  1999. @param applicationTags application tags to filter by
  2000. @param applicationStates application states to filter by
  2001. @param startRange range of application start times to filter by
  2002. @param finishRange range of application finish times to filter by
  2003. @param limit number of applications to limit to
  2004. @return {@link GetApplicationsRequest} to be used with
  2005. {@link ApplicationClientProtocol#getApplications(GetApplicationsRequest)}]]>
  2006. </doc>
  2007. </method>
  2008. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2009. abstract="false" native="false" synchronized="false"
  2010. static="true" final="false" visibility="public"
  2011. deprecated="not deprecated">
  2012. <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
  2013. <doc>
  2014. <![CDATA[<p>
  2015. The request from clients to get a report of Applications matching the
  2016. giving application types in the cluster from the
  2017. <code>ResourceManager</code>.
  2018. </p>
  2019. @param scope {@link ApplicationsRequestScope} to filter by
  2020. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2021. </doc>
  2022. </method>
  2023. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2024. abstract="false" native="false" synchronized="false"
  2025. static="true" final="false" visibility="public"
  2026. deprecated="not deprecated">
  2027. <param name="applicationTypes" type="java.util.Set"/>
  2028. <doc>
  2029. <![CDATA[<p>
  2030. The request from clients to get a report of Applications matching the
  2031. giving application types in the cluster from the
  2032. <code>ResourceManager</code>.
  2033. </p>
  2034. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2035. </doc>
  2036. </method>
  2037. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2038. abstract="false" native="false" synchronized="false"
  2039. static="true" final="false" visibility="public"
  2040. deprecated="not deprecated">
  2041. <param name="applicationStates" type="java.util.EnumSet"/>
  2042. <doc>
  2043. <![CDATA[<p>
  2044. The request from clients to get a report of Applications matching the
  2045. giving application states in the cluster from the
  2046. <code>ResourceManager</code>.
  2047. </p>
  2048. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2049. </doc>
  2050. </method>
  2051. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2052. abstract="false" native="false" synchronized="false"
  2053. static="true" final="false" visibility="public"
  2054. deprecated="not deprecated">
  2055. <param name="applicationTypes" type="java.util.Set"/>
  2056. <param name="applicationStates" type="java.util.EnumSet"/>
  2057. <doc>
  2058. <![CDATA[<p>
  2059. The request from clients to get a report of Applications matching the
  2060. giving and application types and application types in the cluster from the
  2061. <code>ResourceManager</code>.
  2062. </p>
  2063. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2064. </doc>
  2065. </method>
  2066. <method name="getApplicationTypes" return="java.util.Set"
  2067. abstract="true" native="false" synchronized="false"
  2068. static="false" final="false" visibility="public"
  2069. deprecated="not deprecated">
  2070. <doc>
  2071. <![CDATA[Get the application types to filter applications on
  2072. @return Set of Application Types to filter on]]>
  2073. </doc>
  2074. </method>
  2075. <method name="getApplicationStates" return="java.util.EnumSet"
  2076. abstract="true" native="false" synchronized="false"
  2077. static="false" final="false" visibility="public"
  2078. deprecated="not deprecated">
  2079. <doc>
  2080. <![CDATA[Get the application states to filter applications on
  2081. @return Set of Application states to filter on]]>
  2082. </doc>
  2083. </method>
  2084. <doc>
  2085. <![CDATA[<p>The request from clients to get a report of Applications
  2086. in the cluster from the <code>ResourceManager</code>.</p>
  2087. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2088. </doc>
  2089. </class>
  2090. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
  2091. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
  2092. <class name="GetApplicationsResponse" extends="java.lang.Object"
  2093. abstract="true"
  2094. static="false" final="false" visibility="public"
  2095. deprecated="not deprecated">
  2096. <constructor name="GetApplicationsResponse"
  2097. static="false" final="false" visibility="public"
  2098. deprecated="not deprecated">
  2099. </constructor>
  2100. <method name="getApplicationList" return="java.util.List"
  2101. abstract="true" native="false" synchronized="false"
  2102. static="false" final="false" visibility="public"
  2103. deprecated="not deprecated">
  2104. <doc>
  2105. <![CDATA[Get <code>ApplicationReport</code> for applications.
  2106. @return <code>ApplicationReport</code> for applications]]>
  2107. </doc>
  2108. </method>
  2109. <doc>
  2110. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  2111. requesting an {@link ApplicationReport} for applications.</p>
  2112. <p>The <code>ApplicationReport</code> for each application includes details
  2113. such as user, queue, name, host on which the <code>ApplicationMaster</code>
  2114. is running, RPC port, tracking URL, diagnostics, start time etc.</p>
  2115. @see ApplicationReport
  2116. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2117. </doc>
  2118. </class>
  2119. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
  2120. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
  2121. <class name="GetClusterMetricsRequest" extends="java.lang.Object"
  2122. abstract="true"
  2123. static="false" final="false" visibility="public"
  2124. deprecated="not deprecated">
  2125. <constructor name="GetClusterMetricsRequest"
  2126. static="false" final="false" visibility="public"
  2127. deprecated="not deprecated">
  2128. </constructor>
  2129. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"
  2130. abstract="false" native="false" synchronized="false"
  2131. static="true" final="false" visibility="public"
  2132. deprecated="not deprecated">
  2133. </method>
  2134. <doc>
  2135. <![CDATA[<p>The request sent by clients to get cluster metrics from the
  2136. <code>ResourceManager</code>.</p>
  2137. <p>Currently, this is empty.</p>
  2138. @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
  2139. </doc>
  2140. </class>
  2141. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
  2142. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
  2143. <class name="GetClusterMetricsResponse" extends="java.lang.Object"
  2144. abstract="true"
  2145. static="false" final="false" visibility="public"
  2146. deprecated="not deprecated">
  2147. <constructor name="GetClusterMetricsResponse"
  2148. static="false" final="false" visibility="public"
  2149. deprecated="not deprecated">
  2150. </constructor>
  2151. <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.records.YarnClusterMetrics"
  2152. abstract="true" native="false" synchronized="false"
  2153. static="false" final="false" visibility="public"
  2154. deprecated="not deprecated">
  2155. <doc>
  2156. <![CDATA[Get the <code>YarnClusterMetrics</code> for the cluster.
  2157. @return <code>YarnClusterMetrics</code> for the cluster]]>
  2158. </doc>
  2159. </method>
  2160. <doc>
  2161. <![CDATA[The response sent by the <code>ResourceManager</code> to a client
  2162. requesting cluster metrics.
  2163. @see YarnClusterMetrics
  2164. @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
  2165. </doc>
  2166. </class>
  2167. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
  2168. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
  2169. <class name="GetClusterNodeLabelsRequest" extends="java.lang.Object"
  2170. abstract="true"
  2171. static="false" final="false" visibility="public"
  2172. deprecated="not deprecated">
  2173. <constructor name="GetClusterNodeLabelsRequest"
  2174. static="false" final="false" visibility="public"
  2175. deprecated="not deprecated">
  2176. </constructor>
  2177. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"
  2178. abstract="false" native="false" synchronized="false"
  2179. static="true" final="false" visibility="public"
  2180. deprecated="not deprecated">
  2181. </method>
  2182. </class>
  2183. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
  2184. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
  2185. <class name="GetClusterNodeLabelsResponse" extends="java.lang.Object"
  2186. abstract="true"
  2187. static="false" final="false" visibility="public"
  2188. deprecated="not deprecated">
  2189. <constructor name="GetClusterNodeLabelsResponse"
  2190. static="false" final="false" visibility="public"
  2191. deprecated="not deprecated">
  2192. </constructor>
  2193. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  2194. abstract="false" native="false" synchronized="false"
  2195. static="true" final="false" visibility="public"
  2196. deprecated="Use {@link #newInstance(List)} instead.">
  2197. <param name="labels" type="java.util.Set"/>
  2198. <doc>
  2199. <![CDATA[Creates a new instance.
  2200. @param labels Node labels
  2201. @return response
  2202. @deprecated Use {@link #newInstance(List)} instead.]]>
  2203. </doc>
  2204. </method>
  2205. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  2206. abstract="false" native="false" synchronized="false"
  2207. static="true" final="false" visibility="public"
  2208. deprecated="not deprecated">
  2209. <param name="labels" type="java.util.List"/>
  2210. </method>
  2211. <method name="setNodeLabelList"
  2212. abstract="true" native="false" synchronized="false"
  2213. static="false" final="false" visibility="public"
  2214. deprecated="not deprecated">
  2215. <param name="labels" type="java.util.List"/>
  2216. </method>
  2217. <method name="getNodeLabelList" return="java.util.List"
  2218. abstract="true" native="false" synchronized="false"
  2219. static="false" final="false" visibility="public"
  2220. deprecated="not deprecated">
  2221. </method>
  2222. <method name="setNodeLabels"
  2223. abstract="true" native="false" synchronized="false"
  2224. static="false" final="false" visibility="public"
  2225. deprecated="Use {@link #setNodeLabelList(List)} instead.">
  2226. <param name="labels" type="java.util.Set"/>
  2227. <doc>
  2228. <![CDATA[Set node labels to the response.
  2229. @param labels Node labels
  2230. @deprecated Use {@link #setNodeLabelList(List)} instead.]]>
  2231. </doc>
  2232. </method>
  2233. <method name="getNodeLabels" return="java.util.Set"
  2234. abstract="true" native="false" synchronized="false"
  2235. static="false" final="false" visibility="public"
  2236. deprecated="Use {@link #getNodeLabelList()} instead.">
  2237. <doc>
  2238. <![CDATA[Get node labels of the response.
  2239. @return Node labels
  2240. @deprecated Use {@link #getNodeLabelList()} instead.]]>
  2241. </doc>
  2242. </method>
  2243. </class>
  2244. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
  2245. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
  2246. <class name="GetClusterNodesRequest" extends="java.lang.Object"
  2247. abstract="true"
  2248. static="false" final="false" visibility="public"
  2249. deprecated="not deprecated">
  2250. <constructor name="GetClusterNodesRequest"
  2251. static="false" final="false" visibility="public"
  2252. deprecated="not deprecated">
  2253. </constructor>
  2254. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
  2255. abstract="false" native="false" synchronized="false"
  2256. static="true" final="false" visibility="public"
  2257. deprecated="not deprecated">
  2258. <param name="states" type="java.util.EnumSet"/>
  2259. </method>
  2260. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
  2261. abstract="false" native="false" synchronized="false"
  2262. static="true" final="false" visibility="public"
  2263. deprecated="not deprecated">
  2264. </method>
  2265. <method name="getNodeStates" return="java.util.EnumSet"
  2266. abstract="true" native="false" synchronized="false"
  2267. static="false" final="false" visibility="public"
  2268. deprecated="not deprecated">
  2269. <doc>
  2270. <![CDATA[The state to filter the cluster nodes with.]]>
  2271. </doc>
  2272. </method>
  2273. <method name="setNodeStates"
  2274. abstract="true" native="false" synchronized="false"
  2275. static="false" final="false" visibility="public"
  2276. deprecated="not deprecated">
  2277. <param name="states" type="java.util.EnumSet"/>
  2278. <doc>
  2279. <![CDATA[The state to filter the cluster nodes with.]]>
  2280. </doc>
  2281. </method>
  2282. <doc>
  2283. <![CDATA[<p>The request from clients to get a report of all nodes
  2284. in the cluster from the <code>ResourceManager</code>.</p>
  2285. The request will ask for all nodes in the given {@link NodeState}s.
  2286. @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
  2287. </doc>
  2288. </class>
  2289. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
  2290. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
  2291. <class name="GetClusterNodesResponse" extends="java.lang.Object"
  2292. abstract="true"
  2293. static="false" final="false" visibility="public"
  2294. deprecated="not deprecated">
  2295. <constructor name="GetClusterNodesResponse"
  2296. static="false" final="false" visibility="public"
  2297. deprecated="not deprecated">
  2298. </constructor>
  2299. <method name="getNodeReports" return="java.util.List"
  2300. abstract="true" native="false" synchronized="false"
  2301. static="false" final="false" visibility="public"
  2302. deprecated="not deprecated">
  2303. <doc>
  2304. <![CDATA[Get <code>NodeReport</code> for all nodes in the cluster.
  2305. @return <code>NodeReport</code> for all nodes in the cluster]]>
  2306. </doc>
  2307. </method>
  2308. <doc>
  2309. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  2310. requesting a {@link NodeReport} for all nodes.</p>
  2311. <p>The <code>NodeReport</code> contains per-node information such as
  2312. available resources, number of containers, tracking url, rack name, health
  2313. status etc.
  2314. @see NodeReport
  2315. @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
  2316. </doc>
  2317. </class>
  2318. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
  2319. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
  2320. <class name="GetContainerReportRequest" extends="java.lang.Object"
  2321. abstract="true"
  2322. static="false" final="false" visibility="public"
  2323. deprecated="not deprecated">
  2324. <constructor name="GetContainerReportRequest"
  2325. static="false" final="false" visibility="public"
  2326. deprecated="not deprecated">
  2327. </constructor>
  2328. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"
  2329. abstract="false" native="false" synchronized="false"
  2330. static="true" final="false" visibility="public"
  2331. deprecated="not deprecated">
  2332. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  2333. </method>
  2334. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  2335. abstract="true" native="false" synchronized="false"
  2336. static="false" final="false" visibility="public"
  2337. deprecated="not deprecated">
  2338. <doc>
  2339. <![CDATA[Get the <code>ContainerId</code> of the Container.
  2340. @return <code>ContainerId</code> of the Container]]>
  2341. </doc>
  2342. </method>
  2343. <method name="setContainerId"
  2344. abstract="true" native="false" synchronized="false"
  2345. static="false" final="false" visibility="public"
  2346. deprecated="not deprecated">
  2347. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  2348. <doc>
  2349. <![CDATA[Set the <code>ContainerId</code> of the container
  2350. @param containerId
  2351. <code>ContainerId</code> of the container]]>
  2352. </doc>
  2353. </method>
  2354. <doc>
  2355. <![CDATA[<p>
  2356. The request sent by a client to the <code>ResourceManager</code> to get an
  2357. {@link ContainerReport} for a container.
  2358. </p>]]>
  2359. </doc>
  2360. </class>
  2361. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
  2362. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
  2363. <class name="GetContainerReportResponse" extends="java.lang.Object"
  2364. abstract="true"
  2365. static="false" final="false" visibility="public"
  2366. deprecated="not deprecated">
  2367. <constructor name="GetContainerReportResponse"
  2368. static="false" final="false" visibility="public"
  2369. deprecated="not deprecated">
  2370. </constructor>
  2371. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
  2372. abstract="false" native="false" synchronized="false"
  2373. static="true" final="false" visibility="public"
  2374. deprecated="not deprecated">
  2375. <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
  2376. </method>
  2377. <method name="getContainerReport" return="org.apache.hadoop.yarn.api.records.ContainerReport"
  2378. abstract="true" native="false" synchronized="false"
  2379. static="false" final="false" visibility="public"
  2380. deprecated="not deprecated">
  2381. <doc>
  2382. <![CDATA[Get the <code>ContainerReport</code> for the container.
  2383. @return <code>ContainerReport</code> for the container]]>
  2384. </doc>
  2385. </method>
  2386. <method name="setContainerReport"
  2387. abstract="true" native="false" synchronized="false"
  2388. static="false" final="false" visibility="public"
  2389. deprecated="not deprecated">
  2390. <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
  2391. </method>
  2392. <doc>
  2393. <![CDATA[<p>
  2394. The response sent by the <code>ResourceManager</code> to a client requesting
  2395. a container report.
  2396. </p>
  2397. <p>
  2398. The response includes a {@link ContainerReport} which has details of a
  2399. container.
  2400. </p>]]>
  2401. </doc>
  2402. </class>
  2403. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
  2404. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
  2405. <class name="GetContainersRequest" extends="java.lang.Object"
  2406. abstract="true"
  2407. static="false" final="false" visibility="public"
  2408. deprecated="not deprecated">
  2409. <constructor name="GetContainersRequest"
  2410. static="false" final="false" visibility="public"
  2411. deprecated="not deprecated">
  2412. </constructor>
  2413. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"
  2414. abstract="false" native="false" synchronized="false"
  2415. static="true" final="false" visibility="public"
  2416. deprecated="not deprecated">
  2417. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2418. </method>
  2419. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2420. abstract="true" native="false" synchronized="false"
  2421. static="false" final="false" visibility="public"
  2422. deprecated="not deprecated">
  2423. <doc>
  2424. <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
  2425. @return <code>ApplicationAttemptId</code> of an application attempt]]>
  2426. </doc>
  2427. </method>
  2428. <method name="setApplicationAttemptId"
  2429. abstract="true" native="false" synchronized="false"
  2430. static="false" final="false" visibility="public"
  2431. deprecated="not deprecated">
  2432. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2433. <doc>
  2434. <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
  2435. @param applicationAttemptId
  2436. <code>ApplicationAttemptId</code> of an application attempt]]>
  2437. </doc>
  2438. </method>
  2439. <doc>
  2440. <![CDATA[<p>
  2441. The request from clients to get a list of container reports, which belong to
  2442. an application attempt from the <code>ResourceManager</code>.
  2443. </p>
  2444. @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
  2445. </doc>
  2446. </class>
  2447. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
  2448. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
  2449. <class name="GetContainersResponse" extends="java.lang.Object"
  2450. abstract="true"
  2451. static="false" final="false" visibility="public"
  2452. deprecated="not deprecated">
  2453. <constructor name="GetContainersResponse"
  2454. static="false" final="false" visibility="public"
  2455. deprecated="not deprecated">
  2456. </constructor>
  2457. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
  2458. abstract="false" native="false" synchronized="false"
  2459. static="true" final="false" visibility="public"
  2460. deprecated="not deprecated">
  2461. <param name="containers" type="java.util.List"/>
  2462. </method>
  2463. <method name="getContainerList" return="java.util.List"
  2464. abstract="true" native="false" synchronized="false"
  2465. static="false" final="false" visibility="public"
  2466. deprecated="not deprecated">
  2467. <doc>
  2468. <![CDATA[Get a list of <code>ContainerReport</code> for all the containers of an
  2469. application attempt.
  2470. @return a list of <code>ContainerReport</code> for all the containers of an
  2471. application attempt]]>
  2472. </doc>
  2473. </method>
  2474. <method name="setContainerList"
  2475. abstract="true" native="false" synchronized="false"
  2476. static="false" final="false" visibility="public"
  2477. deprecated="not deprecated">
  2478. <param name="containers" type="java.util.List"/>
  2479. <doc>
  2480. <![CDATA[Set a list of <code>ContainerReport</code> for all the containers of an
  2481. application attempt.
  2482. @param containers
  2483. a list of <code>ContainerReport</code> for all the containers of
  2484. an application attempt]]>
  2485. </doc>
  2486. </method>
  2487. <doc>
  2488. <![CDATA[<p>
  2489. The response sent by the <code>ResourceManager</code> to a client requesting
  2490. a list of {@link ContainerReport} for containers.
  2491. </p>
  2492. <p>
  2493. The <code>ContainerReport</code> for each container includes the container
  2494. details.
  2495. </p>
  2496. @see ContainerReport
  2497. @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
  2498. </doc>
  2499. </class>
  2500. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
  2501. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
  2502. <class name="GetContainerStatusesRequest" extends="java.lang.Object"
  2503. abstract="true"
  2504. static="false" final="false" visibility="public"
  2505. deprecated="not deprecated">
  2506. <constructor name="GetContainerStatusesRequest"
  2507. static="false" final="false" visibility="public"
  2508. deprecated="not deprecated">
  2509. </constructor>
  2510. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"
  2511. abstract="false" native="false" synchronized="false"
  2512. static="true" final="false" visibility="public"
  2513. deprecated="not deprecated">
  2514. <param name="containerIds" type="java.util.List"/>
  2515. </method>
  2516. <method name="getContainerIds" return="java.util.List"
  2517. abstract="true" native="false" synchronized="false"
  2518. static="false" final="false" visibility="public"
  2519. deprecated="not deprecated">
  2520. <doc>
  2521. <![CDATA[Get the list of <code>ContainerId</code>s of containers for which to obtain
  2522. the <code>ContainerStatus</code>.
  2523. @return the list of <code>ContainerId</code>s of containers for which to
  2524. obtain the <code>ContainerStatus</code>.]]>
  2525. </doc>
  2526. </method>
  2527. <method name="setContainerIds"
  2528. abstract="true" native="false" synchronized="false"
  2529. static="false" final="false" visibility="public"
  2530. deprecated="not deprecated">
  2531. <param name="containerIds" type="java.util.List"/>
  2532. <doc>
  2533. <![CDATA[Set a list of <code>ContainerId</code>s of containers for which to obtain
  2534. the <code>ContainerStatus</code>
  2535. @param containerIds
  2536. a list of <code>ContainerId</code>s of containers for which to
  2537. obtain the <code>ContainerStatus</code>]]>
  2538. </doc>
  2539. </method>
  2540. <doc>
  2541. <![CDATA[The request sent by the <code>ApplicationMaster</code> to the
  2542. <code>NodeManager</code> to get {@link ContainerStatus} of requested
  2543. containers.
  2544. @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
  2545. </doc>
  2546. </class>
  2547. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
  2548. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
  2549. <class name="GetContainerStatusesResponse" extends="java.lang.Object"
  2550. abstract="true"
  2551. static="false" final="false" visibility="public"
  2552. deprecated="not deprecated">
  2553. <constructor name="GetContainerStatusesResponse"
  2554. static="false" final="false" visibility="public"
  2555. deprecated="not deprecated">
  2556. </constructor>
  2557. <method name="getContainerStatuses" return="java.util.List"
  2558. abstract="true" native="false" synchronized="false"
  2559. static="false" final="false" visibility="public"
  2560. deprecated="not deprecated">
  2561. <doc>
  2562. <![CDATA[Get the <code>ContainerStatus</code>es of the requested containers.
  2563. @return <code>ContainerStatus</code>es of the requested containers.]]>
  2564. </doc>
  2565. </method>
  2566. <method name="getFailedRequests" return="java.util.Map"
  2567. abstract="true" native="false" synchronized="false"
  2568. static="false" final="false" visibility="public"
  2569. deprecated="not deprecated">
  2570. <doc>
  2571. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  2572. from per container for failed requests]]>
  2573. </doc>
  2574. </method>
  2575. <doc>
  2576. <![CDATA[The response sent by the <code>NodeManager</code> to the
  2577. <code>ApplicationMaster</code> when asked to obtain the
  2578. <code>ContainerStatus</code> of requested containers.
  2579. @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
  2580. </doc>
  2581. </class>
  2582. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
  2583. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
  2584. <class name="GetDelegationTokenRequest" extends="java.lang.Object"
  2585. abstract="true"
  2586. static="false" final="false" visibility="public"
  2587. deprecated="not deprecated">
  2588. <constructor name="GetDelegationTokenRequest"
  2589. static="false" final="false" visibility="public"
  2590. deprecated="not deprecated">
  2591. </constructor>
  2592. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"
  2593. abstract="false" native="false" synchronized="false"
  2594. static="true" final="false" visibility="public"
  2595. deprecated="not deprecated">
  2596. <param name="renewer" type="java.lang.String"/>
  2597. </method>
  2598. <method name="getRenewer" return="java.lang.String"
  2599. abstract="true" native="false" synchronized="false"
  2600. static="false" final="false" visibility="public"
  2601. deprecated="not deprecated">
  2602. </method>
  2603. <method name="setRenewer"
  2604. abstract="true" native="false" synchronized="false"
  2605. static="false" final="false" visibility="public"
  2606. deprecated="not deprecated">
  2607. <param name="renewer" type="java.lang.String"/>
  2608. </method>
  2609. <doc>
  2610. <![CDATA[The request issued by the client to get a delegation token from
  2611. the {@code ResourceManager}.
  2612. for more information.]]>
  2613. </doc>
  2614. </class>
  2615. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
  2616. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
  2617. <class name="GetDelegationTokenResponse" extends="java.lang.Object"
  2618. abstract="true"
  2619. static="false" final="false" visibility="public"
  2620. deprecated="not deprecated">
  2621. <constructor name="GetDelegationTokenResponse"
  2622. static="false" final="false" visibility="public"
  2623. deprecated="not deprecated">
  2624. </constructor>
  2625. <method name="getRMDelegationToken" return="org.apache.hadoop.yarn.api.records.Token"
  2626. abstract="true" native="false" synchronized="false"
  2627. static="false" final="false" visibility="public"
  2628. deprecated="not deprecated">
  2629. <doc>
  2630. <![CDATA[The Delegation tokens have a identifier which maps to
  2631. {@link AbstractDelegationTokenIdentifier}.]]>
  2632. </doc>
  2633. </method>
  2634. <doc>
  2635. <![CDATA[Response to a {@link GetDelegationTokenRequest} request
  2636. from the client. The response contains the token that
  2637. can be used by the containers to talk to ClientRMService.]]>
  2638. </doc>
  2639. </class>
  2640. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
  2641. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
  2642. <class name="GetNewApplicationRequest" extends="java.lang.Object"
  2643. abstract="true"
  2644. static="false" final="false" visibility="public"
  2645. deprecated="not deprecated">
  2646. <constructor name="GetNewApplicationRequest"
  2647. static="false" final="false" visibility="public"
  2648. deprecated="not deprecated">
  2649. </constructor>
  2650. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"
  2651. abstract="false" native="false" synchronized="false"
  2652. static="true" final="false" visibility="public"
  2653. deprecated="not deprecated">
  2654. </method>
  2655. <doc>
  2656. <![CDATA[<p>The request sent by clients to get a new {@link ApplicationId} for
  2657. submitting an application.</p>
  2658. <p>Currently, this is empty.</p>
  2659. @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
  2660. </doc>
  2661. </class>
  2662. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
  2663. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
  2664. <class name="GetNewApplicationResponse" extends="java.lang.Object"
  2665. abstract="true"
  2666. static="false" final="false" visibility="public"
  2667. deprecated="not deprecated">
  2668. <constructor name="GetNewApplicationResponse"
  2669. static="false" final="false" visibility="public"
  2670. deprecated="not deprecated">
  2671. </constructor>
  2672. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2673. abstract="true" native="false" synchronized="false"
  2674. static="false" final="false" visibility="public"
  2675. deprecated="not deprecated">
  2676. <doc>
  2677. <![CDATA[Get the <em>new</em> <code>ApplicationId</code> allocated by the
  2678. <code>ResourceManager</code>.
  2679. @return <em>new</em> <code>ApplicationId</code> allocated by the
  2680. <code>ResourceManager</code>]]>
  2681. </doc>
  2682. </method>
  2683. <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  2684. abstract="true" native="false" synchronized="false"
  2685. static="false" final="false" visibility="public"
  2686. deprecated="not deprecated">
  2687. <doc>
  2688. <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
  2689. <code>ResourceManager</code> in the cluster.
  2690. @return maximum capability of allocated resources in the cluster]]>
  2691. </doc>
  2692. </method>
  2693. <doc>
  2694. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client for
  2695. a request to get a new {@link ApplicationId} for submitting applications.</p>
  2696. <p>Clients can submit an application with the returned
  2697. {@link ApplicationId}.</p>
  2698. @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
  2699. </doc>
  2700. </class>
  2701. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
  2702. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest -->
  2703. <class name="GetNewReservationRequest" extends="java.lang.Object"
  2704. abstract="true"
  2705. static="false" final="false" visibility="public"
  2706. deprecated="not deprecated">
  2707. <constructor name="GetNewReservationRequest"
  2708. static="false" final="false" visibility="public"
  2709. deprecated="not deprecated">
  2710. </constructor>
  2711. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest"
  2712. abstract="false" native="false" synchronized="false"
  2713. static="true" final="false" visibility="public"
  2714. deprecated="not deprecated">
  2715. </method>
  2716. <doc>
  2717. <![CDATA[<p>The request sent by clients to get a new {@code ReservationId} for
  2718. submitting an reservation.</p>
  2719. {@code ApplicationClientProtocol#getNewReservation(GetNewReservationRequest)}]]>
  2720. </doc>
  2721. </class>
  2722. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest -->
  2723. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse -->
  2724. <class name="GetNewReservationResponse" extends="java.lang.Object"
  2725. abstract="true"
  2726. static="false" final="false" visibility="public"
  2727. deprecated="not deprecated">
  2728. <constructor name="GetNewReservationResponse"
  2729. static="false" final="false" visibility="public"
  2730. deprecated="not deprecated">
  2731. </constructor>
  2732. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  2733. abstract="true" native="false" synchronized="false"
  2734. static="false" final="false" visibility="public"
  2735. deprecated="not deprecated">
  2736. <doc>
  2737. <![CDATA[Get a new {@link ReservationId} to be used to submit a reservation.
  2738. @return a {@link ReservationId} representing the unique id to identify
  2739. a reservation with which it was submitted.]]>
  2740. </doc>
  2741. </method>
  2742. <doc>
  2743. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client for
  2744. a request to get a new {@link ReservationId} for submitting reservations.</p>
  2745. <p>Clients can submit an reservation with the returned
  2746. {@link ReservationId}.</p>
  2747. {@code ApplicationClientProtocol#getNewReservation(GetNewReservationRequest)}]]>
  2748. </doc>
  2749. </class>
  2750. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse -->
  2751. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
  2752. <class name="GetQueueInfoRequest" extends="java.lang.Object"
  2753. abstract="true"
  2754. static="false" final="false" visibility="public"
  2755. deprecated="not deprecated">
  2756. <constructor name="GetQueueInfoRequest"
  2757. static="false" final="false" visibility="public"
  2758. deprecated="not deprecated">
  2759. </constructor>
  2760. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"
  2761. abstract="false" native="false" synchronized="false"
  2762. static="true" final="false" visibility="public"
  2763. deprecated="not deprecated">
  2764. <param name="queueName" type="java.lang.String"/>
  2765. <param name="includeApplications" type="boolean"/>
  2766. <param name="includeChildQueues" type="boolean"/>
  2767. <param name="recursive" type="boolean"/>
  2768. </method>
  2769. <method name="getQueueName" return="java.lang.String"
  2770. abstract="true" native="false" synchronized="false"
  2771. static="false" final="false" visibility="public"
  2772. deprecated="not deprecated">
  2773. <doc>
  2774. <![CDATA[Get the <em>queue name</em> for which to get queue information.
  2775. @return <em>queue name</em> for which to get queue information]]>
  2776. </doc>
  2777. </method>
  2778. <method name="setQueueName"
  2779. abstract="true" native="false" synchronized="false"
  2780. static="false" final="false" visibility="public"
  2781. deprecated="not deprecated">
  2782. <param name="queueName" type="java.lang.String"/>
  2783. <doc>
  2784. <![CDATA[Set the <em>queue name</em> for which to get queue information
  2785. @param queueName <em>queue name</em> for which to get queue information]]>
  2786. </doc>
  2787. </method>
  2788. <method name="getIncludeApplications" return="boolean"
  2789. abstract="true" native="false" synchronized="false"
  2790. static="false" final="false" visibility="public"
  2791. deprecated="not deprecated">
  2792. <doc>
  2793. <![CDATA[Is information about <em>active applications</em> required?
  2794. @return <code>true</code> if applications' information is to be included,
  2795. else <code>false</code>]]>
  2796. </doc>
  2797. </method>
  2798. <method name="setIncludeApplications"
  2799. abstract="true" native="false" synchronized="false"
  2800. static="false" final="false" visibility="public"
  2801. deprecated="not deprecated">
  2802. <param name="includeApplications" type="boolean"/>
  2803. <doc>
  2804. <![CDATA[Should we get fetch information about <em>active applications</em>?
  2805. @param includeApplications fetch information about <em>active
  2806. applications</em>?]]>
  2807. </doc>
  2808. </method>
  2809. <method name="getIncludeChildQueues" return="boolean"
  2810. abstract="true" native="false" synchronized="false"
  2811. static="false" final="false" visibility="public"
  2812. deprecated="not deprecated">
  2813. <doc>
  2814. <![CDATA[Is information about <em>child queues</em> required?
  2815. @return <code>true</code> if information about child queues is required,
  2816. else <code>false</code>]]>
  2817. </doc>
  2818. </method>
  2819. <method name="setIncludeChildQueues"
  2820. abstract="true" native="false" synchronized="false"
  2821. static="false" final="false" visibility="public"
  2822. deprecated="not deprecated">
  2823. <param name="includeChildQueues" type="boolean"/>
  2824. <doc>
  2825. <![CDATA[Should we fetch information about <em>child queues</em>?
  2826. @param includeChildQueues fetch information about <em>child queues</em>?]]>
  2827. </doc>
  2828. </method>
  2829. <method name="getRecursive" return="boolean"
  2830. abstract="true" native="false" synchronized="false"
  2831. static="false" final="false" visibility="public"
  2832. deprecated="not deprecated">
  2833. <doc>
  2834. <![CDATA[Is information on the entire <em>child queue hierarchy</em> required?
  2835. @return <code>true</code> if information about entire hierarchy is
  2836. required, <code>false</code> otherwise]]>
  2837. </doc>
  2838. </method>
  2839. <method name="setRecursive"
  2840. abstract="true" native="false" synchronized="false"
  2841. static="false" final="false" visibility="public"
  2842. deprecated="not deprecated">
  2843. <param name="recursive" type="boolean"/>
  2844. <doc>
  2845. <![CDATA[Should we fetch information on the entire <em>child queue hierarchy</em>?
  2846. @param recursive fetch information on the entire <em>child queue
  2847. hierarchy</em>?]]>
  2848. </doc>
  2849. </method>
  2850. <doc>
  2851. <![CDATA[<p>The request sent by clients to get <em>queue information</em>
  2852. from the <code>ResourceManager</code>.</p>
  2853. @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
  2854. </doc>
  2855. </class>
  2856. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
  2857. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
  2858. <class name="GetQueueInfoResponse" extends="java.lang.Object"
  2859. abstract="true"
  2860. static="false" final="false" visibility="public"
  2861. deprecated="not deprecated">
  2862. <constructor name="GetQueueInfoResponse"
  2863. static="false" final="false" visibility="public"
  2864. deprecated="not deprecated">
  2865. </constructor>
  2866. <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.records.QueueInfo"
  2867. abstract="true" native="false" synchronized="false"
  2868. static="false" final="false" visibility="public"
  2869. deprecated="not deprecated">
  2870. <doc>
  2871. <![CDATA[Get the <code>QueueInfo</code> for the specified queue.
  2872. @return <code>QueueInfo</code> for the specified queue]]>
  2873. </doc>
  2874. </method>
  2875. <doc>
  2876. <![CDATA[The response sent by the {@code ResourceManager} to a client
  2877. requesting information about queues in the system.
  2878. <p>
  2879. The response includes a {@link QueueInfo} which has details such as
  2880. queue name, used/total capacities, running applications, child queues etc.
  2881. @see QueueInfo
  2882. @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
  2883. </doc>
  2884. </class>
  2885. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
  2886. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
  2887. <class name="GetQueueUserAclsInfoRequest" extends="java.lang.Object"
  2888. abstract="true"
  2889. static="false" final="false" visibility="public"
  2890. deprecated="not deprecated">
  2891. <constructor name="GetQueueUserAclsInfoRequest"
  2892. static="false" final="false" visibility="public"
  2893. deprecated="not deprecated">
  2894. </constructor>
  2895. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"
  2896. abstract="false" native="false" synchronized="false"
  2897. static="true" final="false" visibility="public"
  2898. deprecated="not deprecated">
  2899. </method>
  2900. <doc>
  2901. <![CDATA[<p>The request sent by clients to the <code>ResourceManager</code> to
  2902. get queue acls for the <em>current user</em>.</p>
  2903. <p>Currently, this is empty.</p>
  2904. @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  2905. </doc>
  2906. </class>
  2907. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
  2908. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
  2909. <class name="GetQueueUserAclsInfoResponse" extends="java.lang.Object"
  2910. abstract="true"
  2911. static="false" final="false" visibility="public"
  2912. deprecated="not deprecated">
  2913. <constructor name="GetQueueUserAclsInfoResponse"
  2914. static="false" final="false" visibility="public"
  2915. deprecated="not deprecated">
  2916. </constructor>
  2917. <method name="getUserAclsInfoList" return="java.util.List"
  2918. abstract="true" native="false" synchronized="false"
  2919. static="false" final="false" visibility="public"
  2920. deprecated="not deprecated">
  2921. <doc>
  2922. <![CDATA[Get the <code>QueueUserACLInfo</code> per queue for the user.
  2923. @return <code>QueueUserACLInfo</code> per queue for the user]]>
  2924. </doc>
  2925. </method>
  2926. <doc>
  2927. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to clients
  2928. seeking queue acls for the user.</p>
  2929. <p>The response contains a list of {@link QueueUserACLInfo} which
  2930. provides information about {@link QueueACL} per queue.</p>
  2931. @see QueueACL
  2932. @see QueueUserACLInfo
  2933. @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  2934. </doc>
  2935. </class>
  2936. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
  2937. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest -->
  2938. <class name="IncreaseContainersResourceRequest" extends="java.lang.Object"
  2939. abstract="true"
  2940. static="false" final="false" visibility="public"
  2941. deprecated="not deprecated">
  2942. <constructor name="IncreaseContainersResourceRequest"
  2943. static="false" final="false" visibility="public"
  2944. deprecated="not deprecated">
  2945. </constructor>
  2946. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest"
  2947. abstract="false" native="false" synchronized="false"
  2948. static="true" final="false" visibility="public"
  2949. deprecated="not deprecated">
  2950. <param name="containersToIncrease" type="java.util.List"/>
  2951. </method>
  2952. <method name="getContainersToIncrease" return="java.util.List"
  2953. abstract="true" native="false" synchronized="false"
  2954. static="false" final="false" visibility="public"
  2955. deprecated="not deprecated">
  2956. <doc>
  2957. <![CDATA[Get a list of container tokens to be used for authorization during
  2958. container resource increase.
  2959. <p>
  2960. Note: {@link NMToken} will be used for authenticating communication with
  2961. {@code NodeManager}.
  2962. @return the list of container tokens to be used for authorization during
  2963. container resource increase.
  2964. @see NMToken]]>
  2965. </doc>
  2966. </method>
  2967. <method name="setContainersToIncrease"
  2968. abstract="true" native="false" synchronized="false"
  2969. static="false" final="false" visibility="public"
  2970. deprecated="not deprecated">
  2971. <param name="containersToIncrease" type="java.util.List"/>
  2972. <doc>
  2973. <![CDATA[Set container tokens to be used during container resource increase.
  2974. The token is acquired from
  2975. <code>AllocateResponse.getIncreasedContainers</code>.
  2976. The token contains the container id and resource capability required for
  2977. container resource increase.
  2978. @param containersToIncrease the list of container tokens to be used
  2979. for container resource increase.]]>
  2980. </doc>
  2981. </method>
  2982. <doc>
  2983. <![CDATA[<p>The request sent by <code>Application Master</code> to the
  2984. <code>Node Manager</code> to change the resource quota of a container.</p>
  2985. @see ContainerManagementProtocol#increaseContainersResource(IncreaseContainersResourceRequest)]]>
  2986. </doc>
  2987. </class>
  2988. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest -->
  2989. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse -->
  2990. <class name="IncreaseContainersResourceResponse" extends="java.lang.Object"
  2991. abstract="true"
  2992. static="false" final="false" visibility="public"
  2993. deprecated="not deprecated">
  2994. <constructor name="IncreaseContainersResourceResponse"
  2995. static="false" final="false" visibility="public"
  2996. deprecated="not deprecated">
  2997. </constructor>
  2998. <method name="getSuccessfullyIncreasedContainers" return="java.util.List"
  2999. abstract="true" native="false" synchronized="false"
  3000. static="false" final="false" visibility="public"
  3001. deprecated="not deprecated">
  3002. <doc>
  3003. <![CDATA[Get the list of containerIds of containers whose resource
  3004. have been successfully increased.
  3005. @return the list of containerIds of containers whose resource have
  3006. been successfully increased.]]>
  3007. </doc>
  3008. </method>
  3009. <method name="getFailedRequests" return="java.util.Map"
  3010. abstract="true" native="false" synchronized="false"
  3011. static="false" final="false" visibility="public"
  3012. deprecated="not deprecated">
  3013. <doc>
  3014. <![CDATA[Get the containerId-to-exception map in which the exception indicates
  3015. error from each container for failed requests.]]>
  3016. </doc>
  3017. </method>
  3018. <doc>
  3019. <![CDATA[<p>
  3020. The response sent by the <code>NodeManager</code> to the
  3021. <code>ApplicationMaster</code> when asked to increase container resource.
  3022. </p>
  3023. @see ContainerManagementProtocol#increaseContainersResource(IncreaseContainersResourceRequest)]]>
  3024. </doc>
  3025. </class>
  3026. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse -->
  3027. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
  3028. <class name="KillApplicationRequest" extends="java.lang.Object"
  3029. abstract="true"
  3030. static="false" final="false" visibility="public"
  3031. deprecated="not deprecated">
  3032. <constructor name="KillApplicationRequest"
  3033. static="false" final="false" visibility="public"
  3034. deprecated="not deprecated">
  3035. </constructor>
  3036. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"
  3037. abstract="false" native="false" synchronized="false"
  3038. static="true" final="false" visibility="public"
  3039. deprecated="not deprecated">
  3040. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3041. </method>
  3042. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3043. abstract="true" native="false" synchronized="false"
  3044. static="false" final="false" visibility="public"
  3045. deprecated="not deprecated">
  3046. <doc>
  3047. <![CDATA[Get the <code>ApplicationId</code> of the application to be aborted.
  3048. @return <code>ApplicationId</code> of the application to be aborted]]>
  3049. </doc>
  3050. </method>
  3051. <method name="setApplicationId"
  3052. abstract="true" native="false" synchronized="false"
  3053. static="false" final="false" visibility="public"
  3054. deprecated="not deprecated">
  3055. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3056. </method>
  3057. <method name="getDiagnostics" return="java.lang.String"
  3058. abstract="true" native="false" synchronized="false"
  3059. static="false" final="false" visibility="public"
  3060. deprecated="not deprecated">
  3061. <doc>
  3062. <![CDATA[Get the <em>diagnostics</em> to which the application is being killed.
  3063. @return <em>diagnostics</em> to which the application is being killed]]>
  3064. </doc>
  3065. </method>
  3066. <method name="setDiagnostics"
  3067. abstract="true" native="false" synchronized="false"
  3068. static="false" final="false" visibility="public"
  3069. deprecated="not deprecated">
  3070. <param name="diagnostics" type="java.lang.String"/>
  3071. <doc>
  3072. <![CDATA[Set the <em>diagnostics</em> to which the application is being killed.
  3073. @param diagnostics <em>diagnostics</em> to which the application is being
  3074. killed]]>
  3075. </doc>
  3076. </method>
  3077. <doc>
  3078. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  3079. to abort a submitted application.</p>
  3080. <p>The request includes the {@link ApplicationId} of the application to be
  3081. aborted.</p>
  3082. @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
  3083. </doc>
  3084. </class>
  3085. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
  3086. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
  3087. <class name="KillApplicationResponse" extends="java.lang.Object"
  3088. abstract="true"
  3089. static="false" final="false" visibility="public"
  3090. deprecated="not deprecated">
  3091. <constructor name="KillApplicationResponse"
  3092. static="false" final="false" visibility="public"
  3093. deprecated="not deprecated">
  3094. </constructor>
  3095. <method name="getIsKillCompleted" return="boolean"
  3096. abstract="true" native="false" synchronized="false"
  3097. static="false" final="false" visibility="public"
  3098. deprecated="not deprecated">
  3099. <doc>
  3100. <![CDATA[Get the flag which indicates that the process of killing application is completed or not.]]>
  3101. </doc>
  3102. </method>
  3103. <doc>
  3104. <![CDATA[The response sent by the <code>ResourceManager</code> to the client aborting
  3105. a submitted application.
  3106. <p>
  3107. The response, includes:
  3108. <ul>
  3109. <li>
  3110. A flag which indicates that the process of killing the application is
  3111. completed or not.
  3112. </li>
  3113. </ul>
  3114. Note: user is recommended to wait until this flag becomes true, otherwise if
  3115. the <code>ResourceManager</code> crashes before the process of killing the
  3116. application is completed, the <code>ResourceManager</code> may retry this
  3117. application on recovery.
  3118. @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
  3119. </doc>
  3120. </class>
  3121. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
  3122. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
  3123. <class name="MoveApplicationAcrossQueuesRequest" extends="java.lang.Object"
  3124. abstract="true"
  3125. static="false" final="false" visibility="public"
  3126. deprecated="not deprecated">
  3127. <constructor name="MoveApplicationAcrossQueuesRequest"
  3128. static="false" final="false" visibility="public"
  3129. deprecated="not deprecated">
  3130. </constructor>
  3131. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"
  3132. abstract="false" native="false" synchronized="false"
  3133. static="true" final="false" visibility="public"
  3134. deprecated="not deprecated">
  3135. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3136. <param name="queue" type="java.lang.String"/>
  3137. </method>
  3138. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3139. abstract="true" native="false" synchronized="false"
  3140. static="false" final="false" visibility="public"
  3141. deprecated="not deprecated">
  3142. <doc>
  3143. <![CDATA[Get the <code>ApplicationId</code> of the application to be moved.
  3144. @return <code>ApplicationId</code> of the application to be moved]]>
  3145. </doc>
  3146. </method>
  3147. <method name="setApplicationId"
  3148. abstract="true" native="false" synchronized="false"
  3149. static="false" final="false" visibility="public"
  3150. deprecated="not deprecated">
  3151. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3152. <doc>
  3153. <![CDATA[Set the <code>ApplicationId</code> of the application to be moved.
  3154. @param appId <code>ApplicationId</code> of the application to be moved]]>
  3155. </doc>
  3156. </method>
  3157. <method name="getTargetQueue" return="java.lang.String"
  3158. abstract="true" native="false" synchronized="false"
  3159. static="false" final="false" visibility="public"
  3160. deprecated="not deprecated">
  3161. <doc>
  3162. <![CDATA[Get the queue to place the application in.
  3163. @return the name of the queue to place the application in]]>
  3164. </doc>
  3165. </method>
  3166. <method name="setTargetQueue"
  3167. abstract="true" native="false" synchronized="false"
  3168. static="false" final="false" visibility="public"
  3169. deprecated="not deprecated">
  3170. <param name="queue" type="java.lang.String"/>
  3171. <doc>
  3172. <![CDATA[Get the queue to place the application in.
  3173. @param queue the name of the queue to place the application in]]>
  3174. </doc>
  3175. </method>
  3176. <doc>
  3177. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  3178. to move a submitted application to a different queue.</p>
  3179. <p>The request includes the {@link ApplicationId} of the application to be
  3180. moved and the queue to place it in.</p>
  3181. @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
  3182. </doc>
  3183. </class>
  3184. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
  3185. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
  3186. <class name="MoveApplicationAcrossQueuesResponse" extends="java.lang.Object"
  3187. abstract="true"
  3188. static="false" final="false" visibility="public"
  3189. deprecated="not deprecated">
  3190. <constructor name="MoveApplicationAcrossQueuesResponse"
  3191. static="false" final="false" visibility="public"
  3192. deprecated="not deprecated">
  3193. </constructor>
  3194. <doc>
  3195. <![CDATA[<p>
  3196. The response sent by the <code>ResourceManager</code> to the client moving
  3197. a submitted application to a different queue.
  3198. </p>
  3199. <p>
  3200. A response without exception means that the move has completed successfully.
  3201. </p>
  3202. @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
  3203. </doc>
  3204. </class>
  3205. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
  3206. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
  3207. <class name="RegisterApplicationMasterRequest" extends="java.lang.Object"
  3208. abstract="true"
  3209. static="false" final="false" visibility="public"
  3210. deprecated="not deprecated">
  3211. <constructor name="RegisterApplicationMasterRequest"
  3212. static="false" final="false" visibility="public"
  3213. deprecated="not deprecated">
  3214. </constructor>
  3215. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"
  3216. abstract="false" native="false" synchronized="false"
  3217. static="true" final="false" visibility="public"
  3218. deprecated="not deprecated">
  3219. <param name="host" type="java.lang.String"/>
  3220. <param name="port" type="int"/>
  3221. <param name="trackingUrl" type="java.lang.String"/>
  3222. <doc>
  3223. <![CDATA[Create a new instance of <code>RegisterApplicationMasterRequest</code>.
  3224. If <em>port, trackingUrl</em> is not used, use the following default value:
  3225. <ul>
  3226. <li>port: -1</li>
  3227. <li>trackingUrl: null</li>
  3228. </ul>
  3229. The port is allowed to be any integer larger than or equal to -1.
  3230. @return the new instance of <code>RegisterApplicationMasterRequest</code>]]>
  3231. </doc>
  3232. </method>
  3233. <method name="getHost" return="java.lang.String"
  3234. abstract="true" native="false" synchronized="false"
  3235. static="false" final="false" visibility="public"
  3236. deprecated="not deprecated">
  3237. <doc>
  3238. <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code> is
  3239. running.
  3240. @return <em>host</em> on which the <code>ApplicationMaster</code> is running]]>
  3241. </doc>
  3242. </method>
  3243. <method name="setHost"
  3244. abstract="true" native="false" synchronized="false"
  3245. static="false" final="false" visibility="public"
  3246. deprecated="not deprecated">
  3247. <param name="host" type="java.lang.String"/>
  3248. <doc>
  3249. <![CDATA[Set the <em>host</em> on which the <code>ApplicationMaster</code> is
  3250. running.
  3251. @param host <em>host</em> on which the <code>ApplicationMaster</code>
  3252. is running]]>
  3253. </doc>
  3254. </method>
  3255. <method name="getRpcPort" return="int"
  3256. abstract="true" native="false" synchronized="false"
  3257. static="false" final="false" visibility="public"
  3258. deprecated="not deprecated">
  3259. <doc>
  3260. <![CDATA[Get the <em>RPC port</em> on which the {@code ApplicationMaster} is
  3261. responding.
  3262. @return the <em>RPC port</em> on which the {@code ApplicationMaster}
  3263. is responding]]>
  3264. </doc>
  3265. </method>
  3266. <method name="setRpcPort"
  3267. abstract="true" native="false" synchronized="false"
  3268. static="false" final="false" visibility="public"
  3269. deprecated="not deprecated">
  3270. <param name="port" type="int"/>
  3271. <doc>
  3272. <![CDATA[Set the <em>RPC port</em> on which the {@code ApplicationMaster} is
  3273. responding.
  3274. @param port <em>RPC port</em> on which the {@code ApplicationMaster}
  3275. is responding]]>
  3276. </doc>
  3277. </method>
  3278. <method name="getTrackingUrl" return="java.lang.String"
  3279. abstract="true" native="false" synchronized="false"
  3280. static="false" final="false" visibility="public"
  3281. deprecated="not deprecated">
  3282. <doc>
  3283. <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
  3284. This url if contains scheme then that will be used by resource manager
  3285. web application proxy otherwise it will default to http.
  3286. @return <em>tracking URL</em> for the <code>ApplicationMaster</code>]]>
  3287. </doc>
  3288. </method>
  3289. <method name="setTrackingUrl"
  3290. abstract="true" native="false" synchronized="false"
  3291. static="false" final="false" visibility="public"
  3292. deprecated="not deprecated">
  3293. <param name="trackingUrl" type="java.lang.String"/>
  3294. <doc>
  3295. <![CDATA[Set the <em>tracking URL</em>for the <code>ApplicationMaster</code> while
  3296. it is running. This is the web-URL to which ResourceManager or
  3297. web-application proxy will redirect client/users while the application and
  3298. the <code>ApplicationMaster</code> are still running.
  3299. <p>
  3300. If the passed url has a scheme then that will be used by the
  3301. ResourceManager and web-application proxy, otherwise the scheme will
  3302. default to http.
  3303. </p>
  3304. <p>
  3305. Empty, null, "N/A" strings are all valid besides a real URL. In case an url
  3306. isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
  3307. <p>
  3308. @param trackingUrl
  3309. <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  3310. </doc>
  3311. </method>
  3312. <doc>
  3313. <![CDATA[The request sent by the {@code ApplicationMaster} to {@code ResourceManager}
  3314. on registration.
  3315. <p>
  3316. The registration includes details such as:
  3317. <ul>
  3318. <li>Hostname on which the AM is running.</li>
  3319. <li>RPC Port</li>
  3320. <li>Tracking URL</li>
  3321. </ul>
  3322. @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
  3323. </doc>
  3324. </class>
  3325. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
  3326. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
  3327. <class name="RegisterApplicationMasterResponse" extends="java.lang.Object"
  3328. abstract="true"
  3329. static="false" final="false" visibility="public"
  3330. deprecated="not deprecated">
  3331. <constructor name="RegisterApplicationMasterResponse"
  3332. static="false" final="false" visibility="public"
  3333. deprecated="not deprecated">
  3334. </constructor>
  3335. <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  3336. abstract="true" native="false" synchronized="false"
  3337. static="false" final="false" visibility="public"
  3338. deprecated="not deprecated">
  3339. <doc>
  3340. <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
  3341. <code>ResourceManager</code> in the cluster.
  3342. @return maximum capability of allocated resources in the cluster]]>
  3343. </doc>
  3344. </method>
  3345. <method name="getApplicationACLs" return="java.util.Map"
  3346. abstract="true" native="false" synchronized="false"
  3347. static="false" final="false" visibility="public"
  3348. deprecated="not deprecated">
  3349. <doc>
  3350. <![CDATA[Get the <code>ApplicationACL</code>s for the application.
  3351. @return all the <code>ApplicationACL</code>s]]>
  3352. </doc>
  3353. </method>
  3354. <method name="getClientToAMTokenMasterKey" return="java.nio.ByteBuffer"
  3355. abstract="true" native="false" synchronized="false"
  3356. static="false" final="false" visibility="public"
  3357. deprecated="not deprecated">
  3358. <doc>
  3359. <![CDATA[<p>Get ClientToAMToken master key.</p>
  3360. <p>The ClientToAMToken master key is sent to <code>ApplicationMaster</code>
  3361. by <code>ResourceManager</code> via {@link RegisterApplicationMasterResponse}
  3362. , used to verify corresponding ClientToAMToken.</p>]]>
  3363. </doc>
  3364. </method>
  3365. <method name="setClientToAMTokenMasterKey"
  3366. abstract="true" native="false" synchronized="false"
  3367. static="false" final="false" visibility="public"
  3368. deprecated="not deprecated">
  3369. <param name="key" type="java.nio.ByteBuffer"/>
  3370. <doc>
  3371. <![CDATA[Set ClientToAMToken master key.]]>
  3372. </doc>
  3373. </method>
  3374. <method name="getQueue" return="java.lang.String"
  3375. abstract="true" native="false" synchronized="false"
  3376. static="false" final="false" visibility="public"
  3377. deprecated="not deprecated">
  3378. <doc>
  3379. <![CDATA[<p>Get the queue that the application was placed in.<p>]]>
  3380. </doc>
  3381. </method>
  3382. <method name="setQueue"
  3383. abstract="true" native="false" synchronized="false"
  3384. static="false" final="false" visibility="public"
  3385. deprecated="not deprecated">
  3386. <param name="queue" type="java.lang.String"/>
  3387. <doc>
  3388. <![CDATA[<p>Set the queue that the application was placed in.<p>]]>
  3389. </doc>
  3390. </method>
  3391. <method name="getContainersFromPreviousAttempts" return="java.util.List"
  3392. abstract="true" native="false" synchronized="false"
  3393. static="false" final="false" visibility="public"
  3394. deprecated="not deprecated">
  3395. <doc>
  3396. <![CDATA[<p>
  3397. Get the list of running containers as viewed by
  3398. <code>ResourceManager</code> from previous application attempts.
  3399. </p>
  3400. @return the list of running containers as viewed by
  3401. <code>ResourceManager</code> from previous application attempts
  3402. @see RegisterApplicationMasterResponse#getNMTokensFromPreviousAttempts()]]>
  3403. </doc>
  3404. </method>
  3405. <method name="getNMTokensFromPreviousAttempts" return="java.util.List"
  3406. abstract="true" native="false" synchronized="false"
  3407. static="false" final="false" visibility="public"
  3408. deprecated="not deprecated">
  3409. <doc>
  3410. <![CDATA[Get the list of NMTokens for communicating with the NMs where the
  3411. containers of previous application attempts are running.
  3412. @return the list of NMTokens for communicating with the NMs where the
  3413. containers of previous application attempts are running.
  3414. @see RegisterApplicationMasterResponse#getContainersFromPreviousAttempts()]]>
  3415. </doc>
  3416. </method>
  3417. <method name="getSchedulerResourceTypes" return="java.util.EnumSet"
  3418. abstract="true" native="false" synchronized="false"
  3419. static="false" final="false" visibility="public"
  3420. deprecated="not deprecated">
  3421. <doc>
  3422. <![CDATA[Get a set of the resource types considered by the scheduler.
  3423. @return a Map of RM settings]]>
  3424. </doc>
  3425. </method>
  3426. <doc>
  3427. <![CDATA[The response sent by the {@code ResourceManager} to a new
  3428. {@code ApplicationMaster} on registration.
  3429. <p>
  3430. The response contains critical details such as:
  3431. <ul>
  3432. <li>Maximum capability for allocated resources in the cluster.</li>
  3433. <li>{@code ApplicationACL}s for the application.</li>
  3434. <li>ClientToAMToken master key.</li>
  3435. </ul>
  3436. @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
  3437. </doc>
  3438. </class>
  3439. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
  3440. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
  3441. <class name="ReleaseSharedCacheResourceRequest" extends="java.lang.Object"
  3442. abstract="true"
  3443. static="false" final="false" visibility="public"
  3444. deprecated="not deprecated">
  3445. <constructor name="ReleaseSharedCacheResourceRequest"
  3446. static="false" final="false" visibility="public"
  3447. deprecated="not deprecated">
  3448. </constructor>
  3449. <method name="getAppId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3450. abstract="true" native="false" synchronized="false"
  3451. static="false" final="false" visibility="public"
  3452. deprecated="not deprecated">
  3453. <doc>
  3454. <![CDATA[Get the <code>ApplicationId</code> of the resource to be released.
  3455. @return <code>ApplicationId</code>]]>
  3456. </doc>
  3457. </method>
  3458. <method name="setAppId"
  3459. abstract="true" native="false" synchronized="false"
  3460. static="false" final="false" visibility="public"
  3461. deprecated="not deprecated">
  3462. <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3463. <doc>
  3464. <![CDATA[Set the <code>ApplicationId</code> of the resource to be released.
  3465. @param id <code>ApplicationId</code>]]>
  3466. </doc>
  3467. </method>
  3468. <method name="getResourceKey" return="java.lang.String"
  3469. abstract="true" native="false" synchronized="false"
  3470. static="false" final="false" visibility="public"
  3471. deprecated="not deprecated">
  3472. <doc>
  3473. <![CDATA[Get the <code>key</code> of the resource to be released.
  3474. @return <code>key</code>]]>
  3475. </doc>
  3476. </method>
  3477. <method name="setResourceKey"
  3478. abstract="true" native="false" synchronized="false"
  3479. static="false" final="false" visibility="public"
  3480. deprecated="not deprecated">
  3481. <param name="key" type="java.lang.String"/>
  3482. <doc>
  3483. <![CDATA[Set the <code>key</code> of the resource to be released.
  3484. @param key unique identifier for the resource]]>
  3485. </doc>
  3486. </method>
  3487. <doc>
  3488. <![CDATA[<p>The request from clients to release a resource in the shared cache.</p>]]>
  3489. </doc>
  3490. </class>
  3491. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
  3492. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
  3493. <class name="ReleaseSharedCacheResourceResponse" extends="java.lang.Object"
  3494. abstract="true"
  3495. static="false" final="false" visibility="public"
  3496. deprecated="not deprecated">
  3497. <constructor name="ReleaseSharedCacheResourceResponse"
  3498. static="false" final="false" visibility="public"
  3499. deprecated="not deprecated">
  3500. </constructor>
  3501. <doc>
  3502. <![CDATA[<p>
  3503. The response to clients from the <code>SharedCacheManager</code> when
  3504. releasing a resource in the shared cache.
  3505. </p>
  3506. <p>
  3507. Currently, this is empty.
  3508. </p>]]>
  3509. </doc>
  3510. </class>
  3511. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
  3512. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
  3513. <class name="ReservationDeleteRequest" extends="java.lang.Object"
  3514. abstract="true"
  3515. static="false" final="false" visibility="public"
  3516. deprecated="not deprecated">
  3517. <constructor name="ReservationDeleteRequest"
  3518. static="false" final="false" visibility="public"
  3519. deprecated="not deprecated">
  3520. </constructor>
  3521. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"
  3522. abstract="false" native="false" synchronized="false"
  3523. static="true" final="false" visibility="public"
  3524. deprecated="not deprecated">
  3525. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3526. </method>
  3527. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  3528. abstract="true" native="false" synchronized="false"
  3529. static="false" final="false" visibility="public"
  3530. deprecated="not deprecated">
  3531. <doc>
  3532. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  3533. allocation in the scheduler (between start and end time of this
  3534. reservation)
  3535. @return the {@link ReservationId} representing the unique id of the
  3536. corresponding reserved resource allocation in the scheduler]]>
  3537. </doc>
  3538. </method>
  3539. <method name="setReservationId"
  3540. abstract="true" native="false" synchronized="false"
  3541. static="false" final="false" visibility="public"
  3542. deprecated="not deprecated">
  3543. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3544. <doc>
  3545. <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
  3546. allocation in the scheduler (between start and end time of this
  3547. reservation)
  3548. @param reservationId the {@link ReservationId} representing the the unique
  3549. id of the corresponding reserved resource allocation in the
  3550. scheduler]]>
  3551. </doc>
  3552. </method>
  3553. <doc>
  3554. <![CDATA[{@link ReservationDeleteRequest} captures the set of requirements the user
  3555. has to delete an existing reservation.
  3556. @see ReservationDefinition]]>
  3557. </doc>
  3558. </class>
  3559. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
  3560. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
  3561. <class name="ReservationDeleteResponse" extends="java.lang.Object"
  3562. abstract="true"
  3563. static="false" final="false" visibility="public"
  3564. deprecated="not deprecated">
  3565. <constructor name="ReservationDeleteResponse"
  3566. static="false" final="false" visibility="public"
  3567. deprecated="not deprecated">
  3568. </constructor>
  3569. <doc>
  3570. <![CDATA[{@link ReservationDeleteResponse} contains the answer of the admission
  3571. control system in the {@code ResourceManager} to a reservation delete
  3572. operation. Currently response is empty if the operation was successful, if
  3573. not an exception reporting reason for a failure.
  3574. @see ReservationDefinition]]>
  3575. </doc>
  3576. </class>
  3577. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
  3578. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest -->
  3579. <class name="ReservationListRequest" extends="java.lang.Object"
  3580. abstract="true"
  3581. static="false" final="false" visibility="public"
  3582. deprecated="not deprecated">
  3583. <constructor name="ReservationListRequest"
  3584. static="false" final="false" visibility="public"
  3585. deprecated="not deprecated">
  3586. </constructor>
  3587. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
  3588. abstract="false" native="false" synchronized="false"
  3589. static="true" final="false" visibility="public"
  3590. deprecated="not deprecated">
  3591. <param name="queue" type="java.lang.String"/>
  3592. <param name="reservationId" type="java.lang.String"/>
  3593. <param name="startTime" type="long"/>
  3594. <param name="endTime" type="long"/>
  3595. <param name="includeReservationAllocations" type="boolean"/>
  3596. <doc>
  3597. <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
  3598. reservations to list if it is provided. Otherwise, it will select active
  3599. reservations within the startTime and endTime (inclusive).
  3600. @param queue Required. Cannot be null or empty. Refers to the reservable
  3601. queue in the scheduler that was selected when creating a
  3602. reservation submission {@link ReservationSubmissionRequest}.
  3603. @param reservationId Optional. String representation of
  3604. {@code ReservationId} If provided, other fields will
  3605. be ignored.
  3606. @param startTime Optional. If provided, only reservations that
  3607. end after the startTime will be selected. This defaults
  3608. to 0 if an invalid number is used.
  3609. @param endTime Optional. If provided, only reservations that
  3610. start on or before endTime will be selected. This defaults
  3611. to Long.MAX_VALUE if an invalid number is used.
  3612. @param includeReservationAllocations Optional. Flag that
  3613. determines whether the entire reservation allocations are
  3614. to be returned. Reservation allocations are subject to
  3615. change in the event of re-planning as described by
  3616. {@code ReservationDefinition}.]]>
  3617. </doc>
  3618. </method>
  3619. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
  3620. abstract="false" native="false" synchronized="false"
  3621. static="true" final="false" visibility="public"
  3622. deprecated="not deprecated">
  3623. <param name="queue" type="java.lang.String"/>
  3624. <param name="reservationId" type="java.lang.String"/>
  3625. <param name="includeReservationAllocations" type="boolean"/>
  3626. <doc>
  3627. <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
  3628. reservations to list if it is provided. Otherwise, it will select active
  3629. reservations within the startTime and endTime (inclusive).
  3630. @param queue Required. Cannot be null or empty. Refers to the reservable
  3631. queue in the scheduler that was selected when creating a
  3632. reservation submission {@link ReservationSubmissionRequest}.
  3633. @param reservationId Optional. String representation of
  3634. {@code ReservationId} If provided, other fields will
  3635. be ignored.
  3636. @param includeReservationAllocations Optional. Flag that
  3637. determines whether the entire reservation allocations are
  3638. to be returned. Reservation allocations are subject to
  3639. change in the event of re-planning as described by
  3640. {@code ReservationDefinition}.]]>
  3641. </doc>
  3642. </method>
  3643. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
  3644. abstract="false" native="false" synchronized="false"
  3645. static="true" final="false" visibility="public"
  3646. deprecated="not deprecated">
  3647. <param name="queue" type="java.lang.String"/>
  3648. <param name="reservationId" type="java.lang.String"/>
  3649. <doc>
  3650. <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
  3651. reservations to list if it is provided. Otherwise, it will select active
  3652. reservations within the startTime and endTime (inclusive).
  3653. @param queue Required. Cannot be null or empty. Refers to the reservable
  3654. queue in the scheduler that was selected when creating a
  3655. reservation submission {@link ReservationSubmissionRequest}.
  3656. @param reservationId Optional. String representation of
  3657. {@code ReservationId} If provided, other fields will
  3658. be ignored.]]>
  3659. </doc>
  3660. </method>
  3661. <method name="getQueue" return="java.lang.String"
  3662. abstract="true" native="false" synchronized="false"
  3663. static="false" final="false" visibility="public"
  3664. deprecated="not deprecated">
  3665. <doc>
  3666. <![CDATA[Get queue name to use to find reservations.
  3667. @return the queue name to use to find reservations.]]>
  3668. </doc>
  3669. </method>
  3670. <method name="setQueue"
  3671. abstract="true" native="false" synchronized="false"
  3672. static="false" final="false" visibility="public"
  3673. deprecated="not deprecated">
  3674. <param name="queue" type="java.lang.String"/>
  3675. <doc>
  3676. <![CDATA[Set queue name to use to find resource allocations.
  3677. @param queue Required. Cannot be null or empty.]]>
  3678. </doc>
  3679. </method>
  3680. <method name="getReservationId" return="java.lang.String"
  3681. abstract="true" native="false" synchronized="false"
  3682. static="false" final="false" visibility="public"
  3683. deprecated="not deprecated">
  3684. <doc>
  3685. <![CDATA[Get the reservation id to use to find a reservation.
  3686. @return the reservation id of the reservation.]]>
  3687. </doc>
  3688. </method>
  3689. <method name="setReservationId"
  3690. abstract="true" native="false" synchronized="false"
  3691. static="false" final="false" visibility="public"
  3692. deprecated="not deprecated">
  3693. <param name="reservationId" type="java.lang.String"/>
  3694. <doc>
  3695. <![CDATA[Set the reservation id to use to find a reservation.
  3696. @param reservationId Optional. String representation of
  3697. {@code ReservationId} If provided, other fields will
  3698. be ignored.]]>
  3699. </doc>
  3700. </method>
  3701. <method name="getStartTime" return="long"
  3702. abstract="true" native="false" synchronized="false"
  3703. static="false" final="false" visibility="public"
  3704. deprecated="not deprecated">
  3705. <doc>
  3706. <![CDATA[Get the start time to use to search for reservations.
  3707. When this is set, reservations that start before this start
  3708. time are ignored.
  3709. @return the start time to use to search for reservations.]]>
  3710. </doc>
  3711. </method>
  3712. <method name="setStartTime"
  3713. abstract="true" native="false" synchronized="false"
  3714. static="false" final="false" visibility="public"
  3715. deprecated="not deprecated">
  3716. <param name="startTime" type="long"/>
  3717. <doc>
  3718. <![CDATA[Set the start time to use to search for reservations.
  3719. When this is set, reservations that start before this start
  3720. time are ignored.
  3721. @param startTime Optional. If provided, only reservations that
  3722. end after the startTime will be selected. This defaults
  3723. to 0 if an invalid number is used.]]>
  3724. </doc>
  3725. </method>
  3726. <method name="getEndTime" return="long"
  3727. abstract="true" native="false" synchronized="false"
  3728. static="false" final="false" visibility="public"
  3729. deprecated="not deprecated">
  3730. <doc>
  3731. <![CDATA[Get the end time to use to search for reservations.
  3732. When this is set, reservations that start after this end
  3733. time are ignored.
  3734. @return the end time to use to search for reservations.]]>
  3735. </doc>
  3736. </method>
  3737. <method name="setEndTime"
  3738. abstract="true" native="false" synchronized="false"
  3739. static="false" final="false" visibility="public"
  3740. deprecated="not deprecated">
  3741. <param name="endTime" type="long"/>
  3742. <doc>
  3743. <![CDATA[Set the end time to use to search for reservations.
  3744. When this is set, reservations that start after this end
  3745. time are ignored.
  3746. @param endTime Optional. If provided, only reservations that
  3747. start before endTime will be selected. This defaults
  3748. to Long.MAX_VALUE if an invalid number is used.]]>
  3749. </doc>
  3750. </method>
  3751. <method name="getIncludeResourceAllocations" return="boolean"
  3752. abstract="true" native="false" synchronized="false"
  3753. static="false" final="false" visibility="public"
  3754. deprecated="not deprecated">
  3755. <doc>
  3756. <![CDATA[Get the boolean representing whether or not the user
  3757. is requesting the full resource allocation.
  3758. If this is true, the full resource allocation will
  3759. be included in the response.
  3760. @return the end time to use to search for reservations.]]>
  3761. </doc>
  3762. </method>
  3763. <method name="setIncludeResourceAllocations"
  3764. abstract="true" native="false" synchronized="false"
  3765. static="false" final="false" visibility="public"
  3766. deprecated="not deprecated">
  3767. <param name="includeReservationAllocations" type="boolean"/>
  3768. <doc>
  3769. <![CDATA[Set the boolean representing whether or not the user
  3770. is requesting the full resource allocation.
  3771. If this is true, the full resource allocation will
  3772. be included in the response.
  3773. @param includeReservationAllocations Optional. Flag that
  3774. determines whether the entire list of
  3775. {@code ResourceAllocationRequest} will be returned.]]>
  3776. </doc>
  3777. </method>
  3778. <doc>
  3779. <![CDATA[{@link ReservationListRequest} captures the set of requirements the
  3780. user has to list reservations.]]>
  3781. </doc>
  3782. </class>
  3783. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest -->
  3784. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse -->
  3785. <class name="ReservationListResponse" extends="java.lang.Object"
  3786. abstract="true"
  3787. static="false" final="false" visibility="public"
  3788. deprecated="not deprecated">
  3789. <constructor name="ReservationListResponse"
  3790. static="false" final="false" visibility="public"
  3791. deprecated="not deprecated">
  3792. </constructor>
  3793. <method name="getReservationAllocationState" return="java.util.List"
  3794. abstract="true" native="false" synchronized="false"
  3795. static="false" final="false" visibility="public"
  3796. deprecated="not deprecated">
  3797. <doc>
  3798. <![CDATA[Get the list of {@link ReservationAllocationState}, that corresponds
  3799. to a reservation in the scheduler.
  3800. @return the list of {@link ReservationAllocationState} which holds
  3801. information of a particular reservation]]>
  3802. </doc>
  3803. </method>
  3804. <doc>
  3805. <![CDATA[{@link ReservationListResponse} captures the list of reservations that the
  3806. user has queried.
  3807. The resulting list of {@link ReservationAllocationState} contains a list of
  3808. {@code ResourceAllocationRequest} representing the current state of the
  3809. reservation resource allocations will be returned. This is subject to change
  3810. in the event of re-planning a described by {@code ReservationDefinition}
  3811. @see ReservationAllocationState]]>
  3812. </doc>
  3813. </class>
  3814. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse -->
  3815. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
  3816. <class name="ReservationSubmissionRequest" extends="java.lang.Object"
  3817. abstract="true"
  3818. static="false" final="false" visibility="public"
  3819. deprecated="not deprecated">
  3820. <constructor name="ReservationSubmissionRequest"
  3821. static="false" final="false" visibility="public"
  3822. deprecated="not deprecated">
  3823. </constructor>
  3824. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"
  3825. abstract="false" native="false" synchronized="false"
  3826. static="true" final="false" visibility="public"
  3827. deprecated="not deprecated">
  3828. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3829. <param name="queueName" type="java.lang.String"/>
  3830. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3831. </method>
  3832. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  3833. abstract="true" native="false" synchronized="false"
  3834. static="false" final="false" visibility="public"
  3835. deprecated="not deprecated">
  3836. <doc>
  3837. <![CDATA[Get the {@link ReservationDefinition} representing the user constraints for
  3838. this reservation
  3839. @return the reservation definition representing user constraints]]>
  3840. </doc>
  3841. </method>
  3842. <method name="setReservationDefinition"
  3843. abstract="true" native="false" synchronized="false"
  3844. static="false" final="false" visibility="public"
  3845. deprecated="not deprecated">
  3846. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3847. <doc>
  3848. <![CDATA[Set the {@link ReservationDefinition} representing the user constraints for
  3849. this reservation
  3850. @param reservationDefinition the reservation request representing the
  3851. reservation]]>
  3852. </doc>
  3853. </method>
  3854. <method name="getQueue" return="java.lang.String"
  3855. abstract="true" native="false" synchronized="false"
  3856. static="false" final="false" visibility="public"
  3857. deprecated="not deprecated">
  3858. <doc>
  3859. <![CDATA[Get the name of the {@code Plan} that corresponds to the name of the
  3860. {@link QueueInfo} in the scheduler to which the reservation will be
  3861. submitted to.
  3862. @return the name of the {@code Plan} that corresponds to the name of the
  3863. {@link QueueInfo} in the scheduler to which the reservation will be
  3864. submitted to]]>
  3865. </doc>
  3866. </method>
  3867. <method name="setQueue"
  3868. abstract="true" native="false" synchronized="false"
  3869. static="false" final="false" visibility="public"
  3870. deprecated="not deprecated">
  3871. <param name="queueName" type="java.lang.String"/>
  3872. <doc>
  3873. <![CDATA[Set the name of the {@code Plan} that corresponds to the name of the
  3874. {@link QueueInfo} in the scheduler to which the reservation will be
  3875. submitted to
  3876. @param queueName the name of the parent {@code Plan} that corresponds to
  3877. the name of the {@link QueueInfo} in the scheduler to which the
  3878. reservation will be submitted to]]>
  3879. </doc>
  3880. </method>
  3881. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  3882. abstract="true" native="false" synchronized="false"
  3883. static="false" final="false" visibility="public"
  3884. deprecated="not deprecated">
  3885. <doc>
  3886. <![CDATA[Get the reservation id that corresponds to the reservation submission.
  3887. @return reservation id that will be used to identify the reservation
  3888. submission.]]>
  3889. </doc>
  3890. </method>
  3891. <method name="setReservationId"
  3892. abstract="true" native="false" synchronized="false"
  3893. static="false" final="false" visibility="public"
  3894. deprecated="not deprecated">
  3895. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3896. <doc>
  3897. <![CDATA[Set the reservation id that corresponds to the reservation submission.
  3898. @param reservationId reservation id that will be used to identify the
  3899. reservation submission.]]>
  3900. </doc>
  3901. </method>
  3902. <doc>
  3903. <![CDATA[{@link ReservationSubmissionRequest} captures the set of requirements the
  3904. user has to create a reservation.
  3905. @see ReservationDefinition]]>
  3906. </doc>
  3907. </class>
  3908. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
  3909. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
  3910. <class name="ReservationSubmissionResponse" extends="java.lang.Object"
  3911. abstract="true"
  3912. static="false" final="false" visibility="public"
  3913. deprecated="not deprecated">
  3914. <constructor name="ReservationSubmissionResponse"
  3915. static="false" final="false" visibility="public"
  3916. deprecated="not deprecated">
  3917. </constructor>
  3918. <doc>
  3919. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client on
  3920. reservation submission.</p>
  3921. <p>Currently, this is empty.</p>
  3922. {@code ApplicationClientProtocol#submitReservation(
  3923. ReservationSubmissionRequest)}]]>
  3924. </doc>
  3925. </class>
  3926. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
  3927. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
  3928. <class name="ReservationUpdateRequest" extends="java.lang.Object"
  3929. abstract="true"
  3930. static="false" final="false" visibility="public"
  3931. deprecated="not deprecated">
  3932. <constructor name="ReservationUpdateRequest"
  3933. static="false" final="false" visibility="public"
  3934. deprecated="not deprecated">
  3935. </constructor>
  3936. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"
  3937. abstract="false" native="false" synchronized="false"
  3938. static="true" final="false" visibility="public"
  3939. deprecated="not deprecated">
  3940. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3941. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3942. </method>
  3943. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  3944. abstract="true" native="false" synchronized="false"
  3945. static="false" final="false" visibility="public"
  3946. deprecated="not deprecated">
  3947. <doc>
  3948. <![CDATA[Get the {@link ReservationDefinition} representing the updated user
  3949. constraints for this reservation
  3950. @return the reservation definition representing user constraints]]>
  3951. </doc>
  3952. </method>
  3953. <method name="setReservationDefinition"
  3954. abstract="true" native="false" synchronized="false"
  3955. static="false" final="false" visibility="public"
  3956. deprecated="not deprecated">
  3957. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3958. <doc>
  3959. <![CDATA[Set the {@link ReservationDefinition} representing the updated user
  3960. constraints for this reservation
  3961. @param reservationDefinition the reservation request representing the
  3962. reservation]]>
  3963. </doc>
  3964. </method>
  3965. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  3966. abstract="true" native="false" synchronized="false"
  3967. static="false" final="false" visibility="public"
  3968. deprecated="not deprecated">
  3969. <doc>
  3970. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  3971. allocation in the scheduler (between start and end time of this
  3972. reservation)
  3973. @return the {@link ReservationId} representing the unique id of the
  3974. corresponding reserved resource allocation in the scheduler]]>
  3975. </doc>
  3976. </method>
  3977. <method name="setReservationId"
  3978. abstract="true" native="false" synchronized="false"
  3979. static="false" final="false" visibility="public"
  3980. deprecated="not deprecated">
  3981. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3982. <doc>
  3983. <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
  3984. allocation in the scheduler (between start and end time of this
  3985. reservation)
  3986. @param reservationId the {@link ReservationId} representing the the unique
  3987. id of the corresponding reserved resource allocation in the
  3988. scheduler]]>
  3989. </doc>
  3990. </method>
  3991. <doc>
  3992. <![CDATA[{@link ReservationUpdateRequest} captures the set of requirements the user
  3993. has to update an existing reservation.
  3994. @see ReservationDefinition]]>
  3995. </doc>
  3996. </class>
  3997. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
  3998. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
  3999. <class name="ReservationUpdateResponse" extends="java.lang.Object"
  4000. abstract="true"
  4001. static="false" final="false" visibility="public"
  4002. deprecated="not deprecated">
  4003. <constructor name="ReservationUpdateResponse"
  4004. static="false" final="false" visibility="public"
  4005. deprecated="not deprecated">
  4006. </constructor>
  4007. <doc>
  4008. <![CDATA[{@link ReservationUpdateResponse} contains the answer of the admission
  4009. control system in the {@code ResourceManager} to a reservation update
  4010. operation. Currently response is empty if the operation was successful, if
  4011. not an exception reporting reason for a failure.
  4012. @see ReservationDefinition]]>
  4013. </doc>
  4014. </class>
  4015. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
  4016. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest -->
  4017. <class name="SignalContainerRequest" extends="java.lang.Object"
  4018. abstract="true"
  4019. static="false" final="false" visibility="public"
  4020. deprecated="not deprecated">
  4021. <constructor name="SignalContainerRequest"
  4022. static="false" final="false" visibility="public"
  4023. deprecated="not deprecated">
  4024. </constructor>
  4025. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest"
  4026. abstract="false" native="false" synchronized="false"
  4027. static="true" final="false" visibility="public"
  4028. deprecated="not deprecated">
  4029. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  4030. <param name="signalContainerCommand" type="org.apache.hadoop.yarn.api.records.SignalContainerCommand"/>
  4031. </method>
  4032. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  4033. abstract="true" native="false" synchronized="false"
  4034. static="false" final="false" visibility="public"
  4035. deprecated="not deprecated">
  4036. <doc>
  4037. <![CDATA[Get the <code>ContainerId</code> of the container to signal.
  4038. @return <code>ContainerId</code> of the container to signal.]]>
  4039. </doc>
  4040. </method>
  4041. <method name="setContainerId"
  4042. abstract="true" native="false" synchronized="false"
  4043. static="false" final="false" visibility="public"
  4044. deprecated="not deprecated">
  4045. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  4046. <doc>
  4047. <![CDATA[Set the <code>ContainerId</code> of the container to signal.]]>
  4048. </doc>
  4049. </method>
  4050. <method name="getCommand" return="org.apache.hadoop.yarn.api.records.SignalContainerCommand"
  4051. abstract="true" native="false" synchronized="false"
  4052. static="false" final="false" visibility="public"
  4053. deprecated="not deprecated">
  4054. <doc>
  4055. <![CDATA[Get the <code>SignalContainerCommand</code> of the signal request.
  4056. @return <code>SignalContainerCommand</code> of the signal request.]]>
  4057. </doc>
  4058. </method>
  4059. <method name="setCommand"
  4060. abstract="true" native="false" synchronized="false"
  4061. static="false" final="false" visibility="public"
  4062. deprecated="not deprecated">
  4063. <param name="command" type="org.apache.hadoop.yarn.api.records.SignalContainerCommand"/>
  4064. <doc>
  4065. <![CDATA[Set the <code>SignalContainerCommand</code> of the signal request.]]>
  4066. </doc>
  4067. </method>
  4068. <doc>
  4069. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  4070. or by the <code>ApplicationMaster</code> to the <code>NodeManager</code>
  4071. to signal a container.
  4072. @see SignalContainerCommand </p>]]>
  4073. </doc>
  4074. </class>
  4075. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest -->
  4076. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse -->
  4077. <class name="SignalContainerResponse" extends="java.lang.Object"
  4078. abstract="true"
  4079. static="false" final="false" visibility="public"
  4080. deprecated="not deprecated">
  4081. <constructor name="SignalContainerResponse"
  4082. static="false" final="false" visibility="public"
  4083. deprecated="not deprecated">
  4084. </constructor>
  4085. <doc>
  4086. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client
  4087. signalling a container.</p>
  4088. <p>Currently it's empty.</p>
  4089. @see ApplicationClientProtocol#signalToContainer(SignalContainerRequest)]]>
  4090. </doc>
  4091. </class>
  4092. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse -->
  4093. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
  4094. <class name="StartContainerRequest" extends="java.lang.Object"
  4095. abstract="true"
  4096. static="false" final="false" visibility="public"
  4097. deprecated="not deprecated">
  4098. <constructor name="StartContainerRequest"
  4099. static="false" final="false" visibility="public"
  4100. deprecated="not deprecated">
  4101. </constructor>
  4102. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest"
  4103. abstract="false" native="false" synchronized="false"
  4104. static="true" final="false" visibility="public"
  4105. deprecated="not deprecated">
  4106. <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4107. <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
  4108. </method>
  4109. <method name="getContainerLaunchContext" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  4110. abstract="true" native="false" synchronized="false"
  4111. static="false" final="false" visibility="public"
  4112. deprecated="not deprecated">
  4113. <doc>
  4114. <![CDATA[Get the <code>ContainerLaunchContext</code> for the container to be started
  4115. by the <code>NodeManager</code>.
  4116. @return <code>ContainerLaunchContext</code> for the container to be started
  4117. by the <code>NodeManager</code>]]>
  4118. </doc>
  4119. </method>
  4120. <method name="setContainerLaunchContext"
  4121. abstract="true" native="false" synchronized="false"
  4122. static="false" final="false" visibility="public"
  4123. deprecated="not deprecated">
  4124. <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4125. <doc>
  4126. <![CDATA[Set the <code>ContainerLaunchContext</code> for the container to be started
  4127. by the <code>NodeManager</code>
  4128. @param context <code>ContainerLaunchContext</code> for the container to be
  4129. started by the <code>NodeManager</code>]]>
  4130. </doc>
  4131. </method>
  4132. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  4133. abstract="true" native="false" synchronized="false"
  4134. static="false" final="false" visibility="public"
  4135. deprecated="not deprecated">
  4136. <doc>
  4137. <![CDATA[Get the container token to be used for authorization during starting
  4138. container.
  4139. <p>
  4140. Note: {@link NMToken} will be used for authenticating communication with
  4141. {@code NodeManager}.
  4142. @return the container token to be used for authorization during starting
  4143. container.
  4144. @see NMToken
  4145. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  4146. </doc>
  4147. </method>
  4148. <method name="setContainerToken"
  4149. abstract="true" native="false" synchronized="false"
  4150. static="false" final="false" visibility="public"
  4151. deprecated="not deprecated">
  4152. <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
  4153. </method>
  4154. <doc>
  4155. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
  4156. <code>NodeManager</code> to <em>start</em> a container.</p>
  4157. <p>The <code>ApplicationMaster</code> has to provide details such as
  4158. allocated resource capability, security tokens (if enabled), command
  4159. to be executed to start the container, environment for the process,
  4160. necessary binaries/jar/shared-objects etc. via the
  4161. {@link ContainerLaunchContext}.</p>
  4162. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  4163. </doc>
  4164. </class>
  4165. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
  4166. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
  4167. <class name="StartContainersRequest" extends="java.lang.Object"
  4168. abstract="true"
  4169. static="false" final="false" visibility="public"
  4170. deprecated="not deprecated">
  4171. <constructor name="StartContainersRequest"
  4172. static="false" final="false" visibility="public"
  4173. deprecated="not deprecated">
  4174. </constructor>
  4175. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"
  4176. abstract="false" native="false" synchronized="false"
  4177. static="true" final="false" visibility="public"
  4178. deprecated="not deprecated">
  4179. <param name="requests" type="java.util.List"/>
  4180. </method>
  4181. <method name="getStartContainerRequests" return="java.util.List"
  4182. abstract="true" native="false" synchronized="false"
  4183. static="false" final="false" visibility="public"
  4184. deprecated="not deprecated">
  4185. <doc>
  4186. <![CDATA[Get a list of {@link StartContainerRequest} to start containers.
  4187. @return a list of {@link StartContainerRequest} to start containers.]]>
  4188. </doc>
  4189. </method>
  4190. <method name="setStartContainerRequests"
  4191. abstract="true" native="false" synchronized="false"
  4192. static="false" final="false" visibility="public"
  4193. deprecated="not deprecated">
  4194. <param name="request" type="java.util.List"/>
  4195. <doc>
  4196. <![CDATA[Set a list of {@link StartContainerRequest} to start containers.
  4197. @param request a list of {@link StartContainerRequest} to start containers]]>
  4198. </doc>
  4199. </method>
  4200. <doc>
  4201. <![CDATA[<p>
  4202. The request which contains a list of {@link StartContainerRequest} sent by
  4203. the <code>ApplicationMaster</code> to the <code>NodeManager</code> to
  4204. <em>start</em> containers.
  4205. </p>
  4206. <p>
  4207. In each {@link StartContainerRequest}, the <code>ApplicationMaster</code> has
  4208. to provide details such as allocated resource capability, security tokens (if
  4209. enabled), command to be executed to start the container, environment for the
  4210. process, necessary binaries/jar/shared-objects etc. via the
  4211. {@link ContainerLaunchContext}.
  4212. </p>
  4213. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  4214. </doc>
  4215. </class>
  4216. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
  4217. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
  4218. <class name="StartContainersResponse" extends="java.lang.Object"
  4219. abstract="true"
  4220. static="false" final="false" visibility="public"
  4221. deprecated="not deprecated">
  4222. <constructor name="StartContainersResponse"
  4223. static="false" final="false" visibility="public"
  4224. deprecated="not deprecated">
  4225. </constructor>
  4226. <method name="getSuccessfullyStartedContainers" return="java.util.List"
  4227. abstract="true" native="false" synchronized="false"
  4228. static="false" final="false" visibility="public"
  4229. deprecated="not deprecated">
  4230. <doc>
  4231. <![CDATA[Get the list of <code>ContainerId</code> s of the containers that are
  4232. started successfully.
  4233. @return the list of <code>ContainerId</code> s of the containers that are
  4234. started successfully.
  4235. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  4236. </doc>
  4237. </method>
  4238. <method name="getFailedRequests" return="java.util.Map"
  4239. abstract="true" native="false" synchronized="false"
  4240. static="false" final="false" visibility="public"
  4241. deprecated="not deprecated">
  4242. <doc>
  4243. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  4244. from per container for failed requests]]>
  4245. </doc>
  4246. </method>
  4247. <method name="getAllServicesMetaData" return="java.util.Map"
  4248. abstract="true" native="false" synchronized="false"
  4249. static="false" final="false" visibility="public"
  4250. deprecated="not deprecated">
  4251. <doc>
  4252. <![CDATA[<p>
  4253. Get the meta-data from all auxiliary services running on the
  4254. <code>NodeManager</code>.
  4255. </p>
  4256. <p>
  4257. The meta-data is returned as a Map between the auxiliary service names and
  4258. their corresponding per service meta-data as an opaque blob
  4259. <code>ByteBuffer</code>
  4260. </p>
  4261. <p>
  4262. To be able to interpret the per-service meta-data, you should consult the
  4263. documentation for the Auxiliary-service configured on the NodeManager
  4264. </p>
  4265. @return a Map between the names of auxiliary services and their
  4266. corresponding meta-data]]>
  4267. </doc>
  4268. </method>
  4269. <doc>
  4270. <![CDATA[<p>
  4271. The response sent by the <code>NodeManager</code> to the
  4272. <code>ApplicationMaster</code> when asked to <em>start</em> an allocated
  4273. container.
  4274. </p>
  4275. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  4276. </doc>
  4277. </class>
  4278. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
  4279. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
  4280. <class name="StopContainersRequest" extends="java.lang.Object"
  4281. abstract="true"
  4282. static="false" final="false" visibility="public"
  4283. deprecated="not deprecated">
  4284. <constructor name="StopContainersRequest"
  4285. static="false" final="false" visibility="public"
  4286. deprecated="not deprecated">
  4287. </constructor>
  4288. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"
  4289. abstract="false" native="false" synchronized="false"
  4290. static="true" final="false" visibility="public"
  4291. deprecated="not deprecated">
  4292. <param name="containerIds" type="java.util.List"/>
  4293. </method>
  4294. <method name="getContainerIds" return="java.util.List"
  4295. abstract="true" native="false" synchronized="false"
  4296. static="false" final="false" visibility="public"
  4297. deprecated="not deprecated">
  4298. <doc>
  4299. <![CDATA[Get the <code>ContainerId</code>s of the containers to be stopped.
  4300. @return <code>ContainerId</code>s of containers to be stopped]]>
  4301. </doc>
  4302. </method>
  4303. <method name="setContainerIds"
  4304. abstract="true" native="false" synchronized="false"
  4305. static="false" final="false" visibility="public"
  4306. deprecated="not deprecated">
  4307. <param name="containerIds" type="java.util.List"/>
  4308. <doc>
  4309. <![CDATA[Set the <code>ContainerId</code>s of the containers to be stopped.
  4310. @param containerIds <code>ContainerId</code>s of the containers to be stopped]]>
  4311. </doc>
  4312. </method>
  4313. <doc>
  4314. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
  4315. <code>NodeManager</code> to <em>stop</em> containers.</p>
  4316. @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
  4317. </doc>
  4318. </class>
  4319. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
  4320. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
  4321. <class name="StopContainersResponse" extends="java.lang.Object"
  4322. abstract="true"
  4323. static="false" final="false" visibility="public"
  4324. deprecated="not deprecated">
  4325. <constructor name="StopContainersResponse"
  4326. static="false" final="false" visibility="public"
  4327. deprecated="not deprecated">
  4328. </constructor>
  4329. <method name="getSuccessfullyStoppedContainers" return="java.util.List"
  4330. abstract="true" native="false" synchronized="false"
  4331. static="false" final="false" visibility="public"
  4332. deprecated="not deprecated">
  4333. <doc>
  4334. <![CDATA[Get the list of containerIds of successfully stopped containers.
  4335. @return the list of containerIds of successfully stopped containers.]]>
  4336. </doc>
  4337. </method>
  4338. <method name="getFailedRequests" return="java.util.Map"
  4339. abstract="true" native="false" synchronized="false"
  4340. static="false" final="false" visibility="public"
  4341. deprecated="not deprecated">
  4342. <doc>
  4343. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  4344. from per container for failed requests]]>
  4345. </doc>
  4346. </method>
  4347. <doc>
  4348. <![CDATA[<p>
  4349. The response sent by the <code>NodeManager</code> to the
  4350. <code>ApplicationMaster</code> when asked to <em>stop</em> allocated
  4351. containers.
  4352. </p>
  4353. @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
  4354. </doc>
  4355. </class>
  4356. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
  4357. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
  4358. <class name="SubmitApplicationRequest" extends="java.lang.Object"
  4359. abstract="true"
  4360. static="false" final="false" visibility="public"
  4361. deprecated="not deprecated">
  4362. <constructor name="SubmitApplicationRequest"
  4363. static="false" final="false" visibility="public"
  4364. deprecated="not deprecated">
  4365. </constructor>
  4366. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"
  4367. abstract="false" native="false" synchronized="false"
  4368. static="true" final="false" visibility="public"
  4369. deprecated="not deprecated">
  4370. <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
  4371. </method>
  4372. <method name="getApplicationSubmissionContext" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4373. abstract="true" native="false" synchronized="false"
  4374. static="false" final="false" visibility="public"
  4375. deprecated="not deprecated">
  4376. <doc>
  4377. <![CDATA[Get the <code>ApplicationSubmissionContext</code> for the application.
  4378. @return <code>ApplicationSubmissionContext</code> for the application]]>
  4379. </doc>
  4380. </method>
  4381. <method name="setApplicationSubmissionContext"
  4382. abstract="true" native="false" synchronized="false"
  4383. static="false" final="false" visibility="public"
  4384. deprecated="not deprecated">
  4385. <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
  4386. <doc>
  4387. <![CDATA[Set the <code>ApplicationSubmissionContext</code> for the application.
  4388. @param context <code>ApplicationSubmissionContext</code> for the
  4389. application]]>
  4390. </doc>
  4391. </method>
  4392. <doc>
  4393. <![CDATA[<p>The request sent by a client to <em>submit an application</em> to the
  4394. <code>ResourceManager</code>.</p>
  4395. <p>The request, via {@link ApplicationSubmissionContext}, contains
  4396. details such as queue, {@link Resource} required to run the
  4397. <code>ApplicationMaster</code>, the equivalent of
  4398. {@link ContainerLaunchContext} for launching the
  4399. <code>ApplicationMaster</code> etc.
  4400. @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
  4401. </doc>
  4402. </class>
  4403. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
  4404. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
  4405. <class name="SubmitApplicationResponse" extends="java.lang.Object"
  4406. abstract="true"
  4407. static="false" final="false" visibility="public"
  4408. deprecated="not deprecated">
  4409. <constructor name="SubmitApplicationResponse"
  4410. static="false" final="false" visibility="public"
  4411. deprecated="not deprecated">
  4412. </constructor>
  4413. <doc>
  4414. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client on
  4415. application submission.</p>
  4416. <p>Currently, this is empty.</p>
  4417. @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
  4418. </doc>
  4419. </class>
  4420. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
  4421. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest -->
  4422. <class name="UpdateApplicationPriorityRequest" extends="java.lang.Object"
  4423. abstract="true"
  4424. static="false" final="false" visibility="public"
  4425. deprecated="not deprecated">
  4426. <constructor name="UpdateApplicationPriorityRequest"
  4427. static="false" final="false" visibility="public"
  4428. deprecated="not deprecated">
  4429. </constructor>
  4430. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest"
  4431. abstract="false" native="false" synchronized="false"
  4432. static="true" final="false" visibility="public"
  4433. deprecated="not deprecated">
  4434. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4435. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4436. </method>
  4437. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4438. abstract="true" native="false" synchronized="false"
  4439. static="false" final="false" visibility="public"
  4440. deprecated="not deprecated">
  4441. <doc>
  4442. <![CDATA[Get the <code>ApplicationId</code> of the application.
  4443. @return <code>ApplicationId</code> of the application]]>
  4444. </doc>
  4445. </method>
  4446. <method name="setApplicationId"
  4447. abstract="true" native="false" synchronized="false"
  4448. static="false" final="false" visibility="public"
  4449. deprecated="not deprecated">
  4450. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4451. <doc>
  4452. <![CDATA[Set the <code>ApplicationId</code> of the application.
  4453. @param applicationId <code>ApplicationId</code> of the application]]>
  4454. </doc>
  4455. </method>
  4456. <method name="getApplicationPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  4457. abstract="true" native="false" synchronized="false"
  4458. static="false" final="false" visibility="public"
  4459. deprecated="not deprecated">
  4460. <doc>
  4461. <![CDATA[Get the <code>Priority</code> of the application to be set.
  4462. @return <code>Priority</code> of the application to be set.]]>
  4463. </doc>
  4464. </method>
  4465. <method name="setApplicationPriority"
  4466. abstract="true" native="false" synchronized="false"
  4467. static="false" final="false" visibility="public"
  4468. deprecated="not deprecated">
  4469. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4470. <doc>
  4471. <![CDATA[Set the <code>Priority</code> of the application.
  4472. @param priority <code>Priority</code> of the application]]>
  4473. </doc>
  4474. </method>
  4475. <doc>
  4476. <![CDATA[<p>
  4477. The request sent by the client to the <code>ResourceManager</code> to set or
  4478. update the application priority.
  4479. </p>
  4480. <p>
  4481. The request includes the {@link ApplicationId} of the application and
  4482. {@link Priority} to be set for an application
  4483. </p>
  4484. @see ApplicationClientProtocol#updateApplicationPriority(UpdateApplicationPriorityRequest)]]>
  4485. </doc>
  4486. </class>
  4487. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest -->
  4488. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse -->
  4489. <class name="UpdateApplicationPriorityResponse" extends="java.lang.Object"
  4490. abstract="true"
  4491. static="false" final="false" visibility="public"
  4492. deprecated="not deprecated">
  4493. <constructor name="UpdateApplicationPriorityResponse"
  4494. static="false" final="false" visibility="public"
  4495. deprecated="not deprecated">
  4496. </constructor>
  4497. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse"
  4498. abstract="false" native="false" synchronized="false"
  4499. static="true" final="false" visibility="public"
  4500. deprecated="not deprecated">
  4501. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4502. </method>
  4503. <method name="getApplicationPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  4504. abstract="true" native="false" synchronized="false"
  4505. static="false" final="false" visibility="public"
  4506. deprecated="not deprecated">
  4507. <doc>
  4508. <![CDATA[Get the <code>Priority</code> of the application to be set.
  4509. @return Updated <code>Priority</code> of the application.]]>
  4510. </doc>
  4511. </method>
  4512. <method name="setApplicationPriority"
  4513. abstract="true" native="false" synchronized="false"
  4514. static="false" final="false" visibility="public"
  4515. deprecated="not deprecated">
  4516. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4517. <doc>
  4518. <![CDATA[Set the <code>Priority</code> of the application.
  4519. @param priority <code>Priority</code> of the application]]>
  4520. </doc>
  4521. </method>
  4522. <doc>
  4523. <![CDATA[<p>
  4524. The response sent by the <code>ResourceManager</code> to the client on update
  4525. the application priority.
  4526. </p>
  4527. <p>
  4528. A response without exception means that the move has completed successfully.
  4529. </p>
  4530. @see ApplicationClientProtocol#updateApplicationPriority(UpdateApplicationPriorityRequest)]]>
  4531. </doc>
  4532. </class>
  4533. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse -->
  4534. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
  4535. <class name="UseSharedCacheResourceRequest" extends="java.lang.Object"
  4536. abstract="true"
  4537. static="false" final="false" visibility="public"
  4538. deprecated="not deprecated">
  4539. <constructor name="UseSharedCacheResourceRequest"
  4540. static="false" final="false" visibility="public"
  4541. deprecated="not deprecated">
  4542. </constructor>
  4543. <method name="getAppId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4544. abstract="true" native="false" synchronized="false"
  4545. static="false" final="false" visibility="public"
  4546. deprecated="not deprecated">
  4547. <doc>
  4548. <![CDATA[Get the <code>ApplicationId</code> of the resource to be used.
  4549. @return <code>ApplicationId</code>]]>
  4550. </doc>
  4551. </method>
  4552. <method name="setAppId"
  4553. abstract="true" native="false" synchronized="false"
  4554. static="false" final="false" visibility="public"
  4555. deprecated="not deprecated">
  4556. <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4557. <doc>
  4558. <![CDATA[Set the <code>ApplicationId</code> of the resource to be used.
  4559. @param id <code>ApplicationId</code>]]>
  4560. </doc>
  4561. </method>
  4562. <method name="getResourceKey" return="java.lang.String"
  4563. abstract="true" native="false" synchronized="false"
  4564. static="false" final="false" visibility="public"
  4565. deprecated="not deprecated">
  4566. <doc>
  4567. <![CDATA[Get the <code>key</code> of the resource to be used.
  4568. @return <code>key</code>]]>
  4569. </doc>
  4570. </method>
  4571. <method name="setResourceKey"
  4572. abstract="true" native="false" synchronized="false"
  4573. static="false" final="false" visibility="public"
  4574. deprecated="not deprecated">
  4575. <param name="key" type="java.lang.String"/>
  4576. <doc>
  4577. <![CDATA[Set the <code>key</code> of the resource to be used.
  4578. @param key unique identifier for the resource]]>
  4579. </doc>
  4580. </method>
  4581. <doc>
  4582. <![CDATA[<p>
  4583. The request from clients to the <code>SharedCacheManager</code> that claims a
  4584. resource in the shared cache.
  4585. </p>]]>
  4586. </doc>
  4587. </class>
  4588. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
  4589. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
  4590. <class name="UseSharedCacheResourceResponse" extends="java.lang.Object"
  4591. abstract="true"
  4592. static="false" final="false" visibility="public"
  4593. deprecated="not deprecated">
  4594. <constructor name="UseSharedCacheResourceResponse"
  4595. static="false" final="false" visibility="public"
  4596. deprecated="not deprecated">
  4597. </constructor>
  4598. <method name="getPath" return="java.lang.String"
  4599. abstract="true" native="false" synchronized="false"
  4600. static="false" final="false" visibility="public"
  4601. deprecated="not deprecated">
  4602. <doc>
  4603. <![CDATA[Get the <code>Path</code> corresponding to the requested resource in the
  4604. shared cache.
  4605. @return String A <code>Path</code> if the resource exists in the shared
  4606. cache, <code>null</code> otherwise]]>
  4607. </doc>
  4608. </method>
  4609. <method name="setPath"
  4610. abstract="true" native="false" synchronized="false"
  4611. static="false" final="false" visibility="public"
  4612. deprecated="not deprecated">
  4613. <param name="p" type="java.lang.String"/>
  4614. <doc>
  4615. <![CDATA[Set the <code>Path</code> corresponding to a resource in the shared cache.
  4616. @param p A <code>Path</code> corresponding to a resource in the shared
  4617. cache]]>
  4618. </doc>
  4619. </method>
  4620. <doc>
  4621. <![CDATA[<p>
  4622. The response from the SharedCacheManager to the client that indicates whether
  4623. a requested resource exists in the cache.
  4624. </p>]]>
  4625. </doc>
  4626. </class>
  4627. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
  4628. </package>
  4629. <package name="org.apache.hadoop.yarn.api.records">
  4630. <!-- start class org.apache.hadoop.yarn.api.records.AMCommand -->
  4631. <class name="AMCommand" extends="java.lang.Enum"
  4632. abstract="false"
  4633. static="false" final="true" visibility="public"
  4634. deprecated="not deprecated">
  4635. <method name="values" return="org.apache.hadoop.yarn.api.records.AMCommand[]"
  4636. abstract="false" native="false" synchronized="false"
  4637. static="true" final="false" visibility="public"
  4638. deprecated="not deprecated">
  4639. </method>
  4640. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.AMCommand"
  4641. abstract="false" native="false" synchronized="false"
  4642. static="true" final="false" visibility="public"
  4643. deprecated="not deprecated">
  4644. <param name="name" type="java.lang.String"/>
  4645. </method>
  4646. <doc>
  4647. <![CDATA[Command sent by the Resource Manager to the Application Master in the
  4648. AllocateResponse
  4649. @see AllocateResponse]]>
  4650. </doc>
  4651. </class>
  4652. <!-- end class org.apache.hadoop.yarn.api.records.AMCommand -->
  4653. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
  4654. <class name="ApplicationAccessType" extends="java.lang.Enum"
  4655. abstract="false"
  4656. static="false" final="true" visibility="public"
  4657. deprecated="not deprecated">
  4658. <method name="values" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType[]"
  4659. abstract="false" native="false" synchronized="false"
  4660. static="true" final="false" visibility="public"
  4661. deprecated="not deprecated">
  4662. </method>
  4663. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType"
  4664. abstract="false" native="false" synchronized="false"
  4665. static="true" final="false" visibility="public"
  4666. deprecated="not deprecated">
  4667. <param name="name" type="java.lang.String"/>
  4668. </method>
  4669. <doc>
  4670. <![CDATA[Application access types.]]>
  4671. </doc>
  4672. </class>
  4673. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
  4674. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
  4675. <class name="ApplicationAttemptId" extends="java.lang.Object"
  4676. abstract="true"
  4677. static="false" final="false" visibility="public"
  4678. deprecated="not deprecated">
  4679. <implements name="java.lang.Comparable"/>
  4680. <constructor name="ApplicationAttemptId"
  4681. static="false" final="false" visibility="public"
  4682. deprecated="not deprecated">
  4683. </constructor>
  4684. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  4685. abstract="false" native="false" synchronized="false"
  4686. static="true" final="false" visibility="public"
  4687. deprecated="not deprecated">
  4688. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4689. <param name="attemptId" type="int"/>
  4690. </method>
  4691. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4692. abstract="true" native="false" synchronized="false"
  4693. static="false" final="false" visibility="public"
  4694. deprecated="not deprecated">
  4695. <doc>
  4696. <![CDATA[Get the <code>ApplicationId</code> of the <code>ApplicationAttempId</code>.
  4697. @return <code>ApplicationId</code> of the <code>ApplicationAttempId</code>]]>
  4698. </doc>
  4699. </method>
  4700. <method name="getAttemptId" return="int"
  4701. abstract="true" native="false" synchronized="false"
  4702. static="false" final="false" visibility="public"
  4703. deprecated="not deprecated">
  4704. <doc>
  4705. <![CDATA[Get the <code>attempt id</code> of the <code>Application</code>.
  4706. @return <code>attempt id</code> of the <code>Application</code>]]>
  4707. </doc>
  4708. </method>
  4709. <method name="hashCode" return="int"
  4710. abstract="false" native="false" synchronized="false"
  4711. static="false" final="false" visibility="public"
  4712. deprecated="not deprecated">
  4713. </method>
  4714. <method name="equals" return="boolean"
  4715. abstract="false" native="false" synchronized="false"
  4716. static="false" final="false" visibility="public"
  4717. deprecated="not deprecated">
  4718. <param name="obj" type="java.lang.Object"/>
  4719. </method>
  4720. <method name="compareTo" return="int"
  4721. abstract="false" native="false" synchronized="false"
  4722. static="false" final="false" visibility="public"
  4723. deprecated="not deprecated">
  4724. <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  4725. </method>
  4726. <method name="toString" return="java.lang.String"
  4727. abstract="false" native="false" synchronized="false"
  4728. static="false" final="false" visibility="public"
  4729. deprecated="not deprecated">
  4730. </method>
  4731. <method name="build"
  4732. abstract="true" native="false" synchronized="false"
  4733. static="false" final="false" visibility="protected"
  4734. deprecated="not deprecated">
  4735. </method>
  4736. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  4737. abstract="false" native="false" synchronized="false"
  4738. static="true" final="false" visibility="public"
  4739. deprecated="not deprecated">
  4740. <param name="appAttemptIdStr" type="java.lang.String"/>
  4741. </method>
  4742. <field name="appAttemptIdStrPrefix" type="java.lang.String"
  4743. transient="false" volatile="false"
  4744. static="true" final="true" visibility="public"
  4745. deprecated="not deprecated">
  4746. </field>
  4747. <doc>
  4748. <![CDATA[<p><code>ApplicationAttemptId</code> denotes the particular <em>attempt</em>
  4749. of an <code>ApplicationMaster</code> for a given {@link ApplicationId}.</p>
  4750. <p>Multiple attempts might be needed to run an application to completion due
  4751. to temporal failures of the <code>ApplicationMaster</code> such as hardware
  4752. failures, connectivity issues etc. on the node on which it was scheduled.</p>]]>
  4753. </doc>
  4754. </class>
  4755. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
  4756. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
  4757. <class name="ApplicationAttemptReport" extends="java.lang.Object"
  4758. abstract="true"
  4759. static="false" final="false" visibility="public"
  4760. deprecated="not deprecated">
  4761. <constructor name="ApplicationAttemptReport"
  4762. static="false" final="false" visibility="public"
  4763. deprecated="not deprecated">
  4764. </constructor>
  4765. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
  4766. abstract="false" native="false" synchronized="false"
  4767. static="true" final="false" visibility="public"
  4768. deprecated="not deprecated">
  4769. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  4770. <param name="host" type="java.lang.String"/>
  4771. <param name="rpcPort" type="int"/>
  4772. <param name="url" type="java.lang.String"/>
  4773. <param name="oUrl" type="java.lang.String"/>
  4774. <param name="diagnostics" type="java.lang.String"/>
  4775. <param name="state" type="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"/>
  4776. <param name="amContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  4777. </method>
  4778. <method name="getYarnApplicationAttemptState" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
  4779. abstract="true" native="false" synchronized="false"
  4780. static="false" final="false" visibility="public"
  4781. deprecated="not deprecated">
  4782. <doc>
  4783. <![CDATA[Get the <em>YarnApplicationAttemptState</em> of the application attempt.
  4784. @return <em>YarnApplicationAttemptState</em> of the application attempt]]>
  4785. </doc>
  4786. </method>
  4787. <method name="getRpcPort" return="int"
  4788. abstract="true" native="false" synchronized="false"
  4789. static="false" final="false" visibility="public"
  4790. deprecated="not deprecated">
  4791. <doc>
  4792. <![CDATA[Get the <em>RPC port</em> of this attempt <code>ApplicationMaster</code>.
  4793. @return <em>RPC port</em> of this attempt <code>ApplicationMaster</code>]]>
  4794. </doc>
  4795. </method>
  4796. <method name="getHost" return="java.lang.String"
  4797. abstract="true" native="false" synchronized="false"
  4798. static="false" final="false" visibility="public"
  4799. deprecated="not deprecated">
  4800. <doc>
  4801. <![CDATA[Get the <em>host</em> on which this attempt of
  4802. <code>ApplicationMaster</code> is running.
  4803. @return <em>host</em> on which this attempt of
  4804. <code>ApplicationMaster</code> is running]]>
  4805. </doc>
  4806. </method>
  4807. <method name="getDiagnostics" return="java.lang.String"
  4808. abstract="true" native="false" synchronized="false"
  4809. static="false" final="false" visibility="public"
  4810. deprecated="not deprecated">
  4811. <doc>
  4812. <![CDATA[Get the <em>diagnositic information</em> of the application attempt in case
  4813. of errors.
  4814. @return <em>diagnositic information</em> of the application attempt in case
  4815. of errors]]>
  4816. </doc>
  4817. </method>
  4818. <method name="getTrackingUrl" return="java.lang.String"
  4819. abstract="true" native="false" synchronized="false"
  4820. static="false" final="false" visibility="public"
  4821. deprecated="not deprecated">
  4822. <doc>
  4823. <![CDATA[Get the <em>tracking url</em> for the application attempt.
  4824. @return <em>tracking url</em> for the application attempt]]>
  4825. </doc>
  4826. </method>
  4827. <method name="getOriginalTrackingUrl" return="java.lang.String"
  4828. abstract="true" native="false" synchronized="false"
  4829. static="false" final="false" visibility="public"
  4830. deprecated="not deprecated">
  4831. <doc>
  4832. <![CDATA[Get the <em>original tracking url</em> for the application attempt.
  4833. @return <em>original tracking url</em> for the application attempt]]>
  4834. </doc>
  4835. </method>
  4836. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  4837. abstract="true" native="false" synchronized="false"
  4838. static="false" final="false" visibility="public"
  4839. deprecated="not deprecated">
  4840. <doc>
  4841. <![CDATA[Get the <code>ApplicationAttemptId</code> of this attempt of the
  4842. application
  4843. @return <code>ApplicationAttemptId</code> of the attempt]]>
  4844. </doc>
  4845. </method>
  4846. <method name="getAMContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  4847. abstract="true" native="false" synchronized="false"
  4848. static="false" final="false" visibility="public"
  4849. deprecated="not deprecated">
  4850. <doc>
  4851. <![CDATA[Get the <code>ContainerId</code> of AMContainer for this attempt
  4852. @return <code>ContainerId</code> of the attempt]]>
  4853. </doc>
  4854. </method>
  4855. <method name="getStartTime" return="long"
  4856. abstract="true" native="false" synchronized="false"
  4857. static="false" final="false" visibility="public"
  4858. deprecated="not deprecated">
  4859. </method>
  4860. <method name="getFinishTime" return="long"
  4861. abstract="true" native="false" synchronized="false"
  4862. static="false" final="false" visibility="public"
  4863. deprecated="not deprecated">
  4864. <doc>
  4865. <![CDATA[Get the <em>finish time</em> of the application.
  4866. @return <em>finish time</em> of the application]]>
  4867. </doc>
  4868. </method>
  4869. <doc>
  4870. <![CDATA[{@code ApplicationAttemptReport} is a report of an application attempt.
  4871. <p>
  4872. It includes details such as:
  4873. <ul>
  4874. <li>{@link ApplicationAttemptId} of the application.</li>
  4875. <li>Host on which the <code>ApplicationMaster</code> of this attempt is
  4876. running.</li>
  4877. <li>RPC port of the <code>ApplicationMaster</code> of this attempt.</li>
  4878. <li>Tracking URL.</li>
  4879. <li>Diagnostic information in case of errors.</li>
  4880. <li>{@link YarnApplicationAttemptState} of the application attempt.</li>
  4881. <li>{@link ContainerId} of the master Container.</li>
  4882. </ul>]]>
  4883. </doc>
  4884. </class>
  4885. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
  4886. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationId -->
  4887. <class name="ApplicationId" extends="java.lang.Object"
  4888. abstract="true"
  4889. static="false" final="false" visibility="public"
  4890. deprecated="not deprecated">
  4891. <implements name="java.lang.Comparable"/>
  4892. <constructor name="ApplicationId"
  4893. static="false" final="false" visibility="public"
  4894. deprecated="not deprecated">
  4895. </constructor>
  4896. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4897. abstract="false" native="false" synchronized="false"
  4898. static="true" final="false" visibility="public"
  4899. deprecated="not deprecated">
  4900. <param name="clusterTimestamp" type="long"/>
  4901. <param name="id" type="int"/>
  4902. </method>
  4903. <method name="getId" return="int"
  4904. abstract="true" native="false" synchronized="false"
  4905. static="false" final="false" visibility="public"
  4906. deprecated="not deprecated">
  4907. <doc>
  4908. <![CDATA[Get the short integer identifier of the <code>ApplicationId</code>
  4909. which is unique for all applications started by a particular instance
  4910. of the <code>ResourceManager</code>.
  4911. @return short integer identifier of the <code>ApplicationId</code>]]>
  4912. </doc>
  4913. </method>
  4914. <method name="getClusterTimestamp" return="long"
  4915. abstract="true" native="false" synchronized="false"
  4916. static="false" final="false" visibility="public"
  4917. deprecated="not deprecated">
  4918. <doc>
  4919. <![CDATA[Get the <em>start time</em> of the <code>ResourceManager</code> which is
  4920. used to generate globally unique <code>ApplicationId</code>.
  4921. @return <em>start time</em> of the <code>ResourceManager</code>]]>
  4922. </doc>
  4923. </method>
  4924. <method name="build"
  4925. abstract="true" native="false" synchronized="false"
  4926. static="false" final="false" visibility="protected"
  4927. deprecated="not deprecated">
  4928. </method>
  4929. <method name="compareTo" return="int"
  4930. abstract="false" native="false" synchronized="false"
  4931. static="false" final="false" visibility="public"
  4932. deprecated="not deprecated">
  4933. <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4934. </method>
  4935. <method name="toString" return="java.lang.String"
  4936. abstract="false" native="false" synchronized="false"
  4937. static="false" final="false" visibility="public"
  4938. deprecated="not deprecated">
  4939. </method>
  4940. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4941. abstract="false" native="false" synchronized="false"
  4942. static="true" final="false" visibility="public"
  4943. deprecated="not deprecated">
  4944. <param name="appIdStr" type="java.lang.String"/>
  4945. </method>
  4946. <method name="hashCode" return="int"
  4947. abstract="false" native="false" synchronized="false"
  4948. static="false" final="false" visibility="public"
  4949. deprecated="not deprecated">
  4950. </method>
  4951. <method name="equals" return="boolean"
  4952. abstract="false" native="false" synchronized="false"
  4953. static="false" final="false" visibility="public"
  4954. deprecated="not deprecated">
  4955. <param name="obj" type="java.lang.Object"/>
  4956. </method>
  4957. <field name="appIdStrPrefix" type="java.lang.String"
  4958. transient="false" volatile="false"
  4959. static="true" final="true" visibility="public"
  4960. deprecated="not deprecated">
  4961. </field>
  4962. <doc>
  4963. <![CDATA[<p><code>ApplicationId</code> represents the <em>globally unique</em>
  4964. identifier for an application.</p>
  4965. <p>The globally unique nature of the identifier is achieved by using the
  4966. <em>cluster timestamp</em> i.e. start-time of the
  4967. <code>ResourceManager</code> along with a monotonically increasing counter
  4968. for the application.</p>]]>
  4969. </doc>
  4970. </class>
  4971. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationId -->
  4972. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationReport -->
  4973. <class name="ApplicationReport" extends="java.lang.Object"
  4974. abstract="true"
  4975. static="false" final="false" visibility="public"
  4976. deprecated="not deprecated">
  4977. <constructor name="ApplicationReport"
  4978. static="false" final="false" visibility="public"
  4979. deprecated="not deprecated">
  4980. </constructor>
  4981. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4982. abstract="true" native="false" synchronized="false"
  4983. static="false" final="false" visibility="public"
  4984. deprecated="not deprecated">
  4985. <doc>
  4986. <![CDATA[Get the <code>ApplicationId</code> of the application.
  4987. @return <code>ApplicationId</code> of the application]]>
  4988. </doc>
  4989. </method>
  4990. <method name="getCurrentApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  4991. abstract="true" native="false" synchronized="false"
  4992. static="false" final="false" visibility="public"
  4993. deprecated="not deprecated">
  4994. <doc>
  4995. <![CDATA[Get the <code>ApplicationAttemptId</code> of the current
  4996. attempt of the application
  4997. @return <code>ApplicationAttemptId</code> of the attempt]]>
  4998. </doc>
  4999. </method>
  5000. <method name="getUser" return="java.lang.String"
  5001. abstract="true" native="false" synchronized="false"
  5002. static="false" final="false" visibility="public"
  5003. deprecated="not deprecated">
  5004. <doc>
  5005. <![CDATA[Get the <em>user</em> who submitted the application.
  5006. @return <em>user</em> who submitted the application]]>
  5007. </doc>
  5008. </method>
  5009. <method name="getQueue" return="java.lang.String"
  5010. abstract="true" native="false" synchronized="false"
  5011. static="false" final="false" visibility="public"
  5012. deprecated="not deprecated">
  5013. <doc>
  5014. <![CDATA[Get the <em>queue</em> to which the application was submitted.
  5015. @return <em>queue</em> to which the application was submitted]]>
  5016. </doc>
  5017. </method>
  5018. <method name="getName" return="java.lang.String"
  5019. abstract="true" native="false" synchronized="false"
  5020. static="false" final="false" visibility="public"
  5021. deprecated="not deprecated">
  5022. <doc>
  5023. <![CDATA[Get the user-defined <em>name</em> of the application.
  5024. @return <em>name</em> of the application]]>
  5025. </doc>
  5026. </method>
  5027. <method name="getHost" return="java.lang.String"
  5028. abstract="true" native="false" synchronized="false"
  5029. static="false" final="false" visibility="public"
  5030. deprecated="not deprecated">
  5031. <doc>
  5032. <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code>
  5033. is running.
  5034. @return <em>host</em> on which the <code>ApplicationMaster</code>
  5035. is running]]>
  5036. </doc>
  5037. </method>
  5038. <method name="getRpcPort" return="int"
  5039. abstract="true" native="false" synchronized="false"
  5040. static="false" final="false" visibility="public"
  5041. deprecated="not deprecated">
  5042. <doc>
  5043. <![CDATA[Get the <em>RPC port</em> of the <code>ApplicationMaster</code>.
  5044. @return <em>RPC port</em> of the <code>ApplicationMaster</code>]]>
  5045. </doc>
  5046. </method>
  5047. <method name="getClientToAMToken" return="org.apache.hadoop.yarn.api.records.Token"
  5048. abstract="true" native="false" synchronized="false"
  5049. static="false" final="false" visibility="public"
  5050. deprecated="not deprecated">
  5051. <doc>
  5052. <![CDATA[Get the <em>client token</em> for communicating with the
  5053. <code>ApplicationMaster</code>.
  5054. <p>
  5055. <em>ClientToAMToken</em> is the security token used by the AMs to verify
  5056. authenticity of any <code>client</code>.
  5057. </p>
  5058. <p>
  5059. The <code>ResourceManager</code>, provides a secure token (via
  5060. {@link ApplicationReport#getClientToAMToken()}) which is verified by the
  5061. ApplicationMaster when the client directly talks to an AM.
  5062. </p>
  5063. @return <em>client token</em> for communicating with the
  5064. <code>ApplicationMaster</code>]]>
  5065. </doc>
  5066. </method>
  5067. <method name="getYarnApplicationState" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
  5068. abstract="true" native="false" synchronized="false"
  5069. static="false" final="false" visibility="public"
  5070. deprecated="not deprecated">
  5071. <doc>
  5072. <![CDATA[Get the <code>YarnApplicationState</code> of the application.
  5073. @return <code>YarnApplicationState</code> of the application]]>
  5074. </doc>
  5075. </method>
  5076. <method name="getDiagnostics" return="java.lang.String"
  5077. abstract="true" native="false" synchronized="false"
  5078. static="false" final="false" visibility="public"
  5079. deprecated="not deprecated">
  5080. <doc>
  5081. <![CDATA[Get the <em>diagnositic information</em> of the application in case of
  5082. errors.
  5083. @return <em>diagnositic information</em> of the application in case
  5084. of errors]]>
  5085. </doc>
  5086. </method>
  5087. <method name="getTrackingUrl" return="java.lang.String"
  5088. abstract="true" native="false" synchronized="false"
  5089. static="false" final="false" visibility="public"
  5090. deprecated="not deprecated">
  5091. <doc>
  5092. <![CDATA[Get the <em>tracking url</em> for the application.
  5093. @return <em>tracking url</em> for the application]]>
  5094. </doc>
  5095. </method>
  5096. <method name="getStartTime" return="long"
  5097. abstract="true" native="false" synchronized="false"
  5098. static="false" final="false" visibility="public"
  5099. deprecated="not deprecated">
  5100. <doc>
  5101. <![CDATA[Get the <em>start time</em> of the application.
  5102. @return <em>start time</em> of the application]]>
  5103. </doc>
  5104. </method>
  5105. <method name="getFinishTime" return="long"
  5106. abstract="true" native="false" synchronized="false"
  5107. static="false" final="false" visibility="public"
  5108. deprecated="not deprecated">
  5109. <doc>
  5110. <![CDATA[Get the <em>finish time</em> of the application.
  5111. @return <em>finish time</em> of the application]]>
  5112. </doc>
  5113. </method>
  5114. <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  5115. abstract="true" native="false" synchronized="false"
  5116. static="false" final="false" visibility="public"
  5117. deprecated="not deprecated">
  5118. <doc>
  5119. <![CDATA[Get the <em>final finish status</em> of the application.
  5120. @return <em>final finish status</em> of the application]]>
  5121. </doc>
  5122. </method>
  5123. <method name="getApplicationResourceUsageReport" return="org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport"
  5124. abstract="true" native="false" synchronized="false"
  5125. static="false" final="false" visibility="public"
  5126. deprecated="not deprecated">
  5127. <doc>
  5128. <![CDATA[Retrieve the structure containing the job resources for this application
  5129. @return the job resources structure for this application]]>
  5130. </doc>
  5131. </method>
  5132. <method name="getProgress" return="float"
  5133. abstract="true" native="false" synchronized="false"
  5134. static="false" final="false" visibility="public"
  5135. deprecated="not deprecated">
  5136. <doc>
  5137. <![CDATA[Get the application's progress ( range 0.0 to 1.0 )
  5138. @return application's progress]]>
  5139. </doc>
  5140. </method>
  5141. <method name="getApplicationType" return="java.lang.String"
  5142. abstract="true" native="false" synchronized="false"
  5143. static="false" final="false" visibility="public"
  5144. deprecated="not deprecated">
  5145. <doc>
  5146. <![CDATA[Get the application's Type
  5147. @return application's Type]]>
  5148. </doc>
  5149. </method>
  5150. <method name="getApplicationTags" return="java.util.Set"
  5151. abstract="true" native="false" synchronized="false"
  5152. static="false" final="false" visibility="public"
  5153. deprecated="not deprecated">
  5154. <doc>
  5155. <![CDATA[Get all tags corresponding to the application
  5156. @return Application's tags]]>
  5157. </doc>
  5158. </method>
  5159. <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
  5160. abstract="true" native="false" synchronized="false"
  5161. static="false" final="false" visibility="public"
  5162. deprecated="not deprecated">
  5163. <doc>
  5164. <![CDATA[Get the AMRM token of the application.
  5165. <p>
  5166. The AMRM token is required for AM to RM scheduling operations. For
  5167. managed Application Masters Yarn takes care of injecting it. For unmanaged
  5168. Applications Masters, the token must be obtained via this method and set
  5169. in the {@link org.apache.hadoop.security.UserGroupInformation} of the
  5170. current user.
  5171. <p>
  5172. The AMRM token will be returned only if all the following conditions are
  5173. met:
  5174. <ul>
  5175. <li>the requester is the owner of the ApplicationMaster</li>
  5176. <li>the application master is an unmanaged ApplicationMaster</li>
  5177. <li>the application master is in ACCEPTED state</li>
  5178. </ul>
  5179. Else this method returns NULL.
  5180. @return the AM to RM token if available.]]>
  5181. </doc>
  5182. </method>
  5183. <method name="getLogAggregationStatus" return="org.apache.hadoop.yarn.api.records.LogAggregationStatus"
  5184. abstract="true" native="false" synchronized="false"
  5185. static="false" final="false" visibility="public"
  5186. deprecated="not deprecated">
  5187. <doc>
  5188. <![CDATA[Get log aggregation status for the application
  5189. @return Application's log aggregation status]]>
  5190. </doc>
  5191. </method>
  5192. <method name="isUnmanagedApp" return="boolean"
  5193. abstract="true" native="false" synchronized="false"
  5194. static="false" final="false" visibility="public"
  5195. deprecated="not deprecated">
  5196. <doc>
  5197. <![CDATA[@return true if the AM is not managed by the RM]]>
  5198. </doc>
  5199. </method>
  5200. <method name="setUnmanagedApp"
  5201. abstract="true" native="false" synchronized="false"
  5202. static="false" final="false" visibility="public"
  5203. deprecated="not deprecated">
  5204. <param name="unmanagedApplication" type="boolean"/>
  5205. <doc>
  5206. <![CDATA[@param unmanagedApplication true if RM should not manage the AM]]>
  5207. </doc>
  5208. </method>
  5209. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  5210. abstract="true" native="false" synchronized="false"
  5211. static="false" final="false" visibility="public"
  5212. deprecated="not deprecated">
  5213. <doc>
  5214. <![CDATA[Get priority of the application
  5215. @return Application's priority]]>
  5216. </doc>
  5217. </method>
  5218. <method name="getAppNodeLabelExpression" return="java.lang.String"
  5219. abstract="true" native="false" synchronized="false"
  5220. static="false" final="false" visibility="public"
  5221. deprecated="not deprecated">
  5222. <doc>
  5223. <![CDATA[Get the default Node Label expression for all the application's containers
  5224. @return Application's NodeLabelExpression]]>
  5225. </doc>
  5226. </method>
  5227. <method name="setAppNodeLabelExpression"
  5228. abstract="true" native="false" synchronized="false"
  5229. static="false" final="false" visibility="public"
  5230. deprecated="not deprecated">
  5231. <param name="appNodeLabelExpression" type="java.lang.String"/>
  5232. </method>
  5233. <method name="getAmNodeLabelExpression" return="java.lang.String"
  5234. abstract="true" native="false" synchronized="false"
  5235. static="false" final="false" visibility="public"
  5236. deprecated="not deprecated">
  5237. <doc>
  5238. <![CDATA[Get the default Node Label expression for all the application's containers
  5239. @return Application's NodeLabelExpression]]>
  5240. </doc>
  5241. </method>
  5242. <method name="setAmNodeLabelExpression"
  5243. abstract="true" native="false" synchronized="false"
  5244. static="false" final="false" visibility="public"
  5245. deprecated="not deprecated">
  5246. <param name="amNodeLabelExpression" type="java.lang.String"/>
  5247. </method>
  5248. <doc>
  5249. <![CDATA[{@code ApplicationReport} is a report of an application.
  5250. <p>
  5251. It includes details such as:
  5252. <ul>
  5253. <li>{@link ApplicationId} of the application.</li>
  5254. <li>Applications user.</li>
  5255. <li>Application queue.</li>
  5256. <li>Application name.</li>
  5257. <li>Host on which the <code>ApplicationMaster</code> is running.</li>
  5258. <li>RPC port of the <code>ApplicationMaster</code>.</li>
  5259. <li>Tracking URL.</li>
  5260. <li>{@link YarnApplicationState} of the application.</li>
  5261. <li>Diagnostic information in case of errors.</li>
  5262. <li>Start time of the application.</li>
  5263. <li>Client {@link Token} of the application (if security is enabled).</li>
  5264. </ul>
  5265. @see ApplicationClientProtocol#getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest)]]>
  5266. </doc>
  5267. </class>
  5268. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationReport -->
  5269. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
  5270. <class name="ApplicationResourceUsageReport" extends="java.lang.Object"
  5271. abstract="true"
  5272. static="false" final="false" visibility="public"
  5273. deprecated="not deprecated">
  5274. <constructor name="ApplicationResourceUsageReport"
  5275. static="false" final="false" visibility="public"
  5276. deprecated="not deprecated">
  5277. </constructor>
  5278. <method name="getNumUsedContainers" return="int"
  5279. abstract="true" native="false" synchronized="false"
  5280. static="false" final="false" visibility="public"
  5281. deprecated="not deprecated">
  5282. <doc>
  5283. <![CDATA[Get the number of used containers. -1 for invalid/inaccessible reports.
  5284. @return the number of used containers]]>
  5285. </doc>
  5286. </method>
  5287. <method name="getUsedResources" return="org.apache.hadoop.yarn.api.records.Resource"
  5288. abstract="true" native="false" synchronized="false"
  5289. static="false" final="false" visibility="public"
  5290. deprecated="not deprecated">
  5291. <doc>
  5292. <![CDATA[Get the used <code>Resource</code>. -1 for invalid/inaccessible reports.
  5293. @return the used <code>Resource</code>]]>
  5294. </doc>
  5295. </method>
  5296. <method name="getReservedResources" return="org.apache.hadoop.yarn.api.records.Resource"
  5297. abstract="true" native="false" synchronized="false"
  5298. static="false" final="false" visibility="public"
  5299. deprecated="not deprecated">
  5300. <doc>
  5301. <![CDATA[Get the reserved <code>Resource</code>. -1 for invalid/inaccessible reports.
  5302. @return the reserved <code>Resource</code>]]>
  5303. </doc>
  5304. </method>
  5305. <method name="getNeededResources" return="org.apache.hadoop.yarn.api.records.Resource"
  5306. abstract="true" native="false" synchronized="false"
  5307. static="false" final="false" visibility="public"
  5308. deprecated="not deprecated">
  5309. <doc>
  5310. <![CDATA[Get the needed <code>Resource</code>. -1 for invalid/inaccessible reports.
  5311. @return the needed <code>Resource</code>]]>
  5312. </doc>
  5313. </method>
  5314. <method name="getMemorySeconds" return="long"
  5315. abstract="true" native="false" synchronized="false"
  5316. static="false" final="false" visibility="public"
  5317. deprecated="not deprecated">
  5318. <doc>
  5319. <![CDATA[Get the aggregated amount of memory (in megabytes) the application has
  5320. allocated times the number of seconds the application has been running.
  5321. @return the aggregated amount of memory seconds]]>
  5322. </doc>
  5323. </method>
  5324. <method name="getVcoreSeconds" return="long"
  5325. abstract="true" native="false" synchronized="false"
  5326. static="false" final="false" visibility="public"
  5327. deprecated="not deprecated">
  5328. <doc>
  5329. <![CDATA[Get the aggregated number of vcores that the application has allocated
  5330. times the number of seconds the application has been running.
  5331. @return the aggregated number of vcore seconds]]>
  5332. </doc>
  5333. </method>
  5334. <method name="getQueueUsagePercentage" return="float"
  5335. abstract="true" native="false" synchronized="false"
  5336. static="false" final="false" visibility="public"
  5337. deprecated="not deprecated">
  5338. <doc>
  5339. <![CDATA[Get the percentage of resources of the queue that the app is using.
  5340. @return the percentage of resources of the queue that the app is using.]]>
  5341. </doc>
  5342. </method>
  5343. <method name="getClusterUsagePercentage" return="float"
  5344. abstract="true" native="false" synchronized="false"
  5345. static="false" final="false" visibility="public"
  5346. deprecated="not deprecated">
  5347. <doc>
  5348. <![CDATA[Get the percentage of resources of the cluster that the app is using.
  5349. @return the percentage of resources of the cluster that the app is using.]]>
  5350. </doc>
  5351. </method>
  5352. <method name="getPreemptedMemorySeconds" return="long"
  5353. abstract="true" native="false" synchronized="false"
  5354. static="false" final="false" visibility="public"
  5355. deprecated="not deprecated">
  5356. <doc>
  5357. <![CDATA[Get the aggregated amount of memory preempted(in megabytes)
  5358. the application has allocated times the number of
  5359. seconds the application has been running.
  5360. @return the aggregated amount of memory seconds]]>
  5361. </doc>
  5362. </method>
  5363. <method name="getPreemptedVcoreSeconds" return="long"
  5364. abstract="true" native="false" synchronized="false"
  5365. static="false" final="false" visibility="public"
  5366. deprecated="not deprecated">
  5367. <doc>
  5368. <![CDATA[Get the aggregated number of vcores preempted that the application has
  5369. allocated times the number of seconds the application has been running.
  5370. @return the aggregated number of vcore seconds]]>
  5371. </doc>
  5372. </method>
  5373. <doc>
  5374. <![CDATA[Contains various scheduling metrics to be reported by UI and CLI.]]>
  5375. </doc>
  5376. </class>
  5377. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
  5378. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
  5379. <class name="ApplicationSubmissionContext" extends="java.lang.Object"
  5380. abstract="true"
  5381. static="false" final="false" visibility="public"
  5382. deprecated="not deprecated">
  5383. <constructor name="ApplicationSubmissionContext"
  5384. static="false" final="false" visibility="public"
  5385. deprecated="not deprecated">
  5386. </constructor>
  5387. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  5388. abstract="false" native="false" synchronized="false"
  5389. static="true" final="false" visibility="public"
  5390. deprecated="not deprecated">
  5391. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5392. <param name="applicationName" type="java.lang.String"/>
  5393. <param name="queue" type="java.lang.String"/>
  5394. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5395. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  5396. <param name="isUnmanagedAM" type="boolean"/>
  5397. <param name="cancelTokensWhenComplete" type="boolean"/>
  5398. <param name="maxAppAttempts" type="int"/>
  5399. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5400. <param name="applicationType" type="java.lang.String"/>
  5401. <param name="keepContainers" type="boolean"/>
  5402. <param name="appLabelExpression" type="java.lang.String"/>
  5403. <param name="amContainerLabelExpression" type="java.lang.String"/>
  5404. </method>
  5405. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  5406. abstract="false" native="false" synchronized="false"
  5407. static="true" final="false" visibility="public"
  5408. deprecated="not deprecated">
  5409. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5410. <param name="applicationName" type="java.lang.String"/>
  5411. <param name="queue" type="java.lang.String"/>
  5412. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5413. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  5414. <param name="isUnmanagedAM" type="boolean"/>
  5415. <param name="cancelTokensWhenComplete" type="boolean"/>
  5416. <param name="maxAppAttempts" type="int"/>
  5417. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5418. <param name="applicationType" type="java.lang.String"/>
  5419. <param name="keepContainers" type="boolean"/>
  5420. </method>
  5421. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  5422. abstract="false" native="false" synchronized="false"
  5423. static="true" final="false" visibility="public"
  5424. deprecated="not deprecated">
  5425. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5426. <param name="applicationName" type="java.lang.String"/>
  5427. <param name="queue" type="java.lang.String"/>
  5428. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5429. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  5430. <param name="isUnmanagedAM" type="boolean"/>
  5431. <param name="cancelTokensWhenComplete" type="boolean"/>
  5432. <param name="maxAppAttempts" type="int"/>
  5433. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5434. <param name="applicationType" type="java.lang.String"/>
  5435. </method>
  5436. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  5437. abstract="false" native="false" synchronized="false"
  5438. static="true" final="false" visibility="public"
  5439. deprecated="not deprecated">
  5440. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5441. <param name="applicationName" type="java.lang.String"/>
  5442. <param name="queue" type="java.lang.String"/>
  5443. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5444. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  5445. <param name="isUnmanagedAM" type="boolean"/>
  5446. <param name="cancelTokensWhenComplete" type="boolean"/>
  5447. <param name="maxAppAttempts" type="int"/>
  5448. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5449. </method>
  5450. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  5451. abstract="false" native="false" synchronized="false"
  5452. static="true" final="false" visibility="public"
  5453. deprecated="not deprecated">
  5454. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5455. <param name="applicationName" type="java.lang.String"/>
  5456. <param name="queue" type="java.lang.String"/>
  5457. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  5458. <param name="isUnmanagedAM" type="boolean"/>
  5459. <param name="cancelTokensWhenComplete" type="boolean"/>
  5460. <param name="maxAppAttempts" type="int"/>
  5461. <param name="applicationType" type="java.lang.String"/>
  5462. <param name="keepContainers" type="boolean"/>
  5463. <param name="appLabelExpression" type="java.lang.String"/>
  5464. <param name="resourceRequest" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  5465. </method>
  5466. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  5467. abstract="false" native="false" synchronized="false"
  5468. static="true" final="false" visibility="public"
  5469. deprecated="not deprecated">
  5470. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5471. <param name="applicationName" type="java.lang.String"/>
  5472. <param name="queue" type="java.lang.String"/>
  5473. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5474. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  5475. <param name="isUnmanagedAM" type="boolean"/>
  5476. <param name="cancelTokensWhenComplete" type="boolean"/>
  5477. <param name="maxAppAttempts" type="int"/>
  5478. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5479. <param name="applicationType" type="java.lang.String"/>
  5480. <param name="keepContainers" type="boolean"/>
  5481. <param name="attemptFailuresValidityInterval" type="long"/>
  5482. </method>
  5483. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  5484. abstract="false" native="false" synchronized="false"
  5485. static="true" final="false" visibility="public"
  5486. deprecated="not deprecated">
  5487. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5488. <param name="applicationName" type="java.lang.String"/>
  5489. <param name="queue" type="java.lang.String"/>
  5490. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5491. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  5492. <param name="isUnmanagedAM" type="boolean"/>
  5493. <param name="cancelTokensWhenComplete" type="boolean"/>
  5494. <param name="maxAppAttempts" type="int"/>
  5495. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5496. <param name="applicationType" type="java.lang.String"/>
  5497. <param name="keepContainers" type="boolean"/>
  5498. <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
  5499. </method>
  5500. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5501. abstract="true" native="false" synchronized="false"
  5502. static="false" final="false" visibility="public"
  5503. deprecated="not deprecated">
  5504. <doc>
  5505. <![CDATA[Get the <code>ApplicationId</code> of the submitted application.
  5506. @return <code>ApplicationId</code> of the submitted application]]>
  5507. </doc>
  5508. </method>
  5509. <method name="setApplicationId"
  5510. abstract="true" native="false" synchronized="false"
  5511. static="false" final="false" visibility="public"
  5512. deprecated="not deprecated">
  5513. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5514. <doc>
  5515. <![CDATA[Set the <code>ApplicationId</code> of the submitted application.
  5516. @param applicationId <code>ApplicationId</code> of the submitted
  5517. application]]>
  5518. </doc>
  5519. </method>
  5520. <method name="getApplicationName" return="java.lang.String"
  5521. abstract="true" native="false" synchronized="false"
  5522. static="false" final="false" visibility="public"
  5523. deprecated="not deprecated">
  5524. <doc>
  5525. <![CDATA[Get the application <em>name</em>.
  5526. @return application name]]>
  5527. </doc>
  5528. </method>
  5529. <method name="setApplicationName"
  5530. abstract="true" native="false" synchronized="false"
  5531. static="false" final="false" visibility="public"
  5532. deprecated="not deprecated">
  5533. <param name="applicationName" type="java.lang.String"/>
  5534. <doc>
  5535. <![CDATA[Set the application <em>name</em>.
  5536. @param applicationName application name]]>
  5537. </doc>
  5538. </method>
  5539. <method name="getQueue" return="java.lang.String"
  5540. abstract="true" native="false" synchronized="false"
  5541. static="false" final="false" visibility="public"
  5542. deprecated="not deprecated">
  5543. <doc>
  5544. <![CDATA[Get the <em>queue</em> to which the application is being submitted.
  5545. @return <em>queue</em> to which the application is being submitted]]>
  5546. </doc>
  5547. </method>
  5548. <method name="setQueue"
  5549. abstract="true" native="false" synchronized="false"
  5550. static="false" final="false" visibility="public"
  5551. deprecated="not deprecated">
  5552. <param name="queue" type="java.lang.String"/>
  5553. <doc>
  5554. <![CDATA[Set the <em>queue</em> to which the application is being submitted
  5555. @param queue <em>queue</em> to which the application is being submitted]]>
  5556. </doc>
  5557. </method>
  5558. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  5559. abstract="true" native="false" synchronized="false"
  5560. static="false" final="false" visibility="public"
  5561. deprecated="not deprecated">
  5562. <doc>
  5563. <![CDATA[Get the <code>Priority</code> of the application.
  5564. @return <code>Priority</code> of the application]]>
  5565. </doc>
  5566. </method>
  5567. <method name="getAMContainerSpec" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  5568. abstract="true" native="false" synchronized="false"
  5569. static="false" final="false" visibility="public"
  5570. deprecated="not deprecated">
  5571. <doc>
  5572. <![CDATA[Get the <code>ContainerLaunchContext</code> to describe the
  5573. <code>Container</code> with which the <code>ApplicationMaster</code> is
  5574. launched.
  5575. @return <code>ContainerLaunchContext</code> for the
  5576. <code>ApplicationMaster</code> container]]>
  5577. </doc>
  5578. </method>
  5579. <method name="setAMContainerSpec"
  5580. abstract="true" native="false" synchronized="false"
  5581. static="false" final="false" visibility="public"
  5582. deprecated="not deprecated">
  5583. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  5584. <doc>
  5585. <![CDATA[Set the <code>ContainerLaunchContext</code> to describe the
  5586. <code>Container</code> with which the <code>ApplicationMaster</code> is
  5587. launched.
  5588. @param amContainer <code>ContainerLaunchContext</code> for the
  5589. <code>ApplicationMaster</code> container]]>
  5590. </doc>
  5591. </method>
  5592. <method name="getUnmanagedAM" return="boolean"
  5593. abstract="true" native="false" synchronized="false"
  5594. static="false" final="false" visibility="public"
  5595. deprecated="not deprecated">
  5596. <doc>
  5597. <![CDATA[Get if the RM should manage the execution of the AM.
  5598. If true, then the RM
  5599. will not allocate a container for the AM and start it. It will expect the
  5600. AM to be launched and connect to the RM within the AM liveliness period and
  5601. fail the app otherwise. The client should launch the AM only after the RM
  5602. has ACCEPTED the application and changed the <code>YarnApplicationState</code>.
  5603. Such apps will not be retried by the RM on app attempt failure.
  5604. The default value is false.
  5605. @return true if the AM is not managed by the RM]]>
  5606. </doc>
  5607. </method>
  5608. <method name="setUnmanagedAM"
  5609. abstract="true" native="false" synchronized="false"
  5610. static="false" final="false" visibility="public"
  5611. deprecated="not deprecated">
  5612. <param name="value" type="boolean"/>
  5613. <doc>
  5614. <![CDATA[@param value true if RM should not manage the AM]]>
  5615. </doc>
  5616. </method>
  5617. <method name="getMaxAppAttempts" return="int"
  5618. abstract="true" native="false" synchronized="false"
  5619. static="false" final="false" visibility="public"
  5620. deprecated="not deprecated">
  5621. <doc>
  5622. <![CDATA[@return the number of max attempts of the application to be submitted]]>
  5623. </doc>
  5624. </method>
  5625. <method name="setMaxAppAttempts"
  5626. abstract="true" native="false" synchronized="false"
  5627. static="false" final="false" visibility="public"
  5628. deprecated="not deprecated">
  5629. <param name="maxAppAttempts" type="int"/>
  5630. <doc>
  5631. <![CDATA[Set the number of max attempts of the application to be submitted. WARNING:
  5632. it should be no larger than the global number of max attempts in the Yarn
  5633. configuration.
  5634. @param maxAppAttempts the number of max attempts of the application
  5635. to be submitted.]]>
  5636. </doc>
  5637. </method>
  5638. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  5639. abstract="true" native="false" synchronized="false"
  5640. static="false" final="false" visibility="public"
  5641. deprecated="not deprecated">
  5642. <doc>
  5643. <![CDATA[Get the resource required by the <code>ApplicationMaster</code> for this
  5644. application. Please note this will be DEPRECATED, use <em>getResource</em>
  5645. in <em>getAMContainerResourceRequest</em> instead.
  5646. @return the resource required by the <code>ApplicationMaster</code> for
  5647. this application.]]>
  5648. </doc>
  5649. </method>
  5650. <method name="setResource"
  5651. abstract="true" native="false" synchronized="false"
  5652. static="false" final="false" visibility="public"
  5653. deprecated="not deprecated">
  5654. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5655. <doc>
  5656. <![CDATA[Set the resource required by the <code>ApplicationMaster</code> for this
  5657. application.
  5658. @param resource the resource required by the <code>ApplicationMaster</code>
  5659. for this application.]]>
  5660. </doc>
  5661. </method>
  5662. <method name="getApplicationType" return="java.lang.String"
  5663. abstract="true" native="false" synchronized="false"
  5664. static="false" final="false" visibility="public"
  5665. deprecated="not deprecated">
  5666. <doc>
  5667. <![CDATA[Get the application type
  5668. @return the application type]]>
  5669. </doc>
  5670. </method>
  5671. <method name="setApplicationType"
  5672. abstract="true" native="false" synchronized="false"
  5673. static="false" final="false" visibility="public"
  5674. deprecated="not deprecated">
  5675. <param name="applicationType" type="java.lang.String"/>
  5676. <doc>
  5677. <![CDATA[Set the application type
  5678. @param applicationType the application type]]>
  5679. </doc>
  5680. </method>
  5681. <method name="getKeepContainersAcrossApplicationAttempts" return="boolean"
  5682. abstract="true" native="false" synchronized="false"
  5683. static="false" final="false" visibility="public"
  5684. deprecated="not deprecated">
  5685. <doc>
  5686. <![CDATA[Get the flag which indicates whether to keep containers across application
  5687. attempts or not.
  5688. @return the flag which indicates whether to keep containers across
  5689. application attempts or not.]]>
  5690. </doc>
  5691. </method>
  5692. <method name="setKeepContainersAcrossApplicationAttempts"
  5693. abstract="true" native="false" synchronized="false"
  5694. static="false" final="false" visibility="public"
  5695. deprecated="not deprecated">
  5696. <param name="keepContainers" type="boolean"/>
  5697. <doc>
  5698. <![CDATA[Set the flag which indicates whether to keep containers across application
  5699. attempts.
  5700. <p>
  5701. If the flag is true, running containers will not be killed when application
  5702. attempt fails and these containers will be retrieved by the new application
  5703. attempt on registration via
  5704. {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}.
  5705. </p>
  5706. @param keepContainers
  5707. the flag which indicates whether to keep containers across
  5708. application attempts.]]>
  5709. </doc>
  5710. </method>
  5711. <method name="getApplicationTags" return="java.util.Set"
  5712. abstract="true" native="false" synchronized="false"
  5713. static="false" final="false" visibility="public"
  5714. deprecated="not deprecated">
  5715. <doc>
  5716. <![CDATA[Get tags for the application
  5717. @return the application tags]]>
  5718. </doc>
  5719. </method>
  5720. <method name="setApplicationTags"
  5721. abstract="true" native="false" synchronized="false"
  5722. static="false" final="false" visibility="public"
  5723. deprecated="not deprecated">
  5724. <param name="tags" type="java.util.Set"/>
  5725. <doc>
  5726. <![CDATA[Set tags for the application. A maximum of
  5727. {@link YarnConfiguration#APPLICATION_MAX_TAGS} are allowed
  5728. per application. Each tag can be at most
  5729. {@link YarnConfiguration#APPLICATION_MAX_TAG_LENGTH}
  5730. characters, and can contain only ASCII characters.
  5731. @param tags tags to set]]>
  5732. </doc>
  5733. </method>
  5734. <method name="getNodeLabelExpression" return="java.lang.String"
  5735. abstract="true" native="false" synchronized="false"
  5736. static="false" final="false" visibility="public"
  5737. deprecated="not deprecated">
  5738. <doc>
  5739. <![CDATA[Get node-label-expression for this app. If this is set, all containers of
  5740. this application without setting node-label-expression in ResurceRequest
  5741. will get allocated resources on only those nodes that satisfy this
  5742. node-label-expression.
  5743. If different node-label-expression of this app and ResourceRequest are set
  5744. at the same time, the one set in ResourceRequest will be used when
  5745. allocating container
  5746. @return node-label-expression for this app]]>
  5747. </doc>
  5748. </method>
  5749. <method name="setNodeLabelExpression"
  5750. abstract="true" native="false" synchronized="false"
  5751. static="false" final="false" visibility="public"
  5752. deprecated="not deprecated">
  5753. <param name="nodeLabelExpression" type="java.lang.String"/>
  5754. <doc>
  5755. <![CDATA[Set node-label-expression for this app
  5756. @param nodeLabelExpression node-label-expression of this app]]>
  5757. </doc>
  5758. </method>
  5759. <method name="getAMContainerResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  5760. abstract="true" native="false" synchronized="false"
  5761. static="false" final="false" visibility="public"
  5762. deprecated="not deprecated">
  5763. <doc>
  5764. <![CDATA[Get ResourceRequest of AM container, if this is not null, scheduler will
  5765. use this to acquire resource for AM container.
  5766. If this is null, scheduler will assemble a ResourceRequest by using
  5767. <em>getResource</em> and <em>getPriority</em> of
  5768. <em>ApplicationSubmissionContext</em>.
  5769. Number of containers and Priority will be ignore.
  5770. @return ResourceRequest of AM container]]>
  5771. </doc>
  5772. </method>
  5773. <method name="setAMContainerResourceRequest"
  5774. abstract="true" native="false" synchronized="false"
  5775. static="false" final="false" visibility="public"
  5776. deprecated="not deprecated">
  5777. <param name="request" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  5778. <doc>
  5779. <![CDATA[Set ResourceRequest of AM container
  5780. @param request of AM container]]>
  5781. </doc>
  5782. </method>
  5783. <method name="getAttemptFailuresValidityInterval" return="long"
  5784. abstract="true" native="false" synchronized="false"
  5785. static="false" final="false" visibility="public"
  5786. deprecated="not deprecated">
  5787. <doc>
  5788. <![CDATA[Get the attemptFailuresValidityInterval in milliseconds for the application
  5789. @return the attemptFailuresValidityInterval]]>
  5790. </doc>
  5791. </method>
  5792. <method name="setAttemptFailuresValidityInterval"
  5793. abstract="true" native="false" synchronized="false"
  5794. static="false" final="false" visibility="public"
  5795. deprecated="not deprecated">
  5796. <param name="attemptFailuresValidityInterval" type="long"/>
  5797. <doc>
  5798. <![CDATA[Set the attemptFailuresValidityInterval in milliseconds for the application
  5799. @param attemptFailuresValidityInterval]]>
  5800. </doc>
  5801. </method>
  5802. <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  5803. abstract="true" native="false" synchronized="false"
  5804. static="false" final="false" visibility="public"
  5805. deprecated="not deprecated">
  5806. <doc>
  5807. <![CDATA[Get <code>LogAggregationContext</code> of the application
  5808. @return <code>LogAggregationContext</code> of the application]]>
  5809. </doc>
  5810. </method>
  5811. <method name="setLogAggregationContext"
  5812. abstract="true" native="false" synchronized="false"
  5813. static="false" final="false" visibility="public"
  5814. deprecated="not deprecated">
  5815. <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
  5816. <doc>
  5817. <![CDATA[Set <code>LogAggregationContext</code> for the application
  5818. @param logAggregationContext
  5819. for the application]]>
  5820. </doc>
  5821. </method>
  5822. <method name="getReservationID" return="org.apache.hadoop.yarn.api.records.ReservationId"
  5823. abstract="true" native="false" synchronized="false"
  5824. static="false" final="false" visibility="public"
  5825. deprecated="not deprecated">
  5826. <doc>
  5827. <![CDATA[Get the reservation id, that corresponds to a valid resource allocation in
  5828. the scheduler (between start and end time of the corresponding reservation)
  5829. @return the reservation id representing the unique id of the corresponding
  5830. reserved resource allocation in the scheduler]]>
  5831. </doc>
  5832. </method>
  5833. <method name="setReservationID"
  5834. abstract="true" native="false" synchronized="false"
  5835. static="false" final="false" visibility="public"
  5836. deprecated="not deprecated">
  5837. <param name="reservationID" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  5838. <doc>
  5839. <![CDATA[Set the reservation id, that correspond to a valid resource allocation in
  5840. the scheduler (between start and end time of the corresponding reservation)
  5841. @param reservationID representing the unique id of the
  5842. corresponding reserved resource allocation in the scheduler]]>
  5843. </doc>
  5844. </method>
  5845. <doc>
  5846. <![CDATA[{@code ApplicationSubmissionContext} represents all of the
  5847. information needed by the {@code ResourceManager} to launch
  5848. the {@code ApplicationMaster} for an application.
  5849. <p>
  5850. It includes details such as:
  5851. <ul>
  5852. <li>{@link ApplicationId} of the application.</li>
  5853. <li>Application user.</li>
  5854. <li>Application name.</li>
  5855. <li>{@link Priority} of the application.</li>
  5856. <li>
  5857. {@link ContainerLaunchContext} of the container in which the
  5858. <code>ApplicationMaster</code> is executed.
  5859. </li>
  5860. <li>
  5861. maxAppAttempts. The maximum number of application attempts.
  5862. It should be no larger than the global number of max attempts in the
  5863. Yarn configuration.
  5864. </li>
  5865. <li>
  5866. attemptFailuresValidityInterval. The default value is -1.
  5867. when attemptFailuresValidityInterval in milliseconds is set to
  5868. {@literal >} 0, the failure number will no take failures which happen
  5869. out of the validityInterval into failure count. If failure count
  5870. reaches to maxAppAttempts, the application will be failed.
  5871. </li>
  5872. <li>Optional, application-specific {@link LogAggregationContext}</li>
  5873. </ul>
  5874. @see ContainerLaunchContext
  5875. @see ApplicationClientProtocol#submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest)]]>
  5876. </doc>
  5877. </class>
  5878. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
  5879. <!-- start class org.apache.hadoop.yarn.api.records.Container -->
  5880. <class name="Container" extends="java.lang.Object"
  5881. abstract="true"
  5882. static="false" final="false" visibility="public"
  5883. deprecated="not deprecated">
  5884. <implements name="java.lang.Comparable"/>
  5885. <constructor name="Container"
  5886. static="false" final="false" visibility="public"
  5887. deprecated="not deprecated">
  5888. </constructor>
  5889. <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5890. abstract="true" native="false" synchronized="false"
  5891. static="false" final="false" visibility="public"
  5892. deprecated="not deprecated">
  5893. <doc>
  5894. <![CDATA[Get the globally unique identifier for the container.
  5895. @return globally unique identifier for the container]]>
  5896. </doc>
  5897. </method>
  5898. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  5899. abstract="true" native="false" synchronized="false"
  5900. static="false" final="false" visibility="public"
  5901. deprecated="not deprecated">
  5902. <doc>
  5903. <![CDATA[Get the identifier of the node on which the container is allocated.
  5904. @return identifier of the node on which the container is allocated]]>
  5905. </doc>
  5906. </method>
  5907. <method name="getNodeHttpAddress" return="java.lang.String"
  5908. abstract="true" native="false" synchronized="false"
  5909. static="false" final="false" visibility="public"
  5910. deprecated="not deprecated">
  5911. <doc>
  5912. <![CDATA[Get the http uri of the node on which the container is allocated.
  5913. @return http uri of the node on which the container is allocated]]>
  5914. </doc>
  5915. </method>
  5916. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  5917. abstract="true" native="false" synchronized="false"
  5918. static="false" final="false" visibility="public"
  5919. deprecated="not deprecated">
  5920. <doc>
  5921. <![CDATA[Get the <code>Resource</code> allocated to the container.
  5922. @return <code>Resource</code> allocated to the container]]>
  5923. </doc>
  5924. </method>
  5925. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  5926. abstract="true" native="false" synchronized="false"
  5927. static="false" final="false" visibility="public"
  5928. deprecated="not deprecated">
  5929. <doc>
  5930. <![CDATA[Get the <code>Priority</code> at which the <code>Container</code> was
  5931. allocated.
  5932. @return <code>Priority</code> at which the <code>Container</code> was
  5933. allocated]]>
  5934. </doc>
  5935. </method>
  5936. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  5937. abstract="true" native="false" synchronized="false"
  5938. static="false" final="false" visibility="public"
  5939. deprecated="not deprecated">
  5940. <doc>
  5941. <![CDATA[Get the <code>ContainerToken</code> for the container.
  5942. <p><code>ContainerToken</code> is the security token used by the framework
  5943. to verify authenticity of any <code>Container</code>.</p>
  5944. <p>The <code>ResourceManager</code>, on container allocation provides a
  5945. secure token which is verified by the <code>NodeManager</code> on
  5946. container launch.</p>
  5947. <p>Applications do not need to care about <code>ContainerToken</code>, they
  5948. are transparently handled by the framework - the allocated
  5949. <code>Container</code> includes the <code>ContainerToken</code>.</p>
  5950. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
  5951. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
  5952. @return <code>ContainerToken</code> for the container]]>
  5953. </doc>
  5954. </method>
  5955. <doc>
  5956. <![CDATA[{@code Container} represents an allocated resource in the cluster.
  5957. <p>
  5958. The {@code ResourceManager} is the sole authority to allocate any
  5959. {@code Container} to applications. The allocated {@code Container}
  5960. is always on a single node and has a unique {@link ContainerId}. It has
  5961. a specific amount of {@link Resource} allocated.
  5962. <p>
  5963. It includes details such as:
  5964. <ul>
  5965. <li>{@link ContainerId} for the container, which is globally unique.</li>
  5966. <li>
  5967. {@link NodeId} of the node on which it is allocated.
  5968. </li>
  5969. <li>HTTP uri of the node.</li>
  5970. <li>{@link Resource} allocated to the container.</li>
  5971. <li>{@link Priority} at which the container was allocated.</li>
  5972. <li>
  5973. Container {@link Token} of the container, used to securely verify
  5974. authenticity of the allocation.
  5975. </li>
  5976. </ul>
  5977. Typically, an {@code ApplicationMaster} receives the {@code Container}
  5978. from the {@code ResourceManager} during resource-negotiation and then
  5979. talks to the {@code NodeManager} to start/stop containers.
  5980. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
  5981. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
  5982. @see ContainerManagementProtocol#stopContainers(org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest)]]>
  5983. </doc>
  5984. </class>
  5985. <!-- end class org.apache.hadoop.yarn.api.records.Container -->
  5986. <!-- start class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
  5987. <class name="ContainerExitStatus" extends="java.lang.Object"
  5988. abstract="false"
  5989. static="false" final="false" visibility="public"
  5990. deprecated="not deprecated">
  5991. <constructor name="ContainerExitStatus"
  5992. static="false" final="false" visibility="public"
  5993. deprecated="not deprecated">
  5994. </constructor>
  5995. <field name="SUCCESS" type="int"
  5996. transient="false" volatile="false"
  5997. static="true" final="true" visibility="public"
  5998. deprecated="not deprecated">
  5999. </field>
  6000. <field name="INVALID" type="int"
  6001. transient="false" volatile="false"
  6002. static="true" final="true" visibility="public"
  6003. deprecated="not deprecated">
  6004. </field>
  6005. <field name="ABORTED" type="int"
  6006. transient="false" volatile="false"
  6007. static="true" final="true" visibility="public"
  6008. deprecated="not deprecated">
  6009. <doc>
  6010. <![CDATA[Containers killed by the framework, either due to being released by
  6011. the application or being 'lost' due to node failures etc.]]>
  6012. </doc>
  6013. </field>
  6014. <field name="DISKS_FAILED" type="int"
  6015. transient="false" volatile="false"
  6016. static="true" final="true" visibility="public"
  6017. deprecated="not deprecated">
  6018. <doc>
  6019. <![CDATA[When threshold number of the nodemanager-local-directories or
  6020. threshold number of the nodemanager-log-directories become bad.]]>
  6021. </doc>
  6022. </field>
  6023. <field name="PREEMPTED" type="int"
  6024. transient="false" volatile="false"
  6025. static="true" final="true" visibility="public"
  6026. deprecated="not deprecated">
  6027. <doc>
  6028. <![CDATA[Containers preempted by the framework.]]>
  6029. </doc>
  6030. </field>
  6031. <field name="KILLED_EXCEEDED_VMEM" type="int"
  6032. transient="false" volatile="false"
  6033. static="true" final="true" visibility="public"
  6034. deprecated="not deprecated">
  6035. <doc>
  6036. <![CDATA[Container terminated because of exceeding allocated virtual memory.]]>
  6037. </doc>
  6038. </field>
  6039. <field name="KILLED_EXCEEDED_PMEM" type="int"
  6040. transient="false" volatile="false"
  6041. static="true" final="true" visibility="public"
  6042. deprecated="not deprecated">
  6043. <doc>
  6044. <![CDATA[Container terminated because of exceeding allocated physical memory.]]>
  6045. </doc>
  6046. </field>
  6047. <field name="KILLED_BY_APPMASTER" type="int"
  6048. transient="false" volatile="false"
  6049. static="true" final="true" visibility="public"
  6050. deprecated="not deprecated">
  6051. <doc>
  6052. <![CDATA[Container was terminated by stop request by the app master.]]>
  6053. </doc>
  6054. </field>
  6055. <field name="KILLED_BY_RESOURCEMANAGER" type="int"
  6056. transient="false" volatile="false"
  6057. static="true" final="true" visibility="public"
  6058. deprecated="not deprecated">
  6059. <doc>
  6060. <![CDATA[Container was terminated by the resource manager.]]>
  6061. </doc>
  6062. </field>
  6063. <field name="KILLED_AFTER_APP_COMPLETION" type="int"
  6064. transient="false" volatile="false"
  6065. static="true" final="true" visibility="public"
  6066. deprecated="not deprecated">
  6067. <doc>
  6068. <![CDATA[Container was terminated after the application finished.]]>
  6069. </doc>
  6070. </field>
  6071. <doc>
  6072. <![CDATA[Container exit statuses indicating special exit circumstances.]]>
  6073. </doc>
  6074. </class>
  6075. <!-- end class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
  6076. <!-- start class org.apache.hadoop.yarn.api.records.ContainerId -->
  6077. <class name="ContainerId" extends="java.lang.Object"
  6078. abstract="true"
  6079. static="false" final="false" visibility="public"
  6080. deprecated="not deprecated">
  6081. <implements name="java.lang.Comparable"/>
  6082. <constructor name="ContainerId"
  6083. static="false" final="false" visibility="public"
  6084. deprecated="not deprecated">
  6085. </constructor>
  6086. <method name="newContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  6087. abstract="false" native="false" synchronized="false"
  6088. static="true" final="false" visibility="public"
  6089. deprecated="not deprecated">
  6090. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  6091. <param name="containerId" type="long"/>
  6092. </method>
  6093. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  6094. abstract="true" native="false" synchronized="false"
  6095. static="false" final="false" visibility="public"
  6096. deprecated="not deprecated">
  6097. <doc>
  6098. <![CDATA[Get the <code>ApplicationAttemptId</code> of the application to which the
  6099. <code>Container</code> was assigned.
  6100. <p>
  6101. Note: If containers are kept alive across application attempts via
  6102. {@link ApplicationSubmissionContext#setKeepContainersAcrossApplicationAttempts(boolean)}
  6103. the <code>ContainerId</code> does not necessarily contain the current
  6104. running application attempt's <code>ApplicationAttemptId</code> This
  6105. container can be allocated by previously exited application attempt and
  6106. managed by the current running attempt thus have the previous application
  6107. attempt's <code>ApplicationAttemptId</code>.
  6108. </p>
  6109. @return <code>ApplicationAttemptId</code> of the application to which the
  6110. <code>Container</code> was assigned]]>
  6111. </doc>
  6112. </method>
  6113. <method name="getId" return="int"
  6114. abstract="true" native="false" synchronized="false"
  6115. static="false" final="false" visibility="public"
  6116. deprecated="not deprecated">
  6117. <doc>
  6118. <![CDATA[Get the lower 32 bits of identifier of the <code>ContainerId</code>,
  6119. which doesn't include epoch. Note that this method will be marked as
  6120. deprecated, so please use <code>getContainerId</code> instead.
  6121. @return lower 32 bits of identifier of the <code>ContainerId</code>]]>
  6122. </doc>
  6123. </method>
  6124. <method name="getContainerId" return="long"
  6125. abstract="true" native="false" synchronized="false"
  6126. static="false" final="false" visibility="public"
  6127. deprecated="not deprecated">
  6128. <doc>
  6129. <![CDATA[Get the identifier of the <code>ContainerId</code>. Upper 24 bits are
  6130. reserved as epoch of cluster, and lower 40 bits are reserved as
  6131. sequential number of containers.
  6132. @return identifier of the <code>ContainerId</code>]]>
  6133. </doc>
  6134. </method>
  6135. <method name="hashCode" return="int"
  6136. abstract="false" native="false" synchronized="false"
  6137. static="false" final="false" visibility="public"
  6138. deprecated="not deprecated">
  6139. </method>
  6140. <method name="equals" return="boolean"
  6141. abstract="false" native="false" synchronized="false"
  6142. static="false" final="false" visibility="public"
  6143. deprecated="not deprecated">
  6144. <param name="obj" type="java.lang.Object"/>
  6145. </method>
  6146. <method name="compareTo" return="int"
  6147. abstract="false" native="false" synchronized="false"
  6148. static="false" final="false" visibility="public"
  6149. deprecated="not deprecated">
  6150. <param name="other" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  6151. </method>
  6152. <method name="toString" return="java.lang.String"
  6153. abstract="false" native="false" synchronized="false"
  6154. static="false" final="false" visibility="public"
  6155. deprecated="not deprecated">
  6156. <doc>
  6157. <![CDATA[@return A string representation of containerId. The format is
  6158. container_e*epoch*_*clusterTimestamp*_*appId*_*attemptId*_*containerId*
  6159. when epoch is larger than 0
  6160. (e.g. container_e17_1410901177871_0001_01_000005).
  6161. *epoch* is increased when RM restarts or fails over.
  6162. When epoch is 0, epoch is omitted
  6163. (e.g. container_1410901177871_0001_01_000005).]]>
  6164. </doc>
  6165. </method>
  6166. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ContainerId"
  6167. abstract="false" native="false" synchronized="false"
  6168. static="true" final="false" visibility="public"
  6169. deprecated="not deprecated">
  6170. <param name="containerIdStr" type="java.lang.String"/>
  6171. </method>
  6172. <method name="build"
  6173. abstract="true" native="false" synchronized="false"
  6174. static="false" final="false" visibility="protected"
  6175. deprecated="not deprecated">
  6176. </method>
  6177. <field name="CONTAINER_ID_BITMASK" type="long"
  6178. transient="false" volatile="false"
  6179. static="true" final="true" visibility="public"
  6180. deprecated="not deprecated">
  6181. </field>
  6182. <doc>
  6183. <![CDATA[<p><code>ContainerId</code> represents a globally unique identifier
  6184. for a {@link Container} in the cluster.</p>]]>
  6185. </doc>
  6186. </class>
  6187. <!-- end class org.apache.hadoop.yarn.api.records.ContainerId -->
  6188. <!-- start class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
  6189. <class name="ContainerLaunchContext" extends="java.lang.Object"
  6190. abstract="true"
  6191. static="false" final="false" visibility="public"
  6192. deprecated="not deprecated">
  6193. <constructor name="ContainerLaunchContext"
  6194. static="false" final="false" visibility="public"
  6195. deprecated="not deprecated">
  6196. </constructor>
  6197. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  6198. abstract="false" native="false" synchronized="false"
  6199. static="true" final="false" visibility="public"
  6200. deprecated="not deprecated">
  6201. <param name="localResources" type="java.util.Map"/>
  6202. <param name="environment" type="java.util.Map"/>
  6203. <param name="commands" type="java.util.List"/>
  6204. <param name="serviceData" type="java.util.Map"/>
  6205. <param name="tokens" type="java.nio.ByteBuffer"/>
  6206. <param name="acls" type="java.util.Map"/>
  6207. </method>
  6208. <method name="getTokens" return="java.nio.ByteBuffer"
  6209. abstract="true" native="false" synchronized="false"
  6210. static="false" final="false" visibility="public"
  6211. deprecated="not deprecated">
  6212. <doc>
  6213. <![CDATA[Get all the tokens needed by this container. It may include file-system
  6214. tokens, ApplicationMaster related tokens if this container is an
  6215. ApplicationMaster or framework level tokens needed by this container to
  6216. communicate to various services in a secure manner.
  6217. @return tokens needed by this container.]]>
  6218. </doc>
  6219. </method>
  6220. <method name="setTokens"
  6221. abstract="true" native="false" synchronized="false"
  6222. static="false" final="false" visibility="public"
  6223. deprecated="not deprecated">
  6224. <param name="tokens" type="java.nio.ByteBuffer"/>
  6225. <doc>
  6226. <![CDATA[Set security tokens needed by this container.
  6227. @param tokens security tokens]]>
  6228. </doc>
  6229. </method>
  6230. <method name="getLocalResources" return="java.util.Map"
  6231. abstract="true" native="false" synchronized="false"
  6232. static="false" final="false" visibility="public"
  6233. deprecated="not deprecated">
  6234. <doc>
  6235. <![CDATA[Get <code>LocalResource</code> required by the container.
  6236. @return all <code>LocalResource</code> required by the container]]>
  6237. </doc>
  6238. </method>
  6239. <method name="setLocalResources"
  6240. abstract="true" native="false" synchronized="false"
  6241. static="false" final="false" visibility="public"
  6242. deprecated="not deprecated">
  6243. <param name="localResources" type="java.util.Map"/>
  6244. <doc>
  6245. <![CDATA[Set <code>LocalResource</code> required by the container. All pre-existing
  6246. Map entries are cleared before adding the new Map
  6247. @param localResources <code>LocalResource</code> required by the container]]>
  6248. </doc>
  6249. </method>
  6250. <method name="getServiceData" return="java.util.Map"
  6251. abstract="true" native="false" synchronized="false"
  6252. static="false" final="false" visibility="public"
  6253. deprecated="not deprecated">
  6254. <doc>
  6255. <![CDATA[<p>
  6256. Get application-specific binary <em>service data</em>. This is a map keyed
  6257. by the name of each {@link AuxiliaryService} that is configured on a
  6258. NodeManager and value correspond to the application specific data targeted
  6259. for the keyed {@link AuxiliaryService}.
  6260. </p>
  6261. <p>
  6262. This will be used to initialize this application on the specific
  6263. {@link AuxiliaryService} running on the NodeManager by calling
  6264. {@link AuxiliaryService#initializeApplication(ApplicationInitializationContext)}
  6265. </p>
  6266. @return application-specific binary <em>service data</em>]]>
  6267. </doc>
  6268. </method>
  6269. <method name="setServiceData"
  6270. abstract="true" native="false" synchronized="false"
  6271. static="false" final="false" visibility="public"
  6272. deprecated="not deprecated">
  6273. <param name="serviceData" type="java.util.Map"/>
  6274. <doc>
  6275. <![CDATA[<p>
  6276. Set application-specific binary <em>service data</em>. This is a map keyed
  6277. by the name of each {@link AuxiliaryService} that is configured on a
  6278. NodeManager and value correspond to the application specific data targeted
  6279. for the keyed {@link AuxiliaryService}. All pre-existing Map entries are
  6280. preserved.
  6281. </p>
  6282. @param serviceData
  6283. application-specific binary <em>service data</em>]]>
  6284. </doc>
  6285. </method>
  6286. <method name="getEnvironment" return="java.util.Map"
  6287. abstract="true" native="false" synchronized="false"
  6288. static="false" final="false" visibility="public"
  6289. deprecated="not deprecated">
  6290. <doc>
  6291. <![CDATA[Get <em>environment variables</em> for the container.
  6292. @return <em>environment variables</em> for the container]]>
  6293. </doc>
  6294. </method>
  6295. <method name="setEnvironment"
  6296. abstract="true" native="false" synchronized="false"
  6297. static="false" final="false" visibility="public"
  6298. deprecated="not deprecated">
  6299. <param name="environment" type="java.util.Map"/>
  6300. <doc>
  6301. <![CDATA[Add <em>environment variables</em> for the container. All pre-existing Map
  6302. entries are cleared before adding the new Map
  6303. @param environment <em>environment variables</em> for the container]]>
  6304. </doc>
  6305. </method>
  6306. <method name="getCommands" return="java.util.List"
  6307. abstract="true" native="false" synchronized="false"
  6308. static="false" final="false" visibility="public"
  6309. deprecated="not deprecated">
  6310. <doc>
  6311. <![CDATA[Get the list of <em>commands</em> for launching the container.
  6312. @return the list of <em>commands</em> for launching the container]]>
  6313. </doc>
  6314. </method>
  6315. <method name="setCommands"
  6316. abstract="true" native="false" synchronized="false"
  6317. static="false" final="false" visibility="public"
  6318. deprecated="not deprecated">
  6319. <param name="commands" type="java.util.List"/>
  6320. <doc>
  6321. <![CDATA[Add the list of <em>commands</em> for launching the container. All
  6322. pre-existing List entries are cleared before adding the new List
  6323. @param commands the list of <em>commands</em> for launching the container]]>
  6324. </doc>
  6325. </method>
  6326. <method name="getApplicationACLs" return="java.util.Map"
  6327. abstract="true" native="false" synchronized="false"
  6328. static="false" final="false" visibility="public"
  6329. deprecated="not deprecated">
  6330. <doc>
  6331. <![CDATA[Get the <code>ApplicationACL</code>s for the application.
  6332. @return all the <code>ApplicationACL</code>s]]>
  6333. </doc>
  6334. </method>
  6335. <method name="setApplicationACLs"
  6336. abstract="true" native="false" synchronized="false"
  6337. static="false" final="false" visibility="public"
  6338. deprecated="not deprecated">
  6339. <param name="acls" type="java.util.Map"/>
  6340. <doc>
  6341. <![CDATA[Set the <code>ApplicationACL</code>s for the application. All pre-existing
  6342. Map entries are cleared before adding the new Map
  6343. @param acls <code>ApplicationACL</code>s for the application]]>
  6344. </doc>
  6345. </method>
  6346. <doc>
  6347. <![CDATA[{@code ContainerLaunchContext} represents all of the information
  6348. needed by the {@code NodeManager} to launch a container.
  6349. <p>
  6350. It includes details such as:
  6351. <ul>
  6352. <li>{@link ContainerId} of the container.</li>
  6353. <li>{@link Resource} allocated to the container.</li>
  6354. <li>User to whom the container is allocated.</li>
  6355. <li>Security tokens (if security is enabled).</li>
  6356. <li>
  6357. {@link LocalResource} necessary for running the container such
  6358. as binaries, jar, shared-objects, side-files etc.
  6359. </li>
  6360. <li>Optional, application-specific binary service data.</li>
  6361. <li>Environment variables for the launched process.</li>
  6362. <li>Command to launch the container.</li>
  6363. </ul>
  6364. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  6365. </doc>
  6366. </class>
  6367. <!-- end class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
  6368. <!-- start class org.apache.hadoop.yarn.api.records.ContainerReport -->
  6369. <class name="ContainerReport" extends="java.lang.Object"
  6370. abstract="true"
  6371. static="false" final="false" visibility="public"
  6372. deprecated="not deprecated">
  6373. <constructor name="ContainerReport"
  6374. static="false" final="false" visibility="public"
  6375. deprecated="not deprecated">
  6376. </constructor>
  6377. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  6378. abstract="true" native="false" synchronized="false"
  6379. static="false" final="false" visibility="public"
  6380. deprecated="not deprecated">
  6381. <doc>
  6382. <![CDATA[Get the <code>ContainerId</code> of the container.
  6383. @return <code>ContainerId</code> of the container.]]>
  6384. </doc>
  6385. </method>
  6386. <method name="setContainerId"
  6387. abstract="true" native="false" synchronized="false"
  6388. static="false" final="false" visibility="public"
  6389. deprecated="not deprecated">
  6390. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  6391. </method>
  6392. <method name="getAllocatedResource" return="org.apache.hadoop.yarn.api.records.Resource"
  6393. abstract="true" native="false" synchronized="false"
  6394. static="false" final="false" visibility="public"
  6395. deprecated="not deprecated">
  6396. <doc>
  6397. <![CDATA[Get the allocated <code>Resource</code> of the container.
  6398. @return allocated <code>Resource</code> of the container.]]>
  6399. </doc>
  6400. </method>
  6401. <method name="setAllocatedResource"
  6402. abstract="true" native="false" synchronized="false"
  6403. static="false" final="false" visibility="public"
  6404. deprecated="not deprecated">
  6405. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6406. </method>
  6407. <method name="getAssignedNode" return="org.apache.hadoop.yarn.api.records.NodeId"
  6408. abstract="true" native="false" synchronized="false"
  6409. static="false" final="false" visibility="public"
  6410. deprecated="not deprecated">
  6411. <doc>
  6412. <![CDATA[Get the allocated <code>NodeId</code> where container is running.
  6413. @return allocated <code>NodeId</code> where container is running.]]>
  6414. </doc>
  6415. </method>
  6416. <method name="setAssignedNode"
  6417. abstract="true" native="false" synchronized="false"
  6418. static="false" final="false" visibility="public"
  6419. deprecated="not deprecated">
  6420. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  6421. </method>
  6422. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  6423. abstract="true" native="false" synchronized="false"
  6424. static="false" final="false" visibility="public"
  6425. deprecated="not deprecated">
  6426. <doc>
  6427. <![CDATA[Get the allocated <code>Priority</code> of the container.
  6428. @return allocated <code>Priority</code> of the container.]]>
  6429. </doc>
  6430. </method>
  6431. <method name="setPriority"
  6432. abstract="true" native="false" synchronized="false"
  6433. static="false" final="false" visibility="public"
  6434. deprecated="not deprecated">
  6435. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6436. </method>
  6437. <method name="getCreationTime" return="long"
  6438. abstract="true" native="false" synchronized="false"
  6439. static="false" final="false" visibility="public"
  6440. deprecated="not deprecated">
  6441. <doc>
  6442. <![CDATA[Get the creation time of the container.
  6443. @return creation time of the container]]>
  6444. </doc>
  6445. </method>
  6446. <method name="setCreationTime"
  6447. abstract="true" native="false" synchronized="false"
  6448. static="false" final="false" visibility="public"
  6449. deprecated="not deprecated">
  6450. <param name="creationTime" type="long"/>
  6451. </method>
  6452. <method name="getFinishTime" return="long"
  6453. abstract="true" native="false" synchronized="false"
  6454. static="false" final="false" visibility="public"
  6455. deprecated="not deprecated">
  6456. <doc>
  6457. <![CDATA[Get the Finish time of the container.
  6458. @return Finish time of the container]]>
  6459. </doc>
  6460. </method>
  6461. <method name="setFinishTime"
  6462. abstract="true" native="false" synchronized="false"
  6463. static="false" final="false" visibility="public"
  6464. deprecated="not deprecated">
  6465. <param name="finishTime" type="long"/>
  6466. </method>
  6467. <method name="getDiagnosticsInfo" return="java.lang.String"
  6468. abstract="true" native="false" synchronized="false"
  6469. static="false" final="false" visibility="public"
  6470. deprecated="not deprecated">
  6471. <doc>
  6472. <![CDATA[Get the DiagnosticsInfo of the container.
  6473. @return DiagnosticsInfo of the container]]>
  6474. </doc>
  6475. </method>
  6476. <method name="setDiagnosticsInfo"
  6477. abstract="true" native="false" synchronized="false"
  6478. static="false" final="false" visibility="public"
  6479. deprecated="not deprecated">
  6480. <param name="diagnosticsInfo" type="java.lang.String"/>
  6481. </method>
  6482. <method name="getLogUrl" return="java.lang.String"
  6483. abstract="true" native="false" synchronized="false"
  6484. static="false" final="false" visibility="public"
  6485. deprecated="not deprecated">
  6486. <doc>
  6487. <![CDATA[Get the LogURL of the container.
  6488. @return LogURL of the container]]>
  6489. </doc>
  6490. </method>
  6491. <method name="setLogUrl"
  6492. abstract="true" native="false" synchronized="false"
  6493. static="false" final="false" visibility="public"
  6494. deprecated="not deprecated">
  6495. <param name="logUrl" type="java.lang.String"/>
  6496. </method>
  6497. <method name="getContainerState" return="org.apache.hadoop.yarn.api.records.ContainerState"
  6498. abstract="true" native="false" synchronized="false"
  6499. static="false" final="false" visibility="public"
  6500. deprecated="not deprecated">
  6501. <doc>
  6502. <![CDATA[Get the final <code>ContainerState</code> of the container.
  6503. @return final <code>ContainerState</code> of the container.]]>
  6504. </doc>
  6505. </method>
  6506. <method name="setContainerState"
  6507. abstract="true" native="false" synchronized="false"
  6508. static="false" final="false" visibility="public"
  6509. deprecated="not deprecated">
  6510. <param name="containerState" type="org.apache.hadoop.yarn.api.records.ContainerState"/>
  6511. </method>
  6512. <method name="getContainerExitStatus" return="int"
  6513. abstract="true" native="false" synchronized="false"
  6514. static="false" final="false" visibility="public"
  6515. deprecated="not deprecated">
  6516. <doc>
  6517. <![CDATA[Get the final <code>exit status</code> of the container.
  6518. @return final <code>exit status</code> of the container.]]>
  6519. </doc>
  6520. </method>
  6521. <method name="setContainerExitStatus"
  6522. abstract="true" native="false" synchronized="false"
  6523. static="false" final="false" visibility="public"
  6524. deprecated="not deprecated">
  6525. <param name="containerExitStatus" type="int"/>
  6526. </method>
  6527. <method name="getNodeHttpAddress" return="java.lang.String"
  6528. abstract="true" native="false" synchronized="false"
  6529. static="false" final="false" visibility="public"
  6530. deprecated="not deprecated">
  6531. <doc>
  6532. <![CDATA[Get the Node Http address of the container
  6533. @return the node http address of the container]]>
  6534. </doc>
  6535. </method>
  6536. <doc>
  6537. <![CDATA[{@code ContainerReport} is a report of an container.
  6538. <p>
  6539. It includes details such as:
  6540. <ul>
  6541. <li>{@link ContainerId} of the container.</li>
  6542. <li>Allocated Resources to the container.</li>
  6543. <li>Assigned Node id.</li>
  6544. <li>Assigned Priority.</li>
  6545. <li>Creation Time.</li>
  6546. <li>Finish Time.</li>
  6547. <li>Container Exit Status.</li>
  6548. <li>{@link ContainerState} of the container.</li>
  6549. <li>Diagnostic information in case of errors.</li>
  6550. <li>Log URL.</li>
  6551. <li>nodeHttpAddress</li>
  6552. </ul>]]>
  6553. </doc>
  6554. </class>
  6555. <!-- end class org.apache.hadoop.yarn.api.records.ContainerReport -->
  6556. <!-- start class org.apache.hadoop.yarn.api.records.ContainerState -->
  6557. <class name="ContainerState" extends="java.lang.Enum"
  6558. abstract="false"
  6559. static="false" final="true" visibility="public"
  6560. deprecated="not deprecated">
  6561. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerState[]"
  6562. abstract="false" native="false" synchronized="false"
  6563. static="true" final="false" visibility="public"
  6564. deprecated="not deprecated">
  6565. </method>
  6566. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerState"
  6567. abstract="false" native="false" synchronized="false"
  6568. static="true" final="false" visibility="public"
  6569. deprecated="not deprecated">
  6570. <param name="name" type="java.lang.String"/>
  6571. </method>
  6572. <doc>
  6573. <![CDATA[<p>State of a <code>Container</code>.</p>]]>
  6574. </doc>
  6575. </class>
  6576. <!-- end class org.apache.hadoop.yarn.api.records.ContainerState -->
  6577. <!-- start class org.apache.hadoop.yarn.api.records.ContainerStatus -->
  6578. <class name="ContainerStatus" extends="java.lang.Object"
  6579. abstract="true"
  6580. static="false" final="false" visibility="public"
  6581. deprecated="not deprecated">
  6582. <constructor name="ContainerStatus"
  6583. static="false" final="false" visibility="public"
  6584. deprecated="not deprecated">
  6585. </constructor>
  6586. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  6587. abstract="true" native="false" synchronized="false"
  6588. static="false" final="false" visibility="public"
  6589. deprecated="not deprecated">
  6590. <doc>
  6591. <![CDATA[Get the <code>ContainerId</code> of the container.
  6592. @return <code>ContainerId</code> of the container]]>
  6593. </doc>
  6594. </method>
  6595. <method name="getState" return="org.apache.hadoop.yarn.api.records.ContainerState"
  6596. abstract="true" native="false" synchronized="false"
  6597. static="false" final="false" visibility="public"
  6598. deprecated="not deprecated">
  6599. <doc>
  6600. <![CDATA[Get the <code>ContainerState</code> of the container.
  6601. @return <code>ContainerState</code> of the container]]>
  6602. </doc>
  6603. </method>
  6604. <method name="getExitStatus" return="int"
  6605. abstract="true" native="false" synchronized="false"
  6606. static="false" final="false" visibility="public"
  6607. deprecated="not deprecated">
  6608. <doc>
  6609. <![CDATA[<p>Get the <em>exit status</em> for the container.</p>
  6610. <p>Note: This is valid only for completed containers i.e. containers
  6611. with state {@link ContainerState#COMPLETE}.
  6612. Otherwise, it returns an ContainerExitStatus.INVALID.
  6613. </p>
  6614. <p>Containers killed by the framework, either due to being released by
  6615. the application or being 'lost' due to node failures etc. have a special
  6616. exit code of ContainerExitStatus.ABORTED.</p>
  6617. <p>When threshold number of the nodemanager-local-directories or
  6618. threshold number of the nodemanager-log-directories become bad, then
  6619. container is not launched and is exited with ContainersExitStatus.DISKS_FAILED.
  6620. </p>
  6621. @return <em>exit status</em> for the container]]>
  6622. </doc>
  6623. </method>
  6624. <method name="getDiagnostics" return="java.lang.String"
  6625. abstract="true" native="false" synchronized="false"
  6626. static="false" final="false" visibility="public"
  6627. deprecated="not deprecated">
  6628. <doc>
  6629. <![CDATA[Get <em>diagnostic messages</em> for failed containers.
  6630. @return <em>diagnostic messages</em> for failed containers]]>
  6631. </doc>
  6632. </method>
  6633. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  6634. abstract="false" native="false" synchronized="false"
  6635. static="false" final="false" visibility="public"
  6636. deprecated="not deprecated">
  6637. <doc>
  6638. <![CDATA[Get the <code>Resource</code> allocated to the container.
  6639. @return <code>Resource</code> allocated to the container]]>
  6640. </doc>
  6641. </method>
  6642. <doc>
  6643. <![CDATA[{@code ContainerStatus} represents the current status of a
  6644. {@code Container}.
  6645. <p>
  6646. It provides details such as:
  6647. <ul>
  6648. <li>{@code ContainerId} of the container.</li>
  6649. <li>{@code ContainerState} of the container.</li>
  6650. <li><em>Exit status</em> of a completed container.</li>
  6651. <li><em>Diagnostic</em> message for a failed container.</li>
  6652. <li>{@link Resource} allocated to the container.</li>
  6653. </ul>]]>
  6654. </doc>
  6655. </class>
  6656. <!-- end class org.apache.hadoop.yarn.api.records.ContainerStatus -->
  6657. <!-- start class org.apache.hadoop.yarn.api.records.ContainerUpdateType -->
  6658. <class name="ContainerUpdateType" extends="java.lang.Enum"
  6659. abstract="false"
  6660. static="false" final="true" visibility="public"
  6661. deprecated="not deprecated">
  6662. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType[]"
  6663. abstract="false" native="false" synchronized="false"
  6664. static="true" final="false" visibility="public"
  6665. deprecated="not deprecated">
  6666. </method>
  6667. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType"
  6668. abstract="false" native="false" synchronized="false"
  6669. static="true" final="false" visibility="public"
  6670. deprecated="not deprecated">
  6671. <param name="name" type="java.lang.String"/>
  6672. </method>
  6673. <doc>
  6674. <![CDATA[Encodes the type of Container Update.]]>
  6675. </doc>
  6676. </class>
  6677. <!-- end class org.apache.hadoop.yarn.api.records.ContainerUpdateType -->
  6678. <!-- start class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
  6679. <class name="FinalApplicationStatus" extends="java.lang.Enum"
  6680. abstract="false"
  6681. static="false" final="true" visibility="public"
  6682. deprecated="not deprecated">
  6683. <method name="values" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus[]"
  6684. abstract="false" native="false" synchronized="false"
  6685. static="true" final="false" visibility="public"
  6686. deprecated="not deprecated">
  6687. </method>
  6688. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  6689. abstract="false" native="false" synchronized="false"
  6690. static="true" final="false" visibility="public"
  6691. deprecated="not deprecated">
  6692. <param name="name" type="java.lang.String"/>
  6693. </method>
  6694. <doc>
  6695. <![CDATA[Enumeration of various final states of an <code>Application</code>.]]>
  6696. </doc>
  6697. </class>
  6698. <!-- end class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
  6699. <!-- start class org.apache.hadoop.yarn.api.records.LocalResource -->
  6700. <class name="LocalResource" extends="java.lang.Object"
  6701. abstract="true"
  6702. static="false" final="false" visibility="public"
  6703. deprecated="not deprecated">
  6704. <constructor name="LocalResource"
  6705. static="false" final="false" visibility="public"
  6706. deprecated="not deprecated">
  6707. </constructor>
  6708. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  6709. abstract="false" native="false" synchronized="false"
  6710. static="true" final="false" visibility="public"
  6711. deprecated="not deprecated">
  6712. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  6713. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  6714. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  6715. <param name="size" type="long"/>
  6716. <param name="timestamp" type="long"/>
  6717. <param name="pattern" type="java.lang.String"/>
  6718. </method>
  6719. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  6720. abstract="false" native="false" synchronized="false"
  6721. static="true" final="false" visibility="public"
  6722. deprecated="not deprecated">
  6723. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  6724. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  6725. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  6726. <param name="size" type="long"/>
  6727. <param name="timestamp" type="long"/>
  6728. <param name="pattern" type="java.lang.String"/>
  6729. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  6730. </method>
  6731. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  6732. abstract="false" native="false" synchronized="false"
  6733. static="true" final="false" visibility="public"
  6734. deprecated="not deprecated">
  6735. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  6736. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  6737. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  6738. <param name="size" type="long"/>
  6739. <param name="timestamp" type="long"/>
  6740. </method>
  6741. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  6742. abstract="false" native="false" synchronized="false"
  6743. static="true" final="false" visibility="public"
  6744. deprecated="not deprecated">
  6745. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  6746. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  6747. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  6748. <param name="size" type="long"/>
  6749. <param name="timestamp" type="long"/>
  6750. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  6751. </method>
  6752. <method name="getResource" return="org.apache.hadoop.yarn.api.records.URL"
  6753. abstract="true" native="false" synchronized="false"
  6754. static="false" final="false" visibility="public"
  6755. deprecated="not deprecated">
  6756. <doc>
  6757. <![CDATA[Get the <em>location</em> of the resource to be localized.
  6758. @return <em>location</em> of the resource to be localized]]>
  6759. </doc>
  6760. </method>
  6761. <method name="setResource"
  6762. abstract="true" native="false" synchronized="false"
  6763. static="false" final="false" visibility="public"
  6764. deprecated="not deprecated">
  6765. <param name="resource" type="org.apache.hadoop.yarn.api.records.URL"/>
  6766. <doc>
  6767. <![CDATA[Set <em>location</em> of the resource to be localized.
  6768. @param resource <em>location</em> of the resource to be localized]]>
  6769. </doc>
  6770. </method>
  6771. <method name="getSize" return="long"
  6772. abstract="true" native="false" synchronized="false"
  6773. static="false" final="false" visibility="public"
  6774. deprecated="not deprecated">
  6775. <doc>
  6776. <![CDATA[Get the <em>size</em> of the resource to be localized.
  6777. @return <em>size</em> of the resource to be localized]]>
  6778. </doc>
  6779. </method>
  6780. <method name="setSize"
  6781. abstract="true" native="false" synchronized="false"
  6782. static="false" final="false" visibility="public"
  6783. deprecated="not deprecated">
  6784. <param name="size" type="long"/>
  6785. <doc>
  6786. <![CDATA[Set the <em>size</em> of the resource to be localized.
  6787. @param size <em>size</em> of the resource to be localized]]>
  6788. </doc>
  6789. </method>
  6790. <method name="getTimestamp" return="long"
  6791. abstract="true" native="false" synchronized="false"
  6792. static="false" final="false" visibility="public"
  6793. deprecated="not deprecated">
  6794. <doc>
  6795. <![CDATA[Get the original <em>timestamp</em> of the resource to be localized, used
  6796. for verification.
  6797. @return <em>timestamp</em> of the resource to be localized]]>
  6798. </doc>
  6799. </method>
  6800. <method name="setTimestamp"
  6801. abstract="true" native="false" synchronized="false"
  6802. static="false" final="false" visibility="public"
  6803. deprecated="not deprecated">
  6804. <param name="timestamp" type="long"/>
  6805. <doc>
  6806. <![CDATA[Set the <em>timestamp</em> of the resource to be localized, used
  6807. for verification.
  6808. @param timestamp <em>timestamp</em> of the resource to be localized]]>
  6809. </doc>
  6810. </method>
  6811. <method name="getType" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
  6812. abstract="true" native="false" synchronized="false"
  6813. static="false" final="false" visibility="public"
  6814. deprecated="not deprecated">
  6815. <doc>
  6816. <![CDATA[Get the <code>LocalResourceType</code> of the resource to be localized.
  6817. @return <code>LocalResourceType</code> of the resource to be localized]]>
  6818. </doc>
  6819. </method>
  6820. <method name="setType"
  6821. abstract="true" native="false" synchronized="false"
  6822. static="false" final="false" visibility="public"
  6823. deprecated="not deprecated">
  6824. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  6825. <doc>
  6826. <![CDATA[Set the <code>LocalResourceType</code> of the resource to be localized.
  6827. @param type <code>LocalResourceType</code> of the resource to be localized]]>
  6828. </doc>
  6829. </method>
  6830. <method name="getVisibility" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
  6831. abstract="true" native="false" synchronized="false"
  6832. static="false" final="false" visibility="public"
  6833. deprecated="not deprecated">
  6834. <doc>
  6835. <![CDATA[Get the <code>LocalResourceVisibility</code> of the resource to be
  6836. localized.
  6837. @return <code>LocalResourceVisibility</code> of the resource to be
  6838. localized]]>
  6839. </doc>
  6840. </method>
  6841. <method name="setVisibility"
  6842. abstract="true" native="false" synchronized="false"
  6843. static="false" final="false" visibility="public"
  6844. deprecated="not deprecated">
  6845. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  6846. <doc>
  6847. <![CDATA[Set the <code>LocalResourceVisibility</code> of the resource to be
  6848. localized.
  6849. @param visibility <code>LocalResourceVisibility</code> of the resource to be
  6850. localized]]>
  6851. </doc>
  6852. </method>
  6853. <method name="getPattern" return="java.lang.String"
  6854. abstract="true" native="false" synchronized="false"
  6855. static="false" final="false" visibility="public"
  6856. deprecated="not deprecated">
  6857. <doc>
  6858. <![CDATA[Get the <em>pattern</em> that should be used to extract entries from the
  6859. archive (only used when type is <code>PATTERN</code>).
  6860. @return <em>pattern</em> that should be used to extract entries from the
  6861. archive.]]>
  6862. </doc>
  6863. </method>
  6864. <method name="setPattern"
  6865. abstract="true" native="false" synchronized="false"
  6866. static="false" final="false" visibility="public"
  6867. deprecated="not deprecated">
  6868. <param name="pattern" type="java.lang.String"/>
  6869. <doc>
  6870. <![CDATA[Set the <em>pattern</em> that should be used to extract entries from the
  6871. archive (only used when type is <code>PATTERN</code>).
  6872. @param pattern <em>pattern</em> that should be used to extract entries
  6873. from the archive.]]>
  6874. </doc>
  6875. </method>
  6876. <method name="getShouldBeUploadedToSharedCache" return="boolean"
  6877. abstract="true" native="false" synchronized="false"
  6878. static="false" final="false" visibility="public"
  6879. deprecated="not deprecated">
  6880. <doc>
  6881. <![CDATA[NM uses it to decide whether if it is necessary to upload the resource to
  6882. the shared cache]]>
  6883. </doc>
  6884. </method>
  6885. <method name="setShouldBeUploadedToSharedCache"
  6886. abstract="true" native="false" synchronized="false"
  6887. static="false" final="false" visibility="public"
  6888. deprecated="not deprecated">
  6889. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  6890. <doc>
  6891. <![CDATA[Inform NM whether upload to SCM is needed.
  6892. @param shouldBeUploadedToSharedCache <em>shouldBeUploadedToSharedCache</em>
  6893. of this request]]>
  6894. </doc>
  6895. </method>
  6896. <doc>
  6897. <![CDATA[<p><code>LocalResource</code> represents a local resource required to
  6898. run a container.</p>
  6899. <p>The <code>NodeManager</code> is responsible for localizing the resource
  6900. prior to launching the container.</p>
  6901. <p>Applications can specify {@link LocalResourceType} and
  6902. {@link LocalResourceVisibility}.</p>
  6903. @see LocalResourceType
  6904. @see LocalResourceVisibility
  6905. @see ContainerLaunchContext
  6906. @see ApplicationSubmissionContext
  6907. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  6908. </doc>
  6909. </class>
  6910. <!-- end class org.apache.hadoop.yarn.api.records.LocalResource -->
  6911. <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceType -->
  6912. <class name="LocalResourceType" extends="java.lang.Enum"
  6913. abstract="false"
  6914. static="false" final="true" visibility="public"
  6915. deprecated="not deprecated">
  6916. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceType[]"
  6917. abstract="false" native="false" synchronized="false"
  6918. static="true" final="false" visibility="public"
  6919. deprecated="not deprecated">
  6920. </method>
  6921. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
  6922. abstract="false" native="false" synchronized="false"
  6923. static="true" final="false" visibility="public"
  6924. deprecated="not deprecated">
  6925. <param name="name" type="java.lang.String"/>
  6926. </method>
  6927. <doc>
  6928. <![CDATA[{@code LocalResourceType} specifies the <em>type</em>
  6929. of a resource localized by the {@code NodeManager}.
  6930. <p>
  6931. The <em>type</em> can be one of:
  6932. <ul>
  6933. <li>
  6934. {@link #FILE} - Regular file i.e. uninterpreted bytes.
  6935. </li>
  6936. <li>
  6937. {@link #ARCHIVE} - Archive, which is automatically unarchived by the
  6938. <code>NodeManager</code>.
  6939. </li>
  6940. <li>
  6941. {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}.
  6942. </li>
  6943. </ul>
  6944. @see LocalResource
  6945. @see ContainerLaunchContext
  6946. @see ApplicationSubmissionContext
  6947. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  6948. </doc>
  6949. </class>
  6950. <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceType -->
  6951. <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
  6952. <class name="LocalResourceVisibility" extends="java.lang.Enum"
  6953. abstract="false"
  6954. static="false" final="true" visibility="public"
  6955. deprecated="not deprecated">
  6956. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility[]"
  6957. abstract="false" native="false" synchronized="false"
  6958. static="true" final="false" visibility="public"
  6959. deprecated="not deprecated">
  6960. </method>
  6961. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
  6962. abstract="false" native="false" synchronized="false"
  6963. static="true" final="false" visibility="public"
  6964. deprecated="not deprecated">
  6965. <param name="name" type="java.lang.String"/>
  6966. </method>
  6967. <doc>
  6968. <![CDATA[{@code LocalResourceVisibility} specifies the <em>visibility</em>
  6969. of a resource localized by the {@code NodeManager}.
  6970. <p>
  6971. The <em>visibility</em> can be one of:
  6972. <ul>
  6973. <li>{@link #PUBLIC} - Shared by all users on the node.</li>
  6974. <li>
  6975. {@link #PRIVATE} - Shared among all applications of the
  6976. <em>same user</em> on the node.
  6977. </li>
  6978. <li>
  6979. {@link #APPLICATION} - Shared only among containers of the
  6980. <em>same application</em> on the node.
  6981. </li>
  6982. </ul>
  6983. @see LocalResource
  6984. @see ContainerLaunchContext
  6985. @see ApplicationSubmissionContext
  6986. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  6987. </doc>
  6988. </class>
  6989. <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
  6990. <!-- start class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
  6991. <class name="LogAggregationContext" extends="java.lang.Object"
  6992. abstract="true"
  6993. static="false" final="false" visibility="public"
  6994. deprecated="not deprecated">
  6995. <constructor name="LogAggregationContext"
  6996. static="false" final="false" visibility="public"
  6997. deprecated="not deprecated">
  6998. </constructor>
  6999. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  7000. abstract="false" native="false" synchronized="false"
  7001. static="true" final="false" visibility="public"
  7002. deprecated="not deprecated">
  7003. <param name="includePattern" type="java.lang.String"/>
  7004. <param name="excludePattern" type="java.lang.String"/>
  7005. </method>
  7006. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  7007. abstract="false" native="false" synchronized="false"
  7008. static="true" final="false" visibility="public"
  7009. deprecated="not deprecated">
  7010. <param name="includePattern" type="java.lang.String"/>
  7011. <param name="excludePattern" type="java.lang.String"/>
  7012. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  7013. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  7014. </method>
  7015. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  7016. abstract="false" native="false" synchronized="false"
  7017. static="true" final="false" visibility="public"
  7018. deprecated="not deprecated">
  7019. <param name="includePattern" type="java.lang.String"/>
  7020. <param name="excludePattern" type="java.lang.String"/>
  7021. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  7022. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  7023. <param name="policyClassName" type="java.lang.String"/>
  7024. <param name="policyParameters" type="java.lang.String"/>
  7025. </method>
  7026. <method name="getIncludePattern" return="java.lang.String"
  7027. abstract="true" native="false" synchronized="false"
  7028. static="false" final="false" visibility="public"
  7029. deprecated="not deprecated">
  7030. <doc>
  7031. <![CDATA[Get include pattern. This includePattern only takes affect
  7032. on logs that exist at the time of application finish.
  7033. @return include pattern]]>
  7034. </doc>
  7035. </method>
  7036. <method name="setIncludePattern"
  7037. abstract="true" native="false" synchronized="false"
  7038. static="false" final="false" visibility="public"
  7039. deprecated="not deprecated">
  7040. <param name="includePattern" type="java.lang.String"/>
  7041. <doc>
  7042. <![CDATA[Set include pattern. This includePattern only takes affect
  7043. on logs that exist at the time of application finish.
  7044. @param includePattern]]>
  7045. </doc>
  7046. </method>
  7047. <method name="getExcludePattern" return="java.lang.String"
  7048. abstract="true" native="false" synchronized="false"
  7049. static="false" final="false" visibility="public"
  7050. deprecated="not deprecated">
  7051. <doc>
  7052. <![CDATA[Get exclude pattern. This excludePattern only takes affect
  7053. on logs that exist at the time of application finish.
  7054. @return exclude pattern]]>
  7055. </doc>
  7056. </method>
  7057. <method name="setExcludePattern"
  7058. abstract="true" native="false" synchronized="false"
  7059. static="false" final="false" visibility="public"
  7060. deprecated="not deprecated">
  7061. <param name="excludePattern" type="java.lang.String"/>
  7062. <doc>
  7063. <![CDATA[Set exclude pattern. This excludePattern only takes affect
  7064. on logs that exist at the time of application finish.
  7065. @param excludePattern]]>
  7066. </doc>
  7067. </method>
  7068. <method name="getRolledLogsIncludePattern" return="java.lang.String"
  7069. abstract="true" native="false" synchronized="false"
  7070. static="false" final="false" visibility="public"
  7071. deprecated="not deprecated">
  7072. <doc>
  7073. <![CDATA[Get include pattern in a rolling fashion.
  7074. @return include pattern]]>
  7075. </doc>
  7076. </method>
  7077. <method name="setRolledLogsIncludePattern"
  7078. abstract="true" native="false" synchronized="false"
  7079. static="false" final="false" visibility="public"
  7080. deprecated="not deprecated">
  7081. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  7082. <doc>
  7083. <![CDATA[Set include pattern in a rolling fashion.
  7084. @param rolledLogsIncludePattern]]>
  7085. </doc>
  7086. </method>
  7087. <method name="getRolledLogsExcludePattern" return="java.lang.String"
  7088. abstract="true" native="false" synchronized="false"
  7089. static="false" final="false" visibility="public"
  7090. deprecated="not deprecated">
  7091. <doc>
  7092. <![CDATA[Get exclude pattern for aggregation in a rolling fashion.
  7093. @return exclude pattern]]>
  7094. </doc>
  7095. </method>
  7096. <method name="setRolledLogsExcludePattern"
  7097. abstract="true" native="false" synchronized="false"
  7098. static="false" final="false" visibility="public"
  7099. deprecated="not deprecated">
  7100. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  7101. <doc>
  7102. <![CDATA[Set exclude pattern for in a rolling fashion.
  7103. @param rolledLogsExcludePattern]]>
  7104. </doc>
  7105. </method>
  7106. <method name="getLogAggregationPolicyClassName" return="java.lang.String"
  7107. abstract="true" native="false" synchronized="false"
  7108. static="false" final="false" visibility="public"
  7109. deprecated="not deprecated">
  7110. <doc>
  7111. <![CDATA[Get the log aggregation policy class.
  7112. @return log aggregation policy class]]>
  7113. </doc>
  7114. </method>
  7115. <method name="setLogAggregationPolicyClassName"
  7116. abstract="true" native="false" synchronized="false"
  7117. static="false" final="false" visibility="public"
  7118. deprecated="not deprecated">
  7119. <param name="className" type="java.lang.String"/>
  7120. <doc>
  7121. <![CDATA[Set the log aggregation policy class.
  7122. @param className]]>
  7123. </doc>
  7124. </method>
  7125. <method name="getLogAggregationPolicyParameters" return="java.lang.String"
  7126. abstract="true" native="false" synchronized="false"
  7127. static="false" final="false" visibility="public"
  7128. deprecated="not deprecated">
  7129. <doc>
  7130. <![CDATA[Get the log aggregation policy parameters.
  7131. @return log aggregation policy parameters]]>
  7132. </doc>
  7133. </method>
  7134. <method name="setLogAggregationPolicyParameters"
  7135. abstract="true" native="false" synchronized="false"
  7136. static="false" final="false" visibility="public"
  7137. deprecated="not deprecated">
  7138. <param name="parameters" type="java.lang.String"/>
  7139. <doc>
  7140. <![CDATA[Set the log aggregation policy parameters.
  7141. There is no schema defined for the parameters string.
  7142. It is up to the log aggregation policy class to decide how to parse
  7143. the parameters string.
  7144. @param parameters]]>
  7145. </doc>
  7146. </method>
  7147. <doc>
  7148. <![CDATA[{@code LogAggregationContext} represents all of the
  7149. information needed by the {@code NodeManager} to handle
  7150. the logs for an application.
  7151. <p>
  7152. It includes details such as:
  7153. <ul>
  7154. <li>
  7155. includePattern. It uses Java Regex to filter the log files
  7156. which match the defined include pattern and those log files
  7157. will be uploaded when the application finishes.
  7158. </li>
  7159. <li>
  7160. excludePattern. It uses Java Regex to filter the log files
  7161. which match the defined exclude pattern and those log files
  7162. will not be uploaded when application finishes. If the log file
  7163. name matches both the include and the exclude pattern, this file
  7164. will be excluded eventually.
  7165. </li>
  7166. <li>
  7167. rolledLogsIncludePattern. It uses Java Regex to filter the log files
  7168. which match the defined include pattern and those log files
  7169. will be aggregated in a rolling fashion.
  7170. </li>
  7171. <li>
  7172. rolledLogsExcludePattern. It uses Java Regex to filter the log files
  7173. which match the defined exclude pattern and those log files
  7174. will not be aggregated in a rolling fashion. If the log file
  7175. name matches both the include and the exclude pattern, this file
  7176. will be excluded eventually.
  7177. </li>
  7178. <li>
  7179. policyClassName. The policy class name that implements
  7180. ContainerLogAggregationPolicy. At runtime, nodemanager will the policy
  7181. if a given container's log should be aggregated based on the
  7182. ContainerType and other runtime state such as exit code by calling
  7183. ContainerLogAggregationPolicy#shouldDoLogAggregation.
  7184. This is useful when the app only wants to aggregate logs of a subset of
  7185. containers. Here are the available policies. Please make sure to specify
  7186. the canonical name by prefixing org.apache.hadoop.yarn.server.
  7187. nodemanager.containermanager.logaggregation.
  7188. to the class simple name below.
  7189. NoneContainerLogAggregationPolicy: skip aggregation for all containers.
  7190. AllContainerLogAggregationPolicy: aggregate all containers.
  7191. AMOrFailedContainerLogAggregationPolicy: aggregate application master
  7192. or failed containers.
  7193. FailedOrKilledContainerLogAggregationPolicy: aggregate failed or killed
  7194. containers
  7195. FailedContainerLogAggregationPolicy: aggregate failed containers
  7196. AMOnlyLogAggregationPolicy: aggregate application master containers
  7197. SampleContainerLogAggregationPolicy: sample logs of successful worker
  7198. containers, in addition to application master and failed/killed
  7199. containers.
  7200. If it isn't specified, it will use the cluster-wide default policy
  7201. defined by configuration yarn.nodemanager.log-aggregation.policy.class.
  7202. The default value of yarn.nodemanager.log-aggregation.policy.class is
  7203. AllContainerLogAggregationPolicy.
  7204. </li>
  7205. <li>
  7206. policyParameters. The parameters passed to the policy class via
  7207. ContainerLogAggregationPolicy#parseParameters during the policy object
  7208. initialization. This is optional. Some policy class might use parameters
  7209. to adjust its settings. It is up to policy class to define the scheme of
  7210. parameters.
  7211. For example, SampleContainerLogAggregationPolicy supports the format of
  7212. "SR:0.5,MIN:50", which means sample rate of 50% beyond the first 50
  7213. successful worker containers.
  7214. </li>
  7215. </ul>
  7216. @see ApplicationSubmissionContext]]>
  7217. </doc>
  7218. </class>
  7219. <!-- end class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
  7220. <!-- start class org.apache.hadoop.yarn.api.records.NMToken -->
  7221. <class name="NMToken" extends="java.lang.Object"
  7222. abstract="true"
  7223. static="false" final="false" visibility="public"
  7224. deprecated="not deprecated">
  7225. <constructor name="NMToken"
  7226. static="false" final="false" visibility="public"
  7227. deprecated="not deprecated">
  7228. </constructor>
  7229. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  7230. abstract="true" native="false" synchronized="false"
  7231. static="false" final="false" visibility="public"
  7232. deprecated="not deprecated">
  7233. <doc>
  7234. <![CDATA[Get the {@link NodeId} of the <code>NodeManager</code> for which the NMToken
  7235. is used to authenticate.
  7236. @return the {@link NodeId} of the <code>NodeManager</code> for which the
  7237. NMToken is used to authenticate.]]>
  7238. </doc>
  7239. </method>
  7240. <method name="setNodeId"
  7241. abstract="true" native="false" synchronized="false"
  7242. static="false" final="false" visibility="public"
  7243. deprecated="not deprecated">
  7244. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  7245. </method>
  7246. <method name="getToken" return="org.apache.hadoop.yarn.api.records.Token"
  7247. abstract="true" native="false" synchronized="false"
  7248. static="false" final="false" visibility="public"
  7249. deprecated="not deprecated">
  7250. <doc>
  7251. <![CDATA[Get the {@link Token} used for authenticating with <code>NodeManager</code>
  7252. @return the {@link Token} used for authenticating with <code>NodeManager</code>]]>
  7253. </doc>
  7254. </method>
  7255. <method name="setToken"
  7256. abstract="true" native="false" synchronized="false"
  7257. static="false" final="false" visibility="public"
  7258. deprecated="not deprecated">
  7259. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  7260. </method>
  7261. <method name="hashCode" return="int"
  7262. abstract="false" native="false" synchronized="false"
  7263. static="false" final="false" visibility="public"
  7264. deprecated="not deprecated">
  7265. </method>
  7266. <method name="equals" return="boolean"
  7267. abstract="false" native="false" synchronized="false"
  7268. static="false" final="false" visibility="public"
  7269. deprecated="not deprecated">
  7270. <param name="obj" type="java.lang.Object"/>
  7271. </method>
  7272. <doc>
  7273. <![CDATA[<p>The NMToken is used for authenticating communication with
  7274. <code>NodeManager</code></p>
  7275. <p>It is issued by <code>ResourceMananger</code> when <code>ApplicationMaster</code>
  7276. negotiates resource with <code>ResourceManager</code> and
  7277. validated on <code>NodeManager</code> side.</p>
  7278. @see AllocateResponse#getNMTokens()]]>
  7279. </doc>
  7280. </class>
  7281. <!-- end class org.apache.hadoop.yarn.api.records.NMToken -->
  7282. <!-- start class org.apache.hadoop.yarn.api.records.NodeId -->
  7283. <class name="NodeId" extends="java.lang.Object"
  7284. abstract="true"
  7285. static="false" final="false" visibility="public"
  7286. deprecated="not deprecated">
  7287. <implements name="java.lang.Comparable"/>
  7288. <constructor name="NodeId"
  7289. static="false" final="false" visibility="public"
  7290. deprecated="not deprecated">
  7291. </constructor>
  7292. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeId"
  7293. abstract="false" native="false" synchronized="false"
  7294. static="true" final="false" visibility="public"
  7295. deprecated="not deprecated">
  7296. <param name="host" type="java.lang.String"/>
  7297. <param name="port" type="int"/>
  7298. </method>
  7299. <method name="getHost" return="java.lang.String"
  7300. abstract="true" native="false" synchronized="false"
  7301. static="false" final="false" visibility="public"
  7302. deprecated="not deprecated">
  7303. <doc>
  7304. <![CDATA[Get the <em>hostname</em> of the node.
  7305. @return <em>hostname</em> of the node]]>
  7306. </doc>
  7307. </method>
  7308. <method name="getPort" return="int"
  7309. abstract="true" native="false" synchronized="false"
  7310. static="false" final="false" visibility="public"
  7311. deprecated="not deprecated">
  7312. <doc>
  7313. <![CDATA[Get the <em>port</em> for communicating with the node.
  7314. @return <em>port</em> for communicating with the node]]>
  7315. </doc>
  7316. </method>
  7317. <method name="toString" return="java.lang.String"
  7318. abstract="false" native="false" synchronized="false"
  7319. static="false" final="false" visibility="public"
  7320. deprecated="not deprecated">
  7321. </method>
  7322. <method name="hashCode" return="int"
  7323. abstract="false" native="false" synchronized="false"
  7324. static="false" final="false" visibility="public"
  7325. deprecated="not deprecated">
  7326. </method>
  7327. <method name="equals" return="boolean"
  7328. abstract="false" native="false" synchronized="false"
  7329. static="false" final="false" visibility="public"
  7330. deprecated="not deprecated">
  7331. <param name="obj" type="java.lang.Object"/>
  7332. </method>
  7333. <method name="compareTo" return="int"
  7334. abstract="false" native="false" synchronized="false"
  7335. static="false" final="false" visibility="public"
  7336. deprecated="not deprecated">
  7337. <param name="other" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  7338. </method>
  7339. <method name="fromString" return="org.apache.hadoop.yarn.api.records.NodeId"
  7340. abstract="false" native="false" synchronized="false"
  7341. static="true" final="false" visibility="public"
  7342. deprecated="not deprecated">
  7343. <param name="nodeIdStr" type="java.lang.String"/>
  7344. </method>
  7345. <method name="build"
  7346. abstract="true" native="false" synchronized="false"
  7347. static="false" final="false" visibility="protected"
  7348. deprecated="not deprecated">
  7349. </method>
  7350. <doc>
  7351. <![CDATA[<p><code>NodeId</code> is the unique identifier for a node.</p>
  7352. <p>It includes the <em>hostname</em> and <em>port</em> to uniquely
  7353. identify the node. Thus, it is unique across restarts of any
  7354. <code>NodeManager</code>.</p>]]>
  7355. </doc>
  7356. </class>
  7357. <!-- end class org.apache.hadoop.yarn.api.records.NodeId -->
  7358. <!-- start class org.apache.hadoop.yarn.api.records.NodeLabel -->
  7359. <class name="NodeLabel" extends="java.lang.Object"
  7360. abstract="true"
  7361. static="false" final="false" visibility="public"
  7362. deprecated="not deprecated">
  7363. <implements name="java.lang.Comparable"/>
  7364. <constructor name="NodeLabel"
  7365. static="false" final="false" visibility="public"
  7366. deprecated="not deprecated">
  7367. </constructor>
  7368. <method name="getName" return="java.lang.String"
  7369. abstract="true" native="false" synchronized="false"
  7370. static="false" final="false" visibility="public"
  7371. deprecated="not deprecated">
  7372. </method>
  7373. <method name="isExclusive" return="boolean"
  7374. abstract="true" native="false" synchronized="false"
  7375. static="false" final="false" visibility="public"
  7376. deprecated="not deprecated">
  7377. </method>
  7378. <method name="compareTo" return="int"
  7379. abstract="false" native="false" synchronized="false"
  7380. static="false" final="false" visibility="public"
  7381. deprecated="not deprecated">
  7382. <param name="other" type="org.apache.hadoop.yarn.api.records.NodeLabel"/>
  7383. </method>
  7384. <method name="equals" return="boolean"
  7385. abstract="false" native="false" synchronized="false"
  7386. static="false" final="false" visibility="public"
  7387. deprecated="not deprecated">
  7388. <param name="obj" type="java.lang.Object"/>
  7389. </method>
  7390. <method name="toString" return="java.lang.String"
  7391. abstract="false" native="false" synchronized="false"
  7392. static="false" final="false" visibility="public"
  7393. deprecated="not deprecated">
  7394. </method>
  7395. <method name="hashCode" return="int"
  7396. abstract="false" native="false" synchronized="false"
  7397. static="false" final="false" visibility="public"
  7398. deprecated="not deprecated">
  7399. </method>
  7400. <field name="DEFAULT_NODE_LABEL_PARTITION" type="java.lang.String"
  7401. transient="false" volatile="false"
  7402. static="true" final="true" visibility="public"
  7403. deprecated="not deprecated">
  7404. <doc>
  7405. <![CDATA[Default node label partition used for displaying.]]>
  7406. </doc>
  7407. </field>
  7408. <field name="NODE_LABEL_EXPRESSION_NOT_SET" type="java.lang.String"
  7409. transient="false" volatile="false"
  7410. static="true" final="true" visibility="public"
  7411. deprecated="not deprecated">
  7412. <doc>
  7413. <![CDATA[Node Label expression not set .]]>
  7414. </doc>
  7415. </field>
  7416. <field name="DEFAULT_NODE_LABEL_EXCLUSIVITY" type="boolean"
  7417. transient="false" volatile="false"
  7418. static="true" final="true" visibility="public"
  7419. deprecated="not deprecated">
  7420. <doc>
  7421. <![CDATA[By default, node label is exclusive or not]]>
  7422. </doc>
  7423. </field>
  7424. </class>
  7425. <!-- end class org.apache.hadoop.yarn.api.records.NodeLabel -->
  7426. <!-- start class org.apache.hadoop.yarn.api.records.NodeReport -->
  7427. <class name="NodeReport" extends="java.lang.Object"
  7428. abstract="true"
  7429. static="false" final="false" visibility="public"
  7430. deprecated="not deprecated">
  7431. <constructor name="NodeReport"
  7432. static="false" final="false" visibility="public"
  7433. deprecated="not deprecated">
  7434. </constructor>
  7435. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  7436. abstract="true" native="false" synchronized="false"
  7437. static="false" final="false" visibility="public"
  7438. deprecated="not deprecated">
  7439. <doc>
  7440. <![CDATA[Get the <code>NodeId</code> of the node.
  7441. @return <code>NodeId</code> of the node]]>
  7442. </doc>
  7443. </method>
  7444. <method name="getNodeState" return="org.apache.hadoop.yarn.api.records.NodeState"
  7445. abstract="true" native="false" synchronized="false"
  7446. static="false" final="false" visibility="public"
  7447. deprecated="not deprecated">
  7448. <doc>
  7449. <![CDATA[Get the <code>NodeState</code> of the node.
  7450. @return <code>NodeState</code> of the node]]>
  7451. </doc>
  7452. </method>
  7453. <method name="getHttpAddress" return="java.lang.String"
  7454. abstract="true" native="false" synchronized="false"
  7455. static="false" final="false" visibility="public"
  7456. deprecated="not deprecated">
  7457. <doc>
  7458. <![CDATA[Get the <em>http address</em> of the node.
  7459. @return <em>http address</em> of the node]]>
  7460. </doc>
  7461. </method>
  7462. <method name="getRackName" return="java.lang.String"
  7463. abstract="true" native="false" synchronized="false"
  7464. static="false" final="false" visibility="public"
  7465. deprecated="not deprecated">
  7466. <doc>
  7467. <![CDATA[Get the <em>rack name</em> for the node.
  7468. @return <em>rack name</em> for the node]]>
  7469. </doc>
  7470. </method>
  7471. <method name="getUsed" return="org.apache.hadoop.yarn.api.records.Resource"
  7472. abstract="true" native="false" synchronized="false"
  7473. static="false" final="false" visibility="public"
  7474. deprecated="not deprecated">
  7475. <doc>
  7476. <![CDATA[Get <em>used</em> <code>Resource</code> on the node.
  7477. @return <em>used</em> <code>Resource</code> on the node]]>
  7478. </doc>
  7479. </method>
  7480. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  7481. abstract="true" native="false" synchronized="false"
  7482. static="false" final="false" visibility="public"
  7483. deprecated="not deprecated">
  7484. <doc>
  7485. <![CDATA[Get the <em>total</em> <code>Resource</code> on the node.
  7486. @return <em>total</em> <code>Resource</code> on the node]]>
  7487. </doc>
  7488. </method>
  7489. <method name="getHealthReport" return="java.lang.String"
  7490. abstract="true" native="false" synchronized="false"
  7491. static="false" final="false" visibility="public"
  7492. deprecated="not deprecated">
  7493. <doc>
  7494. <![CDATA[Get the <em>diagnostic health report</em> of the node.
  7495. @return <em>diagnostic health report</em> of the node]]>
  7496. </doc>
  7497. </method>
  7498. <method name="getLastHealthReportTime" return="long"
  7499. abstract="true" native="false" synchronized="false"
  7500. static="false" final="false" visibility="public"
  7501. deprecated="not deprecated">
  7502. <doc>
  7503. <![CDATA[Get the <em>last timestamp</em> at which the health report was received.
  7504. @return <em>last timestamp</em> at which the health report was received]]>
  7505. </doc>
  7506. </method>
  7507. <method name="getNodeLabels" return="java.util.Set"
  7508. abstract="true" native="false" synchronized="false"
  7509. static="false" final="false" visibility="public"
  7510. deprecated="not deprecated">
  7511. <doc>
  7512. <![CDATA[Get labels of this node
  7513. @return labels of this node]]>
  7514. </doc>
  7515. </method>
  7516. <method name="getAggregatedContainersUtilization" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  7517. abstract="false" native="false" synchronized="false"
  7518. static="false" final="false" visibility="public"
  7519. deprecated="not deprecated">
  7520. <doc>
  7521. <![CDATA[Get containers aggregated resource utilization in a node
  7522. @return containers resource utilization]]>
  7523. </doc>
  7524. </method>
  7525. <method name="getNodeUtilization" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  7526. abstract="false" native="false" synchronized="false"
  7527. static="false" final="false" visibility="public"
  7528. deprecated="not deprecated">
  7529. <doc>
  7530. <![CDATA[Get node resource utilization
  7531. @return node resource utilization]]>
  7532. </doc>
  7533. </method>
  7534. <doc>
  7535. <![CDATA[{@code NodeReport} is a summary of runtime information of a node
  7536. in the cluster.
  7537. <p>
  7538. It includes details such as:
  7539. <ul>
  7540. <li>{@link NodeId} of the node.</li>
  7541. <li>HTTP Tracking URL of the node.</li>
  7542. <li>Rack name for the node.</li>
  7543. <li>Used {@link Resource} on the node.</li>
  7544. <li>Total available {@link Resource} of the node.</li>
  7545. <li>Number of running containers on the node.</li>
  7546. </ul>
  7547. @see ApplicationClientProtocol#getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)]]>
  7548. </doc>
  7549. </class>
  7550. <!-- end class org.apache.hadoop.yarn.api.records.NodeReport -->
  7551. <!-- start class org.apache.hadoop.yarn.api.records.NodeState -->
  7552. <class name="NodeState" extends="java.lang.Enum"
  7553. abstract="false"
  7554. static="false" final="true" visibility="public"
  7555. deprecated="not deprecated">
  7556. <method name="values" return="org.apache.hadoop.yarn.api.records.NodeState[]"
  7557. abstract="false" native="false" synchronized="false"
  7558. static="true" final="false" visibility="public"
  7559. deprecated="not deprecated">
  7560. </method>
  7561. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.NodeState"
  7562. abstract="false" native="false" synchronized="false"
  7563. static="true" final="false" visibility="public"
  7564. deprecated="not deprecated">
  7565. <param name="name" type="java.lang.String"/>
  7566. </method>
  7567. <method name="isUnusable" return="boolean"
  7568. abstract="false" native="false" synchronized="false"
  7569. static="false" final="false" visibility="public"
  7570. deprecated="not deprecated">
  7571. </method>
  7572. <doc>
  7573. <![CDATA[<p>State of a <code>Node</code>.</p>]]>
  7574. </doc>
  7575. </class>
  7576. <!-- end class org.apache.hadoop.yarn.api.records.NodeState -->
  7577. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
  7578. <class name="PreemptionContainer" extends="java.lang.Object"
  7579. abstract="true"
  7580. static="false" final="false" visibility="public"
  7581. deprecated="not deprecated">
  7582. <constructor name="PreemptionContainer"
  7583. static="false" final="false" visibility="public"
  7584. deprecated="not deprecated">
  7585. </constructor>
  7586. <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  7587. abstract="true" native="false" synchronized="false"
  7588. static="false" final="false" visibility="public"
  7589. deprecated="not deprecated">
  7590. <doc>
  7591. <![CDATA[@return Container referenced by this handle.]]>
  7592. </doc>
  7593. </method>
  7594. <doc>
  7595. <![CDATA[Specific container requested back by the <code>ResourceManager</code>.
  7596. @see PreemptionContract
  7597. @see StrictPreemptionContract]]>
  7598. </doc>
  7599. </class>
  7600. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
  7601. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContract -->
  7602. <class name="PreemptionContract" extends="java.lang.Object"
  7603. abstract="true"
  7604. static="false" final="false" visibility="public"
  7605. deprecated="not deprecated">
  7606. <constructor name="PreemptionContract"
  7607. static="false" final="false" visibility="public"
  7608. deprecated="not deprecated">
  7609. </constructor>
  7610. <method name="getResourceRequest" return="java.util.List"
  7611. abstract="true" native="false" synchronized="false"
  7612. static="false" final="false" visibility="public"
  7613. deprecated="not deprecated">
  7614. <doc>
  7615. <![CDATA[If the AM releases resources matching these requests, then the {@link
  7616. PreemptionContainer}s enumerated in {@link #getContainers()} should not be
  7617. evicted from the cluster. Due to delays in propagating cluster state and
  7618. sending these messages, there are conditions where satisfied contracts may
  7619. not prevent the platform from killing containers.
  7620. @return List of {@link PreemptionResourceRequest} to update the
  7621. <code>ApplicationMaster</code> about resources requested back by the
  7622. <code>ResourceManager</code>.
  7623. @see AllocateRequest#setAskList(List)]]>
  7624. </doc>
  7625. </method>
  7626. <method name="getContainers" return="java.util.Set"
  7627. abstract="true" native="false" synchronized="false"
  7628. static="false" final="false" visibility="public"
  7629. deprecated="not deprecated">
  7630. <doc>
  7631. <![CDATA[Assign the set of {@link PreemptionContainer} specifying which containers
  7632. owned by the <code>ApplicationMaster</code> that may be reclaimed by the
  7633. <code>ResourceManager</code>. If the AM prefers a different set of
  7634. containers, then it may checkpoint or kill containers matching the
  7635. description in {@link #getResourceRequest}.
  7636. @return Set of containers at risk if the contract is not met.]]>
  7637. </doc>
  7638. </method>
  7639. <doc>
  7640. <![CDATA[Description of resources requested back by the <code>ResourceManager</code>.
  7641. The <code>ApplicationMaster</code> (AM) can satisfy this request according
  7642. to its own priorities to prevent containers from being forcibly killed by
  7643. the platform.
  7644. @see PreemptionMessage]]>
  7645. </doc>
  7646. </class>
  7647. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContract -->
  7648. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
  7649. <class name="PreemptionMessage" extends="java.lang.Object"
  7650. abstract="true"
  7651. static="false" final="false" visibility="public"
  7652. deprecated="not deprecated">
  7653. <constructor name="PreemptionMessage"
  7654. static="false" final="false" visibility="public"
  7655. deprecated="not deprecated">
  7656. </constructor>
  7657. <method name="getStrictContract" return="org.apache.hadoop.yarn.api.records.StrictPreemptionContract"
  7658. abstract="true" native="false" synchronized="false"
  7659. static="false" final="false" visibility="public"
  7660. deprecated="not deprecated">
  7661. <doc>
  7662. <![CDATA[@return Specific resources that may be killed by the
  7663. <code>ResourceManager</code>]]>
  7664. </doc>
  7665. </method>
  7666. <method name="getContract" return="org.apache.hadoop.yarn.api.records.PreemptionContract"
  7667. abstract="true" native="false" synchronized="false"
  7668. static="false" final="false" visibility="public"
  7669. deprecated="not deprecated">
  7670. <doc>
  7671. <![CDATA[@return Contract describing resources to return to the cluster.]]>
  7672. </doc>
  7673. </method>
  7674. <doc>
  7675. <![CDATA[A {@link PreemptionMessage} is part of the RM-AM protocol, and it is used by
  7676. the RM to specify resources that the RM wants to reclaim from this
  7677. {@code ApplicationMaster} (AM). The AM receives a {@link
  7678. StrictPreemptionContract} message encoding which containers the platform may
  7679. forcibly kill, granting it an opportunity to checkpoint state or adjust its
  7680. execution plan. The message may also include a {@link PreemptionContract}
  7681. granting the AM more latitude in selecting which resources to return to the
  7682. cluster.
  7683. <p>
  7684. The AM should decode both parts of the message. The {@link
  7685. StrictPreemptionContract} specifies particular allocations that the RM
  7686. requires back. The AM can checkpoint containers' state, adjust its execution
  7687. plan to move the computation, or take no action and hope that conditions that
  7688. caused the RM to ask for the container will change.
  7689. <p>
  7690. In contrast, the {@link PreemptionContract} also includes a description of
  7691. resources with a set of containers. If the AM releases containers matching
  7692. that profile, then the containers enumerated in {@link
  7693. PreemptionContract#getContainers()} may not be killed.
  7694. <p>
  7695. Each preemption message reflects the RM's current understanding of the
  7696. cluster state, so a request to return <em>N</em> containers may not
  7697. reflect containers the AM is releasing, recently exited containers the RM has
  7698. yet to learn about, or new containers allocated before the message was
  7699. generated. Conversely, an RM may request a different profile of containers in
  7700. subsequent requests.
  7701. <p>
  7702. The policy enforced by the RM is part of the scheduler. Generally, only
  7703. containers that have been requested consistently should be killed, but the
  7704. details are not specified.]]>
  7705. </doc>
  7706. </class>
  7707. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
  7708. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
  7709. <class name="PreemptionResourceRequest" extends="java.lang.Object"
  7710. abstract="true"
  7711. static="false" final="false" visibility="public"
  7712. deprecated="not deprecated">
  7713. <constructor name="PreemptionResourceRequest"
  7714. static="false" final="false" visibility="public"
  7715. deprecated="not deprecated">
  7716. </constructor>
  7717. <method name="getResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  7718. abstract="true" native="false" synchronized="false"
  7719. static="false" final="false" visibility="public"
  7720. deprecated="not deprecated">
  7721. <doc>
  7722. <![CDATA[@return Resource described in this request, to be matched against running
  7723. containers.]]>
  7724. </doc>
  7725. </method>
  7726. <doc>
  7727. <![CDATA[Description of resources requested back by the cluster.
  7728. @see PreemptionContract
  7729. @see AllocateRequest#setAskList(java.util.List)]]>
  7730. </doc>
  7731. </class>
  7732. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
  7733. <!-- start class org.apache.hadoop.yarn.api.records.Priority -->
  7734. <class name="Priority" extends="java.lang.Object"
  7735. abstract="true"
  7736. static="false" final="false" visibility="public"
  7737. deprecated="not deprecated">
  7738. <implements name="java.lang.Comparable"/>
  7739. <constructor name="Priority"
  7740. static="false" final="false" visibility="public"
  7741. deprecated="not deprecated">
  7742. </constructor>
  7743. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Priority"
  7744. abstract="false" native="false" synchronized="false"
  7745. static="true" final="false" visibility="public"
  7746. deprecated="not deprecated">
  7747. <param name="p" type="int"/>
  7748. </method>
  7749. <method name="getPriority" return="int"
  7750. abstract="true" native="false" synchronized="false"
  7751. static="false" final="false" visibility="public"
  7752. deprecated="not deprecated">
  7753. <doc>
  7754. <![CDATA[Get the assigned priority
  7755. @return the assigned priority]]>
  7756. </doc>
  7757. </method>
  7758. <method name="setPriority"
  7759. abstract="true" native="false" synchronized="false"
  7760. static="false" final="false" visibility="public"
  7761. deprecated="not deprecated">
  7762. <param name="priority" type="int"/>
  7763. <doc>
  7764. <![CDATA[Set the assigned priority
  7765. @param priority the assigned priority]]>
  7766. </doc>
  7767. </method>
  7768. <method name="hashCode" return="int"
  7769. abstract="false" native="false" synchronized="false"
  7770. static="false" final="false" visibility="public"
  7771. deprecated="not deprecated">
  7772. </method>
  7773. <method name="equals" return="boolean"
  7774. abstract="false" native="false" synchronized="false"
  7775. static="false" final="false" visibility="public"
  7776. deprecated="not deprecated">
  7777. <param name="obj" type="java.lang.Object"/>
  7778. </method>
  7779. <method name="compareTo" return="int"
  7780. abstract="false" native="false" synchronized="false"
  7781. static="false" final="false" visibility="public"
  7782. deprecated="not deprecated">
  7783. <param name="other" type="org.apache.hadoop.yarn.api.records.Priority"/>
  7784. </method>
  7785. <method name="toString" return="java.lang.String"
  7786. abstract="false" native="false" synchronized="false"
  7787. static="false" final="false" visibility="public"
  7788. deprecated="not deprecated">
  7789. </method>
  7790. <field name="UNDEFINED" type="org.apache.hadoop.yarn.api.records.Priority"
  7791. transient="false" volatile="false"
  7792. static="true" final="true" visibility="public"
  7793. deprecated="not deprecated">
  7794. </field>
  7795. <doc>
  7796. <![CDATA[The priority assigned to a ResourceRequest or Application or Container
  7797. allocation]]>
  7798. </doc>
  7799. </class>
  7800. <!-- end class org.apache.hadoop.yarn.api.records.Priority -->
  7801. <!-- start class org.apache.hadoop.yarn.api.records.QueueACL -->
  7802. <class name="QueueACL" extends="java.lang.Enum"
  7803. abstract="false"
  7804. static="false" final="true" visibility="public"
  7805. deprecated="not deprecated">
  7806. <method name="values" return="org.apache.hadoop.yarn.api.records.QueueACL[]"
  7807. abstract="false" native="false" synchronized="false"
  7808. static="true" final="false" visibility="public"
  7809. deprecated="not deprecated">
  7810. </method>
  7811. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueACL"
  7812. abstract="false" native="false" synchronized="false"
  7813. static="true" final="false" visibility="public"
  7814. deprecated="not deprecated">
  7815. <param name="name" type="java.lang.String"/>
  7816. </method>
  7817. <doc>
  7818. <![CDATA[{@code QueueACL} enumerates the various ACLs for queues.
  7819. <p>
  7820. The ACL is one of:
  7821. <ul>
  7822. <li>
  7823. {@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the queue.
  7824. </li>
  7825. <li>{@link #ADMINISTER_QUEUE} - ACL to administer the queue.</li>
  7826. </ul>
  7827. @see QueueInfo
  7828. @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
  7829. </doc>
  7830. </class>
  7831. <!-- end class org.apache.hadoop.yarn.api.records.QueueACL -->
  7832. <!-- start class org.apache.hadoop.yarn.api.records.QueueInfo -->
  7833. <class name="QueueInfo" extends="java.lang.Object"
  7834. abstract="true"
  7835. static="false" final="false" visibility="public"
  7836. deprecated="not deprecated">
  7837. <constructor name="QueueInfo"
  7838. static="false" final="false" visibility="public"
  7839. deprecated="not deprecated">
  7840. </constructor>
  7841. <method name="getQueueName" return="java.lang.String"
  7842. abstract="true" native="false" synchronized="false"
  7843. static="false" final="false" visibility="public"
  7844. deprecated="not deprecated">
  7845. <doc>
  7846. <![CDATA[Get the <em>name</em> of the queue.
  7847. @return <em>name</em> of the queue]]>
  7848. </doc>
  7849. </method>
  7850. <method name="getCapacity" return="float"
  7851. abstract="true" native="false" synchronized="false"
  7852. static="false" final="false" visibility="public"
  7853. deprecated="not deprecated">
  7854. <doc>
  7855. <![CDATA[Get the <em>configured capacity</em> of the queue.
  7856. @return <em>configured capacity</em> of the queue]]>
  7857. </doc>
  7858. </method>
  7859. <method name="getMaximumCapacity" return="float"
  7860. abstract="true" native="false" synchronized="false"
  7861. static="false" final="false" visibility="public"
  7862. deprecated="not deprecated">
  7863. <doc>
  7864. <![CDATA[Get the <em>maximum capacity</em> of the queue.
  7865. @return <em>maximum capacity</em> of the queue]]>
  7866. </doc>
  7867. </method>
  7868. <method name="getCurrentCapacity" return="float"
  7869. abstract="true" native="false" synchronized="false"
  7870. static="false" final="false" visibility="public"
  7871. deprecated="not deprecated">
  7872. <doc>
  7873. <![CDATA[Get the <em>current capacity</em> of the queue.
  7874. @return <em>current capacity</em> of the queue]]>
  7875. </doc>
  7876. </method>
  7877. <method name="getChildQueues" return="java.util.List"
  7878. abstract="true" native="false" synchronized="false"
  7879. static="false" final="false" visibility="public"
  7880. deprecated="not deprecated">
  7881. <doc>
  7882. <![CDATA[Get the <em>child queues</em> of the queue.
  7883. @return <em>child queues</em> of the queue]]>
  7884. </doc>
  7885. </method>
  7886. <method name="getApplications" return="java.util.List"
  7887. abstract="true" native="false" synchronized="false"
  7888. static="false" final="false" visibility="public"
  7889. deprecated="not deprecated">
  7890. <doc>
  7891. <![CDATA[Get the <em>running applications</em> of the queue.
  7892. @return <em>running applications</em> of the queue]]>
  7893. </doc>
  7894. </method>
  7895. <method name="getQueueState" return="org.apache.hadoop.yarn.api.records.QueueState"
  7896. abstract="true" native="false" synchronized="false"
  7897. static="false" final="false" visibility="public"
  7898. deprecated="not deprecated">
  7899. <doc>
  7900. <![CDATA[Get the <code>QueueState</code> of the queue.
  7901. @return <code>QueueState</code> of the queue]]>
  7902. </doc>
  7903. </method>
  7904. <method name="getAccessibleNodeLabels" return="java.util.Set"
  7905. abstract="true" native="false" synchronized="false"
  7906. static="false" final="false" visibility="public"
  7907. deprecated="not deprecated">
  7908. <doc>
  7909. <![CDATA[Get the <code>accessible node labels</code> of the queue.
  7910. @return <code>accessible node labels</code> of the queue]]>
  7911. </doc>
  7912. </method>
  7913. <method name="getDefaultNodeLabelExpression" return="java.lang.String"
  7914. abstract="true" native="false" synchronized="false"
  7915. static="false" final="false" visibility="public"
  7916. deprecated="not deprecated">
  7917. <doc>
  7918. <![CDATA[Get the <code>default node label expression</code> of the queue, this takes
  7919. affect only when the <code>ApplicationSubmissionContext</code> and
  7920. <code>ResourceRequest</code> don't specify their
  7921. <code>NodeLabelExpression</code>.
  7922. @return <code>default node label expression</code> of the queue]]>
  7923. </doc>
  7924. </method>
  7925. <method name="setDefaultNodeLabelExpression"
  7926. abstract="true" native="false" synchronized="false"
  7927. static="false" final="false" visibility="public"
  7928. deprecated="not deprecated">
  7929. <param name="defaultLabelExpression" type="java.lang.String"/>
  7930. </method>
  7931. <method name="getQueueStatistics" return="org.apache.hadoop.yarn.api.records.QueueStatistics"
  7932. abstract="true" native="false" synchronized="false"
  7933. static="false" final="false" visibility="public"
  7934. deprecated="not deprecated">
  7935. <doc>
  7936. <![CDATA[Get the <code>queue stats</code> for the queue
  7937. @return <code>queue stats</code> of the queue]]>
  7938. </doc>
  7939. </method>
  7940. <method name="setQueueStatistics"
  7941. abstract="true" native="false" synchronized="false"
  7942. static="false" final="false" visibility="public"
  7943. deprecated="not deprecated">
  7944. <param name="queueStatistics" type="org.apache.hadoop.yarn.api.records.QueueStatistics"/>
  7945. <doc>
  7946. <![CDATA[Set the queue statistics for the queue
  7947. @param queueStatistics
  7948. the queue statistics]]>
  7949. </doc>
  7950. </method>
  7951. <method name="getPreemptionDisabled" return="java.lang.Boolean"
  7952. abstract="true" native="false" synchronized="false"
  7953. static="false" final="false" visibility="public"
  7954. deprecated="not deprecated">
  7955. <doc>
  7956. <![CDATA[Get the <em>preemption status</em> of the queue.
  7957. @return if property is not in proto, return null;
  7958. otherwise, return <em>preemption status</em> of the queue]]>
  7959. </doc>
  7960. </method>
  7961. <doc>
  7962. <![CDATA[QueueInfo is a report of the runtime information of the queue.
  7963. <p>
  7964. It includes information such as:
  7965. <ul>
  7966. <li>Queue name.</li>
  7967. <li>Capacity of the queue.</li>
  7968. <li>Maximum capacity of the queue.</li>
  7969. <li>Current capacity of the queue.</li>
  7970. <li>Child queues.</li>
  7971. <li>Running applications.</li>
  7972. <li>{@link QueueState} of the queue.</li>
  7973. </ul>
  7974. @see QueueState
  7975. @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
  7976. </doc>
  7977. </class>
  7978. <!-- end class org.apache.hadoop.yarn.api.records.QueueInfo -->
  7979. <!-- start class org.apache.hadoop.yarn.api.records.QueueState -->
  7980. <class name="QueueState" extends="java.lang.Enum"
  7981. abstract="false"
  7982. static="false" final="true" visibility="public"
  7983. deprecated="not deprecated">
  7984. <method name="values" return="org.apache.hadoop.yarn.api.records.QueueState[]"
  7985. abstract="false" native="false" synchronized="false"
  7986. static="true" final="false" visibility="public"
  7987. deprecated="not deprecated">
  7988. </method>
  7989. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueState"
  7990. abstract="false" native="false" synchronized="false"
  7991. static="true" final="false" visibility="public"
  7992. deprecated="not deprecated">
  7993. <param name="name" type="java.lang.String"/>
  7994. </method>
  7995. <doc>
  7996. <![CDATA[State of a Queue.
  7997. <p>
  7998. A queue is in one of:
  7999. <ul>
  8000. <li>{@link #RUNNING} - normal state.</li>
  8001. <li>{@link #STOPPED} - not accepting new application submissions.</li>
  8002. </ul>
  8003. @see QueueInfo
  8004. @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
  8005. </doc>
  8006. </class>
  8007. <!-- end class org.apache.hadoop.yarn.api.records.QueueState -->
  8008. <!-- start class org.apache.hadoop.yarn.api.records.QueueStatistics -->
  8009. <class name="QueueStatistics" extends="java.lang.Object"
  8010. abstract="true"
  8011. static="false" final="false" visibility="public"
  8012. deprecated="not deprecated">
  8013. <constructor name="QueueStatistics"
  8014. static="false" final="false" visibility="public"
  8015. deprecated="not deprecated">
  8016. </constructor>
  8017. <method name="getNumAppsSubmitted" return="long"
  8018. abstract="true" native="false" synchronized="false"
  8019. static="false" final="false" visibility="public"
  8020. deprecated="not deprecated">
  8021. <doc>
  8022. <![CDATA[Get the number of apps submitted
  8023. @return the number of apps submitted]]>
  8024. </doc>
  8025. </method>
  8026. <method name="setNumAppsSubmitted"
  8027. abstract="true" native="false" synchronized="false"
  8028. static="false" final="false" visibility="public"
  8029. deprecated="not deprecated">
  8030. <param name="numAppsSubmitted" type="long"/>
  8031. <doc>
  8032. <![CDATA[Set the number of apps submitted
  8033. @param numAppsSubmitted
  8034. the number of apps submitted]]>
  8035. </doc>
  8036. </method>
  8037. <method name="getNumAppsRunning" return="long"
  8038. abstract="true" native="false" synchronized="false"
  8039. static="false" final="false" visibility="public"
  8040. deprecated="not deprecated">
  8041. <doc>
  8042. <![CDATA[Get the number of running apps
  8043. @return the number of running apps]]>
  8044. </doc>
  8045. </method>
  8046. <method name="setNumAppsRunning"
  8047. abstract="true" native="false" synchronized="false"
  8048. static="false" final="false" visibility="public"
  8049. deprecated="not deprecated">
  8050. <param name="numAppsRunning" type="long"/>
  8051. <doc>
  8052. <![CDATA[Set the number of running apps
  8053. @param numAppsRunning
  8054. the number of running apps]]>
  8055. </doc>
  8056. </method>
  8057. <method name="getNumAppsPending" return="long"
  8058. abstract="true" native="false" synchronized="false"
  8059. static="false" final="false" visibility="public"
  8060. deprecated="not deprecated">
  8061. <doc>
  8062. <![CDATA[Get the number of pending apps
  8063. @return the number of pending apps]]>
  8064. </doc>
  8065. </method>
  8066. <method name="setNumAppsPending"
  8067. abstract="true" native="false" synchronized="false"
  8068. static="false" final="false" visibility="public"
  8069. deprecated="not deprecated">
  8070. <param name="numAppsPending" type="long"/>
  8071. <doc>
  8072. <![CDATA[Set the number of pending apps
  8073. @param numAppsPending
  8074. the number of pending apps]]>
  8075. </doc>
  8076. </method>
  8077. <method name="getNumAppsCompleted" return="long"
  8078. abstract="true" native="false" synchronized="false"
  8079. static="false" final="false" visibility="public"
  8080. deprecated="not deprecated">
  8081. <doc>
  8082. <![CDATA[Get the number of completed apps
  8083. @return the number of completed apps]]>
  8084. </doc>
  8085. </method>
  8086. <method name="setNumAppsCompleted"
  8087. abstract="true" native="false" synchronized="false"
  8088. static="false" final="false" visibility="public"
  8089. deprecated="not deprecated">
  8090. <param name="numAppsCompleted" type="long"/>
  8091. <doc>
  8092. <![CDATA[Set the number of completed apps
  8093. @param numAppsCompleted
  8094. the number of completed apps]]>
  8095. </doc>
  8096. </method>
  8097. <method name="getNumAppsKilled" return="long"
  8098. abstract="true" native="false" synchronized="false"
  8099. static="false" final="false" visibility="public"
  8100. deprecated="not deprecated">
  8101. <doc>
  8102. <![CDATA[Get the number of killed apps
  8103. @return the number of killed apps]]>
  8104. </doc>
  8105. </method>
  8106. <method name="setNumAppsKilled"
  8107. abstract="true" native="false" synchronized="false"
  8108. static="false" final="false" visibility="public"
  8109. deprecated="not deprecated">
  8110. <param name="numAppsKilled" type="long"/>
  8111. <doc>
  8112. <![CDATA[Set the number of killed apps
  8113. @param numAppsKilled
  8114. the number of killed apps]]>
  8115. </doc>
  8116. </method>
  8117. <method name="getNumAppsFailed" return="long"
  8118. abstract="true" native="false" synchronized="false"
  8119. static="false" final="false" visibility="public"
  8120. deprecated="not deprecated">
  8121. <doc>
  8122. <![CDATA[Get the number of failed apps
  8123. @return the number of failed apps]]>
  8124. </doc>
  8125. </method>
  8126. <method name="setNumAppsFailed"
  8127. abstract="true" native="false" synchronized="false"
  8128. static="false" final="false" visibility="public"
  8129. deprecated="not deprecated">
  8130. <param name="numAppsFailed" type="long"/>
  8131. <doc>
  8132. <![CDATA[Set the number of failed apps
  8133. @param numAppsFailed
  8134. the number of failed apps]]>
  8135. </doc>
  8136. </method>
  8137. <method name="getNumActiveUsers" return="long"
  8138. abstract="true" native="false" synchronized="false"
  8139. static="false" final="false" visibility="public"
  8140. deprecated="not deprecated">
  8141. <doc>
  8142. <![CDATA[Get the number of active users
  8143. @return the number of active users]]>
  8144. </doc>
  8145. </method>
  8146. <method name="setNumActiveUsers"
  8147. abstract="true" native="false" synchronized="false"
  8148. static="false" final="false" visibility="public"
  8149. deprecated="not deprecated">
  8150. <param name="numActiveUsers" type="long"/>
  8151. <doc>
  8152. <![CDATA[Set the number of active users
  8153. @param numActiveUsers
  8154. the number of active users]]>
  8155. </doc>
  8156. </method>
  8157. <method name="getAvailableMemoryMB" return="long"
  8158. abstract="true" native="false" synchronized="false"
  8159. static="false" final="false" visibility="public"
  8160. deprecated="not deprecated">
  8161. <doc>
  8162. <![CDATA[Get the available memory in MB
  8163. @return the available memory]]>
  8164. </doc>
  8165. </method>
  8166. <method name="setAvailableMemoryMB"
  8167. abstract="true" native="false" synchronized="false"
  8168. static="false" final="false" visibility="public"
  8169. deprecated="not deprecated">
  8170. <param name="availableMemoryMB" type="long"/>
  8171. <doc>
  8172. <![CDATA[Set the available memory in MB
  8173. @param availableMemoryMB
  8174. the available memory]]>
  8175. </doc>
  8176. </method>
  8177. <method name="getAllocatedMemoryMB" return="long"
  8178. abstract="true" native="false" synchronized="false"
  8179. static="false" final="false" visibility="public"
  8180. deprecated="not deprecated">
  8181. <doc>
  8182. <![CDATA[Get the allocated memory in MB
  8183. @return the allocated memory]]>
  8184. </doc>
  8185. </method>
  8186. <method name="setAllocatedMemoryMB"
  8187. abstract="true" native="false" synchronized="false"
  8188. static="false" final="false" visibility="public"
  8189. deprecated="not deprecated">
  8190. <param name="allocatedMemoryMB" type="long"/>
  8191. <doc>
  8192. <![CDATA[Set the allocated memory in MB
  8193. @param allocatedMemoryMB
  8194. the allocate memory]]>
  8195. </doc>
  8196. </method>
  8197. <method name="getPendingMemoryMB" return="long"
  8198. abstract="true" native="false" synchronized="false"
  8199. static="false" final="false" visibility="public"
  8200. deprecated="not deprecated">
  8201. <doc>
  8202. <![CDATA[Get the pending memory in MB
  8203. @return the pending memory]]>
  8204. </doc>
  8205. </method>
  8206. <method name="setPendingMemoryMB"
  8207. abstract="true" native="false" synchronized="false"
  8208. static="false" final="false" visibility="public"
  8209. deprecated="not deprecated">
  8210. <param name="pendingMemoryMB" type="long"/>
  8211. <doc>
  8212. <![CDATA[Set the pending memory in MB
  8213. @param pendingMemoryMB
  8214. the pending memory]]>
  8215. </doc>
  8216. </method>
  8217. <method name="getReservedMemoryMB" return="long"
  8218. abstract="true" native="false" synchronized="false"
  8219. static="false" final="false" visibility="public"
  8220. deprecated="not deprecated">
  8221. <doc>
  8222. <![CDATA[Get the reserved memory in MB
  8223. @return the reserved memory]]>
  8224. </doc>
  8225. </method>
  8226. <method name="setReservedMemoryMB"
  8227. abstract="true" native="false" synchronized="false"
  8228. static="false" final="false" visibility="public"
  8229. deprecated="not deprecated">
  8230. <param name="reservedMemoryMB" type="long"/>
  8231. <doc>
  8232. <![CDATA[Set the reserved memory in MB
  8233. @param reservedMemoryMB
  8234. the reserved memory]]>
  8235. </doc>
  8236. </method>
  8237. <method name="getAvailableVCores" return="long"
  8238. abstract="true" native="false" synchronized="false"
  8239. static="false" final="false" visibility="public"
  8240. deprecated="not deprecated">
  8241. <doc>
  8242. <![CDATA[Get the available vcores
  8243. @return the available vcores]]>
  8244. </doc>
  8245. </method>
  8246. <method name="setAvailableVCores"
  8247. abstract="true" native="false" synchronized="false"
  8248. static="false" final="false" visibility="public"
  8249. deprecated="not deprecated">
  8250. <param name="availableVCores" type="long"/>
  8251. <doc>
  8252. <![CDATA[Set the available vcores
  8253. @param availableVCores
  8254. the available vcores]]>
  8255. </doc>
  8256. </method>
  8257. <method name="getAllocatedVCores" return="long"
  8258. abstract="true" native="false" synchronized="false"
  8259. static="false" final="false" visibility="public"
  8260. deprecated="not deprecated">
  8261. <doc>
  8262. <![CDATA[Get the allocated vcores
  8263. @return the allocated vcores]]>
  8264. </doc>
  8265. </method>
  8266. <method name="setAllocatedVCores"
  8267. abstract="true" native="false" synchronized="false"
  8268. static="false" final="false" visibility="public"
  8269. deprecated="not deprecated">
  8270. <param name="allocatedVCores" type="long"/>
  8271. <doc>
  8272. <![CDATA[Set the allocated vcores
  8273. @param allocatedVCores
  8274. the allocated vcores]]>
  8275. </doc>
  8276. </method>
  8277. <method name="getPendingVCores" return="long"
  8278. abstract="true" native="false" synchronized="false"
  8279. static="false" final="false" visibility="public"
  8280. deprecated="not deprecated">
  8281. <doc>
  8282. <![CDATA[Get the pending vcores
  8283. @return the pending vcores]]>
  8284. </doc>
  8285. </method>
  8286. <method name="setPendingVCores"
  8287. abstract="true" native="false" synchronized="false"
  8288. static="false" final="false" visibility="public"
  8289. deprecated="not deprecated">
  8290. <param name="pendingVCores" type="long"/>
  8291. <doc>
  8292. <![CDATA[Set the pending vcores
  8293. @param pendingVCores
  8294. the pending vcores]]>
  8295. </doc>
  8296. </method>
  8297. <method name="getPendingContainers" return="long"
  8298. abstract="true" native="false" synchronized="false"
  8299. static="false" final="false" visibility="public"
  8300. deprecated="not deprecated">
  8301. <doc>
  8302. <![CDATA[Get the number of pending containers.
  8303. @return the number of pending containers.]]>
  8304. </doc>
  8305. </method>
  8306. <method name="setPendingContainers"
  8307. abstract="true" native="false" synchronized="false"
  8308. static="false" final="false" visibility="public"
  8309. deprecated="not deprecated">
  8310. <param name="pendingContainers" type="long"/>
  8311. <doc>
  8312. <![CDATA[Set the number of pending containers.
  8313. @param pendingContainers the pending containers.]]>
  8314. </doc>
  8315. </method>
  8316. <method name="getAllocatedContainers" return="long"
  8317. abstract="true" native="false" synchronized="false"
  8318. static="false" final="false" visibility="public"
  8319. deprecated="not deprecated">
  8320. <doc>
  8321. <![CDATA[Get the number of allocated containers.
  8322. @return the number of allocated containers.]]>
  8323. </doc>
  8324. </method>
  8325. <method name="setAllocatedContainers"
  8326. abstract="true" native="false" synchronized="false"
  8327. static="false" final="false" visibility="public"
  8328. deprecated="not deprecated">
  8329. <param name="allocatedContainers" type="long"/>
  8330. <doc>
  8331. <![CDATA[Set the number of allocated containers.
  8332. @param allocatedContainers the allocated containers.]]>
  8333. </doc>
  8334. </method>
  8335. <method name="getReservedContainers" return="long"
  8336. abstract="true" native="false" synchronized="false"
  8337. static="false" final="false" visibility="public"
  8338. deprecated="not deprecated">
  8339. <doc>
  8340. <![CDATA[Get the number of reserved containers.
  8341. @return the number of reserved containers.]]>
  8342. </doc>
  8343. </method>
  8344. <method name="setReservedContainers"
  8345. abstract="true" native="false" synchronized="false"
  8346. static="false" final="false" visibility="public"
  8347. deprecated="not deprecated">
  8348. <param name="reservedContainers" type="long"/>
  8349. <doc>
  8350. <![CDATA[Set the number of reserved containers.
  8351. @param reservedContainers the reserved containers.]]>
  8352. </doc>
  8353. </method>
  8354. <method name="getReservedVCores" return="long"
  8355. abstract="true" native="false" synchronized="false"
  8356. static="false" final="false" visibility="public"
  8357. deprecated="not deprecated">
  8358. <doc>
  8359. <![CDATA[Get the reserved vcores
  8360. @return the reserved vcores]]>
  8361. </doc>
  8362. </method>
  8363. <method name="setReservedVCores"
  8364. abstract="true" native="false" synchronized="false"
  8365. static="false" final="false" visibility="public"
  8366. deprecated="not deprecated">
  8367. <param name="reservedVCores" type="long"/>
  8368. <doc>
  8369. <![CDATA[Set the reserved vcores
  8370. @param reservedVCores
  8371. the reserved vcores]]>
  8372. </doc>
  8373. </method>
  8374. </class>
  8375. <!-- end class org.apache.hadoop.yarn.api.records.QueueStatistics -->
  8376. <!-- start class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
  8377. <class name="QueueUserACLInfo" extends="java.lang.Object"
  8378. abstract="true"
  8379. static="false" final="false" visibility="public"
  8380. deprecated="not deprecated">
  8381. <constructor name="QueueUserACLInfo"
  8382. static="false" final="false" visibility="public"
  8383. deprecated="not deprecated">
  8384. </constructor>
  8385. <method name="getQueueName" return="java.lang.String"
  8386. abstract="true" native="false" synchronized="false"
  8387. static="false" final="false" visibility="public"
  8388. deprecated="not deprecated">
  8389. <doc>
  8390. <![CDATA[Get the <em>queue name</em> of the queue.
  8391. @return <em>queue name</em> of the queue]]>
  8392. </doc>
  8393. </method>
  8394. <method name="getUserAcls" return="java.util.List"
  8395. abstract="true" native="false" synchronized="false"
  8396. static="false" final="false" visibility="public"
  8397. deprecated="not deprecated">
  8398. <doc>
  8399. <![CDATA[Get the list of <code>QueueACL</code> for the given user.
  8400. @return list of <code>QueueACL</code> for the given user]]>
  8401. </doc>
  8402. </method>
  8403. <doc>
  8404. <![CDATA[<p><code>QueueUserACLInfo</code> provides information {@link QueueACL} for
  8405. the given user.</p>
  8406. @see QueueACL
  8407. @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
  8408. </doc>
  8409. </class>
  8410. <!-- end class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
  8411. <!-- start class org.apache.hadoop.yarn.api.records.ReservationACL -->
  8412. <class name="ReservationACL" extends="java.lang.Enum"
  8413. abstract="false"
  8414. static="false" final="true" visibility="public"
  8415. deprecated="not deprecated">
  8416. <method name="values" return="org.apache.hadoop.yarn.api.records.ReservationACL[]"
  8417. abstract="false" native="false" synchronized="false"
  8418. static="true" final="false" visibility="public"
  8419. deprecated="not deprecated">
  8420. </method>
  8421. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ReservationACL"
  8422. abstract="false" native="false" synchronized="false"
  8423. static="true" final="false" visibility="public"
  8424. deprecated="not deprecated">
  8425. <param name="name" type="java.lang.String"/>
  8426. </method>
  8427. <doc>
  8428. <![CDATA[{@code ReservationACL} enumerates the various ACLs for reservations.
  8429. <p>
  8430. The ACL is one of:
  8431. <ul>
  8432. <li>
  8433. {@link #ADMINISTER_RESERVATIONS} - ACL to create, list, update and
  8434. delete reservations.
  8435. </li>
  8436. <li> {@link #LIST_RESERVATIONS} - ACL to list reservations. </li>
  8437. <li> {@link #SUBMIT_RESERVATIONS} - ACL to create reservations. </li>
  8438. </ul>
  8439. Users can always list, update and delete their own reservations.]]>
  8440. </doc>
  8441. </class>
  8442. <!-- end class org.apache.hadoop.yarn.api.records.ReservationACL -->
  8443. <!-- start class org.apache.hadoop.yarn.api.records.ReservationAllocationState -->
  8444. <class name="ReservationAllocationState" extends="java.lang.Object"
  8445. abstract="true"
  8446. static="false" final="false" visibility="public"
  8447. deprecated="not deprecated">
  8448. <constructor name="ReservationAllocationState"
  8449. static="false" final="false" visibility="public"
  8450. deprecated="not deprecated">
  8451. </constructor>
  8452. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationAllocationState"
  8453. abstract="false" native="false" synchronized="false"
  8454. static="true" final="false" visibility="public"
  8455. deprecated="not deprecated">
  8456. <param name="acceptanceTime" type="long"/>
  8457. <param name="user" type="java.lang.String"/>
  8458. <param name="resourceAllocations" type="java.util.List"/>
  8459. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  8460. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  8461. <doc>
  8462. <![CDATA[@param acceptanceTime The acceptance time of the reservation.
  8463. @param user The username of the user who made the reservation.
  8464. @param resourceAllocations List of {@link ResourceAllocationRequest}
  8465. representing the current state of the
  8466. reservation resource allocations. This is
  8467. subject to change in the event of re-planning.
  8468. @param reservationId {@link ReservationId } of the reservation being
  8469. listed.
  8470. @param reservationDefinition {@link ReservationDefinition} used to make
  8471. the reservation.
  8472. @return {@code ReservationAllocationState} that represents the state of
  8473. the reservation.]]>
  8474. </doc>
  8475. </method>
  8476. <method name="getAcceptanceTime" return="long"
  8477. abstract="true" native="false" synchronized="false"
  8478. static="false" final="false" visibility="public"
  8479. deprecated="not deprecated">
  8480. <doc>
  8481. <![CDATA[Get the acceptance time of the reservation.
  8482. @return the time that the reservation was accepted.]]>
  8483. </doc>
  8484. </method>
  8485. <method name="getUser" return="java.lang.String"
  8486. abstract="true" native="false" synchronized="false"
  8487. static="false" final="false" visibility="public"
  8488. deprecated="not deprecated">
  8489. <doc>
  8490. <![CDATA[Get the user who made the reservation.
  8491. @return the name of the user who made the reservation.]]>
  8492. </doc>
  8493. </method>
  8494. <method name="getResourceAllocationRequests" return="java.util.List"
  8495. abstract="true" native="false" synchronized="false"
  8496. static="false" final="false" visibility="public"
  8497. deprecated="not deprecated">
  8498. <doc>
  8499. <![CDATA[Get the Resource allocations of the reservation based on the current state
  8500. of the plan. This is subject to change in the event of re-planning.
  8501. The allocations will be constraint to the user contract as described by
  8502. the {@link ReservationDefinition}
  8503. @return a list of resource allocations for the reservation.]]>
  8504. </doc>
  8505. </method>
  8506. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  8507. abstract="true" native="false" synchronized="false"
  8508. static="false" final="false" visibility="public"
  8509. deprecated="not deprecated">
  8510. <doc>
  8511. <![CDATA[Get the id of the reservation.
  8512. @return the reservation id corresponding to the reservation.]]>
  8513. </doc>
  8514. </method>
  8515. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  8516. abstract="true" native="false" synchronized="false"
  8517. static="false" final="false" visibility="public"
  8518. deprecated="not deprecated">
  8519. <doc>
  8520. <![CDATA[Get the reservation definition used to make the reservation.
  8521. @return the reservation definition used to make the reservation.]]>
  8522. </doc>
  8523. </method>
  8524. <doc>
  8525. <![CDATA[{@code ReservationAllocationState} represents the reservation that is
  8526. made by a user.
  8527. <p>
  8528. It includes:
  8529. <ul>
  8530. <li>Duration of the reservation.</li>
  8531. <li>Acceptance time of the duration.</li>
  8532. <li>
  8533. List of {@link ResourceAllocationRequest}, which includes the time
  8534. interval, and capability of the allocation.
  8535. {@code ResourceAllocationRequest} represents an allocation
  8536. made for a reservation for the current state of the queue. This can be
  8537. changed for reasons such as re-planning, but will always be subject to
  8538. the constraints of the user contract as described by
  8539. {@link ReservationDefinition}
  8540. </li>
  8541. <li>{@link ReservationId} of the reservation.</li>
  8542. <li>{@link ReservationDefinition} used to make the reservation.</li>
  8543. </ul>
  8544. @see ResourceAllocationRequest
  8545. @see ReservationId
  8546. @see ReservationDefinition]]>
  8547. </doc>
  8548. </class>
  8549. <!-- end class org.apache.hadoop.yarn.api.records.ReservationAllocationState -->
  8550. <!-- start class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
  8551. <class name="ReservationDefinition" extends="java.lang.Object"
  8552. abstract="true"
  8553. static="false" final="false" visibility="public"
  8554. deprecated="not deprecated">
  8555. <constructor name="ReservationDefinition"
  8556. static="false" final="false" visibility="public"
  8557. deprecated="not deprecated">
  8558. </constructor>
  8559. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  8560. abstract="false" native="false" synchronized="false"
  8561. static="true" final="false" visibility="public"
  8562. deprecated="not deprecated">
  8563. <param name="arrival" type="long"/>
  8564. <param name="deadline" type="long"/>
  8565. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  8566. <param name="name" type="java.lang.String"/>
  8567. </method>
  8568. <method name="getArrival" return="long"
  8569. abstract="true" native="false" synchronized="false"
  8570. static="false" final="false" visibility="public"
  8571. deprecated="not deprecated">
  8572. <doc>
  8573. <![CDATA[Get the arrival time or the earliest time from which the resource(s) can be
  8574. allocated. Time expressed as UTC.
  8575. @return the earliest valid time for this reservation]]>
  8576. </doc>
  8577. </method>
  8578. <method name="setArrival"
  8579. abstract="true" native="false" synchronized="false"
  8580. static="false" final="false" visibility="public"
  8581. deprecated="not deprecated">
  8582. <param name="earliestStartTime" type="long"/>
  8583. <doc>
  8584. <![CDATA[Set the arrival time or the earliest time from which the resource(s) can be
  8585. allocated. Time expressed as UTC.
  8586. @param earliestStartTime the earliest valid time for this reservation]]>
  8587. </doc>
  8588. </method>
  8589. <method name="getDeadline" return="long"
  8590. abstract="true" native="false" synchronized="false"
  8591. static="false" final="false" visibility="public"
  8592. deprecated="not deprecated">
  8593. <doc>
  8594. <![CDATA[Get the deadline or the latest time by when the resource(s) must be
  8595. allocated. Time expressed as UTC.
  8596. @return the deadline or the latest time by when the resource(s) must be
  8597. allocated]]>
  8598. </doc>
  8599. </method>
  8600. <method name="setDeadline"
  8601. abstract="true" native="false" synchronized="false"
  8602. static="false" final="false" visibility="public"
  8603. deprecated="not deprecated">
  8604. <param name="latestEndTime" type="long"/>
  8605. <doc>
  8606. <![CDATA[Set the deadline or the latest time by when the resource(s) must be
  8607. allocated. Time expressed as UTC.
  8608. @param latestEndTime the deadline or the latest time by when the
  8609. resource(s) should be allocated]]>
  8610. </doc>
  8611. </method>
  8612. <method name="getReservationRequests" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
  8613. abstract="true" native="false" synchronized="false"
  8614. static="false" final="false" visibility="public"
  8615. deprecated="not deprecated">
  8616. <doc>
  8617. <![CDATA[Get the list of {@link ReservationRequests} representing the resources
  8618. required by the application
  8619. @return the list of {@link ReservationRequests}]]>
  8620. </doc>
  8621. </method>
  8622. <method name="setReservationRequests"
  8623. abstract="true" native="false" synchronized="false"
  8624. static="false" final="false" visibility="public"
  8625. deprecated="not deprecated">
  8626. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  8627. <doc>
  8628. <![CDATA[Set the list of {@link ReservationRequests} representing the resources
  8629. required by the application
  8630. @param reservationRequests the list of {@link ReservationRequests}]]>
  8631. </doc>
  8632. </method>
  8633. <method name="getReservationName" return="java.lang.String"
  8634. abstract="true" native="false" synchronized="false"
  8635. static="false" final="false" visibility="public"
  8636. deprecated="not deprecated">
  8637. <doc>
  8638. <![CDATA[Get the name for this reservation. The name need-not be unique, and it is
  8639. just a mnemonic for the user (akin to job names). Accepted reservations are
  8640. uniquely identified by a system-generated ReservationId.
  8641. @return string representing the name of the corresponding reserved resource
  8642. allocation in the scheduler]]>
  8643. </doc>
  8644. </method>
  8645. <method name="setReservationName"
  8646. abstract="true" native="false" synchronized="false"
  8647. static="false" final="false" visibility="public"
  8648. deprecated="not deprecated">
  8649. <param name="name" type="java.lang.String"/>
  8650. <doc>
  8651. <![CDATA[Set the name for this reservation. The name need-not be unique, and it is
  8652. just a mnemonic for the user (akin to job names). Accepted reservations are
  8653. uniquely identified by a system-generated ReservationId.
  8654. @param name representing the name of the corresponding reserved resource
  8655. allocation in the scheduler]]>
  8656. </doc>
  8657. </method>
  8658. <doc>
  8659. <![CDATA[{@link ReservationDefinition} captures the set of resource and time
  8660. constraints the user cares about regarding a reservation.
  8661. @see ResourceRequest]]>
  8662. </doc>
  8663. </class>
  8664. <!-- end class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
  8665. <!-- start class org.apache.hadoop.yarn.api.records.ReservationId -->
  8666. <class name="ReservationId" extends="java.lang.Object"
  8667. abstract="true"
  8668. static="false" final="false" visibility="public"
  8669. deprecated="not deprecated">
  8670. <implements name="java.lang.Comparable"/>
  8671. <constructor name="ReservationId"
  8672. static="false" final="false" visibility="public"
  8673. deprecated="not deprecated">
  8674. </constructor>
  8675. <method name="getId" return="long"
  8676. abstract="true" native="false" synchronized="false"
  8677. static="false" final="false" visibility="public"
  8678. deprecated="not deprecated">
  8679. <doc>
  8680. <![CDATA[Get the long identifier of the {@link ReservationId} which is unique for
  8681. all Reservations started by a particular instance of the
  8682. {@code ResourceManager}.
  8683. @return long identifier of the {@link ReservationId}]]>
  8684. </doc>
  8685. </method>
  8686. <method name="getClusterTimestamp" return="long"
  8687. abstract="true" native="false" synchronized="false"
  8688. static="false" final="false" visibility="public"
  8689. deprecated="not deprecated">
  8690. <doc>
  8691. <![CDATA[Get the <em>start time</em> of the {@code ResourceManager} which is used to
  8692. generate globally unique {@link ReservationId}.
  8693. @return <em>start time</em> of the {@code ResourceManager}]]>
  8694. </doc>
  8695. </method>
  8696. <method name="build"
  8697. abstract="true" native="false" synchronized="false"
  8698. static="false" final="false" visibility="protected"
  8699. deprecated="not deprecated">
  8700. </method>
  8701. <method name="compareTo" return="int"
  8702. abstract="false" native="false" synchronized="false"
  8703. static="false" final="false" visibility="public"
  8704. deprecated="not deprecated">
  8705. <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  8706. </method>
  8707. <method name="toString" return="java.lang.String"
  8708. abstract="false" native="false" synchronized="false"
  8709. static="false" final="false" visibility="public"
  8710. deprecated="not deprecated">
  8711. </method>
  8712. <method name="parseReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  8713. abstract="false" native="false" synchronized="false"
  8714. static="true" final="false" visibility="public"
  8715. deprecated="not deprecated">
  8716. <param name="reservationId" type="java.lang.String"/>
  8717. <exception name="IOException" type="java.io.IOException"/>
  8718. <doc>
  8719. <![CDATA[Parse the string argument as a {@link ReservationId}
  8720. @param reservationId the string representation of the {@link ReservationId}
  8721. @return the {@link ReservationId} corresponding to the input string if
  8722. valid, null if input is null
  8723. @throws IOException if unable to parse the input string]]>
  8724. </doc>
  8725. </method>
  8726. <method name="hashCode" return="int"
  8727. abstract="false" native="false" synchronized="false"
  8728. static="false" final="false" visibility="public"
  8729. deprecated="not deprecated">
  8730. </method>
  8731. <method name="equals" return="boolean"
  8732. abstract="false" native="false" synchronized="false"
  8733. static="false" final="false" visibility="public"
  8734. deprecated="not deprecated">
  8735. <param name="obj" type="java.lang.Object"/>
  8736. </method>
  8737. <field name="reserveIdStrPrefix" type="java.lang.String"
  8738. transient="false" volatile="false"
  8739. static="true" final="true" visibility="public"
  8740. deprecated="not deprecated">
  8741. </field>
  8742. <field name="clusterTimestamp" type="long"
  8743. transient="false" volatile="false"
  8744. static="false" final="false" visibility="protected"
  8745. deprecated="not deprecated">
  8746. </field>
  8747. <field name="id" type="long"
  8748. transient="false" volatile="false"
  8749. static="false" final="false" visibility="protected"
  8750. deprecated="not deprecated">
  8751. </field>
  8752. <doc>
  8753. <![CDATA[<p>
  8754. {@link ReservationId} represents the <em>globally unique</em> identifier for
  8755. a reservation.
  8756. </p>
  8757. <p>
  8758. The globally unique nature of the identifier is achieved by using the
  8759. <em>cluster timestamp</em> i.e. start-time of the {@code ResourceManager}
  8760. along with a monotonically increasing counter for the reservation.
  8761. </p>]]>
  8762. </doc>
  8763. </class>
  8764. <!-- end class org.apache.hadoop.yarn.api.records.ReservationId -->
  8765. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest -->
  8766. <class name="ReservationRequest" extends="java.lang.Object"
  8767. abstract="true"
  8768. static="false" final="false" visibility="public"
  8769. deprecated="not deprecated">
  8770. <implements name="java.lang.Comparable"/>
  8771. <constructor name="ReservationRequest"
  8772. static="false" final="false" visibility="public"
  8773. deprecated="not deprecated">
  8774. </constructor>
  8775. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
  8776. abstract="false" native="false" synchronized="false"
  8777. static="true" final="false" visibility="public"
  8778. deprecated="not deprecated">
  8779. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  8780. <param name="numContainers" type="int"/>
  8781. </method>
  8782. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
  8783. abstract="false" native="false" synchronized="false"
  8784. static="true" final="false" visibility="public"
  8785. deprecated="not deprecated">
  8786. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  8787. <param name="numContainers" type="int"/>
  8788. <param name="concurrency" type="int"/>
  8789. <param name="duration" type="long"/>
  8790. </method>
  8791. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  8792. abstract="true" native="false" synchronized="false"
  8793. static="false" final="false" visibility="public"
  8794. deprecated="not deprecated">
  8795. <doc>
  8796. <![CDATA[Get the {@link Resource} capability of the request.
  8797. @return {@link Resource} capability of the request]]>
  8798. </doc>
  8799. </method>
  8800. <method name="setCapability"
  8801. abstract="true" native="false" synchronized="false"
  8802. static="false" final="false" visibility="public"
  8803. deprecated="not deprecated">
  8804. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  8805. <doc>
  8806. <![CDATA[Set the {@link Resource} capability of the request
  8807. @param capability {@link Resource} capability of the request]]>
  8808. </doc>
  8809. </method>
  8810. <method name="getNumContainers" return="int"
  8811. abstract="true" native="false" synchronized="false"
  8812. static="false" final="false" visibility="public"
  8813. deprecated="not deprecated">
  8814. <doc>
  8815. <![CDATA[Get the number of containers required with the given specifications.
  8816. @return number of containers required with the given specifications]]>
  8817. </doc>
  8818. </method>
  8819. <method name="setNumContainers"
  8820. abstract="true" native="false" synchronized="false"
  8821. static="false" final="false" visibility="public"
  8822. deprecated="not deprecated">
  8823. <param name="numContainers" type="int"/>
  8824. <doc>
  8825. <![CDATA[Set the number of containers required with the given specifications
  8826. @param numContainers number of containers required with the given
  8827. specifications]]>
  8828. </doc>
  8829. </method>
  8830. <method name="getConcurrency" return="int"
  8831. abstract="true" native="false" synchronized="false"
  8832. static="false" final="false" visibility="public"
  8833. deprecated="not deprecated">
  8834. <doc>
  8835. <![CDATA[Get the number of containers that need to be scheduled concurrently. The
  8836. default value of 1 would fall back to the current non concurrency
  8837. constraints on the scheduling behavior.
  8838. @return the number of containers to be concurrently scheduled]]>
  8839. </doc>
  8840. </method>
  8841. <method name="setConcurrency"
  8842. abstract="true" native="false" synchronized="false"
  8843. static="false" final="false" visibility="public"
  8844. deprecated="not deprecated">
  8845. <param name="numContainers" type="int"/>
  8846. <doc>
  8847. <![CDATA[Set the number of containers that need to be scheduled concurrently. The
  8848. default value of 1 would fall back to the current non concurrency
  8849. constraints on the scheduling behavior.
  8850. @param numContainers the number of containers to be concurrently scheduled]]>
  8851. </doc>
  8852. </method>
  8853. <method name="getDuration" return="long"
  8854. abstract="true" native="false" synchronized="false"
  8855. static="false" final="false" visibility="public"
  8856. deprecated="not deprecated">
  8857. <doc>
  8858. <![CDATA[Get the duration in milliseconds for which the resource is required. A
  8859. default value of -1, indicates an unspecified lease duration, and fallback
  8860. to current behavior.
  8861. @return the duration in milliseconds for which the resource is required]]>
  8862. </doc>
  8863. </method>
  8864. <method name="setDuration"
  8865. abstract="true" native="false" synchronized="false"
  8866. static="false" final="false" visibility="public"
  8867. deprecated="not deprecated">
  8868. <param name="duration" type="long"/>
  8869. <doc>
  8870. <![CDATA[Set the duration in milliseconds for which the resource is required.
  8871. @param duration the duration in milliseconds for which the resource is
  8872. required]]>
  8873. </doc>
  8874. </method>
  8875. <method name="hashCode" return="int"
  8876. abstract="false" native="false" synchronized="false"
  8877. static="false" final="false" visibility="public"
  8878. deprecated="not deprecated">
  8879. </method>
  8880. <method name="equals" return="boolean"
  8881. abstract="false" native="false" synchronized="false"
  8882. static="false" final="false" visibility="public"
  8883. deprecated="not deprecated">
  8884. <param name="obj" type="java.lang.Object"/>
  8885. </method>
  8886. <method name="compareTo" return="int"
  8887. abstract="false" native="false" synchronized="false"
  8888. static="false" final="false" visibility="public"
  8889. deprecated="not deprecated">
  8890. <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  8891. </method>
  8892. <doc>
  8893. <![CDATA[{@link ReservationRequest} represents the request made by an application to
  8894. the {@code ResourceManager} to reserve {@link Resource}s.
  8895. <p>
  8896. It includes:
  8897. <ul>
  8898. <li>{@link Resource} required for each request.</li>
  8899. <li>
  8900. Number of containers, of above specifications, which are required by the
  8901. application.
  8902. </li>
  8903. <li>Concurrency that indicates the gang size of the request.</li>
  8904. </ul>]]>
  8905. </doc>
  8906. </class>
  8907. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest -->
  8908. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
  8909. <class name="ReservationRequest.ReservationRequestComparator" extends="java.lang.Object"
  8910. abstract="false"
  8911. static="true" final="false" visibility="public"
  8912. deprecated="not deprecated">
  8913. <implements name="java.util.Comparator"/>
  8914. <implements name="java.io.Serializable"/>
  8915. <constructor name="ReservationRequestComparator"
  8916. static="false" final="false" visibility="public"
  8917. deprecated="not deprecated">
  8918. </constructor>
  8919. <method name="compare" return="int"
  8920. abstract="false" native="false" synchronized="false"
  8921. static="false" final="false" visibility="public"
  8922. deprecated="not deprecated">
  8923. <param name="r1" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  8924. <param name="r2" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  8925. </method>
  8926. </class>
  8927. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
  8928. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
  8929. <class name="ReservationRequestInterpreter" extends="java.lang.Enum"
  8930. abstract="false"
  8931. static="false" final="true" visibility="public"
  8932. deprecated="not deprecated">
  8933. <method name="values" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter[]"
  8934. abstract="false" native="false" synchronized="false"
  8935. static="true" final="false" visibility="public"
  8936. deprecated="not deprecated">
  8937. </method>
  8938. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
  8939. abstract="false" native="false" synchronized="false"
  8940. static="true" final="false" visibility="public"
  8941. deprecated="not deprecated">
  8942. <param name="name" type="java.lang.String"/>
  8943. </method>
  8944. <doc>
  8945. <![CDATA[Enumeration of various types of dependencies among multiple
  8946. {@link ReservationRequests} within one {@link ReservationDefinition} (from
  8947. least constraining to most constraining).]]>
  8948. </doc>
  8949. </class>
  8950. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
  8951. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequests -->
  8952. <class name="ReservationRequests" extends="java.lang.Object"
  8953. abstract="true"
  8954. static="false" final="false" visibility="public"
  8955. deprecated="not deprecated">
  8956. <constructor name="ReservationRequests"
  8957. static="false" final="false" visibility="public"
  8958. deprecated="not deprecated">
  8959. </constructor>
  8960. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
  8961. abstract="false" native="false" synchronized="false"
  8962. static="true" final="false" visibility="public"
  8963. deprecated="not deprecated">
  8964. <param name="reservationResources" type="java.util.List"/>
  8965. <param name="type" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
  8966. </method>
  8967. <method name="getReservationResources" return="java.util.List"
  8968. abstract="true" native="false" synchronized="false"
  8969. static="false" final="false" visibility="public"
  8970. deprecated="not deprecated">
  8971. <doc>
  8972. <![CDATA[Get the list of {@link ReservationRequest} representing the resources
  8973. required by the application
  8974. @return the list of {@link ReservationRequest}]]>
  8975. </doc>
  8976. </method>
  8977. <method name="setReservationResources"
  8978. abstract="true" native="false" synchronized="false"
  8979. static="false" final="false" visibility="public"
  8980. deprecated="not deprecated">
  8981. <param name="reservationResources" type="java.util.List"/>
  8982. <doc>
  8983. <![CDATA[Set the list of {@link ReservationRequest} representing the resources
  8984. required by the application
  8985. @param reservationResources the list of {@link ReservationRequest}]]>
  8986. </doc>
  8987. </method>
  8988. <method name="getInterpreter" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
  8989. abstract="true" native="false" synchronized="false"
  8990. static="false" final="false" visibility="public"
  8991. deprecated="not deprecated">
  8992. <doc>
  8993. <![CDATA[Get the {@link ReservationRequestInterpreter}, representing how the list of
  8994. resources should be allocated, this captures temporal ordering and other
  8995. constraints.
  8996. @return the list of {@link ReservationRequestInterpreter}]]>
  8997. </doc>
  8998. </method>
  8999. <method name="setInterpreter"
  9000. abstract="true" native="false" synchronized="false"
  9001. static="false" final="false" visibility="public"
  9002. deprecated="not deprecated">
  9003. <param name="interpreter" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
  9004. <doc>
  9005. <![CDATA[Set the {@link ReservationRequestInterpreter}, representing how the list of
  9006. resources should be allocated, this captures temporal ordering and other
  9007. constraints.
  9008. @param interpreter the {@link ReservationRequestInterpreter} for this
  9009. reservation]]>
  9010. </doc>
  9011. </method>
  9012. <doc>
  9013. <![CDATA[{@link ReservationRequests} captures the set of resource and constraints the
  9014. user cares about regarding a reservation.
  9015. @see ReservationRequest]]>
  9016. </doc>
  9017. </class>
  9018. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequests -->
  9019. <!-- start class org.apache.hadoop.yarn.api.records.Resource -->
  9020. <class name="Resource" extends="java.lang.Object"
  9021. abstract="true"
  9022. static="false" final="false" visibility="public"
  9023. deprecated="not deprecated">
  9024. <implements name="java.lang.Comparable"/>
  9025. <constructor name="Resource"
  9026. static="false" final="false" visibility="public"
  9027. deprecated="not deprecated">
  9028. </constructor>
  9029. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
  9030. abstract="false" native="false" synchronized="false"
  9031. static="true" final="false" visibility="public"
  9032. deprecated="not deprecated">
  9033. <param name="memory" type="int"/>
  9034. <param name="vCores" type="int"/>
  9035. </method>
  9036. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
  9037. abstract="false" native="false" synchronized="false"
  9038. static="true" final="false" visibility="public"
  9039. deprecated="not deprecated">
  9040. <param name="memory" type="long"/>
  9041. <param name="vCores" type="int"/>
  9042. </method>
  9043. <method name="getMemory" return="int"
  9044. abstract="true" native="false" synchronized="false"
  9045. static="false" final="false" visibility="public"
  9046. deprecated="not deprecated">
  9047. <doc>
  9048. <![CDATA[This method is DEPRECATED:
  9049. Use {@link Resource#getMemorySize()} instead
  9050. Get <em>memory</em> of the resource.
  9051. @return <em>memory</em> of the resource]]>
  9052. </doc>
  9053. </method>
  9054. <method name="getMemorySize" return="long"
  9055. abstract="false" native="false" synchronized="false"
  9056. static="false" final="false" visibility="public"
  9057. deprecated="not deprecated">
  9058. <doc>
  9059. <![CDATA[Get <em>memory</em> of the resource.
  9060. @return <em>memory</em> of the resource]]>
  9061. </doc>
  9062. </method>
  9063. <method name="setMemory"
  9064. abstract="true" native="false" synchronized="false"
  9065. static="false" final="false" visibility="public"
  9066. deprecated="not deprecated">
  9067. <param name="memory" type="int"/>
  9068. <doc>
  9069. <![CDATA[Set <em>memory</em> of the resource.
  9070. @param memory <em>memory</em> of the resource]]>
  9071. </doc>
  9072. </method>
  9073. <method name="setMemorySize"
  9074. abstract="false" native="false" synchronized="false"
  9075. static="false" final="false" visibility="public"
  9076. deprecated="not deprecated">
  9077. <param name="memory" type="long"/>
  9078. <doc>
  9079. <![CDATA[Set <em>memory</em> of the resource.
  9080. @param memory <em>memory</em> of the resource]]>
  9081. </doc>
  9082. </method>
  9083. <method name="getVirtualCores" return="int"
  9084. abstract="true" native="false" synchronized="false"
  9085. static="false" final="false" visibility="public"
  9086. deprecated="not deprecated">
  9087. <doc>
  9088. <![CDATA[Get <em>number of virtual cpu cores</em> of the resource.
  9089. Virtual cores are a unit for expressing CPU parallelism. A node's capacity
  9090. should be configured with virtual cores equal to its number of physical cores.
  9091. A container should be requested with the number of cores it can saturate, i.e.
  9092. the average number of threads it expects to have runnable at a time.
  9093. @return <em>num of virtual cpu cores</em> of the resource]]>
  9094. </doc>
  9095. </method>
  9096. <method name="setVirtualCores"
  9097. abstract="true" native="false" synchronized="false"
  9098. static="false" final="false" visibility="public"
  9099. deprecated="not deprecated">
  9100. <param name="vCores" type="int"/>
  9101. <doc>
  9102. <![CDATA[Set <em>number of virtual cpu cores</em> of the resource.
  9103. Virtual cores are a unit for expressing CPU parallelism. A node's capacity
  9104. should be configured with virtual cores equal to its number of physical cores.
  9105. A container should be requested with the number of cores it can saturate, i.e.
  9106. the average number of threads it expects to have runnable at a time.
  9107. @param vCores <em>number of virtual cpu cores</em> of the resource]]>
  9108. </doc>
  9109. </method>
  9110. <method name="hashCode" return="int"
  9111. abstract="false" native="false" synchronized="false"
  9112. static="false" final="false" visibility="public"
  9113. deprecated="not deprecated">
  9114. </method>
  9115. <method name="equals" return="boolean"
  9116. abstract="false" native="false" synchronized="false"
  9117. static="false" final="false" visibility="public"
  9118. deprecated="not deprecated">
  9119. <param name="obj" type="java.lang.Object"/>
  9120. </method>
  9121. <method name="toString" return="java.lang.String"
  9122. abstract="false" native="false" synchronized="false"
  9123. static="false" final="false" visibility="public"
  9124. deprecated="not deprecated">
  9125. </method>
  9126. <doc>
  9127. <![CDATA[<p><code>Resource</code> models a set of computer resources in the
  9128. cluster.</p>
  9129. <p>Currently it models both <em>memory</em> and <em>CPU</em>.</p>
  9130. <p>The unit for memory is megabytes. CPU is modeled with virtual cores
  9131. (vcores), a unit for expressing parallelism. A node's capacity should
  9132. be configured with virtual cores equal to its number of physical cores. A
  9133. container should be requested with the number of cores it can saturate, i.e.
  9134. the average number of threads it expects to have runnable at a time.</p>
  9135. <p>Virtual cores take integer values and thus currently CPU-scheduling is
  9136. very coarse. A complementary axis for CPU requests that represents processing
  9137. power will likely be added in the future to enable finer-grained resource
  9138. configuration.</p>
  9139. <p>Typically, applications request <code>Resource</code> of suitable
  9140. capability to run their component tasks.</p>
  9141. @see ResourceRequest
  9142. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  9143. </doc>
  9144. </class>
  9145. <!-- end class org.apache.hadoop.yarn.api.records.Resource -->
  9146. <!-- start class org.apache.hadoop.yarn.api.records.ResourceAllocationRequest -->
  9147. <class name="ResourceAllocationRequest" extends="java.lang.Object"
  9148. abstract="true"
  9149. static="false" final="false" visibility="public"
  9150. deprecated="not deprecated">
  9151. <constructor name="ResourceAllocationRequest"
  9152. static="false" final="false" visibility="public"
  9153. deprecated="not deprecated">
  9154. </constructor>
  9155. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceAllocationRequest"
  9156. abstract="false" native="false" synchronized="false"
  9157. static="true" final="false" visibility="public"
  9158. deprecated="not deprecated">
  9159. <param name="startTime" type="long"/>
  9160. <param name="endTime" type="long"/>
  9161. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  9162. <doc>
  9163. <![CDATA[@param startTime The start time that the capability is reserved for.
  9164. @param endTime The end time that the capability is reserved for.
  9165. @param capability {@link Resource} representing the capability of the
  9166. resource allocation.
  9167. @return {ResourceAllocationRequest} which represents the capability of
  9168. the resource allocation for a time interval.]]>
  9169. </doc>
  9170. </method>
  9171. <method name="getStartTime" return="long"
  9172. abstract="true" native="false" synchronized="false"
  9173. static="false" final="false" visibility="public"
  9174. deprecated="not deprecated">
  9175. <doc>
  9176. <![CDATA[Get the start time that the resource is allocated.
  9177. @return the start time that the resource is allocated.]]>
  9178. </doc>
  9179. </method>
  9180. <method name="getEndTime" return="long"
  9181. abstract="true" native="false" synchronized="false"
  9182. static="false" final="false" visibility="public"
  9183. deprecated="not deprecated">
  9184. <doc>
  9185. <![CDATA[Get the end time that the resource is allocated.
  9186. @return the end time that the resource is allocated.]]>
  9187. </doc>
  9188. </method>
  9189. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  9190. abstract="true" native="false" synchronized="false"
  9191. static="false" final="false" visibility="public"
  9192. deprecated="not deprecated">
  9193. <doc>
  9194. <![CDATA[Get the allocated resource.
  9195. @return the allocated resource.]]>
  9196. </doc>
  9197. </method>
  9198. <doc>
  9199. <![CDATA[{@code ResourceAllocationRequest} represents an allocation
  9200. made for a reservation for the current state of the plan. This can be
  9201. changed for reasons such as re-planning, but will always be subject to the
  9202. constraints of the user contract as described by
  9203. {@link ReservationDefinition}
  9204. {@link Resource}
  9205. <p>
  9206. It includes:
  9207. <ul>
  9208. <li>StartTime of the allocation.</li>
  9209. <li>EndTime of the allocation.</li>
  9210. <li>{@link Resource} reserved for the allocation.</li>
  9211. </ul>
  9212. @see Resource]]>
  9213. </doc>
  9214. </class>
  9215. <!-- end class org.apache.hadoop.yarn.api.records.ResourceAllocationRequest -->
  9216. <!-- start class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
  9217. <class name="ResourceBlacklistRequest" extends="java.lang.Object"
  9218. abstract="true"
  9219. static="false" final="false" visibility="public"
  9220. deprecated="not deprecated">
  9221. <constructor name="ResourceBlacklistRequest"
  9222. static="false" final="false" visibility="public"
  9223. deprecated="not deprecated">
  9224. </constructor>
  9225. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
  9226. abstract="false" native="false" synchronized="false"
  9227. static="true" final="false" visibility="public"
  9228. deprecated="not deprecated">
  9229. <param name="additions" type="java.util.List"/>
  9230. <param name="removals" type="java.util.List"/>
  9231. </method>
  9232. <method name="getBlacklistAdditions" return="java.util.List"
  9233. abstract="true" native="false" synchronized="false"
  9234. static="false" final="false" visibility="public"
  9235. deprecated="not deprecated">
  9236. <doc>
  9237. <![CDATA[Get the list of resource-names which should be added to the
  9238. application blacklist.
  9239. @return list of resource-names which should be added to the
  9240. application blacklist]]>
  9241. </doc>
  9242. </method>
  9243. <method name="setBlacklistAdditions"
  9244. abstract="true" native="false" synchronized="false"
  9245. static="false" final="false" visibility="public"
  9246. deprecated="not deprecated">
  9247. <param name="resourceNames" type="java.util.List"/>
  9248. <doc>
  9249. <![CDATA[Set list of resource-names which should be added to the application blacklist.
  9250. @param resourceNames list of resource-names which should be added to the
  9251. application blacklist]]>
  9252. </doc>
  9253. </method>
  9254. <method name="getBlacklistRemovals" return="java.util.List"
  9255. abstract="true" native="false" synchronized="false"
  9256. static="false" final="false" visibility="public"
  9257. deprecated="not deprecated">
  9258. <doc>
  9259. <![CDATA[Get the list of resource-names which should be removed from the
  9260. application blacklist.
  9261. @return list of resource-names which should be removed from the
  9262. application blacklist]]>
  9263. </doc>
  9264. </method>
  9265. <method name="setBlacklistRemovals"
  9266. abstract="true" native="false" synchronized="false"
  9267. static="false" final="false" visibility="public"
  9268. deprecated="not deprecated">
  9269. <param name="resourceNames" type="java.util.List"/>
  9270. <doc>
  9271. <![CDATA[Set list of resource-names which should be removed from the
  9272. application blacklist.
  9273. @param resourceNames list of resource-names which should be removed from the
  9274. application blacklist]]>
  9275. </doc>
  9276. </method>
  9277. <doc>
  9278. <![CDATA[{@link ResourceBlacklistRequest} encapsulates the list of resource-names
  9279. which should be added or removed from the <em>blacklist</em> of resources
  9280. for the application.
  9281. @see ResourceRequest
  9282. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  9283. </doc>
  9284. </class>
  9285. <!-- end class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
  9286. <!-- start class org.apache.hadoop.yarn.api.records.ResourceOption -->
  9287. <class name="ResourceOption" extends="java.lang.Object"
  9288. abstract="true"
  9289. static="false" final="false" visibility="public"
  9290. deprecated="not deprecated">
  9291. <constructor name="ResourceOption"
  9292. static="false" final="false" visibility="public"
  9293. deprecated="not deprecated">
  9294. </constructor>
  9295. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceOption"
  9296. abstract="false" native="false" synchronized="false"
  9297. static="true" final="false" visibility="public"
  9298. deprecated="not deprecated">
  9299. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  9300. <param name="overCommitTimeout" type="int"/>
  9301. </method>
  9302. <method name="toString" return="java.lang.String"
  9303. abstract="false" native="false" synchronized="false"
  9304. static="false" final="false" visibility="public"
  9305. deprecated="not deprecated">
  9306. </method>
  9307. <field name="OVER_COMMIT_TIMEOUT_MILLIS_DEFAULT" type="int"
  9308. transient="false" volatile="false"
  9309. static="true" final="true" visibility="public"
  9310. deprecated="not deprecated">
  9311. <doc>
  9312. <![CDATA[Negative value means no timeout.]]>
  9313. </doc>
  9314. </field>
  9315. </class>
  9316. <!-- end class org.apache.hadoop.yarn.api.records.ResourceOption -->
  9317. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest -->
  9318. <class name="ResourceRequest" extends="java.lang.Object"
  9319. abstract="true"
  9320. static="false" final="false" visibility="public"
  9321. deprecated="not deprecated">
  9322. <implements name="java.lang.Comparable"/>
  9323. <constructor name="ResourceRequest"
  9324. static="false" final="false" visibility="public"
  9325. deprecated="not deprecated">
  9326. </constructor>
  9327. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  9328. abstract="false" native="false" synchronized="false"
  9329. static="true" final="false" visibility="public"
  9330. deprecated="not deprecated">
  9331. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  9332. <param name="hostName" type="java.lang.String"/>
  9333. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  9334. <param name="numContainers" type="int"/>
  9335. </method>
  9336. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  9337. abstract="false" native="false" synchronized="false"
  9338. static="true" final="false" visibility="public"
  9339. deprecated="not deprecated">
  9340. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  9341. <param name="hostName" type="java.lang.String"/>
  9342. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  9343. <param name="numContainers" type="int"/>
  9344. <param name="relaxLocality" type="boolean"/>
  9345. </method>
  9346. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  9347. abstract="false" native="false" synchronized="false"
  9348. static="true" final="false" visibility="public"
  9349. deprecated="not deprecated">
  9350. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  9351. <param name="hostName" type="java.lang.String"/>
  9352. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  9353. <param name="numContainers" type="int"/>
  9354. <param name="relaxLocality" type="boolean"/>
  9355. <param name="labelExpression" type="java.lang.String"/>
  9356. </method>
  9357. <method name="isAnyLocation" return="boolean"
  9358. abstract="false" native="false" synchronized="false"
  9359. static="true" final="false" visibility="public"
  9360. deprecated="not deprecated">
  9361. <param name="hostName" type="java.lang.String"/>
  9362. <doc>
  9363. <![CDATA[Check whether the given <em>host/rack</em> string represents an arbitrary
  9364. host name.
  9365. @param hostName <em>host/rack</em> on which the allocation is desired
  9366. @return whether the given <em>host/rack</em> string represents an arbitrary
  9367. host name]]>
  9368. </doc>
  9369. </method>
  9370. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  9371. abstract="true" native="false" synchronized="false"
  9372. static="false" final="false" visibility="public"
  9373. deprecated="not deprecated">
  9374. <doc>
  9375. <![CDATA[Get the <code>Priority</code> of the request.
  9376. @return <code>Priority</code> of the request]]>
  9377. </doc>
  9378. </method>
  9379. <method name="setPriority"
  9380. abstract="true" native="false" synchronized="false"
  9381. static="false" final="false" visibility="public"
  9382. deprecated="not deprecated">
  9383. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  9384. <doc>
  9385. <![CDATA[Set the <code>Priority</code> of the request
  9386. @param priority <code>Priority</code> of the request]]>
  9387. </doc>
  9388. </method>
  9389. <method name="getResourceName" return="java.lang.String"
  9390. abstract="true" native="false" synchronized="false"
  9391. static="false" final="false" visibility="public"
  9392. deprecated="not deprecated">
  9393. <doc>
  9394. <![CDATA[Get the resource (e.g. <em>host/rack</em>) on which the allocation
  9395. is desired.
  9396. A special value of <em>*</em> signifies that <em>any</em> resource
  9397. (host/rack) is acceptable.
  9398. @return resource (e.g. <em>host/rack</em>) on which the allocation
  9399. is desired]]>
  9400. </doc>
  9401. </method>
  9402. <method name="setResourceName"
  9403. abstract="true" native="false" synchronized="false"
  9404. static="false" final="false" visibility="public"
  9405. deprecated="not deprecated">
  9406. <param name="resourceName" type="java.lang.String"/>
  9407. <doc>
  9408. <![CDATA[Set the resource name (e.g. <em>host/rack</em>) on which the allocation
  9409. is desired.
  9410. A special value of <em>*</em> signifies that <em>any</em> resource name
  9411. (e.g. host/rack) is acceptable.
  9412. @param resourceName (e.g. <em>host/rack</em>) on which the
  9413. allocation is desired]]>
  9414. </doc>
  9415. </method>
  9416. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  9417. abstract="true" native="false" synchronized="false"
  9418. static="false" final="false" visibility="public"
  9419. deprecated="not deprecated">
  9420. <doc>
  9421. <![CDATA[Get the <code>Resource</code> capability of the request.
  9422. @return <code>Resource</code> capability of the request]]>
  9423. </doc>
  9424. </method>
  9425. <method name="setCapability"
  9426. abstract="true" native="false" synchronized="false"
  9427. static="false" final="false" visibility="public"
  9428. deprecated="not deprecated">
  9429. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  9430. <doc>
  9431. <![CDATA[Set the <code>Resource</code> capability of the request
  9432. @param capability <code>Resource</code> capability of the request]]>
  9433. </doc>
  9434. </method>
  9435. <method name="getNumContainers" return="int"
  9436. abstract="true" native="false" synchronized="false"
  9437. static="false" final="false" visibility="public"
  9438. deprecated="not deprecated">
  9439. <doc>
  9440. <![CDATA[Get the number of containers required with the given specifications.
  9441. @return number of containers required with the given specifications]]>
  9442. </doc>
  9443. </method>
  9444. <method name="setNumContainers"
  9445. abstract="true" native="false" synchronized="false"
  9446. static="false" final="false" visibility="public"
  9447. deprecated="not deprecated">
  9448. <param name="numContainers" type="int"/>
  9449. <doc>
  9450. <![CDATA[Set the number of containers required with the given specifications
  9451. @param numContainers number of containers required with the given
  9452. specifications]]>
  9453. </doc>
  9454. </method>
  9455. <method name="getRelaxLocality" return="boolean"
  9456. abstract="true" native="false" synchronized="false"
  9457. static="false" final="false" visibility="public"
  9458. deprecated="not deprecated">
  9459. <doc>
  9460. <![CDATA[Get whether locality relaxation is enabled with this
  9461. <code>ResourceRequest</code>. Defaults to true.
  9462. @return whether locality relaxation is enabled with this
  9463. <code>ResourceRequest</code>.]]>
  9464. </doc>
  9465. </method>
  9466. <method name="setRelaxLocality"
  9467. abstract="true" native="false" synchronized="false"
  9468. static="false" final="false" visibility="public"
  9469. deprecated="not deprecated">
  9470. <param name="relaxLocality" type="boolean"/>
  9471. <doc>
  9472. <![CDATA[<p>For a request at a network hierarchy level, set whether locality can be relaxed
  9473. to that level and beyond.<p>
  9474. <p>If the flag is off on a rack-level <code>ResourceRequest</code>,
  9475. containers at that request's priority will not be assigned to nodes on that
  9476. request's rack unless requests specifically for those nodes have also been
  9477. submitted.<p>
  9478. <p>If the flag is off on an {@link ResourceRequest#ANY}-level
  9479. <code>ResourceRequest</code>, containers at that request's priority will
  9480. only be assigned on racks for which specific requests have also been
  9481. submitted.<p>
  9482. <p>For example, to request a container strictly on a specific node, the
  9483. corresponding rack-level and any-level requests should have locality
  9484. relaxation set to false. Similarly, to request a container strictly on a
  9485. specific rack, the corresponding any-level request should have locality
  9486. relaxation set to false.<p>
  9487. @param relaxLocality whether locality relaxation is enabled with this
  9488. <code>ResourceRequest</code>.]]>
  9489. </doc>
  9490. </method>
  9491. <method name="getNodeLabelExpression" return="java.lang.String"
  9492. abstract="true" native="false" synchronized="false"
  9493. static="false" final="false" visibility="public"
  9494. deprecated="not deprecated">
  9495. <doc>
  9496. <![CDATA[Get node-label-expression for this Resource Request. If this is set, all
  9497. containers allocated to satisfy this resource-request will be only on those
  9498. nodes that satisfy this node-label-expression.
  9499. Please note that node label expression now can only take effect when the
  9500. resource request has resourceName = ANY
  9501. @return node-label-expression]]>
  9502. </doc>
  9503. </method>
  9504. <method name="setNodeLabelExpression"
  9505. abstract="true" native="false" synchronized="false"
  9506. static="false" final="false" visibility="public"
  9507. deprecated="not deprecated">
  9508. <param name="nodelabelExpression" type="java.lang.String"/>
  9509. <doc>
  9510. <![CDATA[Set node label expression of this resource request. Now only support
  9511. specifying a single node label. In the future we will support more complex
  9512. node label expression specification like {@code AND(&&), OR(||)}, etc.
  9513. Any please note that node label expression now can only take effect when
  9514. the resource request has resourceName = ANY
  9515. @param nodelabelExpression
  9516. node-label-expression of this ResourceRequest]]>
  9517. </doc>
  9518. </method>
  9519. <method name="hashCode" return="int"
  9520. abstract="false" native="false" synchronized="false"
  9521. static="false" final="false" visibility="public"
  9522. deprecated="not deprecated">
  9523. </method>
  9524. <method name="equals" return="boolean"
  9525. abstract="false" native="false" synchronized="false"
  9526. static="false" final="false" visibility="public"
  9527. deprecated="not deprecated">
  9528. <param name="obj" type="java.lang.Object"/>
  9529. </method>
  9530. <method name="compareTo" return="int"
  9531. abstract="false" native="false" synchronized="false"
  9532. static="false" final="false" visibility="public"
  9533. deprecated="not deprecated">
  9534. <param name="other" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  9535. </method>
  9536. <field name="ANY" type="java.lang.String"
  9537. transient="false" volatile="false"
  9538. static="true" final="true" visibility="public"
  9539. deprecated="not deprecated">
  9540. <doc>
  9541. <![CDATA[The constant string representing no locality.
  9542. It should be used by all references that want to pass an arbitrary host
  9543. name in.]]>
  9544. </doc>
  9545. </field>
  9546. <doc>
  9547. <![CDATA[{@code ResourceRequest} represents the request made
  9548. by an application to the {@code ResourceManager}
  9549. to obtain various {@code Container} allocations.
  9550. <p>
  9551. It includes:
  9552. <ul>
  9553. <li>{@link Priority} of the request.</li>
  9554. <li>
  9555. The <em>name</em> of the machine or rack on which the allocation is
  9556. desired. A special value of <em>*</em> signifies that
  9557. <em>any</em> host/rack is acceptable to the application.
  9558. </li>
  9559. <li>{@link Resource} required for each request.</li>
  9560. <li>
  9561. Number of containers, of above specifications, which are required
  9562. by the application.
  9563. </li>
  9564. <li>
  9565. A boolean <em>relaxLocality</em> flag, defaulting to {@code true},
  9566. which tells the {@code ResourceManager} if the application wants
  9567. locality to be loose (i.e. allows fall-through to rack or <em>any</em>)
  9568. or strict (i.e. specify hard constraint on resource allocation).
  9569. </li>
  9570. </ul>
  9571. @see Resource
  9572. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  9573. </doc>
  9574. </class>
  9575. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest -->
  9576. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
  9577. <class name="ResourceRequest.ResourceRequestComparator" extends="java.lang.Object"
  9578. abstract="false"
  9579. static="true" final="false" visibility="public"
  9580. deprecated="not deprecated">
  9581. <implements name="java.util.Comparator"/>
  9582. <implements name="java.io.Serializable"/>
  9583. <constructor name="ResourceRequestComparator"
  9584. static="false" final="false" visibility="public"
  9585. deprecated="not deprecated">
  9586. </constructor>
  9587. <method name="compare" return="int"
  9588. abstract="false" native="false" synchronized="false"
  9589. static="false" final="false" visibility="public"
  9590. deprecated="not deprecated">
  9591. <param name="r1" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  9592. <param name="r2" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  9593. </method>
  9594. </class>
  9595. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
  9596. <!-- start class org.apache.hadoop.yarn.api.records.ResourceUtilization -->
  9597. <class name="ResourceUtilization" extends="java.lang.Object"
  9598. abstract="true"
  9599. static="false" final="false" visibility="public"
  9600. deprecated="not deprecated">
  9601. <implements name="java.lang.Comparable"/>
  9602. <constructor name="ResourceUtilization"
  9603. static="false" final="false" visibility="public"
  9604. deprecated="not deprecated">
  9605. </constructor>
  9606. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  9607. abstract="false" native="false" synchronized="false"
  9608. static="true" final="false" visibility="public"
  9609. deprecated="not deprecated">
  9610. <param name="pmem" type="int"/>
  9611. <param name="vmem" type="int"/>
  9612. <param name="cpu" type="float"/>
  9613. </method>
  9614. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  9615. abstract="false" native="false" synchronized="false"
  9616. static="true" final="false" visibility="public"
  9617. deprecated="not deprecated">
  9618. <param name="resourceUtil" type="org.apache.hadoop.yarn.api.records.ResourceUtilization"/>
  9619. </method>
  9620. <method name="getVirtualMemory" return="int"
  9621. abstract="true" native="false" synchronized="false"
  9622. static="false" final="false" visibility="public"
  9623. deprecated="not deprecated">
  9624. <doc>
  9625. <![CDATA[Get used <em>virtual memory</em>.
  9626. @return <em>virtual memory</em> in MB]]>
  9627. </doc>
  9628. </method>
  9629. <method name="setVirtualMemory"
  9630. abstract="true" native="false" synchronized="false"
  9631. static="false" final="false" visibility="public"
  9632. deprecated="not deprecated">
  9633. <param name="vmem" type="int"/>
  9634. <doc>
  9635. <![CDATA[Set used <em>virtual memory</em>.
  9636. @param vmem <em>virtual memory</em> in MB]]>
  9637. </doc>
  9638. </method>
  9639. <method name="getPhysicalMemory" return="int"
  9640. abstract="true" native="false" synchronized="false"
  9641. static="false" final="false" visibility="public"
  9642. deprecated="not deprecated">
  9643. <doc>
  9644. <![CDATA[Get <em>physical memory</em>.
  9645. @return <em>physical memory</em> in MB]]>
  9646. </doc>
  9647. </method>
  9648. <method name="setPhysicalMemory"
  9649. abstract="true" native="false" synchronized="false"
  9650. static="false" final="false" visibility="public"
  9651. deprecated="not deprecated">
  9652. <param name="pmem" type="int"/>
  9653. <doc>
  9654. <![CDATA[Set <em>physical memory</em>.
  9655. @param pmem <em>physical memory</em> in MB]]>
  9656. </doc>
  9657. </method>
  9658. <method name="getCPU" return="float"
  9659. abstract="true" native="false" synchronized="false"
  9660. static="false" final="false" visibility="public"
  9661. deprecated="not deprecated">
  9662. <doc>
  9663. <![CDATA[Get <em>CPU</em> utilization.
  9664. @return <em>CPU utilization</em> normalized to 1 CPU]]>
  9665. </doc>
  9666. </method>
  9667. <method name="setCPU"
  9668. abstract="true" native="false" synchronized="false"
  9669. static="false" final="false" visibility="public"
  9670. deprecated="not deprecated">
  9671. <param name="cpu" type="float"/>
  9672. <doc>
  9673. <![CDATA[Set <em>CPU</em> utilization.
  9674. @param cpu <em>CPU utilization</em> normalized to 1 CPU]]>
  9675. </doc>
  9676. </method>
  9677. <method name="hashCode" return="int"
  9678. abstract="false" native="false" synchronized="false"
  9679. static="false" final="false" visibility="public"
  9680. deprecated="not deprecated">
  9681. </method>
  9682. <method name="equals" return="boolean"
  9683. abstract="false" native="false" synchronized="false"
  9684. static="false" final="false" visibility="public"
  9685. deprecated="not deprecated">
  9686. <param name="obj" type="java.lang.Object"/>
  9687. </method>
  9688. <method name="toString" return="java.lang.String"
  9689. abstract="false" native="false" synchronized="false"
  9690. static="false" final="false" visibility="public"
  9691. deprecated="not deprecated">
  9692. </method>
  9693. <method name="addTo"
  9694. abstract="false" native="false" synchronized="false"
  9695. static="false" final="false" visibility="public"
  9696. deprecated="not deprecated">
  9697. <param name="pmem" type="int"/>
  9698. <param name="vmem" type="int"/>
  9699. <param name="cpu" type="float"/>
  9700. <doc>
  9701. <![CDATA[Add utilization to the current one.
  9702. @param pmem Physical memory used to add.
  9703. @param vmem Virtual memory used to add.
  9704. @param cpu CPU utilization to add.]]>
  9705. </doc>
  9706. </method>
  9707. <method name="subtractFrom"
  9708. abstract="false" native="false" synchronized="false"
  9709. static="false" final="false" visibility="public"
  9710. deprecated="not deprecated">
  9711. <param name="pmem" type="int"/>
  9712. <param name="vmem" type="int"/>
  9713. <param name="cpu" type="float"/>
  9714. <doc>
  9715. <![CDATA[Subtract utilization from the current one.
  9716. @param pmem Physical memory to be subtracted.
  9717. @param vmem Virtual memory to be subtracted.
  9718. @param cpu CPU utilization to be subtracted.]]>
  9719. </doc>
  9720. </method>
  9721. <doc>
  9722. <![CDATA[<p>
  9723. <code>ResourceUtilization</code> models the utilization of a set of computer
  9724. resources in the cluster.
  9725. </p>]]>
  9726. </doc>
  9727. </class>
  9728. <!-- end class org.apache.hadoop.yarn.api.records.ResourceUtilization -->
  9729. <!-- start class org.apache.hadoop.yarn.api.records.SignalContainerCommand -->
  9730. <class name="SignalContainerCommand" extends="java.lang.Enum"
  9731. abstract="false"
  9732. static="false" final="true" visibility="public"
  9733. deprecated="not deprecated">
  9734. <method name="values" return="org.apache.hadoop.yarn.api.records.SignalContainerCommand[]"
  9735. abstract="false" native="false" synchronized="false"
  9736. static="true" final="false" visibility="public"
  9737. deprecated="not deprecated">
  9738. </method>
  9739. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.SignalContainerCommand"
  9740. abstract="false" native="false" synchronized="false"
  9741. static="true" final="false" visibility="public"
  9742. deprecated="not deprecated">
  9743. <param name="name" type="java.lang.String"/>
  9744. </method>
  9745. <doc>
  9746. <![CDATA[Enumeration of various signal container commands.]]>
  9747. </doc>
  9748. </class>
  9749. <!-- end class org.apache.hadoop.yarn.api.records.SignalContainerCommand -->
  9750. <!-- start class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
  9751. <class name="StrictPreemptionContract" extends="java.lang.Object"
  9752. abstract="true"
  9753. static="false" final="false" visibility="public"
  9754. deprecated="not deprecated">
  9755. <constructor name="StrictPreemptionContract"
  9756. static="false" final="false" visibility="public"
  9757. deprecated="not deprecated">
  9758. </constructor>
  9759. <method name="getContainers" return="java.util.Set"
  9760. abstract="true" native="false" synchronized="false"
  9761. static="false" final="false" visibility="public"
  9762. deprecated="not deprecated">
  9763. <doc>
  9764. <![CDATA[Get the set of {@link PreemptionContainer} specifying containers owned by
  9765. the <code>ApplicationMaster</code> that may be reclaimed by the
  9766. <code>ResourceManager</code>.
  9767. @return the set of {@link ContainerId} to be preempted.]]>
  9768. </doc>
  9769. </method>
  9770. <doc>
  9771. <![CDATA[Enumeration of particular allocations to be reclaimed. The platform will
  9772. reclaim exactly these resources, so the <code>ApplicationMaster</code> (AM)
  9773. may attempt to checkpoint work or adjust its execution plan to accommodate
  9774. it. In contrast to {@link PreemptionContract}, the AM has no flexibility in
  9775. selecting which resources to return to the cluster.
  9776. @see PreemptionMessage]]>
  9777. </doc>
  9778. </class>
  9779. <!-- end class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
  9780. <!-- start class org.apache.hadoop.yarn.api.records.Token -->
  9781. <class name="Token" extends="java.lang.Object"
  9782. abstract="true"
  9783. static="false" final="false" visibility="public"
  9784. deprecated="not deprecated">
  9785. <constructor name="Token"
  9786. static="false" final="false" visibility="public"
  9787. deprecated="not deprecated">
  9788. </constructor>
  9789. <method name="getIdentifier" return="java.nio.ByteBuffer"
  9790. abstract="true" native="false" synchronized="false"
  9791. static="false" final="false" visibility="public"
  9792. deprecated="not deprecated">
  9793. <doc>
  9794. <![CDATA[Get the token identifier.
  9795. @return token identifier]]>
  9796. </doc>
  9797. </method>
  9798. <method name="getPassword" return="java.nio.ByteBuffer"
  9799. abstract="true" native="false" synchronized="false"
  9800. static="false" final="false" visibility="public"
  9801. deprecated="not deprecated">
  9802. <doc>
  9803. <![CDATA[Get the token password
  9804. @return token password]]>
  9805. </doc>
  9806. </method>
  9807. <method name="getKind" return="java.lang.String"
  9808. abstract="true" native="false" synchronized="false"
  9809. static="false" final="false" visibility="public"
  9810. deprecated="not deprecated">
  9811. <doc>
  9812. <![CDATA[Get the token kind.
  9813. @return token kind]]>
  9814. </doc>
  9815. </method>
  9816. <method name="getService" return="java.lang.String"
  9817. abstract="true" native="false" synchronized="false"
  9818. static="false" final="false" visibility="public"
  9819. deprecated="not deprecated">
  9820. <doc>
  9821. <![CDATA[Get the service to which the token is allocated.
  9822. @return service to which the token is allocated]]>
  9823. </doc>
  9824. </method>
  9825. <doc>
  9826. <![CDATA[<p><code>Token</code> is the security entity used by the framework
  9827. to verify authenticity of any resource.</p>]]>
  9828. </doc>
  9829. </class>
  9830. <!-- end class org.apache.hadoop.yarn.api.records.Token -->
  9831. <!-- start class org.apache.hadoop.yarn.api.records.UpdateContainerError -->
  9832. <class name="UpdateContainerError" extends="java.lang.Object"
  9833. abstract="true"
  9834. static="false" final="false" visibility="public"
  9835. deprecated="not deprecated">
  9836. <constructor name="UpdateContainerError"
  9837. static="false" final="false" visibility="public"
  9838. deprecated="not deprecated">
  9839. </constructor>
  9840. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdateContainerError"
  9841. abstract="false" native="false" synchronized="false"
  9842. static="true" final="false" visibility="public"
  9843. deprecated="not deprecated">
  9844. <param name="reason" type="java.lang.String"/>
  9845. <param name="updateContainerRequest" type="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"/>
  9846. </method>
  9847. <method name="getReason" return="java.lang.String"
  9848. abstract="true" native="false" synchronized="false"
  9849. static="false" final="false" visibility="public"
  9850. deprecated="not deprecated">
  9851. <doc>
  9852. <![CDATA[Get reason why the update request was not satisfiable.
  9853. @return Reason]]>
  9854. </doc>
  9855. </method>
  9856. <method name="setReason"
  9857. abstract="true" native="false" synchronized="false"
  9858. static="false" final="false" visibility="public"
  9859. deprecated="not deprecated">
  9860. <param name="reason" type="java.lang.String"/>
  9861. <doc>
  9862. <![CDATA[Set reason why the update request was not satisfiable.
  9863. @param reason Reason]]>
  9864. </doc>
  9865. </method>
  9866. <method name="getUpdateContainerRequest" return="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"
  9867. abstract="true" native="false" synchronized="false"
  9868. static="false" final="false" visibility="public"
  9869. deprecated="not deprecated">
  9870. <doc>
  9871. <![CDATA[Get the {@code UpdateContainerRequest} that was not satisfiable.
  9872. @return UpdateContainerRequest]]>
  9873. </doc>
  9874. </method>
  9875. <method name="setUpdateContainerRequest"
  9876. abstract="true" native="false" synchronized="false"
  9877. static="false" final="false" visibility="public"
  9878. deprecated="not deprecated">
  9879. <param name="updateContainerRequest" type="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"/>
  9880. <doc>
  9881. <![CDATA[Set the {@code UpdateContainerRequest} that was not satisfiable.
  9882. @param updateContainerRequest Update Container Request]]>
  9883. </doc>
  9884. </method>
  9885. <method name="hashCode" return="int"
  9886. abstract="false" native="false" synchronized="false"
  9887. static="false" final="false" visibility="public"
  9888. deprecated="not deprecated">
  9889. </method>
  9890. <method name="equals" return="boolean"
  9891. abstract="false" native="false" synchronized="false"
  9892. static="false" final="false" visibility="public"
  9893. deprecated="not deprecated">
  9894. <param name="obj" type="java.lang.Object"/>
  9895. </method>
  9896. <doc>
  9897. <![CDATA[{@code UpdateContainerError} is used by the Scheduler to notify the
  9898. ApplicationMaster of an UpdateContainerRequest it cannot satisfy due to
  9899. an error in the request. It includes the update request as well as
  9900. a reason for why the request was not satisfiable.]]>
  9901. </doc>
  9902. </class>
  9903. <!-- end class org.apache.hadoop.yarn.api.records.UpdateContainerError -->
  9904. <!-- start class org.apache.hadoop.yarn.api.records.UpdateContainerRequest -->
  9905. <class name="UpdateContainerRequest" extends="java.lang.Object"
  9906. abstract="true"
  9907. static="false" final="false" visibility="public"
  9908. deprecated="not deprecated">
  9909. <constructor name="UpdateContainerRequest"
  9910. static="false" final="false" visibility="public"
  9911. deprecated="not deprecated">
  9912. </constructor>
  9913. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"
  9914. abstract="false" native="false" synchronized="false"
  9915. static="true" final="false" visibility="public"
  9916. deprecated="not deprecated">
  9917. <param name="version" type="int"/>
  9918. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  9919. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  9920. <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  9921. </method>
  9922. <method name="getContainerVersion" return="int"
  9923. abstract="true" native="false" synchronized="false"
  9924. static="false" final="false" visibility="public"
  9925. deprecated="not deprecated">
  9926. <doc>
  9927. <![CDATA[Get the <code>ContainerId</code> of the container.
  9928. @return <code>ContainerId</code> of the container]]>
  9929. </doc>
  9930. </method>
  9931. <method name="setContainerVersion"
  9932. abstract="true" native="false" synchronized="false"
  9933. static="false" final="false" visibility="public"
  9934. deprecated="not deprecated">
  9935. <param name="containerVersion" type="int"/>
  9936. <doc>
  9937. <![CDATA[Set the current version of the container.
  9938. @param containerVersion of the container]]>
  9939. </doc>
  9940. </method>
  9941. <method name="getContainerUpdateType" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType"
  9942. abstract="true" native="false" synchronized="false"
  9943. static="false" final="false" visibility="public"
  9944. deprecated="not deprecated">
  9945. <doc>
  9946. <![CDATA[Get the <code>ContainerUpdateType</code> of the container.
  9947. @return <code>ContainerUpdateType</code> of the container.]]>
  9948. </doc>
  9949. </method>
  9950. <method name="setContainerUpdateType"
  9951. abstract="true" native="false" synchronized="false"
  9952. static="false" final="false" visibility="public"
  9953. deprecated="not deprecated">
  9954. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  9955. <doc>
  9956. <![CDATA[Set the <code>ContainerUpdateType</code> of the container.
  9957. @param updateType of the Container]]>
  9958. </doc>
  9959. </method>
  9960. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  9961. abstract="true" native="false" synchronized="false"
  9962. static="false" final="false" visibility="public"
  9963. deprecated="not deprecated">
  9964. <doc>
  9965. <![CDATA[Get the <code>ContainerId</code> of the container.
  9966. @return <code>ContainerId</code> of the container]]>
  9967. </doc>
  9968. </method>
  9969. <method name="setContainerId"
  9970. abstract="true" native="false" synchronized="false"
  9971. static="false" final="false" visibility="public"
  9972. deprecated="not deprecated">
  9973. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  9974. <doc>
  9975. <![CDATA[Set the <code>ContainerId</code> of the container.
  9976. @param containerId <code>ContainerId</code> of the container]]>
  9977. </doc>
  9978. </method>
  9979. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  9980. abstract="true" native="false" synchronized="false"
  9981. static="false" final="false" visibility="public"
  9982. deprecated="not deprecated">
  9983. <doc>
  9984. <![CDATA[Get the <code>Resource</code> capability of the container.
  9985. @return <code>Resource</code> capability of the container]]>
  9986. </doc>
  9987. </method>
  9988. <method name="setCapability"
  9989. abstract="true" native="false" synchronized="false"
  9990. static="false" final="false" visibility="public"
  9991. deprecated="not deprecated">
  9992. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  9993. <doc>
  9994. <![CDATA[Set the <code>Resource</code> capability of the container.
  9995. @param capability <code>Resource</code> capability of the container]]>
  9996. </doc>
  9997. </method>
  9998. <method name="hashCode" return="int"
  9999. abstract="false" native="false" synchronized="false"
  10000. static="false" final="false" visibility="public"
  10001. deprecated="not deprecated">
  10002. </method>
  10003. <method name="equals" return="boolean"
  10004. abstract="false" native="false" synchronized="false"
  10005. static="false" final="false" visibility="public"
  10006. deprecated="not deprecated">
  10007. <param name="obj" type="java.lang.Object"/>
  10008. </method>
  10009. <doc>
  10010. <![CDATA[{@code UpdateContainerRequest} represents the request made by an
  10011. application to the {@code ResourceManager} to update an attribute of a
  10012. {@code Container} such as its Resource allocation or (@code ExecutionType}
  10013. <p>
  10014. It includes:
  10015. <ul>
  10016. <li>version for the container.</li>
  10017. <li>{@link ContainerId} for the container.</li>
  10018. <li>
  10019. {@link Resource} capability of the container after the update request
  10020. is completed.
  10021. </li>
  10022. </ul>
  10023. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  10024. </doc>
  10025. </class>
  10026. <!-- end class org.apache.hadoop.yarn.api.records.UpdateContainerRequest -->
  10027. <!-- start class org.apache.hadoop.yarn.api.records.UpdatedContainer -->
  10028. <class name="UpdatedContainer" extends="java.lang.Object"
  10029. abstract="true"
  10030. static="false" final="false" visibility="public"
  10031. deprecated="not deprecated">
  10032. <constructor name="UpdatedContainer"
  10033. static="false" final="false" visibility="public"
  10034. deprecated="not deprecated">
  10035. </constructor>
  10036. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdatedContainer"
  10037. abstract="false" native="false" synchronized="false"
  10038. static="true" final="false" visibility="public"
  10039. deprecated="not deprecated">
  10040. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  10041. <param name="container" type="org.apache.hadoop.yarn.api.records.Container"/>
  10042. <doc>
  10043. <![CDATA[Static Factory method.
  10044. @param updateType ContainerUpdateType
  10045. @param container Container
  10046. @return UpdatedContainer]]>
  10047. </doc>
  10048. </method>
  10049. <method name="getUpdateType" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType"
  10050. abstract="true" native="false" synchronized="false"
  10051. static="false" final="false" visibility="public"
  10052. deprecated="not deprecated">
  10053. <doc>
  10054. <![CDATA[Get the <code>ContainerUpdateType</code>.
  10055. @return ContainerUpdateType]]>
  10056. </doc>
  10057. </method>
  10058. <method name="setUpdateType"
  10059. abstract="true" native="false" synchronized="false"
  10060. static="false" final="false" visibility="public"
  10061. deprecated="not deprecated">
  10062. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  10063. <doc>
  10064. <![CDATA[Set the <code>ContainerUpdateType</code>.
  10065. @param updateType ContainerUpdateType]]>
  10066. </doc>
  10067. </method>
  10068. <method name="getContainer" return="org.apache.hadoop.yarn.api.records.Container"
  10069. abstract="true" native="false" synchronized="false"
  10070. static="false" final="false" visibility="public"
  10071. deprecated="not deprecated">
  10072. <doc>
  10073. <![CDATA[Get the <code>Container</code>.
  10074. @return Container]]>
  10075. </doc>
  10076. </method>
  10077. <method name="setContainer"
  10078. abstract="true" native="false" synchronized="false"
  10079. static="false" final="false" visibility="public"
  10080. deprecated="not deprecated">
  10081. <param name="container" type="org.apache.hadoop.yarn.api.records.Container"/>
  10082. <doc>
  10083. <![CDATA[Set the <code>Container</code>.
  10084. @param container Container]]>
  10085. </doc>
  10086. </method>
  10087. <method name="hashCode" return="int"
  10088. abstract="false" native="false" synchronized="false"
  10089. static="false" final="false" visibility="public"
  10090. deprecated="not deprecated">
  10091. </method>
  10092. <method name="equals" return="boolean"
  10093. abstract="false" native="false" synchronized="false"
  10094. static="false" final="false" visibility="public"
  10095. deprecated="not deprecated">
  10096. <param name="obj" type="java.lang.Object"/>
  10097. </method>
  10098. <doc>
  10099. <![CDATA[An object that encapsulates an updated container and the
  10100. type of Update.]]>
  10101. </doc>
  10102. </class>
  10103. <!-- end class org.apache.hadoop.yarn.api.records.UpdatedContainer -->
  10104. <!-- start class org.apache.hadoop.yarn.api.records.URL -->
  10105. <class name="URL" extends="java.lang.Object"
  10106. abstract="true"
  10107. static="false" final="false" visibility="public"
  10108. deprecated="not deprecated">
  10109. <constructor name="URL"
  10110. static="false" final="false" visibility="public"
  10111. deprecated="not deprecated">
  10112. </constructor>
  10113. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.URL"
  10114. abstract="false" native="false" synchronized="false"
  10115. static="true" final="false" visibility="public"
  10116. deprecated="not deprecated">
  10117. <param name="scheme" type="java.lang.String"/>
  10118. <param name="host" type="java.lang.String"/>
  10119. <param name="port" type="int"/>
  10120. <param name="file" type="java.lang.String"/>
  10121. </method>
  10122. <method name="getScheme" return="java.lang.String"
  10123. abstract="true" native="false" synchronized="false"
  10124. static="false" final="false" visibility="public"
  10125. deprecated="not deprecated">
  10126. <doc>
  10127. <![CDATA[Get the scheme of the URL.
  10128. @return scheme of the URL]]>
  10129. </doc>
  10130. </method>
  10131. <method name="setScheme"
  10132. abstract="true" native="false" synchronized="false"
  10133. static="false" final="false" visibility="public"
  10134. deprecated="not deprecated">
  10135. <param name="scheme" type="java.lang.String"/>
  10136. <doc>
  10137. <![CDATA[Set the scheme of the URL
  10138. @param scheme scheme of the URL]]>
  10139. </doc>
  10140. </method>
  10141. <method name="getUserInfo" return="java.lang.String"
  10142. abstract="true" native="false" synchronized="false"
  10143. static="false" final="false" visibility="public"
  10144. deprecated="not deprecated">
  10145. <doc>
  10146. <![CDATA[Get the user info of the URL.
  10147. @return user info of the URL]]>
  10148. </doc>
  10149. </method>
  10150. <method name="setUserInfo"
  10151. abstract="true" native="false" synchronized="false"
  10152. static="false" final="false" visibility="public"
  10153. deprecated="not deprecated">
  10154. <param name="userInfo" type="java.lang.String"/>
  10155. <doc>
  10156. <![CDATA[Set the user info of the URL.
  10157. @param userInfo user info of the URL]]>
  10158. </doc>
  10159. </method>
  10160. <method name="getHost" return="java.lang.String"
  10161. abstract="true" native="false" synchronized="false"
  10162. static="false" final="false" visibility="public"
  10163. deprecated="not deprecated">
  10164. <doc>
  10165. <![CDATA[Get the host of the URL.
  10166. @return host of the URL]]>
  10167. </doc>
  10168. </method>
  10169. <method name="setHost"
  10170. abstract="true" native="false" synchronized="false"
  10171. static="false" final="false" visibility="public"
  10172. deprecated="not deprecated">
  10173. <param name="host" type="java.lang.String"/>
  10174. <doc>
  10175. <![CDATA[Set the host of the URL.
  10176. @param host host of the URL]]>
  10177. </doc>
  10178. </method>
  10179. <method name="getPort" return="int"
  10180. abstract="true" native="false" synchronized="false"
  10181. static="false" final="false" visibility="public"
  10182. deprecated="not deprecated">
  10183. <doc>
  10184. <![CDATA[Get the port of the URL.
  10185. @return port of the URL]]>
  10186. </doc>
  10187. </method>
  10188. <method name="setPort"
  10189. abstract="true" native="false" synchronized="false"
  10190. static="false" final="false" visibility="public"
  10191. deprecated="not deprecated">
  10192. <param name="port" type="int"/>
  10193. <doc>
  10194. <![CDATA[Set the port of the URL
  10195. @param port port of the URL]]>
  10196. </doc>
  10197. </method>
  10198. <method name="getFile" return="java.lang.String"
  10199. abstract="true" native="false" synchronized="false"
  10200. static="false" final="false" visibility="public"
  10201. deprecated="not deprecated">
  10202. <doc>
  10203. <![CDATA[Get the file of the URL.
  10204. @return file of the URL]]>
  10205. </doc>
  10206. </method>
  10207. <method name="setFile"
  10208. abstract="true" native="false" synchronized="false"
  10209. static="false" final="false" visibility="public"
  10210. deprecated="not deprecated">
  10211. <param name="file" type="java.lang.String"/>
  10212. <doc>
  10213. <![CDATA[Set the file of the URL.
  10214. @param file file of the URL]]>
  10215. </doc>
  10216. </method>
  10217. <method name="toPath" return="org.apache.hadoop.fs.Path"
  10218. abstract="false" native="false" synchronized="false"
  10219. static="false" final="false" visibility="public"
  10220. deprecated="not deprecated">
  10221. <exception name="URISyntaxException" type="java.net.URISyntaxException"/>
  10222. </method>
  10223. <method name="fromURI" return="org.apache.hadoop.yarn.api.records.URL"
  10224. abstract="false" native="false" synchronized="false"
  10225. static="true" final="false" visibility="public"
  10226. deprecated="not deprecated">
  10227. <param name="uri" type="java.net.URI"/>
  10228. </method>
  10229. <method name="fromPath" return="org.apache.hadoop.yarn.api.records.URL"
  10230. abstract="false" native="false" synchronized="false"
  10231. static="true" final="false" visibility="public"
  10232. deprecated="not deprecated">
  10233. <param name="path" type="org.apache.hadoop.fs.Path"/>
  10234. </method>
  10235. <doc>
  10236. <![CDATA[<p><code>URL</code> represents a serializable {@link java.net.URL}.</p>]]>
  10237. </doc>
  10238. </class>
  10239. <!-- end class org.apache.hadoop.yarn.api.records.URL -->
  10240. <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
  10241. <class name="YarnApplicationAttemptState" extends="java.lang.Enum"
  10242. abstract="false"
  10243. static="false" final="true" visibility="public"
  10244. deprecated="not deprecated">
  10245. <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState[]"
  10246. abstract="false" native="false" synchronized="false"
  10247. static="true" final="false" visibility="public"
  10248. deprecated="not deprecated">
  10249. </method>
  10250. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
  10251. abstract="false" native="false" synchronized="false"
  10252. static="true" final="false" visibility="public"
  10253. deprecated="not deprecated">
  10254. <param name="name" type="java.lang.String"/>
  10255. </method>
  10256. <doc>
  10257. <![CDATA[Enumeration of various states of a <code>RMAppAttempt</code>.]]>
  10258. </doc>
  10259. </class>
  10260. <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
  10261. <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
  10262. <class name="YarnApplicationState" extends="java.lang.Enum"
  10263. abstract="false"
  10264. static="false" final="true" visibility="public"
  10265. deprecated="not deprecated">
  10266. <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationState[]"
  10267. abstract="false" native="false" synchronized="false"
  10268. static="true" final="false" visibility="public"
  10269. deprecated="not deprecated">
  10270. </method>
  10271. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
  10272. abstract="false" native="false" synchronized="false"
  10273. static="true" final="false" visibility="public"
  10274. deprecated="not deprecated">
  10275. <param name="name" type="java.lang.String"/>
  10276. </method>
  10277. <doc>
  10278. <![CDATA[Enumeration of various states of an <code>ApplicationMaster</code>.]]>
  10279. </doc>
  10280. </class>
  10281. <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
  10282. <!-- start class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
  10283. <class name="YarnClusterMetrics" extends="java.lang.Object"
  10284. abstract="true"
  10285. static="false" final="false" visibility="public"
  10286. deprecated="not deprecated">
  10287. <constructor name="YarnClusterMetrics"
  10288. static="false" final="false" visibility="public"
  10289. deprecated="not deprecated">
  10290. </constructor>
  10291. <method name="getNumNodeManagers" return="int"
  10292. abstract="true" native="false" synchronized="false"
  10293. static="false" final="false" visibility="public"
  10294. deprecated="not deprecated">
  10295. <doc>
  10296. <![CDATA[Get the number of <code>NodeManager</code>s in the cluster.
  10297. @return number of <code>NodeManager</code>s in the cluster]]>
  10298. </doc>
  10299. </method>
  10300. <method name="getNumDecommissionedNodeManagers" return="int"
  10301. abstract="true" native="false" synchronized="false"
  10302. static="false" final="false" visibility="public"
  10303. deprecated="not deprecated">
  10304. <doc>
  10305. <![CDATA[Get the number of <code>DecommissionedNodeManager</code>s in the cluster.
  10306. @return number of <code>DecommissionedNodeManager</code>s in the cluster]]>
  10307. </doc>
  10308. </method>
  10309. <method name="getNumActiveNodeManagers" return="int"
  10310. abstract="true" native="false" synchronized="false"
  10311. static="false" final="false" visibility="public"
  10312. deprecated="not deprecated">
  10313. <doc>
  10314. <![CDATA[Get the number of <code>ActiveNodeManager</code>s in the cluster.
  10315. @return number of <code>ActiveNodeManager</code>s in the cluster]]>
  10316. </doc>
  10317. </method>
  10318. <method name="getNumLostNodeManagers" return="int"
  10319. abstract="true" native="false" synchronized="false"
  10320. static="false" final="false" visibility="public"
  10321. deprecated="not deprecated">
  10322. <doc>
  10323. <![CDATA[Get the number of <code>LostNodeManager</code>s in the cluster.
  10324. @return number of <code>LostNodeManager</code>s in the cluster]]>
  10325. </doc>
  10326. </method>
  10327. <method name="getNumUnhealthyNodeManagers" return="int"
  10328. abstract="true" native="false" synchronized="false"
  10329. static="false" final="false" visibility="public"
  10330. deprecated="not deprecated">
  10331. <doc>
  10332. <![CDATA[Get the number of <code>UnhealthyNodeManager</code>s in the cluster.
  10333. @return number of <code>UnhealthyNodeManager</code>s in the cluster]]>
  10334. </doc>
  10335. </method>
  10336. <method name="getNumRebootedNodeManagers" return="int"
  10337. abstract="true" native="false" synchronized="false"
  10338. static="false" final="false" visibility="public"
  10339. deprecated="not deprecated">
  10340. <doc>
  10341. <![CDATA[Get the number of <code>RebootedNodeManager</code>s in the cluster.
  10342. @return number of <code>RebootedNodeManager</code>s in the cluster]]>
  10343. </doc>
  10344. </method>
  10345. <doc>
  10346. <![CDATA[<p><code>YarnClusterMetrics</code> represents cluster metrics.</p>
  10347. <p>Currently only number of <code>NodeManager</code>s is provided.</p>]]>
  10348. </doc>
  10349. </class>
  10350. <!-- end class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
  10351. </package>
  10352. <package name="org.apache.hadoop.yarn.api.records.timeline">
  10353. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineAbout -->
  10354. <class name="TimelineAbout" extends="java.lang.Object"
  10355. abstract="false"
  10356. static="false" final="false" visibility="public"
  10357. deprecated="not deprecated">
  10358. <constructor name="TimelineAbout"
  10359. static="false" final="false" visibility="public"
  10360. deprecated="not deprecated">
  10361. </constructor>
  10362. <constructor name="TimelineAbout" type="java.lang.String"
  10363. static="false" final="false" visibility="public"
  10364. deprecated="not deprecated">
  10365. </constructor>
  10366. <method name="getAbout" return="java.lang.String"
  10367. abstract="false" native="false" synchronized="false"
  10368. static="false" final="false" visibility="public"
  10369. deprecated="not deprecated">
  10370. </method>
  10371. <method name="setAbout"
  10372. abstract="false" native="false" synchronized="false"
  10373. static="false" final="false" visibility="public"
  10374. deprecated="not deprecated">
  10375. <param name="about" type="java.lang.String"/>
  10376. </method>
  10377. <method name="getTimelineServiceVersion" return="java.lang.String"
  10378. abstract="false" native="false" synchronized="false"
  10379. static="false" final="false" visibility="public"
  10380. deprecated="not deprecated">
  10381. </method>
  10382. <method name="setTimelineServiceVersion"
  10383. abstract="false" native="false" synchronized="false"
  10384. static="false" final="false" visibility="public"
  10385. deprecated="not deprecated">
  10386. <param name="timelineServiceVersion" type="java.lang.String"/>
  10387. </method>
  10388. <method name="getTimelineServiceBuildVersion" return="java.lang.String"
  10389. abstract="false" native="false" synchronized="false"
  10390. static="false" final="false" visibility="public"
  10391. deprecated="not deprecated">
  10392. </method>
  10393. <method name="setTimelineServiceBuildVersion"
  10394. abstract="false" native="false" synchronized="false"
  10395. static="false" final="false" visibility="public"
  10396. deprecated="not deprecated">
  10397. <param name="timelineServiceBuildVersion" type="java.lang.String"/>
  10398. </method>
  10399. <method name="getTimelineServiceVersionBuiltOn" return="java.lang.String"
  10400. abstract="false" native="false" synchronized="false"
  10401. static="false" final="false" visibility="public"
  10402. deprecated="not deprecated">
  10403. </method>
  10404. <method name="setTimelineServiceVersionBuiltOn"
  10405. abstract="false" native="false" synchronized="false"
  10406. static="false" final="false" visibility="public"
  10407. deprecated="not deprecated">
  10408. <param name="timelineServiceVersionBuiltOn" type="java.lang.String"/>
  10409. </method>
  10410. <method name="getHadoopVersion" return="java.lang.String"
  10411. abstract="false" native="false" synchronized="false"
  10412. static="false" final="false" visibility="public"
  10413. deprecated="not deprecated">
  10414. </method>
  10415. <method name="setHadoopVersion"
  10416. abstract="false" native="false" synchronized="false"
  10417. static="false" final="false" visibility="public"
  10418. deprecated="not deprecated">
  10419. <param name="hadoopVersion" type="java.lang.String"/>
  10420. </method>
  10421. <method name="getHadoopBuildVersion" return="java.lang.String"
  10422. abstract="false" native="false" synchronized="false"
  10423. static="false" final="false" visibility="public"
  10424. deprecated="not deprecated">
  10425. </method>
  10426. <method name="setHadoopBuildVersion"
  10427. abstract="false" native="false" synchronized="false"
  10428. static="false" final="false" visibility="public"
  10429. deprecated="not deprecated">
  10430. <param name="hadoopBuildVersion" type="java.lang.String"/>
  10431. </method>
  10432. <method name="getHadoopVersionBuiltOn" return="java.lang.String"
  10433. abstract="false" native="false" synchronized="false"
  10434. static="false" final="false" visibility="public"
  10435. deprecated="not deprecated">
  10436. </method>
  10437. <method name="setHadoopVersionBuiltOn"
  10438. abstract="false" native="false" synchronized="false"
  10439. static="false" final="false" visibility="public"
  10440. deprecated="not deprecated">
  10441. <param name="hadoopVersionBuiltOn" type="java.lang.String"/>
  10442. </method>
  10443. </class>
  10444. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineAbout -->
  10445. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
  10446. <class name="TimelineDelegationTokenResponse" extends="java.lang.Object"
  10447. abstract="false"
  10448. static="false" final="false" visibility="public"
  10449. deprecated="not deprecated">
  10450. <constructor name="TimelineDelegationTokenResponse"
  10451. static="false" final="false" visibility="public"
  10452. deprecated="not deprecated">
  10453. </constructor>
  10454. <method name="getType" return="java.lang.String"
  10455. abstract="false" native="false" synchronized="false"
  10456. static="false" final="false" visibility="public"
  10457. deprecated="not deprecated">
  10458. </method>
  10459. <method name="setType"
  10460. abstract="false" native="false" synchronized="false"
  10461. static="false" final="false" visibility="public"
  10462. deprecated="not deprecated">
  10463. <param name="type" type="java.lang.String"/>
  10464. </method>
  10465. <method name="getContent" return="java.lang.Object"
  10466. abstract="false" native="false" synchronized="false"
  10467. static="false" final="false" visibility="public"
  10468. deprecated="not deprecated">
  10469. </method>
  10470. <method name="setContent"
  10471. abstract="false" native="false" synchronized="false"
  10472. static="false" final="false" visibility="public"
  10473. deprecated="not deprecated">
  10474. <param name="content" type="java.lang.Object"/>
  10475. </method>
  10476. <doc>
  10477. <![CDATA[The response of delegation token related request]]>
  10478. </doc>
  10479. </class>
  10480. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
  10481. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
  10482. <class name="TimelineDomain" extends="java.lang.Object"
  10483. abstract="false"
  10484. static="false" final="false" visibility="public"
  10485. deprecated="not deprecated">
  10486. <constructor name="TimelineDomain"
  10487. static="false" final="false" visibility="public"
  10488. deprecated="not deprecated">
  10489. </constructor>
  10490. <method name="getId" return="java.lang.String"
  10491. abstract="false" native="false" synchronized="false"
  10492. static="false" final="false" visibility="public"
  10493. deprecated="not deprecated">
  10494. <doc>
  10495. <![CDATA[Get the domain ID
  10496. @return the domain ID]]>
  10497. </doc>
  10498. </method>
  10499. <method name="setId"
  10500. abstract="false" native="false" synchronized="false"
  10501. static="false" final="false" visibility="public"
  10502. deprecated="not deprecated">
  10503. <param name="id" type="java.lang.String"/>
  10504. <doc>
  10505. <![CDATA[Set the domain ID
  10506. @param id the domain ID]]>
  10507. </doc>
  10508. </method>
  10509. <method name="getDescription" return="java.lang.String"
  10510. abstract="false" native="false" synchronized="false"
  10511. static="false" final="false" visibility="public"
  10512. deprecated="not deprecated">
  10513. <doc>
  10514. <![CDATA[Get the domain description
  10515. @return the domain description]]>
  10516. </doc>
  10517. </method>
  10518. <method name="setDescription"
  10519. abstract="false" native="false" synchronized="false"
  10520. static="false" final="false" visibility="public"
  10521. deprecated="not deprecated">
  10522. <param name="description" type="java.lang.String"/>
  10523. <doc>
  10524. <![CDATA[Set the domain description
  10525. @param description the domain description]]>
  10526. </doc>
  10527. </method>
  10528. <method name="getOwner" return="java.lang.String"
  10529. abstract="false" native="false" synchronized="false"
  10530. static="false" final="false" visibility="public"
  10531. deprecated="not deprecated">
  10532. <doc>
  10533. <![CDATA[Get the domain owner
  10534. @return the domain owner]]>
  10535. </doc>
  10536. </method>
  10537. <method name="setOwner"
  10538. abstract="false" native="false" synchronized="false"
  10539. static="false" final="false" visibility="public"
  10540. deprecated="not deprecated">
  10541. <param name="owner" type="java.lang.String"/>
  10542. <doc>
  10543. <![CDATA[Set the domain owner. The user doesn't need to set it, which will
  10544. automatically set to the user who puts the domain.
  10545. @param owner the domain owner]]>
  10546. </doc>
  10547. </method>
  10548. <method name="getReaders" return="java.lang.String"
  10549. abstract="false" native="false" synchronized="false"
  10550. static="false" final="false" visibility="public"
  10551. deprecated="not deprecated">
  10552. <doc>
  10553. <![CDATA[Get the reader (and/or reader group) list string
  10554. @return the reader (and/or reader group) list string]]>
  10555. </doc>
  10556. </method>
  10557. <method name="setReaders"
  10558. abstract="false" native="false" synchronized="false"
  10559. static="false" final="false" visibility="public"
  10560. deprecated="not deprecated">
  10561. <param name="readers" type="java.lang.String"/>
  10562. <doc>
  10563. <![CDATA[Set the reader (and/or reader group) list string
  10564. @param readers the reader (and/or reader group) list string]]>
  10565. </doc>
  10566. </method>
  10567. <method name="getWriters" return="java.lang.String"
  10568. abstract="false" native="false" synchronized="false"
  10569. static="false" final="false" visibility="public"
  10570. deprecated="not deprecated">
  10571. <doc>
  10572. <![CDATA[Get the writer (and/or writer group) list string
  10573. @return the writer (and/or writer group) list string]]>
  10574. </doc>
  10575. </method>
  10576. <method name="setWriters"
  10577. abstract="false" native="false" synchronized="false"
  10578. static="false" final="false" visibility="public"
  10579. deprecated="not deprecated">
  10580. <param name="writers" type="java.lang.String"/>
  10581. <doc>
  10582. <![CDATA[Set the writer (and/or writer group) list string
  10583. @param writers the writer (and/or writer group) list string]]>
  10584. </doc>
  10585. </method>
  10586. <method name="getCreatedTime" return="java.lang.Long"
  10587. abstract="false" native="false" synchronized="false"
  10588. static="false" final="false" visibility="public"
  10589. deprecated="not deprecated">
  10590. <doc>
  10591. <![CDATA[Get the created time of the domain
  10592. @return the created time of the domain]]>
  10593. </doc>
  10594. </method>
  10595. <method name="setCreatedTime"
  10596. abstract="false" native="false" synchronized="false"
  10597. static="false" final="false" visibility="public"
  10598. deprecated="not deprecated">
  10599. <param name="createdTime" type="java.lang.Long"/>
  10600. <doc>
  10601. <![CDATA[Set the created time of the domain
  10602. @param createdTime the created time of the domain]]>
  10603. </doc>
  10604. </method>
  10605. <method name="getModifiedTime" return="java.lang.Long"
  10606. abstract="false" native="false" synchronized="false"
  10607. static="false" final="false" visibility="public"
  10608. deprecated="not deprecated">
  10609. <doc>
  10610. <![CDATA[Get the modified time of the domain
  10611. @return the modified time of the domain]]>
  10612. </doc>
  10613. </method>
  10614. <method name="setModifiedTime"
  10615. abstract="false" native="false" synchronized="false"
  10616. static="false" final="false" visibility="public"
  10617. deprecated="not deprecated">
  10618. <param name="modifiedTime" type="java.lang.Long"/>
  10619. <doc>
  10620. <![CDATA[Set the modified time of the domain
  10621. @param modifiedTime the modified time of the domain]]>
  10622. </doc>
  10623. </method>
  10624. <doc>
  10625. <![CDATA[<p>
  10626. This class contains the information about a timeline domain, which is used
  10627. to a user to host a number of timeline entities, isolating them from others'.
  10628. The user can also define the reader and writer users/groups for the the
  10629. domain, which is used to control the access to its entities.
  10630. </p>
  10631. <p>
  10632. The reader and writer users/groups pattern that the user can supply is the
  10633. same as what <code>AccessControlList</code> takes.
  10634. </p>]]>
  10635. </doc>
  10636. </class>
  10637. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
  10638. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
  10639. <class name="TimelineDomains" extends="java.lang.Object"
  10640. abstract="false"
  10641. static="false" final="false" visibility="public"
  10642. deprecated="not deprecated">
  10643. <constructor name="TimelineDomains"
  10644. static="false" final="false" visibility="public"
  10645. deprecated="not deprecated">
  10646. </constructor>
  10647. <method name="getDomains" return="java.util.List"
  10648. abstract="false" native="false" synchronized="false"
  10649. static="false" final="false" visibility="public"
  10650. deprecated="not deprecated">
  10651. <doc>
  10652. <![CDATA[Get a list of domains
  10653. @return a list of domains]]>
  10654. </doc>
  10655. </method>
  10656. <method name="addDomain"
  10657. abstract="false" native="false" synchronized="false"
  10658. static="false" final="false" visibility="public"
  10659. deprecated="not deprecated">
  10660. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  10661. <doc>
  10662. <![CDATA[Add a single domain into the existing domain list
  10663. @param domain
  10664. a single domain]]>
  10665. </doc>
  10666. </method>
  10667. <method name="addDomains"
  10668. abstract="false" native="false" synchronized="false"
  10669. static="false" final="false" visibility="public"
  10670. deprecated="not deprecated">
  10671. <param name="domains" type="java.util.List"/>
  10672. <doc>
  10673. <![CDATA[All a list of domains into the existing domain list
  10674. @param domains
  10675. a list of domains]]>
  10676. </doc>
  10677. </method>
  10678. <method name="setDomains"
  10679. abstract="false" native="false" synchronized="false"
  10680. static="false" final="false" visibility="public"
  10681. deprecated="not deprecated">
  10682. <param name="domains" type="java.util.List"/>
  10683. <doc>
  10684. <![CDATA[Set the domain list to the given list of domains
  10685. @param domains
  10686. a list of domains]]>
  10687. </doc>
  10688. </method>
  10689. <doc>
  10690. <![CDATA[The class that hosts a list of timeline domains.]]>
  10691. </doc>
  10692. </class>
  10693. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
  10694. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
  10695. <class name="TimelineEntities" extends="java.lang.Object"
  10696. abstract="false"
  10697. static="false" final="false" visibility="public"
  10698. deprecated="not deprecated">
  10699. <constructor name="TimelineEntities"
  10700. static="false" final="false" visibility="public"
  10701. deprecated="not deprecated">
  10702. </constructor>
  10703. <method name="getEntities" return="java.util.List"
  10704. abstract="false" native="false" synchronized="false"
  10705. static="false" final="false" visibility="public"
  10706. deprecated="not deprecated">
  10707. <doc>
  10708. <![CDATA[Get a list of entities
  10709. @return a list of entities]]>
  10710. </doc>
  10711. </method>
  10712. <method name="addEntity"
  10713. abstract="false" native="false" synchronized="false"
  10714. static="false" final="false" visibility="public"
  10715. deprecated="not deprecated">
  10716. <param name="entity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
  10717. <doc>
  10718. <![CDATA[Add a single entity into the existing entity list
  10719. @param entity
  10720. a single entity]]>
  10721. </doc>
  10722. </method>
  10723. <method name="addEntities"
  10724. abstract="false" native="false" synchronized="false"
  10725. static="false" final="false" visibility="public"
  10726. deprecated="not deprecated">
  10727. <param name="entities" type="java.util.List"/>
  10728. <doc>
  10729. <![CDATA[All a list of entities into the existing entity list
  10730. @param entities
  10731. a list of entities]]>
  10732. </doc>
  10733. </method>
  10734. <method name="setEntities"
  10735. abstract="false" native="false" synchronized="false"
  10736. static="false" final="false" visibility="public"
  10737. deprecated="not deprecated">
  10738. <param name="entities" type="java.util.List"/>
  10739. <doc>
  10740. <![CDATA[Set the entity list to the given list of entities
  10741. @param entities
  10742. a list of entities]]>
  10743. </doc>
  10744. </method>
  10745. <doc>
  10746. <![CDATA[The class that hosts a list of timeline entities.]]>
  10747. </doc>
  10748. </class>
  10749. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
  10750. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
  10751. <class name="TimelineEntity" extends="java.lang.Object"
  10752. abstract="false"
  10753. static="false" final="false" visibility="public"
  10754. deprecated="not deprecated">
  10755. <implements name="java.lang.Comparable"/>
  10756. <constructor name="TimelineEntity"
  10757. static="false" final="false" visibility="public"
  10758. deprecated="not deprecated">
  10759. </constructor>
  10760. <method name="getEntityType" return="java.lang.String"
  10761. abstract="false" native="false" synchronized="false"
  10762. static="false" final="false" visibility="public"
  10763. deprecated="not deprecated">
  10764. <doc>
  10765. <![CDATA[Get the entity type
  10766. @return the entity type]]>
  10767. </doc>
  10768. </method>
  10769. <method name="setEntityType"
  10770. abstract="false" native="false" synchronized="false"
  10771. static="false" final="false" visibility="public"
  10772. deprecated="not deprecated">
  10773. <param name="entityType" type="java.lang.String"/>
  10774. <doc>
  10775. <![CDATA[Set the entity type
  10776. @param entityType
  10777. the entity type]]>
  10778. </doc>
  10779. </method>
  10780. <method name="getEntityId" return="java.lang.String"
  10781. abstract="false" native="false" synchronized="false"
  10782. static="false" final="false" visibility="public"
  10783. deprecated="not deprecated">
  10784. <doc>
  10785. <![CDATA[Get the entity Id
  10786. @return the entity Id]]>
  10787. </doc>
  10788. </method>
  10789. <method name="setEntityId"
  10790. abstract="false" native="false" synchronized="false"
  10791. static="false" final="false" visibility="public"
  10792. deprecated="not deprecated">
  10793. <param name="entityId" type="java.lang.String"/>
  10794. <doc>
  10795. <![CDATA[Set the entity Id
  10796. @param entityId
  10797. the entity Id]]>
  10798. </doc>
  10799. </method>
  10800. <method name="getStartTime" return="java.lang.Long"
  10801. abstract="false" native="false" synchronized="false"
  10802. static="false" final="false" visibility="public"
  10803. deprecated="not deprecated">
  10804. <doc>
  10805. <![CDATA[Get the start time of the entity
  10806. @return the start time of the entity]]>
  10807. </doc>
  10808. </method>
  10809. <method name="setStartTime"
  10810. abstract="false" native="false" synchronized="false"
  10811. static="false" final="false" visibility="public"
  10812. deprecated="not deprecated">
  10813. <param name="startTime" type="java.lang.Long"/>
  10814. <doc>
  10815. <![CDATA[Set the start time of the entity
  10816. @param startTime
  10817. the start time of the entity]]>
  10818. </doc>
  10819. </method>
  10820. <method name="getEvents" return="java.util.List"
  10821. abstract="false" native="false" synchronized="false"
  10822. static="false" final="false" visibility="public"
  10823. deprecated="not deprecated">
  10824. <doc>
  10825. <![CDATA[Get a list of events related to the entity
  10826. @return a list of events related to the entity]]>
  10827. </doc>
  10828. </method>
  10829. <method name="addEvent"
  10830. abstract="false" native="false" synchronized="false"
  10831. static="false" final="false" visibility="public"
  10832. deprecated="not deprecated">
  10833. <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  10834. <doc>
  10835. <![CDATA[Add a single event related to the entity to the existing event list
  10836. @param event
  10837. a single event related to the entity]]>
  10838. </doc>
  10839. </method>
  10840. <method name="addEvents"
  10841. abstract="false" native="false" synchronized="false"
  10842. static="false" final="false" visibility="public"
  10843. deprecated="not deprecated">
  10844. <param name="events" type="java.util.List"/>
  10845. <doc>
  10846. <![CDATA[Add a list of events related to the entity to the existing event list
  10847. @param events
  10848. a list of events related to the entity]]>
  10849. </doc>
  10850. </method>
  10851. <method name="setEvents"
  10852. abstract="false" native="false" synchronized="false"
  10853. static="false" final="false" visibility="public"
  10854. deprecated="not deprecated">
  10855. <param name="events" type="java.util.List"/>
  10856. <doc>
  10857. <![CDATA[Set the event list to the given list of events related to the entity
  10858. @param events
  10859. events a list of events related to the entity]]>
  10860. </doc>
  10861. </method>
  10862. <method name="getRelatedEntities" return="java.util.Map"
  10863. abstract="false" native="false" synchronized="false"
  10864. static="false" final="false" visibility="public"
  10865. deprecated="not deprecated">
  10866. <doc>
  10867. <![CDATA[Get the related entities
  10868. @return the related entities]]>
  10869. </doc>
  10870. </method>
  10871. <method name="addRelatedEntity"
  10872. abstract="false" native="false" synchronized="false"
  10873. static="false" final="false" visibility="public"
  10874. deprecated="not deprecated">
  10875. <param name="entityType" type="java.lang.String"/>
  10876. <param name="entityId" type="java.lang.String"/>
  10877. <doc>
  10878. <![CDATA[Add an entity to the existing related entity map
  10879. @param entityType
  10880. the entity type
  10881. @param entityId
  10882. the entity Id]]>
  10883. </doc>
  10884. </method>
  10885. <method name="addRelatedEntities"
  10886. abstract="false" native="false" synchronized="false"
  10887. static="false" final="false" visibility="public"
  10888. deprecated="not deprecated">
  10889. <param name="relatedEntities" type="java.util.Map"/>
  10890. <doc>
  10891. <![CDATA[Add a map of related entities to the existing related entity map
  10892. @param relatedEntities
  10893. a map of related entities]]>
  10894. </doc>
  10895. </method>
  10896. <method name="setRelatedEntities"
  10897. abstract="false" native="false" synchronized="false"
  10898. static="false" final="false" visibility="public"
  10899. deprecated="not deprecated">
  10900. <param name="relatedEntities" type="java.util.Map"/>
  10901. <doc>
  10902. <![CDATA[Set the related entity map to the given map of related entities
  10903. @param relatedEntities
  10904. a map of related entities]]>
  10905. </doc>
  10906. </method>
  10907. <method name="getPrimaryFilters" return="java.util.Map"
  10908. abstract="false" native="false" synchronized="false"
  10909. static="false" final="false" visibility="public"
  10910. deprecated="not deprecated">
  10911. <doc>
  10912. <![CDATA[Get the primary filters
  10913. @return the primary filters]]>
  10914. </doc>
  10915. </method>
  10916. <method name="addPrimaryFilter"
  10917. abstract="false" native="false" synchronized="false"
  10918. static="false" final="false" visibility="public"
  10919. deprecated="not deprecated">
  10920. <param name="key" type="java.lang.String"/>
  10921. <param name="value" type="java.lang.Object"/>
  10922. <doc>
  10923. <![CDATA[Add a single piece of primary filter to the existing primary filter map
  10924. @param key
  10925. the primary filter key
  10926. @param value
  10927. the primary filter value]]>
  10928. </doc>
  10929. </method>
  10930. <method name="addPrimaryFilters"
  10931. abstract="false" native="false" synchronized="false"
  10932. static="false" final="false" visibility="public"
  10933. deprecated="not deprecated">
  10934. <param name="primaryFilters" type="java.util.Map"/>
  10935. <doc>
  10936. <![CDATA[Add a map of primary filters to the existing primary filter map
  10937. @param primaryFilters
  10938. a map of primary filters]]>
  10939. </doc>
  10940. </method>
  10941. <method name="setPrimaryFilters"
  10942. abstract="false" native="false" synchronized="false"
  10943. static="false" final="false" visibility="public"
  10944. deprecated="not deprecated">
  10945. <param name="primaryFilters" type="java.util.Map"/>
  10946. <doc>
  10947. <![CDATA[Set the primary filter map to the given map of primary filters
  10948. @param primaryFilters
  10949. a map of primary filters]]>
  10950. </doc>
  10951. </method>
  10952. <method name="getOtherInfo" return="java.util.Map"
  10953. abstract="false" native="false" synchronized="false"
  10954. static="false" final="false" visibility="public"
  10955. deprecated="not deprecated">
  10956. <doc>
  10957. <![CDATA[Get the other information of the entity
  10958. @return the other information of the entity]]>
  10959. </doc>
  10960. </method>
  10961. <method name="addOtherInfo"
  10962. abstract="false" native="false" synchronized="false"
  10963. static="false" final="false" visibility="public"
  10964. deprecated="not deprecated">
  10965. <param name="key" type="java.lang.String"/>
  10966. <param name="value" type="java.lang.Object"/>
  10967. <doc>
  10968. <![CDATA[Add one piece of other information of the entity to the existing other info
  10969. map
  10970. @param key
  10971. the other information key
  10972. @param value
  10973. the other information value]]>
  10974. </doc>
  10975. </method>
  10976. <method name="addOtherInfo"
  10977. abstract="false" native="false" synchronized="false"
  10978. static="false" final="false" visibility="public"
  10979. deprecated="not deprecated">
  10980. <param name="otherInfo" type="java.util.Map"/>
  10981. <doc>
  10982. <![CDATA[Add a map of other information of the entity to the existing other info map
  10983. @param otherInfo
  10984. a map of other information]]>
  10985. </doc>
  10986. </method>
  10987. <method name="setOtherInfo"
  10988. abstract="false" native="false" synchronized="false"
  10989. static="false" final="false" visibility="public"
  10990. deprecated="not deprecated">
  10991. <param name="otherInfo" type="java.util.Map"/>
  10992. <doc>
  10993. <![CDATA[Set the other info map to the given map of other information
  10994. @param otherInfo
  10995. a map of other information]]>
  10996. </doc>
  10997. </method>
  10998. <method name="getDomainId" return="java.lang.String"
  10999. abstract="false" native="false" synchronized="false"
  11000. static="false" final="false" visibility="public"
  11001. deprecated="not deprecated">
  11002. <doc>
  11003. <![CDATA[Get the ID of the domain that the entity is to be put
  11004. @return the domain ID]]>
  11005. </doc>
  11006. </method>
  11007. <method name="setDomainId"
  11008. abstract="false" native="false" synchronized="false"
  11009. static="false" final="false" visibility="public"
  11010. deprecated="not deprecated">
  11011. <param name="domainId" type="java.lang.String"/>
  11012. <doc>
  11013. <![CDATA[Set the ID of the domain that the entity is to be put
  11014. @param domainId
  11015. the name space ID]]>
  11016. </doc>
  11017. </method>
  11018. <method name="hashCode" return="int"
  11019. abstract="false" native="false" synchronized="false"
  11020. static="false" final="false" visibility="public"
  11021. deprecated="not deprecated">
  11022. </method>
  11023. <method name="equals" return="boolean"
  11024. abstract="false" native="false" synchronized="false"
  11025. static="false" final="false" visibility="public"
  11026. deprecated="not deprecated">
  11027. <param name="obj" type="java.lang.Object"/>
  11028. </method>
  11029. <method name="compareTo" return="int"
  11030. abstract="false" native="false" synchronized="false"
  11031. static="false" final="false" visibility="public"
  11032. deprecated="not deprecated">
  11033. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
  11034. </method>
  11035. <doc>
  11036. <![CDATA[<p>
  11037. The class that contains the the meta information of some conceptual entity
  11038. and its related events. The entity can be an application, an application
  11039. attempt, a container or whatever the user-defined object.
  11040. </p>
  11041. <p>
  11042. Primary filters will be used to index the entities in
  11043. <code>TimelineStore</code>, such that users should carefully choose the
  11044. information they want to store as the primary filters. The remaining can be
  11045. stored as other information.
  11046. </p>]]>
  11047. </doc>
  11048. </class>
  11049. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
  11050. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId -->
  11051. <class name="TimelineEntityGroupId" extends="java.lang.Object"
  11052. abstract="false"
  11053. static="false" final="false" visibility="public"
  11054. deprecated="not deprecated">
  11055. <implements name="java.lang.Comparable"/>
  11056. <constructor name="TimelineEntityGroupId"
  11057. static="false" final="false" visibility="public"
  11058. deprecated="not deprecated">
  11059. </constructor>
  11060. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"
  11061. abstract="false" native="false" synchronized="false"
  11062. static="true" final="false" visibility="public"
  11063. deprecated="not deprecated">
  11064. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  11065. <param name="id" type="java.lang.String"/>
  11066. </method>
  11067. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  11068. abstract="false" native="false" synchronized="false"
  11069. static="false" final="false" visibility="public"
  11070. deprecated="not deprecated">
  11071. <doc>
  11072. <![CDATA[Get the <code>ApplicationId</code> of the
  11073. <code>TimelineEntityGroupId</code>.
  11074. @return <code>ApplicationId</code> of the
  11075. <code>TimelineEntityGroupId</code>]]>
  11076. </doc>
  11077. </method>
  11078. <method name="setApplicationId"
  11079. abstract="false" native="false" synchronized="false"
  11080. static="false" final="false" visibility="public"
  11081. deprecated="not deprecated">
  11082. <param name="appID" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  11083. </method>
  11084. <method name="getTimelineEntityGroupId" return="java.lang.String"
  11085. abstract="false" native="false" synchronized="false"
  11086. static="false" final="false" visibility="public"
  11087. deprecated="not deprecated">
  11088. <doc>
  11089. <![CDATA[Get the <code>timelineEntityGroupId</code>.
  11090. @return <code>timelineEntityGroupId</code>]]>
  11091. </doc>
  11092. </method>
  11093. <method name="hashCode" return="int"
  11094. abstract="false" native="false" synchronized="false"
  11095. static="false" final="false" visibility="public"
  11096. deprecated="not deprecated">
  11097. </method>
  11098. <method name="equals" return="boolean"
  11099. abstract="false" native="false" synchronized="false"
  11100. static="false" final="false" visibility="public"
  11101. deprecated="not deprecated">
  11102. <param name="obj" type="java.lang.Object"/>
  11103. </method>
  11104. <method name="compareTo" return="int"
  11105. abstract="false" native="false" synchronized="false"
  11106. static="false" final="false" visibility="public"
  11107. deprecated="not deprecated">
  11108. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"/>
  11109. </method>
  11110. <method name="toString" return="java.lang.String"
  11111. abstract="false" native="false" synchronized="false"
  11112. static="false" final="false" visibility="public"
  11113. deprecated="not deprecated">
  11114. </method>
  11115. <method name="fromString" return="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"
  11116. abstract="false" native="false" synchronized="false"
  11117. static="true" final="false" visibility="public"
  11118. deprecated="not deprecated">
  11119. <param name="timelineEntityGroupIdStr" type="java.lang.String"/>
  11120. </method>
  11121. <field name="TIMELINE_ENTITY_GROUPID_STR_PREFIX" type="java.lang.String"
  11122. transient="false" volatile="false"
  11123. static="true" final="true" visibility="public"
  11124. deprecated="not deprecated">
  11125. </field>
  11126. <doc>
  11127. <![CDATA[<p><code>TimelineEntityGroupId</code> is an abstract way for
  11128. timeline service users to represent #a group of related timeline data.
  11129. For example, all entities that represents one data flow DAG execution
  11130. can be grouped into one timeline entity group. </p>]]>
  11131. </doc>
  11132. </class>
  11133. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId -->
  11134. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
  11135. <class name="TimelineEvent" extends="java.lang.Object"
  11136. abstract="false"
  11137. static="false" final="false" visibility="public"
  11138. deprecated="not deprecated">
  11139. <implements name="java.lang.Comparable"/>
  11140. <constructor name="TimelineEvent"
  11141. static="false" final="false" visibility="public"
  11142. deprecated="not deprecated">
  11143. </constructor>
  11144. <method name="getTimestamp" return="long"
  11145. abstract="false" native="false" synchronized="false"
  11146. static="false" final="false" visibility="public"
  11147. deprecated="not deprecated">
  11148. <doc>
  11149. <![CDATA[Get the timestamp of the event
  11150. @return the timestamp of the event]]>
  11151. </doc>
  11152. </method>
  11153. <method name="setTimestamp"
  11154. abstract="false" native="false" synchronized="false"
  11155. static="false" final="false" visibility="public"
  11156. deprecated="not deprecated">
  11157. <param name="timestamp" type="long"/>
  11158. <doc>
  11159. <![CDATA[Set the timestamp of the event
  11160. @param timestamp
  11161. the timestamp of the event]]>
  11162. </doc>
  11163. </method>
  11164. <method name="getEventType" return="java.lang.String"
  11165. abstract="false" native="false" synchronized="false"
  11166. static="false" final="false" visibility="public"
  11167. deprecated="not deprecated">
  11168. <doc>
  11169. <![CDATA[Get the event type
  11170. @return the event type]]>
  11171. </doc>
  11172. </method>
  11173. <method name="setEventType"
  11174. abstract="false" native="false" synchronized="false"
  11175. static="false" final="false" visibility="public"
  11176. deprecated="not deprecated">
  11177. <param name="eventType" type="java.lang.String"/>
  11178. <doc>
  11179. <![CDATA[Set the event type
  11180. @param eventType
  11181. the event type]]>
  11182. </doc>
  11183. </method>
  11184. <method name="getEventInfo" return="java.util.Map"
  11185. abstract="false" native="false" synchronized="false"
  11186. static="false" final="false" visibility="public"
  11187. deprecated="not deprecated">
  11188. <doc>
  11189. <![CDATA[Set the information of the event
  11190. @return the information of the event]]>
  11191. </doc>
  11192. </method>
  11193. <method name="addEventInfo"
  11194. abstract="false" native="false" synchronized="false"
  11195. static="false" final="false" visibility="public"
  11196. deprecated="not deprecated">
  11197. <param name="key" type="java.lang.String"/>
  11198. <param name="value" type="java.lang.Object"/>
  11199. <doc>
  11200. <![CDATA[Add one piece of the information of the event to the existing information
  11201. map
  11202. @param key
  11203. the information key
  11204. @param value
  11205. the information value]]>
  11206. </doc>
  11207. </method>
  11208. <method name="addEventInfo"
  11209. abstract="false" native="false" synchronized="false"
  11210. static="false" final="false" visibility="public"
  11211. deprecated="not deprecated">
  11212. <param name="eventInfo" type="java.util.Map"/>
  11213. <doc>
  11214. <![CDATA[Add a map of the information of the event to the existing information map
  11215. @param eventInfo
  11216. a map of of the information of the event]]>
  11217. </doc>
  11218. </method>
  11219. <method name="setEventInfo"
  11220. abstract="false" native="false" synchronized="false"
  11221. static="false" final="false" visibility="public"
  11222. deprecated="not deprecated">
  11223. <param name="eventInfo" type="java.util.Map"/>
  11224. <doc>
  11225. <![CDATA[Set the information map to the given map of the information of the event
  11226. @param eventInfo
  11227. a map of of the information of the event]]>
  11228. </doc>
  11229. </method>
  11230. <method name="compareTo" return="int"
  11231. abstract="false" native="false" synchronized="false"
  11232. static="false" final="false" visibility="public"
  11233. deprecated="not deprecated">
  11234. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  11235. </method>
  11236. <method name="equals" return="boolean"
  11237. abstract="false" native="false" synchronized="false"
  11238. static="false" final="false" visibility="public"
  11239. deprecated="not deprecated">
  11240. <param name="o" type="java.lang.Object"/>
  11241. </method>
  11242. <method name="hashCode" return="int"
  11243. abstract="false" native="false" synchronized="false"
  11244. static="false" final="false" visibility="public"
  11245. deprecated="not deprecated">
  11246. </method>
  11247. <doc>
  11248. <![CDATA[The class that contains the information of an event that is related to some
  11249. conceptual entity of an application. Users are free to define what the event
  11250. means, such as starting an application, getting allocated a container and
  11251. etc.]]>
  11252. </doc>
  11253. </class>
  11254. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
  11255. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
  11256. <class name="TimelineEvents" extends="java.lang.Object"
  11257. abstract="false"
  11258. static="false" final="false" visibility="public"
  11259. deprecated="not deprecated">
  11260. <constructor name="TimelineEvents"
  11261. static="false" final="false" visibility="public"
  11262. deprecated="not deprecated">
  11263. </constructor>
  11264. <method name="getAllEvents" return="java.util.List"
  11265. abstract="false" native="false" synchronized="false"
  11266. static="false" final="false" visibility="public"
  11267. deprecated="not deprecated">
  11268. <doc>
  11269. <![CDATA[Get a list of {@link EventsOfOneEntity} instances
  11270. @return a list of {@link EventsOfOneEntity} instances]]>
  11271. </doc>
  11272. </method>
  11273. <method name="addEvent"
  11274. abstract="false" native="false" synchronized="false"
  11275. static="false" final="false" visibility="public"
  11276. deprecated="not deprecated">
  11277. <param name="eventsOfOneEntity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity"/>
  11278. <doc>
  11279. <![CDATA[Add a single {@link EventsOfOneEntity} instance into the existing list
  11280. @param eventsOfOneEntity
  11281. a single {@link EventsOfOneEntity} instance]]>
  11282. </doc>
  11283. </method>
  11284. <method name="addEvents"
  11285. abstract="false" native="false" synchronized="false"
  11286. static="false" final="false" visibility="public"
  11287. deprecated="not deprecated">
  11288. <param name="allEvents" type="java.util.List"/>
  11289. <doc>
  11290. <![CDATA[Add a list of {@link EventsOfOneEntity} instances into the existing list
  11291. @param allEvents
  11292. a list of {@link EventsOfOneEntity} instances]]>
  11293. </doc>
  11294. </method>
  11295. <method name="setEvents"
  11296. abstract="false" native="false" synchronized="false"
  11297. static="false" final="false" visibility="public"
  11298. deprecated="not deprecated">
  11299. <param name="allEvents" type="java.util.List"/>
  11300. <doc>
  11301. <![CDATA[Set the list to the given list of {@link EventsOfOneEntity} instances
  11302. @param allEvents
  11303. a list of {@link EventsOfOneEntity} instances]]>
  11304. </doc>
  11305. </method>
  11306. <doc>
  11307. <![CDATA[The class that hosts a list of events, which are categorized according to
  11308. their related entities.]]>
  11309. </doc>
  11310. </class>
  11311. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
  11312. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
  11313. <class name="TimelineEvents.EventsOfOneEntity" extends="java.lang.Object"
  11314. abstract="false"
  11315. static="true" final="false" visibility="public"
  11316. deprecated="not deprecated">
  11317. <constructor name="EventsOfOneEntity"
  11318. static="false" final="false" visibility="public"
  11319. deprecated="not deprecated">
  11320. </constructor>
  11321. <method name="getEntityId" return="java.lang.String"
  11322. abstract="false" native="false" synchronized="false"
  11323. static="false" final="false" visibility="public"
  11324. deprecated="not deprecated">
  11325. <doc>
  11326. <![CDATA[Get the entity Id
  11327. @return the entity Id]]>
  11328. </doc>
  11329. </method>
  11330. <method name="setEntityId"
  11331. abstract="false" native="false" synchronized="false"
  11332. static="false" final="false" visibility="public"
  11333. deprecated="not deprecated">
  11334. <param name="entityId" type="java.lang.String"/>
  11335. <doc>
  11336. <![CDATA[Set the entity Id
  11337. @param entityId
  11338. the entity Id]]>
  11339. </doc>
  11340. </method>
  11341. <method name="getEntityType" return="java.lang.String"
  11342. abstract="false" native="false" synchronized="false"
  11343. static="false" final="false" visibility="public"
  11344. deprecated="not deprecated">
  11345. <doc>
  11346. <![CDATA[Get the entity type
  11347. @return the entity type]]>
  11348. </doc>
  11349. </method>
  11350. <method name="setEntityType"
  11351. abstract="false" native="false" synchronized="false"
  11352. static="false" final="false" visibility="public"
  11353. deprecated="not deprecated">
  11354. <param name="entityType" type="java.lang.String"/>
  11355. <doc>
  11356. <![CDATA[Set the entity type
  11357. @param entityType
  11358. the entity type]]>
  11359. </doc>
  11360. </method>
  11361. <method name="getEvents" return="java.util.List"
  11362. abstract="false" native="false" synchronized="false"
  11363. static="false" final="false" visibility="public"
  11364. deprecated="not deprecated">
  11365. <doc>
  11366. <![CDATA[Get a list of events
  11367. @return a list of events]]>
  11368. </doc>
  11369. </method>
  11370. <method name="addEvent"
  11371. abstract="false" native="false" synchronized="false"
  11372. static="false" final="false" visibility="public"
  11373. deprecated="not deprecated">
  11374. <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  11375. <doc>
  11376. <![CDATA[Add a single event to the existing event list
  11377. @param event
  11378. a single event]]>
  11379. </doc>
  11380. </method>
  11381. <method name="addEvents"
  11382. abstract="false" native="false" synchronized="false"
  11383. static="false" final="false" visibility="public"
  11384. deprecated="not deprecated">
  11385. <param name="events" type="java.util.List"/>
  11386. <doc>
  11387. <![CDATA[Add a list of event to the existing event list
  11388. @param events
  11389. a list of events]]>
  11390. </doc>
  11391. </method>
  11392. <method name="setEvents"
  11393. abstract="false" native="false" synchronized="false"
  11394. static="false" final="false" visibility="public"
  11395. deprecated="not deprecated">
  11396. <param name="events" type="java.util.List"/>
  11397. <doc>
  11398. <![CDATA[Set the event list to the given list of events
  11399. @param events
  11400. a list of events]]>
  11401. </doc>
  11402. </method>
  11403. <doc>
  11404. <![CDATA[The class that hosts a list of events that are only related to one entity.]]>
  11405. </doc>
  11406. </class>
  11407. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
  11408. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
  11409. <class name="TimelinePutResponse" extends="java.lang.Object"
  11410. abstract="false"
  11411. static="false" final="false" visibility="public"
  11412. deprecated="not deprecated">
  11413. <constructor name="TimelinePutResponse"
  11414. static="false" final="false" visibility="public"
  11415. deprecated="not deprecated">
  11416. </constructor>
  11417. <method name="getErrors" return="java.util.List"
  11418. abstract="false" native="false" synchronized="false"
  11419. static="false" final="false" visibility="public"
  11420. deprecated="not deprecated">
  11421. <doc>
  11422. <![CDATA[Get a list of {@link TimelinePutError} instances
  11423. @return a list of {@link TimelinePutError} instances]]>
  11424. </doc>
  11425. </method>
  11426. <method name="addError"
  11427. abstract="false" native="false" synchronized="false"
  11428. static="false" final="false" visibility="public"
  11429. deprecated="not deprecated">
  11430. <param name="error" type="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError"/>
  11431. <doc>
  11432. <![CDATA[Add a single {@link TimelinePutError} instance into the existing list
  11433. @param error
  11434. a single {@link TimelinePutError} instance]]>
  11435. </doc>
  11436. </method>
  11437. <method name="addErrors"
  11438. abstract="false" native="false" synchronized="false"
  11439. static="false" final="false" visibility="public"
  11440. deprecated="not deprecated">
  11441. <param name="errors" type="java.util.List"/>
  11442. <doc>
  11443. <![CDATA[Add a list of {@link TimelinePutError} instances into the existing list
  11444. @param errors
  11445. a list of {@link TimelinePutError} instances]]>
  11446. </doc>
  11447. </method>
  11448. <method name="setErrors"
  11449. abstract="false" native="false" synchronized="false"
  11450. static="false" final="false" visibility="public"
  11451. deprecated="not deprecated">
  11452. <param name="errors" type="java.util.List"/>
  11453. <doc>
  11454. <![CDATA[Set the list to the given list of {@link TimelinePutError} instances
  11455. @param errors
  11456. a list of {@link TimelinePutError} instances]]>
  11457. </doc>
  11458. </method>
  11459. <doc>
  11460. <![CDATA[A class that holds a list of put errors. This is the response returned when a
  11461. list of {@link TimelineEntity} objects is added to the timeline. If there are errors
  11462. in storing individual entity objects, they will be indicated in the list of
  11463. errors.]]>
  11464. </doc>
  11465. </class>
  11466. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
  11467. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
  11468. <class name="TimelinePutResponse.TimelinePutError" extends="java.lang.Object"
  11469. abstract="false"
  11470. static="true" final="false" visibility="public"
  11471. deprecated="not deprecated">
  11472. <constructor name="TimelinePutError"
  11473. static="false" final="false" visibility="public"
  11474. deprecated="not deprecated">
  11475. </constructor>
  11476. <method name="getEntityId" return="java.lang.String"
  11477. abstract="false" native="false" synchronized="false"
  11478. static="false" final="false" visibility="public"
  11479. deprecated="not deprecated">
  11480. <doc>
  11481. <![CDATA[Get the entity Id
  11482. @return the entity Id]]>
  11483. </doc>
  11484. </method>
  11485. <method name="setEntityId"
  11486. abstract="false" native="false" synchronized="false"
  11487. static="false" final="false" visibility="public"
  11488. deprecated="not deprecated">
  11489. <param name="entityId" type="java.lang.String"/>
  11490. <doc>
  11491. <![CDATA[Set the entity Id
  11492. @param entityId
  11493. the entity Id]]>
  11494. </doc>
  11495. </method>
  11496. <method name="getEntityType" return="java.lang.String"
  11497. abstract="false" native="false" synchronized="false"
  11498. static="false" final="false" visibility="public"
  11499. deprecated="not deprecated">
  11500. <doc>
  11501. <![CDATA[Get the entity type
  11502. @return the entity type]]>
  11503. </doc>
  11504. </method>
  11505. <method name="setEntityType"
  11506. abstract="false" native="false" synchronized="false"
  11507. static="false" final="false" visibility="public"
  11508. deprecated="not deprecated">
  11509. <param name="entityType" type="java.lang.String"/>
  11510. <doc>
  11511. <![CDATA[Set the entity type
  11512. @param entityType
  11513. the entity type]]>
  11514. </doc>
  11515. </method>
  11516. <method name="getErrorCode" return="int"
  11517. abstract="false" native="false" synchronized="false"
  11518. static="false" final="false" visibility="public"
  11519. deprecated="not deprecated">
  11520. <doc>
  11521. <![CDATA[Get the error code
  11522. @return an error code]]>
  11523. </doc>
  11524. </method>
  11525. <method name="setErrorCode"
  11526. abstract="false" native="false" synchronized="false"
  11527. static="false" final="false" visibility="public"
  11528. deprecated="not deprecated">
  11529. <param name="errorCode" type="int"/>
  11530. <doc>
  11531. <![CDATA[Set the error code to the given error code
  11532. @param errorCode
  11533. an error code]]>
  11534. </doc>
  11535. </method>
  11536. <field name="NO_START_TIME" type="int"
  11537. transient="false" volatile="false"
  11538. static="true" final="true" visibility="public"
  11539. deprecated="not deprecated">
  11540. <doc>
  11541. <![CDATA[Error code returned when no start time can be found when putting an
  11542. entity. This occurs when the entity does not already exist in the store
  11543. and it is put with no start time or events specified.]]>
  11544. </doc>
  11545. </field>
  11546. <field name="IO_EXCEPTION" type="int"
  11547. transient="false" volatile="false"
  11548. static="true" final="true" visibility="public"
  11549. deprecated="not deprecated">
  11550. <doc>
  11551. <![CDATA[Error code returned if an IOException is encountered when putting an
  11552. entity.]]>
  11553. </doc>
  11554. </field>
  11555. <field name="SYSTEM_FILTER_CONFLICT" type="int"
  11556. transient="false" volatile="false"
  11557. static="true" final="true" visibility="public"
  11558. deprecated="not deprecated">
  11559. <doc>
  11560. <![CDATA[Error code returned if the user specifies the timeline system reserved
  11561. filter key]]>
  11562. </doc>
  11563. </field>
  11564. <field name="ACCESS_DENIED" type="int"
  11565. transient="false" volatile="false"
  11566. static="true" final="true" visibility="public"
  11567. deprecated="not deprecated">
  11568. <doc>
  11569. <![CDATA[Error code returned if the user is denied to access the timeline data]]>
  11570. </doc>
  11571. </field>
  11572. <field name="NO_DOMAIN" type="int"
  11573. transient="false" volatile="false"
  11574. static="true" final="true" visibility="public"
  11575. deprecated="not deprecated">
  11576. <doc>
  11577. <![CDATA[Error code returned if the entity doesn't have an valid domain ID]]>
  11578. </doc>
  11579. </field>
  11580. <field name="FORBIDDEN_RELATION" type="int"
  11581. transient="false" volatile="false"
  11582. static="true" final="true" visibility="public"
  11583. deprecated="not deprecated">
  11584. <doc>
  11585. <![CDATA[Error code returned if the user is denied to relate the entity to another
  11586. one in different domain]]>
  11587. </doc>
  11588. </field>
  11589. <field name="EXPIRED_ENTITY" type="int"
  11590. transient="false" volatile="false"
  11591. static="true" final="true" visibility="public"
  11592. deprecated="not deprecated">
  11593. <doc>
  11594. <![CDATA[Error code returned if the entity start time is before the eviction
  11595. period of old data.]]>
  11596. </doc>
  11597. </field>
  11598. <doc>
  11599. <![CDATA[A class that holds the error code for one entity.]]>
  11600. </doc>
  11601. </class>
  11602. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
  11603. </package>
  11604. <package name="org.apache.hadoop.yarn.conf">
  11605. <!-- start class org.apache.hadoop.yarn.conf.YarnConfiguration -->
  11606. <class name="YarnConfiguration" extends="org.apache.hadoop.conf.Configuration"
  11607. abstract="false"
  11608. static="false" final="false" visibility="public"
  11609. deprecated="not deprecated">
  11610. <constructor name="YarnConfiguration"
  11611. static="false" final="false" visibility="public"
  11612. deprecated="not deprecated">
  11613. </constructor>
  11614. <constructor name="YarnConfiguration" type="org.apache.hadoop.conf.Configuration"
  11615. static="false" final="false" visibility="public"
  11616. deprecated="not deprecated">
  11617. </constructor>
  11618. <method name="getSocketAddr" return="java.net.InetSocketAddress"
  11619. abstract="false" native="false" synchronized="false"
  11620. static="false" final="false" visibility="public"
  11621. deprecated="not deprecated">
  11622. <param name="name" type="java.lang.String"/>
  11623. <param name="defaultAddress" type="java.lang.String"/>
  11624. <param name="defaultPort" type="int"/>
  11625. <doc>
  11626. <![CDATA[Get the socket address for <code>name</code> property as a
  11627. <code>InetSocketAddress</code>. On a HA cluster,
  11628. this fetches the address corresponding to the RM identified by
  11629. {@link #RM_HA_ID}.
  11630. @param name property name.
  11631. @param defaultAddress the default value
  11632. @param defaultPort the default port
  11633. @return InetSocketAddress]]>
  11634. </doc>
  11635. </method>
  11636. <method name="updateConnectAddr" return="java.net.InetSocketAddress"
  11637. abstract="false" native="false" synchronized="false"
  11638. static="false" final="false" visibility="public"
  11639. deprecated="not deprecated">
  11640. <param name="name" type="java.lang.String"/>
  11641. <param name="addr" type="java.net.InetSocketAddress"/>
  11642. </method>
  11643. <method name="useHttps" return="boolean"
  11644. abstract="false" native="false" synchronized="false"
  11645. static="true" final="false" visibility="public"
  11646. deprecated="not deprecated">
  11647. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  11648. </method>
  11649. <method name="shouldRMFailFast" return="boolean"
  11650. abstract="false" native="false" synchronized="false"
  11651. static="true" final="false" visibility="public"
  11652. deprecated="not deprecated">
  11653. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  11654. </method>
  11655. <method name="main"
  11656. abstract="false" native="false" synchronized="false"
  11657. static="true" final="false" visibility="public"
  11658. deprecated="not deprecated">
  11659. <param name="args" type="java.lang.String[]"/>
  11660. <exception name="Exception" type="java.lang.Exception"/>
  11661. </method>
  11662. <field name="DR_CONFIGURATION_FILE" type="java.lang.String"
  11663. transient="false" volatile="false"
  11664. static="true" final="true" visibility="public"
  11665. deprecated="not deprecated">
  11666. </field>
  11667. <field name="CS_CONFIGURATION_FILE" type="java.lang.String"
  11668. transient="false" volatile="false"
  11669. static="true" final="true" visibility="public"
  11670. deprecated="not deprecated">
  11671. </field>
  11672. <field name="HADOOP_POLICY_CONFIGURATION_FILE" type="java.lang.String"
  11673. transient="false" volatile="false"
  11674. static="true" final="true" visibility="public"
  11675. deprecated="not deprecated">
  11676. </field>
  11677. <field name="YARN_SITE_CONFIGURATION_FILE" type="java.lang.String"
  11678. transient="false" volatile="false"
  11679. static="true" final="true" visibility="public"
  11680. deprecated="not deprecated">
  11681. </field>
  11682. <field name="CORE_SITE_CONFIGURATION_FILE" type="java.lang.String"
  11683. transient="false" volatile="false"
  11684. static="true" final="true" visibility="public"
  11685. deprecated="not deprecated">
  11686. </field>
  11687. <field name="RM_CONFIGURATION_FILES" type="java.util.List"
  11688. transient="false" volatile="false"
  11689. static="true" final="true" visibility="public"
  11690. deprecated="not deprecated">
  11691. </field>
  11692. <field name="APPLICATION_MAX_TAGS" type="int"
  11693. transient="false" volatile="false"
  11694. static="true" final="true" visibility="public"
  11695. deprecated="not deprecated">
  11696. </field>
  11697. <field name="APPLICATION_MAX_TAG_LENGTH" type="int"
  11698. transient="false" volatile="false"
  11699. static="true" final="true" visibility="public"
  11700. deprecated="not deprecated">
  11701. </field>
  11702. <field name="YARN_PREFIX" type="java.lang.String"
  11703. transient="false" volatile="false"
  11704. static="true" final="true" visibility="public"
  11705. deprecated="not deprecated">
  11706. </field>
  11707. <field name="DEBUG_NM_DELETE_DELAY_SEC" type="java.lang.String"
  11708. transient="false" volatile="false"
  11709. static="true" final="true" visibility="public"
  11710. deprecated="not deprecated">
  11711. <doc>
  11712. <![CDATA[Delay before deleting resource to ease debugging of NM issues]]>
  11713. </doc>
  11714. </field>
  11715. <field name="NM_LOG_CONTAINER_DEBUG_INFO" type="java.lang.String"
  11716. transient="false" volatile="false"
  11717. static="true" final="true" visibility="public"
  11718. deprecated="not deprecated">
  11719. </field>
  11720. <field name="DEFAULT_NM_LOG_CONTAINER_DEBUG_INFO" type="boolean"
  11721. transient="false" volatile="false"
  11722. static="true" final="true" visibility="public"
  11723. deprecated="not deprecated">
  11724. </field>
  11725. <field name="IPC_PREFIX" type="java.lang.String"
  11726. transient="false" volatile="false"
  11727. static="true" final="true" visibility="public"
  11728. deprecated="not deprecated">
  11729. </field>
  11730. <field name="IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
  11731. transient="false" volatile="false"
  11732. static="true" final="true" visibility="public"
  11733. deprecated="not deprecated">
  11734. <doc>
  11735. <![CDATA[Factory to create client IPC classes.]]>
  11736. </doc>
  11737. </field>
  11738. <field name="DEFAULT_IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
  11739. transient="false" volatile="false"
  11740. static="true" final="true" visibility="public"
  11741. deprecated="not deprecated">
  11742. </field>
  11743. <field name="IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
  11744. transient="false" volatile="false"
  11745. static="true" final="true" visibility="public"
  11746. deprecated="not deprecated">
  11747. <doc>
  11748. <![CDATA[Factory to create server IPC classes.]]>
  11749. </doc>
  11750. </field>
  11751. <field name="DEFAULT_IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
  11752. transient="false" volatile="false"
  11753. static="true" final="true" visibility="public"
  11754. deprecated="not deprecated">
  11755. </field>
  11756. <field name="IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
  11757. transient="false" volatile="false"
  11758. static="true" final="true" visibility="public"
  11759. deprecated="not deprecated">
  11760. <doc>
  11761. <![CDATA[Factory to create serializeable records.]]>
  11762. </doc>
  11763. </field>
  11764. <field name="DEFAULT_IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
  11765. transient="false" volatile="false"
  11766. static="true" final="true" visibility="public"
  11767. deprecated="not deprecated">
  11768. </field>
  11769. <field name="IPC_RPC_IMPL" type="java.lang.String"
  11770. transient="false" volatile="false"
  11771. static="true" final="true" visibility="public"
  11772. deprecated="not deprecated">
  11773. <doc>
  11774. <![CDATA[RPC class implementation]]>
  11775. </doc>
  11776. </field>
  11777. <field name="DEFAULT_IPC_RPC_IMPL" type="java.lang.String"
  11778. transient="false" volatile="false"
  11779. static="true" final="true" visibility="public"
  11780. deprecated="not deprecated">
  11781. </field>
  11782. <field name="RM_PREFIX" type="java.lang.String"
  11783. transient="false" volatile="false"
  11784. static="true" final="true" visibility="public"
  11785. deprecated="not deprecated">
  11786. </field>
  11787. <field name="RM_CLUSTER_ID" type="java.lang.String"
  11788. transient="false" volatile="false"
  11789. static="true" final="true" visibility="public"
  11790. deprecated="not deprecated">
  11791. </field>
  11792. <field name="RM_HOSTNAME" type="java.lang.String"
  11793. transient="false" volatile="false"
  11794. static="true" final="true" visibility="public"
  11795. deprecated="not deprecated">
  11796. </field>
  11797. <field name="RM_ADDRESS" type="java.lang.String"
  11798. transient="false" volatile="false"
  11799. static="true" final="true" visibility="public"
  11800. deprecated="not deprecated">
  11801. <doc>
  11802. <![CDATA[The address of the applications manager interface in the RM.]]>
  11803. </doc>
  11804. </field>
  11805. <field name="DEFAULT_RM_PORT" type="int"
  11806. transient="false" volatile="false"
  11807. static="true" final="true" visibility="public"
  11808. deprecated="not deprecated">
  11809. </field>
  11810. <field name="DEFAULT_RM_ADDRESS" type="java.lang.String"
  11811. transient="false" volatile="false"
  11812. static="true" final="true" visibility="public"
  11813. deprecated="not deprecated">
  11814. </field>
  11815. <field name="RM_BIND_HOST" type="java.lang.String"
  11816. transient="false" volatile="false"
  11817. static="true" final="true" visibility="public"
  11818. deprecated="not deprecated">
  11819. <doc>
  11820. <![CDATA[The actual bind address for the RM.]]>
  11821. </doc>
  11822. </field>
  11823. <field name="RM_CLIENT_THREAD_COUNT" type="java.lang.String"
  11824. transient="false" volatile="false"
  11825. static="true" final="true" visibility="public"
  11826. deprecated="not deprecated">
  11827. <doc>
  11828. <![CDATA[The number of threads used to handle applications manager requests.]]>
  11829. </doc>
  11830. </field>
  11831. <field name="DEFAULT_RM_CLIENT_THREAD_COUNT" type="int"
  11832. transient="false" volatile="false"
  11833. static="true" final="true" visibility="public"
  11834. deprecated="not deprecated">
  11835. </field>
  11836. <field name="RM_AMLAUNCHER_THREAD_COUNT" type="java.lang.String"
  11837. transient="false" volatile="false"
  11838. static="true" final="true" visibility="public"
  11839. deprecated="not deprecated">
  11840. <doc>
  11841. <![CDATA[Number of threads used to launch/cleanup AM.]]>
  11842. </doc>
  11843. </field>
  11844. <field name="DEFAULT_RM_AMLAUNCHER_THREAD_COUNT" type="int"
  11845. transient="false" volatile="false"
  11846. static="true" final="true" visibility="public"
  11847. deprecated="not deprecated">
  11848. </field>
  11849. <field name="RM_NODEMANAGER_CONNECT_RETRIES" type="java.lang.String"
  11850. transient="false" volatile="false"
  11851. static="true" final="true" visibility="public"
  11852. deprecated="not deprecated">
  11853. <doc>
  11854. <![CDATA[Retry times to connect with NM.]]>
  11855. </doc>
  11856. </field>
  11857. <field name="DEFAULT_RM_NODEMANAGER_CONNECT_RETRIES" type="int"
  11858. transient="false" volatile="false"
  11859. static="true" final="true" visibility="public"
  11860. deprecated="not deprecated">
  11861. </field>
  11862. <field name="RM_PRINCIPAL" type="java.lang.String"
  11863. transient="false" volatile="false"
  11864. static="true" final="true" visibility="public"
  11865. deprecated="not deprecated">
  11866. <doc>
  11867. <![CDATA[The Kerberos principal for the resource manager.]]>
  11868. </doc>
  11869. </field>
  11870. <field name="RM_SCHEDULER_ADDRESS" type="java.lang.String"
  11871. transient="false" volatile="false"
  11872. static="true" final="true" visibility="public"
  11873. deprecated="not deprecated">
  11874. <doc>
  11875. <![CDATA[The address of the scheduler interface.]]>
  11876. </doc>
  11877. </field>
  11878. <field name="DEFAULT_RM_SCHEDULER_PORT" type="int"
  11879. transient="false" volatile="false"
  11880. static="true" final="true" visibility="public"
  11881. deprecated="not deprecated">
  11882. </field>
  11883. <field name="DEFAULT_RM_SCHEDULER_ADDRESS" type="java.lang.String"
  11884. transient="false" volatile="false"
  11885. static="true" final="true" visibility="public"
  11886. deprecated="not deprecated">
  11887. </field>
  11888. <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="java.lang.String"
  11889. transient="false" volatile="false"
  11890. static="true" final="true" visibility="public"
  11891. deprecated="not deprecated">
  11892. <doc>
  11893. <![CDATA[Miniumum request grant-able by the RM scheduler.]]>
  11894. </doc>
  11895. </field>
  11896. <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="int"
  11897. transient="false" volatile="false"
  11898. static="true" final="true" visibility="public"
  11899. deprecated="not deprecated">
  11900. </field>
  11901. <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="java.lang.String"
  11902. transient="false" volatile="false"
  11903. static="true" final="true" visibility="public"
  11904. deprecated="not deprecated">
  11905. </field>
  11906. <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="int"
  11907. transient="false" volatile="false"
  11908. static="true" final="true" visibility="public"
  11909. deprecated="not deprecated">
  11910. </field>
  11911. <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="java.lang.String"
  11912. transient="false" volatile="false"
  11913. static="true" final="true" visibility="public"
  11914. deprecated="not deprecated">
  11915. <doc>
  11916. <![CDATA[Maximum request grant-able by the RM scheduler.]]>
  11917. </doc>
  11918. </field>
  11919. <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="int"
  11920. transient="false" volatile="false"
  11921. static="true" final="true" visibility="public"
  11922. deprecated="not deprecated">
  11923. </field>
  11924. <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="java.lang.String"
  11925. transient="false" volatile="false"
  11926. static="true" final="true" visibility="public"
  11927. deprecated="not deprecated">
  11928. </field>
  11929. <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="int"
  11930. transient="false" volatile="false"
  11931. static="true" final="true" visibility="public"
  11932. deprecated="not deprecated">
  11933. </field>
  11934. <field name="RM_SCHEDULER_CLIENT_THREAD_COUNT" type="java.lang.String"
  11935. transient="false" volatile="false"
  11936. static="true" final="true" visibility="public"
  11937. deprecated="not deprecated">
  11938. <doc>
  11939. <![CDATA[Number of threads to handle scheduler interface.]]>
  11940. </doc>
  11941. </field>
  11942. <field name="DEFAULT_RM_SCHEDULER_CLIENT_THREAD_COUNT" type="int"
  11943. transient="false" volatile="false"
  11944. static="true" final="true" visibility="public"
  11945. deprecated="not deprecated">
  11946. </field>
  11947. <field name="RM_SCHEDULER_INCLUDE_PORT_IN_NODE_NAME" type="java.lang.String"
  11948. transient="false" volatile="false"
  11949. static="true" final="true" visibility="public"
  11950. deprecated="not deprecated">
  11951. <doc>
  11952. <![CDATA[If the port should be included or not in the node name. The node name
  11953. is used by the scheduler for resource requests allocation location
  11954. matching. Typically this is just the hostname, using the port is needed
  11955. when using minicluster and specific NM are required.]]>
  11956. </doc>
  11957. </field>
  11958. <field name="DEFAULT_RM_SCHEDULER_USE_PORT_FOR_NODE_NAME" type="boolean"
  11959. transient="false" volatile="false"
  11960. static="true" final="true" visibility="public"
  11961. deprecated="not deprecated">
  11962. </field>
  11963. <field name="RM_WEBAPP_UI_ACTIONS_ENABLED" type="java.lang.String"
  11964. transient="false" volatile="false"
  11965. static="true" final="true" visibility="public"
  11966. deprecated="not deprecated">
  11967. <doc>
  11968. <![CDATA[Enable Resource Manager webapp ui actions]]>
  11969. </doc>
  11970. </field>
  11971. <field name="DEFAULT_RM_WEBAPP_UI_ACTIONS_ENABLED" type="boolean"
  11972. transient="false" volatile="false"
  11973. static="true" final="true" visibility="public"
  11974. deprecated="not deprecated">
  11975. </field>
  11976. <field name="RM_RESERVATION_SYSTEM_ENABLE" type="java.lang.String"
  11977. transient="false" volatile="false"
  11978. static="true" final="true" visibility="public"
  11979. deprecated="not deprecated">
  11980. <doc>
  11981. <![CDATA[Whether the RM should enable Reservation System]]>
  11982. </doc>
  11983. </field>
  11984. <field name="DEFAULT_RM_RESERVATION_SYSTEM_ENABLE" type="boolean"
  11985. transient="false" volatile="false"
  11986. static="true" final="true" visibility="public"
  11987. deprecated="not deprecated">
  11988. </field>
  11989. <field name="RM_RESERVATION_SYSTEM_CLASS" type="java.lang.String"
  11990. transient="false" volatile="false"
  11991. static="true" final="true" visibility="public"
  11992. deprecated="not deprecated">
  11993. <doc>
  11994. <![CDATA[The class to use as the Reservation System.]]>
  11995. </doc>
  11996. </field>
  11997. <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER" type="java.lang.String"
  11998. transient="false" volatile="false"
  11999. static="true" final="true" visibility="public"
  12000. deprecated="not deprecated">
  12001. <doc>
  12002. <![CDATA[The PlanFollower for the Reservation System.]]>
  12003. </doc>
  12004. </field>
  12005. <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="java.lang.String"
  12006. transient="false" volatile="false"
  12007. static="true" final="true" visibility="public"
  12008. deprecated="not deprecated">
  12009. <doc>
  12010. <![CDATA[The step size of the Reservation System.]]>
  12011. </doc>
  12012. </field>
  12013. <field name="DEFAULT_RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="long"
  12014. transient="false" volatile="false"
  12015. static="true" final="true" visibility="public"
  12016. deprecated="not deprecated">
  12017. </field>
  12018. <field name="RM_SCHEDULER_ENABLE_MONITORS" type="java.lang.String"
  12019. transient="false" volatile="false"
  12020. static="true" final="true" visibility="public"
  12021. deprecated="not deprecated">
  12022. <doc>
  12023. <![CDATA[Enable periodic monitor threads.
  12024. @see #RM_SCHEDULER_MONITOR_POLICIES]]>
  12025. </doc>
  12026. </field>
  12027. <field name="DEFAULT_RM_SCHEDULER_ENABLE_MONITORS" type="boolean"
  12028. transient="false" volatile="false"
  12029. static="true" final="true" visibility="public"
  12030. deprecated="not deprecated">
  12031. </field>
  12032. <field name="RM_SCHEDULER_MONITOR_POLICIES" type="java.lang.String"
  12033. transient="false" volatile="false"
  12034. static="true" final="true" visibility="public"
  12035. deprecated="not deprecated">
  12036. <doc>
  12037. <![CDATA[List of SchedulingEditPolicy classes affecting the scheduler.]]>
  12038. </doc>
  12039. </field>
  12040. <field name="RM_WEBAPP_ADDRESS" type="java.lang.String"
  12041. transient="false" volatile="false"
  12042. static="true" final="true" visibility="public"
  12043. deprecated="not deprecated">
  12044. <doc>
  12045. <![CDATA[The address of the RM web application.]]>
  12046. </doc>
  12047. </field>
  12048. <field name="DEFAULT_RM_WEBAPP_PORT" type="int"
  12049. transient="false" volatile="false"
  12050. static="true" final="true" visibility="public"
  12051. deprecated="not deprecated">
  12052. </field>
  12053. <field name="DEFAULT_RM_WEBAPP_ADDRESS" type="java.lang.String"
  12054. transient="false" volatile="false"
  12055. static="true" final="true" visibility="public"
  12056. deprecated="not deprecated">
  12057. </field>
  12058. <field name="RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  12059. transient="false" volatile="false"
  12060. static="true" final="true" visibility="public"
  12061. deprecated="not deprecated">
  12062. <doc>
  12063. <![CDATA[The https address of the RM web application.]]>
  12064. </doc>
  12065. </field>
  12066. <field name="YARN_SSL_CLIENT_HTTPS_NEED_AUTH_DEFAULT" type="boolean"
  12067. transient="false" volatile="false"
  12068. static="true" final="true" visibility="public"
  12069. deprecated="not deprecated">
  12070. </field>
  12071. <field name="YARN_SSL_SERVER_RESOURCE_DEFAULT" type="java.lang.String"
  12072. transient="false" volatile="false"
  12073. static="true" final="true" visibility="public"
  12074. deprecated="not deprecated">
  12075. </field>
  12076. <field name="DEFAULT_RM_WEBAPP_HTTPS_PORT" type="int"
  12077. transient="false" volatile="false"
  12078. static="true" final="true" visibility="public"
  12079. deprecated="not deprecated">
  12080. </field>
  12081. <field name="DEFAULT_RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  12082. transient="false" volatile="false"
  12083. static="true" final="true" visibility="public"
  12084. deprecated="not deprecated">
  12085. </field>
  12086. <field name="RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
  12087. transient="false" volatile="false"
  12088. static="true" final="true" visibility="public"
  12089. deprecated="not deprecated">
  12090. </field>
  12091. <field name="DEFAULT_RM_RESOURCE_TRACKER_PORT" type="int"
  12092. transient="false" volatile="false"
  12093. static="true" final="true" visibility="public"
  12094. deprecated="not deprecated">
  12095. </field>
  12096. <field name="DEFAULT_RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
  12097. transient="false" volatile="false"
  12098. static="true" final="true" visibility="public"
  12099. deprecated="not deprecated">
  12100. </field>
  12101. <field name="RM_AM_EXPIRY_INTERVAL_MS" type="java.lang.String"
  12102. transient="false" volatile="false"
  12103. static="true" final="true" visibility="public"
  12104. deprecated="not deprecated">
  12105. <doc>
  12106. <![CDATA[The expiry interval for application master reporting.]]>
  12107. </doc>
  12108. </field>
  12109. <field name="DEFAULT_RM_AM_EXPIRY_INTERVAL_MS" type="int"
  12110. transient="false" volatile="false"
  12111. static="true" final="true" visibility="public"
  12112. deprecated="not deprecated">
  12113. </field>
  12114. <field name="RM_NM_EXPIRY_INTERVAL_MS" type="java.lang.String"
  12115. transient="false" volatile="false"
  12116. static="true" final="true" visibility="public"
  12117. deprecated="not deprecated">
  12118. <doc>
  12119. <![CDATA[How long to wait until a node manager is considered dead.]]>
  12120. </doc>
  12121. </field>
  12122. <field name="DEFAULT_RM_NM_EXPIRY_INTERVAL_MS" type="int"
  12123. transient="false" volatile="false"
  12124. static="true" final="true" visibility="public"
  12125. deprecated="not deprecated">
  12126. </field>
  12127. <field name="YARN_ACL_ENABLE" type="java.lang.String"
  12128. transient="false" volatile="false"
  12129. static="true" final="true" visibility="public"
  12130. deprecated="not deprecated">
  12131. <doc>
  12132. <![CDATA[Are acls enabled.]]>
  12133. </doc>
  12134. </field>
  12135. <field name="DEFAULT_YARN_ACL_ENABLE" type="boolean"
  12136. transient="false" volatile="false"
  12137. static="true" final="true" visibility="public"
  12138. deprecated="not deprecated">
  12139. </field>
  12140. <field name="YARN_RESERVATION_ACL_ENABLE" type="java.lang.String"
  12141. transient="false" volatile="false"
  12142. static="true" final="true" visibility="public"
  12143. deprecated="not deprecated">
  12144. <doc>
  12145. <![CDATA[Are reservation acls enabled.]]>
  12146. </doc>
  12147. </field>
  12148. <field name="DEFAULT_YARN_RESERVATION_ACL_ENABLE" type="boolean"
  12149. transient="false" volatile="false"
  12150. static="true" final="true" visibility="public"
  12151. deprecated="not deprecated">
  12152. </field>
  12153. <field name="YARN_ADMIN_ACL" type="java.lang.String"
  12154. transient="false" volatile="false"
  12155. static="true" final="true" visibility="public"
  12156. deprecated="not deprecated">
  12157. <doc>
  12158. <![CDATA[ACL of who can be admin of YARN cluster.]]>
  12159. </doc>
  12160. </field>
  12161. <field name="DEFAULT_YARN_ADMIN_ACL" type="java.lang.String"
  12162. transient="false" volatile="false"
  12163. static="true" final="true" visibility="public"
  12164. deprecated="not deprecated">
  12165. </field>
  12166. <field name="DEFAULT_YARN_APP_ACL" type="java.lang.String"
  12167. transient="false" volatile="false"
  12168. static="true" final="true" visibility="public"
  12169. deprecated="not deprecated">
  12170. <doc>
  12171. <![CDATA[ACL used in case none is found. Allows nothing.]]>
  12172. </doc>
  12173. </field>
  12174. <field name="YARN_INTERMEDIATE_DATA_ENCRYPTION" type="java.lang.String"
  12175. transient="false" volatile="false"
  12176. static="true" final="true" visibility="public"
  12177. deprecated="not deprecated">
  12178. <doc>
  12179. <![CDATA[Enable/disable intermediate-data encryption at YARN level. For now, this
  12180. only is used by the FileSystemRMStateStore to setup right file-system
  12181. security attributes.]]>
  12182. </doc>
  12183. </field>
  12184. <field name="DEFAULT_YARN_INTERMEDIATE_DATA_ENCRYPTION" type="boolean"
  12185. transient="false" volatile="false"
  12186. static="true" final="true" visibility="public"
  12187. deprecated="not deprecated">
  12188. </field>
  12189. <field name="RM_ADMIN_ADDRESS" type="java.lang.String"
  12190. transient="false" volatile="false"
  12191. static="true" final="true" visibility="public"
  12192. deprecated="not deprecated">
  12193. <doc>
  12194. <![CDATA[The address of the RM admin interface.]]>
  12195. </doc>
  12196. </field>
  12197. <field name="DEFAULT_RM_ADMIN_PORT" type="int"
  12198. transient="false" volatile="false"
  12199. static="true" final="true" visibility="public"
  12200. deprecated="not deprecated">
  12201. </field>
  12202. <field name="DEFAULT_RM_ADMIN_ADDRESS" type="java.lang.String"
  12203. transient="false" volatile="false"
  12204. static="true" final="true" visibility="public"
  12205. deprecated="not deprecated">
  12206. </field>
  12207. <field name="RM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
  12208. transient="false" volatile="false"
  12209. static="true" final="true" visibility="public"
  12210. deprecated="not deprecated">
  12211. <doc>
  12212. <![CDATA[Number of threads used to handle RM admin interface.]]>
  12213. </doc>
  12214. </field>
  12215. <field name="DEFAULT_RM_ADMIN_CLIENT_THREAD_COUNT" type="int"
  12216. transient="false" volatile="false"
  12217. static="true" final="true" visibility="public"
  12218. deprecated="not deprecated">
  12219. </field>
  12220. <field name="RM_AM_MAX_ATTEMPTS" type="java.lang.String"
  12221. transient="false" volatile="false"
  12222. static="true" final="true" visibility="public"
  12223. deprecated="not deprecated">
  12224. <doc>
  12225. <![CDATA[The maximum number of application attempts.
  12226. It's a global setting for all application masters.]]>
  12227. </doc>
  12228. </field>
  12229. <field name="DEFAULT_RM_AM_MAX_ATTEMPTS" type="int"
  12230. transient="false" volatile="false"
  12231. static="true" final="true" visibility="public"
  12232. deprecated="not deprecated">
  12233. </field>
  12234. <field name="RM_KEYTAB" type="java.lang.String"
  12235. transient="false" volatile="false"
  12236. static="true" final="true" visibility="public"
  12237. deprecated="not deprecated">
  12238. <doc>
  12239. <![CDATA[The keytab for the resource manager.]]>
  12240. </doc>
  12241. </field>
  12242. <field name="RM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
  12243. transient="false" volatile="false"
  12244. static="true" final="true" visibility="public"
  12245. deprecated="not deprecated">
  12246. <doc>
  12247. <![CDATA[The kerberos principal to be used for spnego filter for RM.]]>
  12248. </doc>
  12249. </field>
  12250. <field name="RM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
  12251. transient="false" volatile="false"
  12252. static="true" final="true" visibility="public"
  12253. deprecated="not deprecated">
  12254. <doc>
  12255. <![CDATA[The kerberos keytab to be used for spnego filter for RM.]]>
  12256. </doc>
  12257. </field>
  12258. <field name="RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="java.lang.String"
  12259. transient="false" volatile="false"
  12260. static="true" final="true" visibility="public"
  12261. deprecated="not deprecated">
  12262. <doc>
  12263. <![CDATA[Flag to enable override of the default kerberos authentication filter with
  12264. the RM authentication filter to allow authentication using delegation
  12265. tokens(fallback to kerberos if the tokens are missing). Only applicable
  12266. when the http authentication type is kerberos.]]>
  12267. </doc>
  12268. </field>
  12269. <field name="DEFAULT_RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="boolean"
  12270. transient="false" volatile="false"
  12271. static="true" final="true" visibility="public"
  12272. deprecated="not deprecated">
  12273. </field>
  12274. <field name="RM_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
  12275. transient="false" volatile="false"
  12276. static="true" final="true" visibility="public"
  12277. deprecated="not deprecated">
  12278. <doc>
  12279. <![CDATA[Enable cross origin (CORS) support.]]>
  12280. </doc>
  12281. </field>
  12282. <field name="DEFAULT_RM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
  12283. transient="false" volatile="false"
  12284. static="true" final="true" visibility="public"
  12285. deprecated="not deprecated">
  12286. </field>
  12287. <field name="RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="java.lang.String"
  12288. transient="false" volatile="false"
  12289. static="true" final="true" visibility="public"
  12290. deprecated="not deprecated">
  12291. <doc>
  12292. <![CDATA[How long to wait until a container is considered dead.]]>
  12293. </doc>
  12294. </field>
  12295. <field name="DEFAULT_RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="int"
  12296. transient="false" volatile="false"
  12297. static="true" final="true" visibility="public"
  12298. deprecated="not deprecated">
  12299. </field>
  12300. <field name="RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
  12301. transient="false" volatile="false"
  12302. static="true" final="true" visibility="public"
  12303. deprecated="not deprecated">
  12304. <doc>
  12305. <![CDATA[Path to file with nodes to include.]]>
  12306. </doc>
  12307. </field>
  12308. <field name="DEFAULT_RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
  12309. transient="false" volatile="false"
  12310. static="true" final="true" visibility="public"
  12311. deprecated="not deprecated">
  12312. </field>
  12313. <field name="RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
  12314. transient="false" volatile="false"
  12315. static="true" final="true" visibility="public"
  12316. deprecated="not deprecated">
  12317. <doc>
  12318. <![CDATA[Path to file with nodes to exclude.]]>
  12319. </doc>
  12320. </field>
  12321. <field name="DEFAULT_RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
  12322. transient="false" volatile="false"
  12323. static="true" final="true" visibility="public"
  12324. deprecated="not deprecated">
  12325. </field>
  12326. <field name="RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="java.lang.String"
  12327. transient="false" volatile="false"
  12328. static="true" final="true" visibility="public"
  12329. deprecated="not deprecated">
  12330. <doc>
  12331. <![CDATA[Number of threads to handle resource tracker calls.]]>
  12332. </doc>
  12333. </field>
  12334. <field name="DEFAULT_RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="int"
  12335. transient="false" volatile="false"
  12336. static="true" final="true" visibility="public"
  12337. deprecated="not deprecated">
  12338. </field>
  12339. <field name="RM_SCHEDULER" type="java.lang.String"
  12340. transient="false" volatile="false"
  12341. static="true" final="true" visibility="public"
  12342. deprecated="not deprecated">
  12343. <doc>
  12344. <![CDATA[The class to use as the resource scheduler.]]>
  12345. </doc>
  12346. </field>
  12347. <field name="DEFAULT_RM_SCHEDULER" type="java.lang.String"
  12348. transient="false" volatile="false"
  12349. static="true" final="true" visibility="public"
  12350. deprecated="not deprecated">
  12351. </field>
  12352. <field name="RM_NM_HEARTBEAT_INTERVAL_MS" type="java.lang.String"
  12353. transient="false" volatile="false"
  12354. static="true" final="true" visibility="public"
  12355. deprecated="not deprecated">
  12356. <doc>
  12357. <![CDATA[RM set next Heartbeat interval for NM]]>
  12358. </doc>
  12359. </field>
  12360. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MS" type="long"
  12361. transient="false" volatile="false"
  12362. static="true" final="true" visibility="public"
  12363. deprecated="not deprecated">
  12364. </field>
  12365. <field name="RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="java.lang.String"
  12366. transient="false" volatile="false"
  12367. static="true" final="true" visibility="public"
  12368. deprecated="not deprecated">
  12369. <doc>
  12370. <![CDATA[Number of worker threads that write the history data.]]>
  12371. </doc>
  12372. </field>
  12373. <field name="DEFAULT_RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="int"
  12374. transient="false" volatile="false"
  12375. static="true" final="true" visibility="public"
  12376. deprecated="not deprecated">
  12377. </field>
  12378. <field name="RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="java.lang.String"
  12379. transient="false" volatile="false"
  12380. static="true" final="true" visibility="public"
  12381. deprecated="not deprecated">
  12382. <doc>
  12383. <![CDATA[The setting that controls whether yarn system metrics is published on the
  12384. timeline server or not by RM.]]>
  12385. </doc>
  12386. </field>
  12387. <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="boolean"
  12388. transient="false" volatile="false"
  12389. static="true" final="true" visibility="public"
  12390. deprecated="not deprecated">
  12391. </field>
  12392. <field name="RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="java.lang.String"
  12393. transient="false" volatile="false"
  12394. static="true" final="true" visibility="public"
  12395. deprecated="not deprecated">
  12396. </field>
  12397. <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="int"
  12398. transient="false" volatile="false"
  12399. static="true" final="true" visibility="public"
  12400. deprecated="not deprecated">
  12401. </field>
  12402. <field name="RM_DELEGATION_KEY_UPDATE_INTERVAL_KEY" type="java.lang.String"
  12403. transient="false" volatile="false"
  12404. static="true" final="true" visibility="public"
  12405. deprecated="not deprecated">
  12406. </field>
  12407. <field name="RM_DELEGATION_KEY_UPDATE_INTERVAL_DEFAULT" type="long"
  12408. transient="false" volatile="false"
  12409. static="true" final="true" visibility="public"
  12410. deprecated="not deprecated">
  12411. </field>
  12412. <field name="RM_DELEGATION_TOKEN_RENEW_INTERVAL_KEY" type="java.lang.String"
  12413. transient="false" volatile="false"
  12414. static="true" final="true" visibility="public"
  12415. deprecated="not deprecated">
  12416. </field>
  12417. <field name="RM_DELEGATION_TOKEN_RENEW_INTERVAL_DEFAULT" type="long"
  12418. transient="false" volatile="false"
  12419. static="true" final="true" visibility="public"
  12420. deprecated="not deprecated">
  12421. </field>
  12422. <field name="RM_DELEGATION_TOKEN_MAX_LIFETIME_KEY" type="java.lang.String"
  12423. transient="false" volatile="false"
  12424. static="true" final="true" visibility="public"
  12425. deprecated="not deprecated">
  12426. </field>
  12427. <field name="RM_DELEGATION_TOKEN_MAX_LIFETIME_DEFAULT" type="long"
  12428. transient="false" volatile="false"
  12429. static="true" final="true" visibility="public"
  12430. deprecated="not deprecated">
  12431. </field>
  12432. <field name="RECOVERY_ENABLED" type="java.lang.String"
  12433. transient="false" volatile="false"
  12434. static="true" final="true" visibility="public"
  12435. deprecated="not deprecated">
  12436. </field>
  12437. <field name="DEFAULT_RM_RECOVERY_ENABLED" type="boolean"
  12438. transient="false" volatile="false"
  12439. static="true" final="true" visibility="public"
  12440. deprecated="not deprecated">
  12441. </field>
  12442. <field name="YARN_FAIL_FAST" type="java.lang.String"
  12443. transient="false" volatile="false"
  12444. static="true" final="true" visibility="public"
  12445. deprecated="not deprecated">
  12446. </field>
  12447. <field name="DEFAULT_YARN_FAIL_FAST" type="boolean"
  12448. transient="false" volatile="false"
  12449. static="true" final="true" visibility="public"
  12450. deprecated="not deprecated">
  12451. </field>
  12452. <field name="RM_FAIL_FAST" type="java.lang.String"
  12453. transient="false" volatile="false"
  12454. static="true" final="true" visibility="public"
  12455. deprecated="not deprecated">
  12456. </field>
  12457. <field name="RM_WORK_PRESERVING_RECOVERY_ENABLED" type="java.lang.String"
  12458. transient="false" volatile="false"
  12459. static="true" final="true" visibility="public"
  12460. deprecated="not deprecated">
  12461. </field>
  12462. <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_ENABLED" type="boolean"
  12463. transient="false" volatile="false"
  12464. static="true" final="true" visibility="public"
  12465. deprecated="not deprecated">
  12466. </field>
  12467. <field name="RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="java.lang.String"
  12468. transient="false" volatile="false"
  12469. static="true" final="true" visibility="public"
  12470. deprecated="not deprecated">
  12471. </field>
  12472. <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="long"
  12473. transient="false" volatile="false"
  12474. static="true" final="true" visibility="public"
  12475. deprecated="not deprecated">
  12476. </field>
  12477. <field name="RM_ZK_PREFIX" type="java.lang.String"
  12478. transient="false" volatile="false"
  12479. static="true" final="true" visibility="public"
  12480. deprecated="not deprecated">
  12481. <doc>
  12482. <![CDATA[Zookeeper interaction configs]]>
  12483. </doc>
  12484. </field>
  12485. <field name="RM_ZK_ADDRESS" type="java.lang.String"
  12486. transient="false" volatile="false"
  12487. static="true" final="true" visibility="public"
  12488. deprecated="not deprecated">
  12489. </field>
  12490. <field name="RM_ZK_NUM_RETRIES" type="java.lang.String"
  12491. transient="false" volatile="false"
  12492. static="true" final="true" visibility="public"
  12493. deprecated="not deprecated">
  12494. </field>
  12495. <field name="DEFAULT_ZK_RM_NUM_RETRIES" type="int"
  12496. transient="false" volatile="false"
  12497. static="true" final="true" visibility="public"
  12498. deprecated="not deprecated">
  12499. </field>
  12500. <field name="RM_ZK_RETRY_INTERVAL_MS" type="java.lang.String"
  12501. transient="false" volatile="false"
  12502. static="true" final="true" visibility="public"
  12503. deprecated="not deprecated">
  12504. </field>
  12505. <field name="DEFAULT_RM_ZK_RETRY_INTERVAL_MS" type="int"
  12506. transient="false" volatile="false"
  12507. static="true" final="true" visibility="public"
  12508. deprecated="not deprecated">
  12509. </field>
  12510. <field name="RM_ZK_TIMEOUT_MS" type="java.lang.String"
  12511. transient="false" volatile="false"
  12512. static="true" final="true" visibility="public"
  12513. deprecated="not deprecated">
  12514. </field>
  12515. <field name="DEFAULT_RM_ZK_TIMEOUT_MS" type="int"
  12516. transient="false" volatile="false"
  12517. static="true" final="true" visibility="public"
  12518. deprecated="not deprecated">
  12519. </field>
  12520. <field name="RM_ZK_ACL" type="java.lang.String"
  12521. transient="false" volatile="false"
  12522. static="true" final="true" visibility="public"
  12523. deprecated="not deprecated">
  12524. </field>
  12525. <field name="DEFAULT_RM_ZK_ACL" type="java.lang.String"
  12526. transient="false" volatile="false"
  12527. static="true" final="true" visibility="public"
  12528. deprecated="not deprecated">
  12529. </field>
  12530. <field name="RM_ZK_AUTH" type="java.lang.String"
  12531. transient="false" volatile="false"
  12532. static="true" final="true" visibility="public"
  12533. deprecated="not deprecated">
  12534. </field>
  12535. <field name="ZK_STATE_STORE_PREFIX" type="java.lang.String"
  12536. transient="false" volatile="false"
  12537. static="true" final="true" visibility="public"
  12538. deprecated="not deprecated">
  12539. </field>
  12540. <field name="ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
  12541. transient="false" volatile="false"
  12542. static="true" final="true" visibility="public"
  12543. deprecated="not deprecated">
  12544. <doc>
  12545. <![CDATA[Parent znode path under which ZKRMStateStore will create znodes]]>
  12546. </doc>
  12547. </field>
  12548. <field name="DEFAULT_ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
  12549. transient="false" volatile="false"
  12550. static="true" final="true" visibility="public"
  12551. deprecated="not deprecated">
  12552. </field>
  12553. <field name="ZK_RM_STATE_STORE_ROOT_NODE_ACL" type="java.lang.String"
  12554. transient="false" volatile="false"
  12555. static="true" final="true" visibility="public"
  12556. deprecated="not deprecated">
  12557. <doc>
  12558. <![CDATA[Root node ACLs for fencing]]>
  12559. </doc>
  12560. </field>
  12561. <field name="RM_HA_PREFIX" type="java.lang.String"
  12562. transient="false" volatile="false"
  12563. static="true" final="true" visibility="public"
  12564. deprecated="not deprecated">
  12565. <doc>
  12566. <![CDATA[HA related configs]]>
  12567. </doc>
  12568. </field>
  12569. <field name="RM_HA_ENABLED" type="java.lang.String"
  12570. transient="false" volatile="false"
  12571. static="true" final="true" visibility="public"
  12572. deprecated="not deprecated">
  12573. </field>
  12574. <field name="DEFAULT_RM_HA_ENABLED" type="boolean"
  12575. transient="false" volatile="false"
  12576. static="true" final="true" visibility="public"
  12577. deprecated="not deprecated">
  12578. </field>
  12579. <field name="RM_HA_IDS" type="java.lang.String"
  12580. transient="false" volatile="false"
  12581. static="true" final="true" visibility="public"
  12582. deprecated="not deprecated">
  12583. </field>
  12584. <field name="RM_HA_ID" type="java.lang.String"
  12585. transient="false" volatile="false"
  12586. static="true" final="true" visibility="public"
  12587. deprecated="not deprecated">
  12588. </field>
  12589. <field name="FS_BASED_RM_CONF_STORE" type="java.lang.String"
  12590. transient="false" volatile="false"
  12591. static="true" final="true" visibility="public"
  12592. deprecated="not deprecated">
  12593. <doc>
  12594. <![CDATA[Store the related configuration files in File System]]>
  12595. </doc>
  12596. </field>
  12597. <field name="DEFAULT_FS_BASED_RM_CONF_STORE" type="java.lang.String"
  12598. transient="false" volatile="false"
  12599. static="true" final="true" visibility="public"
  12600. deprecated="not deprecated">
  12601. </field>
  12602. <field name="RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
  12603. transient="false" volatile="false"
  12604. static="true" final="true" visibility="public"
  12605. deprecated="not deprecated">
  12606. </field>
  12607. <field name="DEFAULT_RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
  12608. transient="false" volatile="false"
  12609. static="true" final="true" visibility="public"
  12610. deprecated="not deprecated">
  12611. </field>
  12612. <field name="YARN_AUTHORIZATION_PROVIDER" type="java.lang.String"
  12613. transient="false" volatile="false"
  12614. static="true" final="true" visibility="public"
  12615. deprecated="not deprecated">
  12616. </field>
  12617. <field name="AUTO_FAILOVER_PREFIX" type="java.lang.String"
  12618. transient="false" volatile="false"
  12619. static="true" final="true" visibility="public"
  12620. deprecated="not deprecated">
  12621. </field>
  12622. <field name="AUTO_FAILOVER_ENABLED" type="java.lang.String"
  12623. transient="false" volatile="false"
  12624. static="true" final="true" visibility="public"
  12625. deprecated="not deprecated">
  12626. </field>
  12627. <field name="DEFAULT_AUTO_FAILOVER_ENABLED" type="boolean"
  12628. transient="false" volatile="false"
  12629. static="true" final="true" visibility="public"
  12630. deprecated="not deprecated">
  12631. </field>
  12632. <field name="AUTO_FAILOVER_EMBEDDED" type="java.lang.String"
  12633. transient="false" volatile="false"
  12634. static="true" final="true" visibility="public"
  12635. deprecated="not deprecated">
  12636. </field>
  12637. <field name="DEFAULT_AUTO_FAILOVER_EMBEDDED" type="boolean"
  12638. transient="false" volatile="false"
  12639. static="true" final="true" visibility="public"
  12640. deprecated="not deprecated">
  12641. </field>
  12642. <field name="AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
  12643. transient="false" volatile="false"
  12644. static="true" final="true" visibility="public"
  12645. deprecated="not deprecated">
  12646. </field>
  12647. <field name="DEFAULT_AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
  12648. transient="false" volatile="false"
  12649. static="true" final="true" visibility="public"
  12650. deprecated="not deprecated">
  12651. </field>
  12652. <field name="CLIENT_FAILOVER_PREFIX" type="java.lang.String"
  12653. transient="false" volatile="false"
  12654. static="true" final="true" visibility="public"
  12655. deprecated="not deprecated">
  12656. </field>
  12657. <field name="CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
  12658. transient="false" volatile="false"
  12659. static="true" final="true" visibility="public"
  12660. deprecated="not deprecated">
  12661. </field>
  12662. <field name="DEFAULT_CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
  12663. transient="false" volatile="false"
  12664. static="true" final="true" visibility="public"
  12665. deprecated="not deprecated">
  12666. </field>
  12667. <field name="CLIENT_FAILOVER_MAX_ATTEMPTS" type="java.lang.String"
  12668. transient="false" volatile="false"
  12669. static="true" final="true" visibility="public"
  12670. deprecated="not deprecated">
  12671. </field>
  12672. <field name="CLIENT_FAILOVER_SLEEPTIME_BASE_MS" type="java.lang.String"
  12673. transient="false" volatile="false"
  12674. static="true" final="true" visibility="public"
  12675. deprecated="not deprecated">
  12676. </field>
  12677. <field name="CLIENT_FAILOVER_SLEEPTIME_MAX_MS" type="java.lang.String"
  12678. transient="false" volatile="false"
  12679. static="true" final="true" visibility="public"
  12680. deprecated="not deprecated">
  12681. </field>
  12682. <field name="CLIENT_FAILOVER_RETRIES" type="java.lang.String"
  12683. transient="false" volatile="false"
  12684. static="true" final="true" visibility="public"
  12685. deprecated="not deprecated">
  12686. </field>
  12687. <field name="DEFAULT_CLIENT_FAILOVER_RETRIES" type="int"
  12688. transient="false" volatile="false"
  12689. static="true" final="true" visibility="public"
  12690. deprecated="not deprecated">
  12691. </field>
  12692. <field name="CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="java.lang.String"
  12693. transient="false" volatile="false"
  12694. static="true" final="true" visibility="public"
  12695. deprecated="not deprecated">
  12696. </field>
  12697. <field name="DEFAULT_CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="int"
  12698. transient="false" volatile="false"
  12699. static="true" final="true" visibility="public"
  12700. deprecated="not deprecated">
  12701. </field>
  12702. <field name="RM_HA_FC_ELECTOR_ZK_RETRIES_KEY" type="java.lang.String"
  12703. transient="false" volatile="false"
  12704. static="true" final="true" visibility="public"
  12705. deprecated="not deprecated">
  12706. <doc>
  12707. <![CDATA[number of zookeeper operation retry times in ActiveStandbyElector]]>
  12708. </doc>
  12709. </field>
  12710. <field name="CURATOR_LEADER_ELECTOR" type="java.lang.String"
  12711. transient="false" volatile="false"
  12712. static="true" final="true" visibility="public"
  12713. deprecated="not deprecated">
  12714. <doc>
  12715. <![CDATA[Whether to use curator-based elector for leader election.
  12716. Deprecated Eventually, we want to default to the curator-based
  12717. implementation and remove the {@link ActiveStandbyElector} based
  12718. implementation. We should remove this config then.]]>
  12719. </doc>
  12720. </field>
  12721. <field name="DEFAULT_CURATOR_LEADER_ELECTOR_ENABLED" type="boolean"
  12722. transient="false" volatile="false"
  12723. static="true" final="true" visibility="public"
  12724. deprecated="not deprecated">
  12725. </field>
  12726. <field name="RM_STORE" type="java.lang.String"
  12727. transient="false" volatile="false"
  12728. static="true" final="true" visibility="public"
  12729. deprecated="not deprecated">
  12730. <doc>
  12731. <![CDATA[The class to use as the persistent store.]]>
  12732. </doc>
  12733. </field>
  12734. <field name="FS_RM_STATE_STORE_URI" type="java.lang.String"
  12735. transient="false" volatile="false"
  12736. static="true" final="true" visibility="public"
  12737. deprecated="not deprecated">
  12738. <doc>
  12739. <![CDATA[URI for FileSystemRMStateStore]]>
  12740. </doc>
  12741. </field>
  12742. <field name="FS_RM_STATE_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  12743. transient="false" volatile="false"
  12744. static="true" final="true" visibility="public"
  12745. deprecated="not deprecated">
  12746. </field>
  12747. <field name="DEFAULT_FS_RM_STATE_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  12748. transient="false" volatile="false"
  12749. static="true" final="true" visibility="public"
  12750. deprecated="not deprecated">
  12751. </field>
  12752. <field name="FS_RM_STATE_STORE_NUM_RETRIES" type="java.lang.String"
  12753. transient="false" volatile="false"
  12754. static="true" final="true" visibility="public"
  12755. deprecated="not deprecated">
  12756. </field>
  12757. <field name="DEFAULT_FS_RM_STATE_STORE_NUM_RETRIES" type="int"
  12758. transient="false" volatile="false"
  12759. static="true" final="true" visibility="public"
  12760. deprecated="not deprecated">
  12761. </field>
  12762. <field name="FS_RM_STATE_STORE_RETRY_INTERVAL_MS" type="java.lang.String"
  12763. transient="false" volatile="false"
  12764. static="true" final="true" visibility="public"
  12765. deprecated="not deprecated">
  12766. </field>
  12767. <field name="DEFAULT_FS_RM_STATE_STORE_RETRY_INTERVAL_MS" type="long"
  12768. transient="false" volatile="false"
  12769. static="true" final="true" visibility="public"
  12770. deprecated="not deprecated">
  12771. </field>
  12772. <field name="RM_LEVELDB_STORE_PATH" type="java.lang.String"
  12773. transient="false" volatile="false"
  12774. static="true" final="true" visibility="public"
  12775. deprecated="not deprecated">
  12776. </field>
  12777. <field name="RM_LEVELDB_COMPACTION_INTERVAL_SECS" type="java.lang.String"
  12778. transient="false" volatile="false"
  12779. static="true" final="true" visibility="public"
  12780. deprecated="not deprecated">
  12781. <doc>
  12782. <![CDATA[The time in seconds between full compactions of the leveldb database.
  12783. Setting the interval to zero disables the full compaction cycles.]]>
  12784. </doc>
  12785. </field>
  12786. <field name="DEFAULT_RM_LEVELDB_COMPACTION_INTERVAL_SECS" type="long"
  12787. transient="false" volatile="false"
  12788. static="true" final="true" visibility="public"
  12789. deprecated="not deprecated">
  12790. </field>
  12791. <field name="RM_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
  12792. transient="false" volatile="false"
  12793. static="true" final="true" visibility="public"
  12794. deprecated="not deprecated">
  12795. <doc>
  12796. <![CDATA[The maximum number of completed applications RM keeps.]]>
  12797. </doc>
  12798. </field>
  12799. <field name="DEFAULT_RM_MAX_COMPLETED_APPLICATIONS" type="int"
  12800. transient="false" volatile="false"
  12801. static="true" final="true" visibility="public"
  12802. deprecated="not deprecated">
  12803. </field>
  12804. <field name="RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
  12805. transient="false" volatile="false"
  12806. static="true" final="true" visibility="public"
  12807. deprecated="not deprecated">
  12808. <doc>
  12809. <![CDATA[The maximum number of completed applications RM state store keeps, by
  12810. default equals to DEFAULT_RM_MAX_COMPLETED_APPLICATIONS]]>
  12811. </doc>
  12812. </field>
  12813. <field name="DEFAULT_RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="int"
  12814. transient="false" volatile="false"
  12815. static="true" final="true" visibility="public"
  12816. deprecated="not deprecated">
  12817. </field>
  12818. <field name="DEFAULT_APPLICATION_NAME" type="java.lang.String"
  12819. transient="false" volatile="false"
  12820. static="true" final="true" visibility="public"
  12821. deprecated="not deprecated">
  12822. <doc>
  12823. <![CDATA[Default application name]]>
  12824. </doc>
  12825. </field>
  12826. <field name="DEFAULT_APPLICATION_TYPE" type="java.lang.String"
  12827. transient="false" volatile="false"
  12828. static="true" final="true" visibility="public"
  12829. deprecated="not deprecated">
  12830. <doc>
  12831. <![CDATA[Default application type]]>
  12832. </doc>
  12833. </field>
  12834. <field name="APPLICATION_TYPE_LENGTH" type="int"
  12835. transient="false" volatile="false"
  12836. static="true" final="true" visibility="public"
  12837. deprecated="not deprecated">
  12838. <doc>
  12839. <![CDATA[Default application type length]]>
  12840. </doc>
  12841. </field>
  12842. <field name="DEFAULT_QUEUE_NAME" type="java.lang.String"
  12843. transient="false" volatile="false"
  12844. static="true" final="true" visibility="public"
  12845. deprecated="not deprecated">
  12846. <doc>
  12847. <![CDATA[Default queue name]]>
  12848. </doc>
  12849. </field>
  12850. <field name="RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
  12851. transient="false" volatile="false"
  12852. static="true" final="true" visibility="public"
  12853. deprecated="not deprecated">
  12854. <doc>
  12855. <![CDATA[Buckets (in minutes) for the number of apps running in each queue.]]>
  12856. </doc>
  12857. </field>
  12858. <field name="DEFAULT_RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
  12859. transient="false" volatile="false"
  12860. static="true" final="true" visibility="public"
  12861. deprecated="not deprecated">
  12862. <doc>
  12863. <![CDATA[Default sizes of the runtime metric buckets in minutes.]]>
  12864. </doc>
  12865. </field>
  12866. <field name="RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  12867. transient="false" volatile="false"
  12868. static="true" final="true" visibility="public"
  12869. deprecated="not deprecated">
  12870. </field>
  12871. <field name="DEFAULT_RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  12872. transient="false" volatile="false"
  12873. static="true" final="true" visibility="public"
  12874. deprecated="not deprecated">
  12875. </field>
  12876. <field name="RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  12877. transient="false" volatile="false"
  12878. static="true" final="true" visibility="public"
  12879. deprecated="not deprecated">
  12880. </field>
  12881. <field name="DEFAULT_RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  12882. transient="false" volatile="false"
  12883. static="true" final="true" visibility="public"
  12884. deprecated="not deprecated">
  12885. </field>
  12886. <field name="RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  12887. transient="false" volatile="false"
  12888. static="true" final="true" visibility="public"
  12889. deprecated="not deprecated">
  12890. </field>
  12891. <field name="DEFAULT_RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  12892. transient="false" volatile="false"
  12893. static="true" final="true" visibility="public"
  12894. deprecated="not deprecated">
  12895. </field>
  12896. <field name="RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  12897. transient="false" volatile="false"
  12898. static="true" final="true" visibility="public"
  12899. deprecated="not deprecated">
  12900. </field>
  12901. <field name="DEFAULT_RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  12902. transient="false" volatile="false"
  12903. static="true" final="true" visibility="public"
  12904. deprecated="not deprecated">
  12905. </field>
  12906. <field name="RM_NODEMANAGER_UNTRACKED_REMOVAL_TIMEOUT_MSEC" type="java.lang.String"
  12907. transient="false" volatile="false"
  12908. static="true" final="true" visibility="public"
  12909. deprecated="not deprecated">
  12910. <doc>
  12911. <![CDATA[Timeout(msec) for an untracked node to remain in shutdown or decommissioned
  12912. state.]]>
  12913. </doc>
  12914. </field>
  12915. <field name="DEFAULT_RM_NODEMANAGER_UNTRACKED_REMOVAL_TIMEOUT_MSEC" type="int"
  12916. transient="false" volatile="false"
  12917. static="true" final="true" visibility="public"
  12918. deprecated="not deprecated">
  12919. </field>
  12920. <field name="RM_PROXY_USER_PREFIX" type="java.lang.String"
  12921. transient="false" volatile="false"
  12922. static="true" final="true" visibility="public"
  12923. deprecated="not deprecated">
  12924. <doc>
  12925. <![CDATA[RM proxy users' prefix]]>
  12926. </doc>
  12927. </field>
  12928. <field name="NM_PREFIX" type="java.lang.String"
  12929. transient="false" volatile="false"
  12930. static="true" final="true" visibility="public"
  12931. deprecated="not deprecated">
  12932. <doc>
  12933. <![CDATA[Prefix for all node manager configs.]]>
  12934. </doc>
  12935. </field>
  12936. <field name="NM_ADMIN_USER_ENV" type="java.lang.String"
  12937. transient="false" volatile="false"
  12938. static="true" final="true" visibility="public"
  12939. deprecated="not deprecated">
  12940. <doc>
  12941. <![CDATA[Environment variables that will be sent to containers.]]>
  12942. </doc>
  12943. </field>
  12944. <field name="DEFAULT_NM_ADMIN_USER_ENV" type="java.lang.String"
  12945. transient="false" volatile="false"
  12946. static="true" final="true" visibility="public"
  12947. deprecated="not deprecated">
  12948. </field>
  12949. <field name="NM_ENV_WHITELIST" type="java.lang.String"
  12950. transient="false" volatile="false"
  12951. static="true" final="true" visibility="public"
  12952. deprecated="not deprecated">
  12953. <doc>
  12954. <![CDATA[Environment variables that containers may override rather than use NodeManager's default.]]>
  12955. </doc>
  12956. </field>
  12957. <field name="DEFAULT_NM_ENV_WHITELIST" type="java.lang.String"
  12958. transient="false" volatile="false"
  12959. static="true" final="true" visibility="public"
  12960. deprecated="not deprecated">
  12961. </field>
  12962. <field name="NM_ADDRESS" type="java.lang.String"
  12963. transient="false" volatile="false"
  12964. static="true" final="true" visibility="public"
  12965. deprecated="not deprecated">
  12966. <doc>
  12967. <![CDATA[address of node manager IPC.]]>
  12968. </doc>
  12969. </field>
  12970. <field name="DEFAULT_NM_PORT" type="int"
  12971. transient="false" volatile="false"
  12972. static="true" final="true" visibility="public"
  12973. deprecated="not deprecated">
  12974. </field>
  12975. <field name="DEFAULT_NM_ADDRESS" type="java.lang.String"
  12976. transient="false" volatile="false"
  12977. static="true" final="true" visibility="public"
  12978. deprecated="not deprecated">
  12979. </field>
  12980. <field name="NM_BIND_HOST" type="java.lang.String"
  12981. transient="false" volatile="false"
  12982. static="true" final="true" visibility="public"
  12983. deprecated="not deprecated">
  12984. <doc>
  12985. <![CDATA[The actual bind address or the NM.]]>
  12986. </doc>
  12987. </field>
  12988. <field name="NM_CONTAINER_EXECUTOR" type="java.lang.String"
  12989. transient="false" volatile="false"
  12990. static="true" final="true" visibility="public"
  12991. deprecated="not deprecated">
  12992. <doc>
  12993. <![CDATA[who will execute(launch) the containers.]]>
  12994. </doc>
  12995. </field>
  12996. <field name="NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="java.lang.String"
  12997. transient="false" volatile="false"
  12998. static="true" final="true" visibility="public"
  12999. deprecated="not deprecated">
  13000. <doc>
  13001. <![CDATA[Adjustment to make to the container os scheduling priority.
  13002. The valid values for this could vary depending on the platform.
  13003. On Linux, higher values mean run the containers at a less
  13004. favorable priority than the NM.
  13005. The value specified is an int.]]>
  13006. </doc>
  13007. </field>
  13008. <field name="DEFAULT_NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="int"
  13009. transient="false" volatile="false"
  13010. static="true" final="true" visibility="public"
  13011. deprecated="not deprecated">
  13012. </field>
  13013. <field name="NM_CONTAINER_MGR_THREAD_COUNT" type="java.lang.String"
  13014. transient="false" volatile="false"
  13015. static="true" final="true" visibility="public"
  13016. deprecated="not deprecated">
  13017. <doc>
  13018. <![CDATA[Number of threads container manager uses.]]>
  13019. </doc>
  13020. </field>
  13021. <field name="DEFAULT_NM_CONTAINER_MGR_THREAD_COUNT" type="int"
  13022. transient="false" volatile="false"
  13023. static="true" final="true" visibility="public"
  13024. deprecated="not deprecated">
  13025. </field>
  13026. <field name="NM_DELETE_THREAD_COUNT" type="java.lang.String"
  13027. transient="false" volatile="false"
  13028. static="true" final="true" visibility="public"
  13029. deprecated="not deprecated">
  13030. <doc>
  13031. <![CDATA[Number of threads used in cleanup.]]>
  13032. </doc>
  13033. </field>
  13034. <field name="DEFAULT_NM_DELETE_THREAD_COUNT" type="int"
  13035. transient="false" volatile="false"
  13036. static="true" final="true" visibility="public"
  13037. deprecated="not deprecated">
  13038. </field>
  13039. <field name="NM_KEYTAB" type="java.lang.String"
  13040. transient="false" volatile="false"
  13041. static="true" final="true" visibility="public"
  13042. deprecated="not deprecated">
  13043. <doc>
  13044. <![CDATA[Keytab for NM.]]>
  13045. </doc>
  13046. </field>
  13047. <field name="NM_LOCAL_DIRS" type="java.lang.String"
  13048. transient="false" volatile="false"
  13049. static="true" final="true" visibility="public"
  13050. deprecated="not deprecated">
  13051. <doc>
  13052. <![CDATA[List of directories to store localized files in.]]>
  13053. </doc>
  13054. </field>
  13055. <field name="DEFAULT_NM_LOCAL_DIRS" type="java.lang.String"
  13056. transient="false" volatile="false"
  13057. static="true" final="true" visibility="public"
  13058. deprecated="not deprecated">
  13059. </field>
  13060. <field name="NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="java.lang.String"
  13061. transient="false" volatile="false"
  13062. static="true" final="true" visibility="public"
  13063. deprecated="not deprecated">
  13064. <doc>
  13065. <![CDATA[Number of files in each localized directories
  13066. Avoid tuning this too low.]]>
  13067. </doc>
  13068. </field>
  13069. <field name="DEFAULT_NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="int"
  13070. transient="false" volatile="false"
  13071. static="true" final="true" visibility="public"
  13072. deprecated="not deprecated">
  13073. </field>
  13074. <field name="NM_LOCALIZER_ADDRESS" type="java.lang.String"
  13075. transient="false" volatile="false"
  13076. static="true" final="true" visibility="public"
  13077. deprecated="not deprecated">
  13078. <doc>
  13079. <![CDATA[Address where the localizer IPC is.]]>
  13080. </doc>
  13081. </field>
  13082. <field name="DEFAULT_NM_LOCALIZER_PORT" type="int"
  13083. transient="false" volatile="false"
  13084. static="true" final="true" visibility="public"
  13085. deprecated="not deprecated">
  13086. </field>
  13087. <field name="DEFAULT_NM_LOCALIZER_ADDRESS" type="java.lang.String"
  13088. transient="false" volatile="false"
  13089. static="true" final="true" visibility="public"
  13090. deprecated="not deprecated">
  13091. </field>
  13092. <field name="NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="java.lang.String"
  13093. transient="false" volatile="false"
  13094. static="true" final="true" visibility="public"
  13095. deprecated="not deprecated">
  13096. <doc>
  13097. <![CDATA[Interval in between cache cleanups.]]>
  13098. </doc>
  13099. </field>
  13100. <field name="DEFAULT_NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="long"
  13101. transient="false" volatile="false"
  13102. static="true" final="true" visibility="public"
  13103. deprecated="not deprecated">
  13104. </field>
  13105. <field name="NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="java.lang.String"
  13106. transient="false" volatile="false"
  13107. static="true" final="true" visibility="public"
  13108. deprecated="not deprecated">
  13109. <doc>
  13110. <![CDATA[Target size of localizer cache in MB, per nodemanager. It is a target
  13111. retention size that only includes resources with PUBLIC and PRIVATE
  13112. visibility and excludes resources with APPLICATION visibility]]>
  13113. </doc>
  13114. </field>
  13115. <field name="DEFAULT_NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="long"
  13116. transient="false" volatile="false"
  13117. static="true" final="true" visibility="public"
  13118. deprecated="not deprecated">
  13119. </field>
  13120. <field name="NM_LOCALIZER_CLIENT_THREAD_COUNT" type="java.lang.String"
  13121. transient="false" volatile="false"
  13122. static="true" final="true" visibility="public"
  13123. deprecated="not deprecated">
  13124. <doc>
  13125. <![CDATA[Number of threads to handle localization requests.]]>
  13126. </doc>
  13127. </field>
  13128. <field name="DEFAULT_NM_LOCALIZER_CLIENT_THREAD_COUNT" type="int"
  13129. transient="false" volatile="false"
  13130. static="true" final="true" visibility="public"
  13131. deprecated="not deprecated">
  13132. </field>
  13133. <field name="NM_LOCALIZER_FETCH_THREAD_COUNT" type="java.lang.String"
  13134. transient="false" volatile="false"
  13135. static="true" final="true" visibility="public"
  13136. deprecated="not deprecated">
  13137. <doc>
  13138. <![CDATA[Number of threads to use for localization fetching.]]>
  13139. </doc>
  13140. </field>
  13141. <field name="DEFAULT_NM_LOCALIZER_FETCH_THREAD_COUNT" type="int"
  13142. transient="false" volatile="false"
  13143. static="true" final="true" visibility="public"
  13144. deprecated="not deprecated">
  13145. </field>
  13146. <field name="NM_LOG_DIRS" type="java.lang.String"
  13147. transient="false" volatile="false"
  13148. static="true" final="true" visibility="public"
  13149. deprecated="not deprecated">
  13150. <doc>
  13151. <![CDATA[Where to store container logs.]]>
  13152. </doc>
  13153. </field>
  13154. <field name="DEFAULT_NM_LOG_DIRS" type="java.lang.String"
  13155. transient="false" volatile="false"
  13156. static="true" final="true" visibility="public"
  13157. deprecated="not deprecated">
  13158. </field>
  13159. <field name="NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  13160. transient="false" volatile="false"
  13161. static="true" final="true" visibility="public"
  13162. deprecated="not deprecated">
  13163. </field>
  13164. <field name="DEFAULT_NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  13165. transient="false" volatile="false"
  13166. static="true" final="true" visibility="public"
  13167. deprecated="not deprecated">
  13168. </field>
  13169. <field name="RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="java.lang.String"
  13170. transient="false" volatile="false"
  13171. static="true" final="true" visibility="public"
  13172. deprecated="not deprecated">
  13173. <doc>
  13174. <![CDATA[Interval at which the delayed token removal thread runs]]>
  13175. </doc>
  13176. </field>
  13177. <field name="DEFAULT_RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="long"
  13178. transient="false" volatile="false"
  13179. static="true" final="true" visibility="public"
  13180. deprecated="not deprecated">
  13181. </field>
  13182. <field name="RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="java.lang.String"
  13183. transient="false" volatile="false"
  13184. static="true" final="true" visibility="public"
  13185. deprecated="not deprecated">
  13186. <doc>
  13187. <![CDATA[Delegation Token renewer thread count]]>
  13188. </doc>
  13189. </field>
  13190. <field name="DEFAULT_RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="int"
  13191. transient="false" volatile="false"
  13192. static="true" final="true" visibility="public"
  13193. deprecated="not deprecated">
  13194. </field>
  13195. <field name="RM_PROXY_USER_PRIVILEGES_ENABLED" type="java.lang.String"
  13196. transient="false" volatile="false"
  13197. static="true" final="true" visibility="public"
  13198. deprecated="not deprecated">
  13199. </field>
  13200. <field name="DEFAULT_RM_PROXY_USER_PRIVILEGES_ENABLED" type="boolean"
  13201. transient="false" volatile="false"
  13202. static="true" final="true" visibility="public"
  13203. deprecated="not deprecated">
  13204. </field>
  13205. <field name="RM_NODE_IP_CACHE_EXPIRY_INTERVAL_SECS" type="java.lang.String"
  13206. transient="false" volatile="false"
  13207. static="true" final="true" visibility="public"
  13208. deprecated="not deprecated">
  13209. <doc>
  13210. <![CDATA[The expiry interval for node IP caching. -1 disables the caching]]>
  13211. </doc>
  13212. </field>
  13213. <field name="DEFAULT_RM_NODE_IP_CACHE_EXPIRY_INTERVAL_SECS" type="int"
  13214. transient="false" volatile="false"
  13215. static="true" final="true" visibility="public"
  13216. deprecated="not deprecated">
  13217. </field>
  13218. <field name="RM_MAX_LOG_AGGREGATION_DIAGNOSTICS_IN_MEMORY" type="java.lang.String"
  13219. transient="false" volatile="false"
  13220. static="true" final="true" visibility="public"
  13221. deprecated="not deprecated">
  13222. <doc>
  13223. <![CDATA[How many diagnostics/failure messages can be saved in RM for
  13224. log aggregation. It also defines the number of diagnostics/failure
  13225. messages can be shown in log aggregation web ui.]]>
  13226. </doc>
  13227. </field>
  13228. <field name="DEFAULT_RM_MAX_LOG_AGGREGATION_DIAGNOSTICS_IN_MEMORY" type="int"
  13229. transient="false" volatile="false"
  13230. static="true" final="true" visibility="public"
  13231. deprecated="not deprecated">
  13232. </field>
  13233. <field name="LOG_AGGREGATION_ENABLED" type="java.lang.String"
  13234. transient="false" volatile="false"
  13235. static="true" final="true" visibility="public"
  13236. deprecated="not deprecated">
  13237. <doc>
  13238. <![CDATA[Whether to enable log aggregation]]>
  13239. </doc>
  13240. </field>
  13241. <field name="DEFAULT_LOG_AGGREGATION_ENABLED" type="boolean"
  13242. transient="false" volatile="false"
  13243. static="true" final="true" visibility="public"
  13244. deprecated="not deprecated">
  13245. </field>
  13246. <field name="LOG_AGGREGATION_RETAIN_SECONDS" type="java.lang.String"
  13247. transient="false" volatile="false"
  13248. static="true" final="true" visibility="public"
  13249. deprecated="not deprecated">
  13250. <doc>
  13251. <![CDATA[How long to wait before deleting aggregated logs, -1 disables.
  13252. Be careful set this too small and you will spam the name node.]]>
  13253. </doc>
  13254. </field>
  13255. <field name="DEFAULT_LOG_AGGREGATION_RETAIN_SECONDS" type="long"
  13256. transient="false" volatile="false"
  13257. static="true" final="true" visibility="public"
  13258. deprecated="not deprecated">
  13259. </field>
  13260. <field name="LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="java.lang.String"
  13261. transient="false" volatile="false"
  13262. static="true" final="true" visibility="public"
  13263. deprecated="not deprecated">
  13264. <doc>
  13265. <![CDATA[How long to wait between aggregated log retention checks. If set to
  13266. a value {@literal <=} 0 then the value is computed as one-tenth of the
  13267. log retention setting. Be careful set this too small and you will spam
  13268. the name node.]]>
  13269. </doc>
  13270. </field>
  13271. <field name="DEFAULT_LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="long"
  13272. transient="false" volatile="false"
  13273. static="true" final="true" visibility="public"
  13274. deprecated="not deprecated">
  13275. </field>
  13276. <field name="LOG_AGGREGATION_STATUS_TIME_OUT_MS" type="java.lang.String"
  13277. transient="false" volatile="false"
  13278. static="true" final="true" visibility="public"
  13279. deprecated="not deprecated">
  13280. <doc>
  13281. <![CDATA[How long for ResourceManager to wait for NodeManager to report its
  13282. log aggregation status. If waiting time of which the log aggregation status
  13283. is reported from NodeManager exceeds the configured value, RM will report
  13284. log aggregation status for this NodeManager as TIME_OUT]]>
  13285. </doc>
  13286. </field>
  13287. <field name="DEFAULT_LOG_AGGREGATION_STATUS_TIME_OUT_MS" type="long"
  13288. transient="false" volatile="false"
  13289. static="true" final="true" visibility="public"
  13290. deprecated="not deprecated">
  13291. </field>
  13292. <field name="NM_LOG_RETAIN_SECONDS" type="java.lang.String"
  13293. transient="false" volatile="false"
  13294. static="true" final="true" visibility="public"
  13295. deprecated="not deprecated">
  13296. <doc>
  13297. <![CDATA[Number of seconds to retain logs on the NodeManager. Only applicable if Log
  13298. aggregation is disabled]]>
  13299. </doc>
  13300. </field>
  13301. <field name="DEFAULT_NM_LOG_RETAIN_SECONDS" type="long"
  13302. transient="false" volatile="false"
  13303. static="true" final="true" visibility="public"
  13304. deprecated="not deprecated">
  13305. </field>
  13306. <field name="NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="java.lang.String"
  13307. transient="false" volatile="false"
  13308. static="true" final="true" visibility="public"
  13309. deprecated="not deprecated">
  13310. <doc>
  13311. <![CDATA[Define how often NMs wake up and upload log files]]>
  13312. </doc>
  13313. </field>
  13314. <field name="DEFAULT_NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="long"
  13315. transient="false" volatile="false"
  13316. static="true" final="true" visibility="public"
  13317. deprecated="not deprecated">
  13318. </field>
  13319. <field name="NM_LOG_DELETION_THREADS_COUNT" type="java.lang.String"
  13320. transient="false" volatile="false"
  13321. static="true" final="true" visibility="public"
  13322. deprecated="not deprecated">
  13323. <doc>
  13324. <![CDATA[Number of threads used in log cleanup. Only applicable if Log aggregation
  13325. is disabled]]>
  13326. </doc>
  13327. </field>
  13328. <field name="DEFAULT_NM_LOG_DELETE_THREAD_COUNT" type="int"
  13329. transient="false" volatile="false"
  13330. static="true" final="true" visibility="public"
  13331. deprecated="not deprecated">
  13332. </field>
  13333. <field name="NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
  13334. transient="false" volatile="false"
  13335. static="true" final="true" visibility="public"
  13336. deprecated="not deprecated">
  13337. <doc>
  13338. <![CDATA[Where to aggregate logs to.]]>
  13339. </doc>
  13340. </field>
  13341. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
  13342. transient="false" volatile="false"
  13343. static="true" final="true" visibility="public"
  13344. deprecated="not deprecated">
  13345. </field>
  13346. <field name="NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
  13347. transient="false" volatile="false"
  13348. static="true" final="true" visibility="public"
  13349. deprecated="not deprecated">
  13350. <doc>
  13351. <![CDATA[The remote log dir will be created at
  13352. NM_REMOTE_APP_LOG_DIR/${user}/NM_REMOTE_APP_LOG_DIR_SUFFIX/${appId}]]>
  13353. </doc>
  13354. </field>
  13355. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
  13356. transient="false" volatile="false"
  13357. static="true" final="true" visibility="public"
  13358. deprecated="not deprecated">
  13359. </field>
  13360. <field name="YARN_LOG_SERVER_URL" type="java.lang.String"
  13361. transient="false" volatile="false"
  13362. static="true" final="true" visibility="public"
  13363. deprecated="not deprecated">
  13364. </field>
  13365. <field name="YARN_TRACKING_URL_GENERATOR" type="java.lang.String"
  13366. transient="false" volatile="false"
  13367. static="true" final="true" visibility="public"
  13368. deprecated="not deprecated">
  13369. </field>
  13370. <field name="NM_PMEM_MB" type="java.lang.String"
  13371. transient="false" volatile="false"
  13372. static="true" final="true" visibility="public"
  13373. deprecated="not deprecated">
  13374. <doc>
  13375. <![CDATA[Amount of memory in MB that can be allocated for containers.]]>
  13376. </doc>
  13377. </field>
  13378. <field name="DEFAULT_NM_PMEM_MB" type="int"
  13379. transient="false" volatile="false"
  13380. static="true" final="true" visibility="public"
  13381. deprecated="not deprecated">
  13382. </field>
  13383. <field name="NM_SYSTEM_RESERVED_PMEM_MB" type="java.lang.String"
  13384. transient="false" volatile="false"
  13385. static="true" final="true" visibility="public"
  13386. deprecated="not deprecated">
  13387. <doc>
  13388. <![CDATA[Amount of memory in MB that has been reserved for non-yarn use.]]>
  13389. </doc>
  13390. </field>
  13391. <field name="NM_PMEM_CHECK_ENABLED" type="java.lang.String"
  13392. transient="false" volatile="false"
  13393. static="true" final="true" visibility="public"
  13394. deprecated="not deprecated">
  13395. <doc>
  13396. <![CDATA[Specifies whether physical memory check is enabled.]]>
  13397. </doc>
  13398. </field>
  13399. <field name="DEFAULT_NM_PMEM_CHECK_ENABLED" type="boolean"
  13400. transient="false" volatile="false"
  13401. static="true" final="true" visibility="public"
  13402. deprecated="not deprecated">
  13403. </field>
  13404. <field name="NM_VMEM_CHECK_ENABLED" type="java.lang.String"
  13405. transient="false" volatile="false"
  13406. static="true" final="true" visibility="public"
  13407. deprecated="not deprecated">
  13408. <doc>
  13409. <![CDATA[Specifies whether physical memory check is enabled.]]>
  13410. </doc>
  13411. </field>
  13412. <field name="DEFAULT_NM_VMEM_CHECK_ENABLED" type="boolean"
  13413. transient="false" volatile="false"
  13414. static="true" final="true" visibility="public"
  13415. deprecated="not deprecated">
  13416. </field>
  13417. <field name="NM_VMEM_PMEM_RATIO" type="java.lang.String"
  13418. transient="false" volatile="false"
  13419. static="true" final="true" visibility="public"
  13420. deprecated="not deprecated">
  13421. <doc>
  13422. <![CDATA[Conversion ratio for physical memory to virtual memory.]]>
  13423. </doc>
  13424. </field>
  13425. <field name="DEFAULT_NM_VMEM_PMEM_RATIO" type="float"
  13426. transient="false" volatile="false"
  13427. static="true" final="true" visibility="public"
  13428. deprecated="not deprecated">
  13429. </field>
  13430. <field name="NM_VCORES" type="java.lang.String"
  13431. transient="false" volatile="false"
  13432. static="true" final="true" visibility="public"
  13433. deprecated="not deprecated">
  13434. <doc>
  13435. <![CDATA[Number of Virtual CPU Cores which can be allocated for containers.]]>
  13436. </doc>
  13437. </field>
  13438. <field name="DEFAULT_NM_VCORES" type="int"
  13439. transient="false" volatile="false"
  13440. static="true" final="true" visibility="public"
  13441. deprecated="not deprecated">
  13442. </field>
  13443. <field name="NM_COUNT_LOGICAL_PROCESSORS_AS_CORES" type="java.lang.String"
  13444. transient="false" volatile="false"
  13445. static="true" final="true" visibility="public"
  13446. deprecated="not deprecated">
  13447. <doc>
  13448. <![CDATA[Count logical processors(like hyperthreads) as cores.]]>
  13449. </doc>
  13450. </field>
  13451. <field name="DEFAULT_NM_COUNT_LOGICAL_PROCESSORS_AS_CORES" type="boolean"
  13452. transient="false" volatile="false"
  13453. static="true" final="true" visibility="public"
  13454. deprecated="not deprecated">
  13455. </field>
  13456. <field name="NM_PCORES_VCORES_MULTIPLIER" type="java.lang.String"
  13457. transient="false" volatile="false"
  13458. static="true" final="true" visibility="public"
  13459. deprecated="not deprecated">
  13460. <doc>
  13461. <![CDATA[Multiplier to convert physical cores to vcores.]]>
  13462. </doc>
  13463. </field>
  13464. <field name="DEFAULT_NM_PCORES_VCORES_MULTIPLIER" type="float"
  13465. transient="false" volatile="false"
  13466. static="true" final="true" visibility="public"
  13467. deprecated="not deprecated">
  13468. </field>
  13469. <field name="NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="java.lang.String"
  13470. transient="false" volatile="false"
  13471. static="true" final="true" visibility="public"
  13472. deprecated="not deprecated">
  13473. <doc>
  13474. <![CDATA[Percentage of overall CPU which can be allocated for containers.]]>
  13475. </doc>
  13476. </field>
  13477. <field name="DEFAULT_NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="int"
  13478. transient="false" volatile="false"
  13479. static="true" final="true" visibility="public"
  13480. deprecated="not deprecated">
  13481. </field>
  13482. <field name="NM_ENABLE_HARDWARE_CAPABILITY_DETECTION" type="java.lang.String"
  13483. transient="false" volatile="false"
  13484. static="true" final="true" visibility="public"
  13485. deprecated="not deprecated">
  13486. <doc>
  13487. <![CDATA[Enable or disable node hardware capability detection.]]>
  13488. </doc>
  13489. </field>
  13490. <field name="DEFAULT_NM_ENABLE_HARDWARE_CAPABILITY_DETECTION" type="boolean"
  13491. transient="false" volatile="false"
  13492. static="true" final="true" visibility="public"
  13493. deprecated="not deprecated">
  13494. </field>
  13495. <field name="NM_DISK_RESOURCE_PREFIX" type="java.lang.String"
  13496. transient="false" volatile="false"
  13497. static="true" final="true" visibility="public"
  13498. deprecated="not deprecated">
  13499. <doc>
  13500. <![CDATA[Prefix for disk configurations. Work in progress: This configuration
  13501. parameter may be changed/removed in the future.]]>
  13502. </doc>
  13503. </field>
  13504. <field name="NM_DISK_RESOURCE_ENABLED" type="java.lang.String"
  13505. transient="false" volatile="false"
  13506. static="true" final="true" visibility="public"
  13507. deprecated="not deprecated">
  13508. <doc>
  13509. <![CDATA[This setting controls if resource handling for disk operations is enabled.
  13510. Work in progress: This configuration parameter may be changed/removed in
  13511. the future]]>
  13512. </doc>
  13513. </field>
  13514. <field name="DEFAULT_NM_DISK_RESOURCE_ENABLED" type="boolean"
  13515. transient="false" volatile="false"
  13516. static="true" final="true" visibility="public"
  13517. deprecated="not deprecated">
  13518. <doc>
  13519. <![CDATA[Disk as a resource is disabled by default.]]>
  13520. </doc>
  13521. </field>
  13522. <field name="NM_NETWORK_RESOURCE_PREFIX" type="java.lang.String"
  13523. transient="false" volatile="false"
  13524. static="true" final="true" visibility="public"
  13525. deprecated="not deprecated">
  13526. </field>
  13527. <field name="NM_NETWORK_RESOURCE_ENABLED" type="java.lang.String"
  13528. transient="false" volatile="false"
  13529. static="true" final="true" visibility="public"
  13530. deprecated="not deprecated">
  13531. <doc>
  13532. <![CDATA[This setting controls if resource handling for network bandwidth is
  13533. enabled. Work in progress: This configuration parameter may be
  13534. changed/removed in the future]]>
  13535. </doc>
  13536. </field>
  13537. <field name="DEFAULT_NM_NETWORK_RESOURCE_ENABLED" type="boolean"
  13538. transient="false" volatile="false"
  13539. static="true" final="true" visibility="public"
  13540. deprecated="not deprecated">
  13541. <doc>
  13542. <![CDATA[Network as a resource is disabled by default.]]>
  13543. </doc>
  13544. </field>
  13545. <field name="NM_NETWORK_RESOURCE_INTERFACE" type="java.lang.String"
  13546. transient="false" volatile="false"
  13547. static="true" final="true" visibility="public"
  13548. deprecated="not deprecated">
  13549. <doc>
  13550. <![CDATA[Specifies the interface to be used for applying network throttling rules.
  13551. Work in progress: This configuration parameter may be changed/removed in
  13552. the future]]>
  13553. </doc>
  13554. </field>
  13555. <field name="DEFAULT_NM_NETWORK_RESOURCE_INTERFACE" type="java.lang.String"
  13556. transient="false" volatile="false"
  13557. static="true" final="true" visibility="public"
  13558. deprecated="not deprecated">
  13559. </field>
  13560. <field name="NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT" type="java.lang.String"
  13561. transient="false" volatile="false"
  13562. static="true" final="true" visibility="public"
  13563. deprecated="not deprecated">
  13564. <doc>
  13565. <![CDATA[Specifies the total available outbound bandwidth on the node. Work in
  13566. progress: This configuration parameter may be changed/removed in the future]]>
  13567. </doc>
  13568. </field>
  13569. <field name="DEFAULT_NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT" type="int"
  13570. transient="false" volatile="false"
  13571. static="true" final="true" visibility="public"
  13572. deprecated="not deprecated">
  13573. </field>
  13574. <field name="NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_YARN_MBIT" type="java.lang.String"
  13575. transient="false" volatile="false"
  13576. static="true" final="true" visibility="public"
  13577. deprecated="not deprecated">
  13578. <doc>
  13579. <![CDATA[Specifies the total outbound bandwidth available to YARN containers.
  13580. defaults to NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT if not specified.
  13581. Work in progress: This configuration parameter may be changed/removed in
  13582. the future]]>
  13583. </doc>
  13584. </field>
  13585. <field name="NM_WEBAPP_ADDRESS" type="java.lang.String"
  13586. transient="false" volatile="false"
  13587. static="true" final="true" visibility="public"
  13588. deprecated="not deprecated">
  13589. <doc>
  13590. <![CDATA[NM Webapp address.]]>
  13591. </doc>
  13592. </field>
  13593. <field name="DEFAULT_NM_WEBAPP_PORT" type="int"
  13594. transient="false" volatile="false"
  13595. static="true" final="true" visibility="public"
  13596. deprecated="not deprecated">
  13597. </field>
  13598. <field name="DEFAULT_NM_WEBAPP_ADDRESS" type="java.lang.String"
  13599. transient="false" volatile="false"
  13600. static="true" final="true" visibility="public"
  13601. deprecated="not deprecated">
  13602. </field>
  13603. <field name="NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  13604. transient="false" volatile="false"
  13605. static="true" final="true" visibility="public"
  13606. deprecated="not deprecated">
  13607. <doc>
  13608. <![CDATA[NM Webapp https address.]]>
  13609. </doc>
  13610. </field>
  13611. <field name="DEFAULT_NM_WEBAPP_HTTPS_PORT" type="int"
  13612. transient="false" volatile="false"
  13613. static="true" final="true" visibility="public"
  13614. deprecated="not deprecated">
  13615. </field>
  13616. <field name="DEFAULT_NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  13617. transient="false" volatile="false"
  13618. static="true" final="true" visibility="public"
  13619. deprecated="not deprecated">
  13620. </field>
  13621. <field name="NM_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
  13622. transient="false" volatile="false"
  13623. static="true" final="true" visibility="public"
  13624. deprecated="not deprecated">
  13625. <doc>
  13626. <![CDATA[Enable/disable CORS filter.]]>
  13627. </doc>
  13628. </field>
  13629. <field name="DEFAULT_NM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
  13630. transient="false" volatile="false"
  13631. static="true" final="true" visibility="public"
  13632. deprecated="not deprecated">
  13633. </field>
  13634. <field name="NM_RESOURCE_MON_INTERVAL_MS" type="java.lang.String"
  13635. transient="false" volatile="false"
  13636. static="true" final="true" visibility="public"
  13637. deprecated="not deprecated">
  13638. <doc>
  13639. <![CDATA[How often to monitor resource in a node.]]>
  13640. </doc>
  13641. </field>
  13642. <field name="DEFAULT_NM_RESOURCE_MON_INTERVAL_MS" type="int"
  13643. transient="false" volatile="false"
  13644. static="true" final="true" visibility="public"
  13645. deprecated="not deprecated">
  13646. </field>
  13647. <field name="NM_CONTAINER_MON_INTERVAL_MS" type="java.lang.String"
  13648. transient="false" volatile="false"
  13649. static="true" final="true" visibility="public"
  13650. deprecated="not deprecated">
  13651. <doc>
  13652. <![CDATA[How often to monitor containers.]]>
  13653. </doc>
  13654. </field>
  13655. <field name="DEFAULT_NM_CONTAINER_MON_INTERVAL_MS" type="int"
  13656. transient="false" volatile="false"
  13657. static="true" final="true" visibility="public"
  13658. deprecated="not deprecated">
  13659. </field>
  13660. <field name="NM_MON_RESOURCE_CALCULATOR" type="java.lang.String"
  13661. transient="false" volatile="false"
  13662. static="true" final="true" visibility="public"
  13663. deprecated="not deprecated">
  13664. <doc>
  13665. <![CDATA[Class that calculates current resource utilization.]]>
  13666. </doc>
  13667. </field>
  13668. <field name="NM_CONTAINER_MON_RESOURCE_CALCULATOR" type="java.lang.String"
  13669. transient="false" volatile="false"
  13670. static="true" final="true" visibility="public"
  13671. deprecated="not deprecated">
  13672. <doc>
  13673. <![CDATA[Class that calculates containers current resource utilization.]]>
  13674. </doc>
  13675. </field>
  13676. <field name="NM_CONTAINER_MON_PROCESS_TREE" type="java.lang.String"
  13677. transient="false" volatile="false"
  13678. static="true" final="true" visibility="public"
  13679. deprecated="not deprecated">
  13680. <doc>
  13681. <![CDATA[Class that calculates process tree resource utilization.]]>
  13682. </doc>
  13683. </field>
  13684. <field name="PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="java.lang.String"
  13685. transient="false" volatile="false"
  13686. static="true" final="true" visibility="public"
  13687. deprecated="not deprecated">
  13688. </field>
  13689. <field name="DEFAULT_PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="boolean"
  13690. transient="false" volatile="false"
  13691. static="true" final="true" visibility="public"
  13692. deprecated="not deprecated">
  13693. </field>
  13694. <field name="NM_CONTAINER_METRICS_ENABLE" type="java.lang.String"
  13695. transient="false" volatile="false"
  13696. static="true" final="true" visibility="public"
  13697. deprecated="not deprecated">
  13698. <doc>
  13699. <![CDATA[Enable/disable container metrics.]]>
  13700. </doc>
  13701. </field>
  13702. <field name="DEFAULT_NM_CONTAINER_METRICS_ENABLE" type="boolean"
  13703. transient="false" volatile="false"
  13704. static="true" final="true" visibility="public"
  13705. deprecated="not deprecated">
  13706. </field>
  13707. <field name="NM_CONTAINER_METRICS_PERIOD_MS" type="java.lang.String"
  13708. transient="false" volatile="false"
  13709. static="true" final="true" visibility="public"
  13710. deprecated="not deprecated">
  13711. <doc>
  13712. <![CDATA[Container metrics flush period. -1 for flush on completion.]]>
  13713. </doc>
  13714. </field>
  13715. <field name="DEFAULT_NM_CONTAINER_METRICS_PERIOD_MS" type="int"
  13716. transient="false" volatile="false"
  13717. static="true" final="true" visibility="public"
  13718. deprecated="not deprecated">
  13719. </field>
  13720. <field name="NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="java.lang.String"
  13721. transient="false" volatile="false"
  13722. static="true" final="true" visibility="public"
  13723. deprecated="not deprecated">
  13724. <doc>
  13725. <![CDATA[The delay time ms to unregister container metrics after completion.]]>
  13726. </doc>
  13727. </field>
  13728. <field name="DEFAULT_NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="int"
  13729. transient="false" volatile="false"
  13730. static="true" final="true" visibility="public"
  13731. deprecated="not deprecated">
  13732. </field>
  13733. <field name="NM_DISK_HEALTH_CHECK_ENABLE" type="java.lang.String"
  13734. transient="false" volatile="false"
  13735. static="true" final="true" visibility="public"
  13736. deprecated="not deprecated">
  13737. <doc>
  13738. <![CDATA[Enable/Disable disks' health checker. Default is true. An expert level
  13739. configuration property.]]>
  13740. </doc>
  13741. </field>
  13742. <field name="NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
  13743. transient="false" volatile="false"
  13744. static="true" final="true" visibility="public"
  13745. deprecated="not deprecated">
  13746. <doc>
  13747. <![CDATA[Frequency of running disks' health checker.]]>
  13748. </doc>
  13749. </field>
  13750. <field name="DEFAULT_NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="long"
  13751. transient="false" volatile="false"
  13752. static="true" final="true" visibility="public"
  13753. deprecated="not deprecated">
  13754. <doc>
  13755. <![CDATA[By default, disks' health is checked every 2 minutes.]]>
  13756. </doc>
  13757. </field>
  13758. <field name="NM_MIN_HEALTHY_DISKS_FRACTION" type="java.lang.String"
  13759. transient="false" volatile="false"
  13760. static="true" final="true" visibility="public"
  13761. deprecated="not deprecated">
  13762. <doc>
  13763. <![CDATA[The minimum fraction of number of disks to be healthy for the nodemanager
  13764. to launch new containers. This applies to nm-local-dirs and nm-log-dirs.]]>
  13765. </doc>
  13766. </field>
  13767. <field name="DEFAULT_NM_MIN_HEALTHY_DISKS_FRACTION" type="float"
  13768. transient="false" volatile="false"
  13769. static="true" final="true" visibility="public"
  13770. deprecated="not deprecated">
  13771. <doc>
  13772. <![CDATA[By default, at least 25% of disks are to be healthy to say that the node is
  13773. healthy in terms of disks.]]>
  13774. </doc>
  13775. </field>
  13776. <field name="NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="java.lang.String"
  13777. transient="false" volatile="false"
  13778. static="true" final="true" visibility="public"
  13779. deprecated="not deprecated">
  13780. <doc>
  13781. <![CDATA[The maximum percentage of disk space that can be used after which a disk is
  13782. marked as offline. Values can range from 0.0 to 100.0. If the value is
  13783. greater than or equal to 100, NM will check for full disk. This applies to
  13784. nm-local-dirs and nm-log-dirs.]]>
  13785. </doc>
  13786. </field>
  13787. <field name="DEFAULT_NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="float"
  13788. transient="false" volatile="false"
  13789. static="true" final="true" visibility="public"
  13790. deprecated="not deprecated">
  13791. <doc>
  13792. <![CDATA[By default, 90% of the disk can be used before it is marked as offline.]]>
  13793. </doc>
  13794. </field>
  13795. <field name="NM_WM_LOW_PER_DISK_UTILIZATION_PERCENTAGE" type="java.lang.String"
  13796. transient="false" volatile="false"
  13797. static="true" final="true" visibility="public"
  13798. deprecated="not deprecated">
  13799. <doc>
  13800. <![CDATA[The low threshold percentage of disk space used when an offline disk is
  13801. marked as online. Values can range from 0.0 to 100.0. The value shouldn't
  13802. be more than NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE. If its value is
  13803. more than NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE or not set, it will be
  13804. set to the same value as NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE.
  13805. This applies to nm-local-dirs and nm-log-dirs.]]>
  13806. </doc>
  13807. </field>
  13808. <field name="NM_MIN_PER_DISK_FREE_SPACE_MB" type="java.lang.String"
  13809. transient="false" volatile="false"
  13810. static="true" final="true" visibility="public"
  13811. deprecated="not deprecated">
  13812. <doc>
  13813. <![CDATA[The minimum space that must be available on a local dir for it to be used.
  13814. This applies to nm-local-dirs and nm-log-dirs.]]>
  13815. </doc>
  13816. </field>
  13817. <field name="DEFAULT_NM_MIN_PER_DISK_FREE_SPACE_MB" type="long"
  13818. transient="false" volatile="false"
  13819. static="true" final="true" visibility="public"
  13820. deprecated="not deprecated">
  13821. <doc>
  13822. <![CDATA[By default, all of the disk can be used before it is marked as offline.]]>
  13823. </doc>
  13824. </field>
  13825. <field name="NM_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
  13826. transient="false" volatile="false"
  13827. static="true" final="true" visibility="public"
  13828. deprecated="not deprecated">
  13829. <doc>
  13830. <![CDATA[Frequency of running node health script.]]>
  13831. </doc>
  13832. </field>
  13833. <field name="DEFAULT_NM_HEALTH_CHECK_INTERVAL_MS" type="long"
  13834. transient="false" volatile="false"
  13835. static="true" final="true" visibility="public"
  13836. deprecated="not deprecated">
  13837. </field>
  13838. <field name="NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="java.lang.String"
  13839. transient="false" volatile="false"
  13840. static="true" final="true" visibility="public"
  13841. deprecated="not deprecated">
  13842. <doc>
  13843. <![CDATA[Health check script time out period.]]>
  13844. </doc>
  13845. </field>
  13846. <field name="DEFAULT_NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="long"
  13847. transient="false" volatile="false"
  13848. static="true" final="true" visibility="public"
  13849. deprecated="not deprecated">
  13850. </field>
  13851. <field name="NM_HEALTH_CHECK_SCRIPT_PATH" type="java.lang.String"
  13852. transient="false" volatile="false"
  13853. static="true" final="true" visibility="public"
  13854. deprecated="not deprecated">
  13855. <doc>
  13856. <![CDATA[The health check script to run.]]>
  13857. </doc>
  13858. </field>
  13859. <field name="NM_HEALTH_CHECK_SCRIPT_OPTS" type="java.lang.String"
  13860. transient="false" volatile="false"
  13861. static="true" final="true" visibility="public"
  13862. deprecated="not deprecated">
  13863. <doc>
  13864. <![CDATA[The arguments to pass to the health check script.]]>
  13865. </doc>
  13866. </field>
  13867. <field name="NM_CONTAINER_LOCALIZER_JAVA_OPTS_KEY" type="java.lang.String"
  13868. transient="false" volatile="false"
  13869. static="true" final="true" visibility="public"
  13870. deprecated="not deprecated">
  13871. <doc>
  13872. <![CDATA[The JVM options used on forking ContainerLocalizer process
  13873. by container executor.]]>
  13874. </doc>
  13875. </field>
  13876. <field name="NM_CONTAINER_LOCALIZER_JAVA_OPTS_DEFAULT" type="java.lang.String"
  13877. transient="false" volatile="false"
  13878. static="true" final="true" visibility="public"
  13879. deprecated="not deprecated">
  13880. </field>
  13881. <field name="NM_DOCKER_CONTAINER_EXECUTOR_IMAGE_NAME" type="java.lang.String"
  13882. transient="false" volatile="false"
  13883. static="true" final="true" visibility="public"
  13884. deprecated="not deprecated">
  13885. <doc>
  13886. <![CDATA[The Docker image name(For DockerContainerExecutor).]]>
  13887. </doc>
  13888. </field>
  13889. <field name="NM_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME" type="java.lang.String"
  13890. transient="false" volatile="false"
  13891. static="true" final="true" visibility="public"
  13892. deprecated="not deprecated">
  13893. <doc>
  13894. <![CDATA[The name of the docker executor (For DockerContainerExecutor).]]>
  13895. </doc>
  13896. </field>
  13897. <field name="NM_DEFAULT_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME" type="java.lang.String"
  13898. transient="false" volatile="false"
  13899. static="true" final="true" visibility="public"
  13900. deprecated="not deprecated">
  13901. <doc>
  13902. <![CDATA[The default docker executor (For DockerContainerExecutor).]]>
  13903. </doc>
  13904. </field>
  13905. <field name="LINUX_CONTAINER_RUNTIME_PREFIX" type="java.lang.String"
  13906. transient="false" volatile="false"
  13907. static="true" final="true" visibility="public"
  13908. deprecated="not deprecated">
  13909. <doc>
  13910. <![CDATA[Prefix for runtime configuration constants.]]>
  13911. </doc>
  13912. </field>
  13913. <field name="LINUX_CONTAINER_RUNTIME_ALLOWED_RUNTIMES" type="java.lang.String"
  13914. transient="false" volatile="false"
  13915. static="true" final="true" visibility="public"
  13916. deprecated="not deprecated">
  13917. <doc>
  13918. <![CDATA[Comma separated list of runtimes that are allowed when using
  13919. LinuxContainerExecutor. The allowed values are:
  13920. <ul>
  13921. <li>default</li>
  13922. <li>docker</li>
  13923. </ul>]]>
  13924. </doc>
  13925. </field>
  13926. <field name="DEFAULT_LINUX_CONTAINER_RUNTIME_ALLOWED_RUNTIMES" type="java.lang.String[]"
  13927. transient="false" volatile="false"
  13928. static="true" final="true" visibility="public"
  13929. deprecated="not deprecated">
  13930. <doc>
  13931. <![CDATA[The default list of allowed runtimes when using LinuxContainerExecutor.]]>
  13932. </doc>
  13933. </field>
  13934. <field name="DOCKER_CONTAINER_RUNTIME_PREFIX" type="java.lang.String"
  13935. transient="false" volatile="false"
  13936. static="true" final="true" visibility="public"
  13937. deprecated="not deprecated">
  13938. </field>
  13939. <field name="NM_DOCKER_CONTAINER_CAPABILITIES" type="java.lang.String"
  13940. transient="false" volatile="false"
  13941. static="true" final="true" visibility="public"
  13942. deprecated="not deprecated">
  13943. <doc>
  13944. <![CDATA[Capabilities allowed (and added by default) for docker containers.]]>
  13945. </doc>
  13946. </field>
  13947. <field name="DEFAULT_NM_DOCKER_CONTAINER_CAPABILITIES" type="java.lang.String[]"
  13948. transient="false" volatile="false"
  13949. static="true" final="true" visibility="public"
  13950. deprecated="not deprecated">
  13951. <doc>
  13952. <![CDATA[These are the default capabilities added by docker. We'll use the same
  13953. set here. While these may not be case-sensitive from a docker
  13954. perspective, it is best to keep these uppercase.]]>
  13955. </doc>
  13956. </field>
  13957. <field name="NM_DOCKER_ALLOW_PRIVILEGED_CONTAINERS" type="java.lang.String"
  13958. transient="false" volatile="false"
  13959. static="true" final="true" visibility="public"
  13960. deprecated="not deprecated">
  13961. <doc>
  13962. <![CDATA[Allow privileged containers. Use with extreme care.]]>
  13963. </doc>
  13964. </field>
  13965. <field name="DEFAULT_NM_DOCKER_ALLOW_PRIVILEGED_CONTAINERS" type="boolean"
  13966. transient="false" volatile="false"
  13967. static="true" final="true" visibility="public"
  13968. deprecated="not deprecated">
  13969. <doc>
  13970. <![CDATA[Privileged containers are disabled by default.]]>
  13971. </doc>
  13972. </field>
  13973. <field name="NM_DOCKER_PRIVILEGED_CONTAINERS_ACL" type="java.lang.String"
  13974. transient="false" volatile="false"
  13975. static="true" final="true" visibility="public"
  13976. deprecated="not deprecated">
  13977. <doc>
  13978. <![CDATA[ACL list for users allowed to run privileged containers.]]>
  13979. </doc>
  13980. </field>
  13981. <field name="DEFAULT_NM_DOCKER_PRIVILEGED_CONTAINERS_ACL" type="java.lang.String"
  13982. transient="false" volatile="false"
  13983. static="true" final="true" visibility="public"
  13984. deprecated="not deprecated">
  13985. <doc>
  13986. <![CDATA[Default list for users allowed to run privileged containers is empty.]]>
  13987. </doc>
  13988. </field>
  13989. <field name="NM_LINUX_CONTAINER_EXECUTOR_PATH" type="java.lang.String"
  13990. transient="false" volatile="false"
  13991. static="true" final="true" visibility="public"
  13992. deprecated="not deprecated">
  13993. <doc>
  13994. <![CDATA[The path to the Linux container executor.]]>
  13995. </doc>
  13996. </field>
  13997. <field name="NM_LINUX_CONTAINER_GROUP" type="java.lang.String"
  13998. transient="false" volatile="false"
  13999. static="true" final="true" visibility="public"
  14000. deprecated="not deprecated">
  14001. <doc>
  14002. <![CDATA[The UNIX group that the linux-container-executor should run as.
  14003. This is intended to be set as part of container-executor.cfg.]]>
  14004. </doc>
  14005. </field>
  14006. <field name="NM_NONSECURE_MODE_LIMIT_USERS" type="java.lang.String"
  14007. transient="false" volatile="false"
  14008. static="true" final="true" visibility="public"
  14009. deprecated="not deprecated">
  14010. <doc>
  14011. <![CDATA[If linux-container-executor should limit itself to one user
  14012. when running in non-secure mode.]]>
  14013. </doc>
  14014. </field>
  14015. <field name="DEFAULT_NM_NONSECURE_MODE_LIMIT_USERS" type="boolean"
  14016. transient="false" volatile="false"
  14017. static="true" final="true" visibility="public"
  14018. deprecated="not deprecated">
  14019. </field>
  14020. <field name="NM_NONSECURE_MODE_LOCAL_USER_KEY" type="java.lang.String"
  14021. transient="false" volatile="false"
  14022. static="true" final="true" visibility="public"
  14023. deprecated="not deprecated">
  14024. <doc>
  14025. <![CDATA[The UNIX user that containers will run as when Linux-container-executor
  14026. is used in nonsecure mode (a use case for this is using cgroups).]]>
  14027. </doc>
  14028. </field>
  14029. <field name="DEFAULT_NM_NONSECURE_MODE_LOCAL_USER" type="java.lang.String"
  14030. transient="false" volatile="false"
  14031. static="true" final="true" visibility="public"
  14032. deprecated="not deprecated">
  14033. </field>
  14034. <field name="NM_NONSECURE_MODE_USER_PATTERN_KEY" type="java.lang.String"
  14035. transient="false" volatile="false"
  14036. static="true" final="true" visibility="public"
  14037. deprecated="not deprecated">
  14038. <doc>
  14039. <![CDATA[The allowed pattern for UNIX user names enforced by
  14040. Linux-container-executor when used in nonsecure mode (use case for this
  14041. is using cgroups). The default value is taken from /usr/sbin/adduser]]>
  14042. </doc>
  14043. </field>
  14044. <field name="DEFAULT_NM_NONSECURE_MODE_USER_PATTERN" type="java.lang.String"
  14045. transient="false" volatile="false"
  14046. static="true" final="true" visibility="public"
  14047. deprecated="not deprecated">
  14048. </field>
  14049. <field name="NM_LINUX_CONTAINER_RESOURCES_HANDLER" type="java.lang.String"
  14050. transient="false" volatile="false"
  14051. static="true" final="true" visibility="public"
  14052. deprecated="not deprecated">
  14053. <doc>
  14054. <![CDATA[The type of resource enforcement to use with the
  14055. linux container executor.]]>
  14056. </doc>
  14057. </field>
  14058. <field name="NM_LINUX_CONTAINER_CGROUPS_HIERARCHY" type="java.lang.String"
  14059. transient="false" volatile="false"
  14060. static="true" final="true" visibility="public"
  14061. deprecated="not deprecated">
  14062. <doc>
  14063. <![CDATA[The path the linux container executor should use for cgroups]]>
  14064. </doc>
  14065. </field>
  14066. <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT" type="java.lang.String"
  14067. transient="false" volatile="false"
  14068. static="true" final="true" visibility="public"
  14069. deprecated="not deprecated">
  14070. <doc>
  14071. <![CDATA[Whether the linux container executor should mount cgroups if not found]]>
  14072. </doc>
  14073. </field>
  14074. <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT_PATH" type="java.lang.String"
  14075. transient="false" volatile="false"
  14076. static="true" final="true" visibility="public"
  14077. deprecated="not deprecated">
  14078. <doc>
  14079. <![CDATA[Where the linux container executor should mount cgroups if not found]]>
  14080. </doc>
  14081. </field>
  14082. <field name="NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="java.lang.String"
  14083. transient="false" volatile="false"
  14084. static="true" final="true" visibility="public"
  14085. deprecated="not deprecated">
  14086. <doc>
  14087. <![CDATA[Whether the apps should run in strict resource usage mode(not allowed to
  14088. use spare CPU)]]>
  14089. </doc>
  14090. </field>
  14091. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="boolean"
  14092. transient="false" volatile="false"
  14093. static="true" final="true" visibility="public"
  14094. deprecated="not deprecated">
  14095. </field>
  14096. <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="java.lang.String"
  14097. transient="false" volatile="false"
  14098. static="true" final="true" visibility="public"
  14099. deprecated="not deprecated">
  14100. <doc>
  14101. <![CDATA[Interval of time the linux container executor should try cleaning up
  14102. cgroups entry when cleaning up a container. This is required due to what
  14103. it seems a race condition because the SIGTERM/SIGKILL is asynch.]]>
  14104. </doc>
  14105. </field>
  14106. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="long"
  14107. transient="false" volatile="false"
  14108. static="true" final="true" visibility="public"
  14109. deprecated="not deprecated">
  14110. </field>
  14111. <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="java.lang.String"
  14112. transient="false" volatile="false"
  14113. static="true" final="true" visibility="public"
  14114. deprecated="not deprecated">
  14115. <doc>
  14116. <![CDATA[Delay between attempts to remove linux cgroup.]]>
  14117. </doc>
  14118. </field>
  14119. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="long"
  14120. transient="false" volatile="false"
  14121. static="true" final="true" visibility="public"
  14122. deprecated="not deprecated">
  14123. </field>
  14124. <field name="NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="java.lang.String"
  14125. transient="false" volatile="false"
  14126. static="true" final="true" visibility="public"
  14127. deprecated="not deprecated">
  14128. <doc>
  14129. <![CDATA[Indicates if memory and CPU limits will be set for the Windows Job
  14130. Object for the containers launched by the default container executor.]]>
  14131. </doc>
  14132. </field>
  14133. <field name="DEFAULT_NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="boolean"
  14134. transient="false" volatile="false"
  14135. static="true" final="true" visibility="public"
  14136. deprecated="not deprecated">
  14137. </field>
  14138. <field name="NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="java.lang.String"
  14139. transient="false" volatile="false"
  14140. static="true" final="true" visibility="public"
  14141. deprecated="not deprecated">
  14142. </field>
  14143. <field name="DEFAULT_NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="boolean"
  14144. transient="false" volatile="false"
  14145. static="true" final="true" visibility="public"
  14146. deprecated="not deprecated">
  14147. </field>
  14148. <field name="NM_WINDOWS_SECURE_CONTAINER_GROUP" type="java.lang.String"
  14149. transient="false" volatile="false"
  14150. static="true" final="true" visibility="public"
  14151. deprecated="not deprecated">
  14152. <doc>
  14153. <![CDATA[/* The Windows group that the windows-secure-container-executor should run as.]]>
  14154. </doc>
  14155. </field>
  14156. <field name="NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
  14157. transient="false" volatile="false"
  14158. static="true" final="true" visibility="public"
  14159. deprecated="not deprecated">
  14160. <doc>
  14161. <![CDATA[T-file compression types used to compress aggregated logs.]]>
  14162. </doc>
  14163. </field>
  14164. <field name="DEFAULT_NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
  14165. transient="false" volatile="false"
  14166. static="true" final="true" visibility="public"
  14167. deprecated="not deprecated">
  14168. </field>
  14169. <field name="NM_PRINCIPAL" type="java.lang.String"
  14170. transient="false" volatile="false"
  14171. static="true" final="true" visibility="public"
  14172. deprecated="not deprecated">
  14173. <doc>
  14174. <![CDATA[The kerberos principal for the node manager.]]>
  14175. </doc>
  14176. </field>
  14177. <field name="NM_AUX_SERVICES" type="java.lang.String"
  14178. transient="false" volatile="false"
  14179. static="true" final="true" visibility="public"
  14180. deprecated="not deprecated">
  14181. </field>
  14182. <field name="NM_AUX_SERVICE_FMT" type="java.lang.String"
  14183. transient="false" volatile="false"
  14184. static="true" final="true" visibility="public"
  14185. deprecated="not deprecated">
  14186. </field>
  14187. <field name="NM_USER_HOME_DIR" type="java.lang.String"
  14188. transient="false" volatile="false"
  14189. static="true" final="true" visibility="public"
  14190. deprecated="not deprecated">
  14191. </field>
  14192. <field name="NM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
  14193. transient="false" volatile="false"
  14194. static="true" final="true" visibility="public"
  14195. deprecated="not deprecated">
  14196. <doc>
  14197. <![CDATA[The kerberos principal to be used for spnego filter for NM.]]>
  14198. </doc>
  14199. </field>
  14200. <field name="NM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
  14201. transient="false" volatile="false"
  14202. static="true" final="true" visibility="public"
  14203. deprecated="not deprecated">
  14204. <doc>
  14205. <![CDATA[The kerberos keytab to be used for spnego filter for NM.]]>
  14206. </doc>
  14207. </field>
  14208. <field name="DEFAULT_NM_USER_HOME_DIR" type="java.lang.String"
  14209. transient="false" volatile="false"
  14210. static="true" final="true" visibility="public"
  14211. deprecated="not deprecated">
  14212. </field>
  14213. <field name="NM_RECOVERY_PREFIX" type="java.lang.String"
  14214. transient="false" volatile="false"
  14215. static="true" final="true" visibility="public"
  14216. deprecated="not deprecated">
  14217. </field>
  14218. <field name="NM_RECOVERY_ENABLED" type="java.lang.String"
  14219. transient="false" volatile="false"
  14220. static="true" final="true" visibility="public"
  14221. deprecated="not deprecated">
  14222. </field>
  14223. <field name="DEFAULT_NM_RECOVERY_ENABLED" type="boolean"
  14224. transient="false" volatile="false"
  14225. static="true" final="true" visibility="public"
  14226. deprecated="not deprecated">
  14227. </field>
  14228. <field name="NM_RECOVERY_DIR" type="java.lang.String"
  14229. transient="false" volatile="false"
  14230. static="true" final="true" visibility="public"
  14231. deprecated="not deprecated">
  14232. </field>
  14233. <field name="NM_RECOVERY_COMPACTION_INTERVAL_SECS" type="java.lang.String"
  14234. transient="false" volatile="false"
  14235. static="true" final="true" visibility="public"
  14236. deprecated="not deprecated">
  14237. <doc>
  14238. <![CDATA[The time in seconds between full compactions of the NM state database.
  14239. Setting the interval to zero disables the full compaction cycles.]]>
  14240. </doc>
  14241. </field>
  14242. <field name="DEFAULT_NM_RECOVERY_COMPACTION_INTERVAL_SECS" type="int"
  14243. transient="false" volatile="false"
  14244. static="true" final="true" visibility="public"
  14245. deprecated="not deprecated">
  14246. </field>
  14247. <field name="NM_RECOVERY_SUPERVISED" type="java.lang.String"
  14248. transient="false" volatile="false"
  14249. static="true" final="true" visibility="public"
  14250. deprecated="not deprecated">
  14251. </field>
  14252. <field name="DEFAULT_NM_RECOVERY_SUPERVISED" type="boolean"
  14253. transient="false" volatile="false"
  14254. static="true" final="true" visibility="public"
  14255. deprecated="not deprecated">
  14256. </field>
  14257. <field name="NM_LOG_AGG_POLICY_CLASS" type="java.lang.String"
  14258. transient="false" volatile="false"
  14259. static="true" final="true" visibility="public"
  14260. deprecated="not deprecated">
  14261. </field>
  14262. <field name="NM_LOG_AGG_POLICY_CLASS_PARAMETERS" type="java.lang.String"
  14263. transient="false" volatile="false"
  14264. static="true" final="true" visibility="public"
  14265. deprecated="not deprecated">
  14266. </field>
  14267. <field name="PROXY_PREFIX" type="java.lang.String"
  14268. transient="false" volatile="false"
  14269. static="true" final="true" visibility="public"
  14270. deprecated="not deprecated">
  14271. </field>
  14272. <field name="PROXY_PRINCIPAL" type="java.lang.String"
  14273. transient="false" volatile="false"
  14274. static="true" final="true" visibility="public"
  14275. deprecated="not deprecated">
  14276. <doc>
  14277. <![CDATA[The kerberos principal for the proxy.]]>
  14278. </doc>
  14279. </field>
  14280. <field name="PROXY_KEYTAB" type="java.lang.String"
  14281. transient="false" volatile="false"
  14282. static="true" final="true" visibility="public"
  14283. deprecated="not deprecated">
  14284. <doc>
  14285. <![CDATA[Keytab for Proxy.]]>
  14286. </doc>
  14287. </field>
  14288. <field name="PROXY_ADDRESS" type="java.lang.String"
  14289. transient="false" volatile="false"
  14290. static="true" final="true" visibility="public"
  14291. deprecated="not deprecated">
  14292. <doc>
  14293. <![CDATA[The address for the web proxy.]]>
  14294. </doc>
  14295. </field>
  14296. <field name="DEFAULT_PROXY_PORT" type="int"
  14297. transient="false" volatile="false"
  14298. static="true" final="true" visibility="public"
  14299. deprecated="not deprecated">
  14300. </field>
  14301. <field name="DEFAULT_PROXY_ADDRESS" type="java.lang.String"
  14302. transient="false" volatile="false"
  14303. static="true" final="true" visibility="public"
  14304. deprecated="not deprecated">
  14305. </field>
  14306. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCETRACKER_PROTOCOL" type="java.lang.String"
  14307. transient="false" volatile="false"
  14308. static="true" final="true" visibility="public"
  14309. deprecated="not deprecated">
  14310. <doc>
  14311. <![CDATA[YARN Service Level Authorization]]>
  14312. </doc>
  14313. </field>
  14314. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONCLIENT_PROTOCOL" type="java.lang.String"
  14315. transient="false" volatile="false"
  14316. static="true" final="true" visibility="public"
  14317. deprecated="not deprecated">
  14318. </field>
  14319. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCEMANAGER_ADMINISTRATION_PROTOCOL" type="java.lang.String"
  14320. transient="false" volatile="false"
  14321. static="true" final="true" visibility="public"
  14322. deprecated="not deprecated">
  14323. </field>
  14324. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONMASTER_PROTOCOL" type="java.lang.String"
  14325. transient="false" volatile="false"
  14326. static="true" final="true" visibility="public"
  14327. deprecated="not deprecated">
  14328. </field>
  14329. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_CONTAINER_MANAGEMENT_PROTOCOL" type="java.lang.String"
  14330. transient="false" volatile="false"
  14331. static="true" final="true" visibility="public"
  14332. deprecated="not deprecated">
  14333. </field>
  14334. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCE_LOCALIZER" type="java.lang.String"
  14335. transient="false" volatile="false"
  14336. static="true" final="true" visibility="public"
  14337. deprecated="not deprecated">
  14338. </field>
  14339. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONHISTORY_PROTOCOL" type="java.lang.String"
  14340. transient="false" volatile="false"
  14341. static="true" final="true" visibility="public"
  14342. deprecated="not deprecated">
  14343. </field>
  14344. <field name="NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="java.lang.String"
  14345. transient="false" volatile="false"
  14346. static="true" final="true" visibility="public"
  14347. deprecated="not deprecated">
  14348. <doc>
  14349. <![CDATA[No. of milliseconds to wait between sending a SIGTERM and SIGKILL
  14350. to a running container]]>
  14351. </doc>
  14352. </field>
  14353. <field name="DEFAULT_NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="long"
  14354. transient="false" volatile="false"
  14355. static="true" final="true" visibility="public"
  14356. deprecated="not deprecated">
  14357. </field>
  14358. <field name="NM_PROCESS_KILL_WAIT_MS" type="java.lang.String"
  14359. transient="false" volatile="false"
  14360. static="true" final="true" visibility="public"
  14361. deprecated="not deprecated">
  14362. <doc>
  14363. <![CDATA[Max time to wait for a process to come up when trying to cleanup
  14364. container resources]]>
  14365. </doc>
  14366. </field>
  14367. <field name="DEFAULT_NM_PROCESS_KILL_WAIT_MS" type="long"
  14368. transient="false" volatile="false"
  14369. static="true" final="true" visibility="public"
  14370. deprecated="not deprecated">
  14371. </field>
  14372. <field name="RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  14373. transient="false" volatile="false"
  14374. static="true" final="true" visibility="public"
  14375. deprecated="not deprecated">
  14376. <doc>
  14377. <![CDATA[Max time to wait to establish a connection to RM]]>
  14378. </doc>
  14379. </field>
  14380. <field name="DEFAULT_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="long"
  14381. transient="false" volatile="false"
  14382. static="true" final="true" visibility="public"
  14383. deprecated="not deprecated">
  14384. </field>
  14385. <field name="RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  14386. transient="false" volatile="false"
  14387. static="true" final="true" visibility="public"
  14388. deprecated="not deprecated">
  14389. <doc>
  14390. <![CDATA[Time interval between each attempt to connect to RM]]>
  14391. </doc>
  14392. </field>
  14393. <field name="DEFAULT_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="long"
  14394. transient="false" volatile="false"
  14395. static="true" final="true" visibility="public"
  14396. deprecated="not deprecated">
  14397. </field>
  14398. <field name="DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="java.lang.String"
  14399. transient="false" volatile="false"
  14400. static="true" final="true" visibility="public"
  14401. deprecated="not deprecated">
  14402. </field>
  14403. <field name="DEFAULT_DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="long"
  14404. transient="false" volatile="false"
  14405. static="true" final="true" visibility="public"
  14406. deprecated="not deprecated">
  14407. </field>
  14408. <field name="YARN_APPLICATION_CLASSPATH" type="java.lang.String"
  14409. transient="false" volatile="false"
  14410. static="true" final="true" visibility="public"
  14411. deprecated="not deprecated">
  14412. <doc>
  14413. <![CDATA[CLASSPATH for YARN applications. A comma-separated list of CLASSPATH
  14414. entries]]>
  14415. </doc>
  14416. </field>
  14417. <field name="AMRM_PROXY_ENABLED" type="java.lang.String"
  14418. transient="false" volatile="false"
  14419. static="true" final="true" visibility="public"
  14420. deprecated="not deprecated">
  14421. </field>
  14422. <field name="DEFAULT_AMRM_PROXY_ENABLED" type="boolean"
  14423. transient="false" volatile="false"
  14424. static="true" final="true" visibility="public"
  14425. deprecated="not deprecated">
  14426. </field>
  14427. <field name="AMRM_PROXY_ADDRESS" type="java.lang.String"
  14428. transient="false" volatile="false"
  14429. static="true" final="true" visibility="public"
  14430. deprecated="not deprecated">
  14431. </field>
  14432. <field name="DEFAULT_AMRM_PROXY_PORT" type="int"
  14433. transient="false" volatile="false"
  14434. static="true" final="true" visibility="public"
  14435. deprecated="not deprecated">
  14436. </field>
  14437. <field name="DEFAULT_AMRM_PROXY_ADDRESS" type="java.lang.String"
  14438. transient="false" volatile="false"
  14439. static="true" final="true" visibility="public"
  14440. deprecated="not deprecated">
  14441. </field>
  14442. <field name="AMRM_PROXY_CLIENT_THREAD_COUNT" type="java.lang.String"
  14443. transient="false" volatile="false"
  14444. static="true" final="true" visibility="public"
  14445. deprecated="not deprecated">
  14446. </field>
  14447. <field name="DEFAULT_AMRM_PROXY_CLIENT_THREAD_COUNT" type="int"
  14448. transient="false" volatile="false"
  14449. static="true" final="true" visibility="public"
  14450. deprecated="not deprecated">
  14451. </field>
  14452. <field name="AMRM_PROXY_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  14453. transient="false" volatile="false"
  14454. static="true" final="true" visibility="public"
  14455. deprecated="not deprecated">
  14456. </field>
  14457. <field name="DEFAULT_AMRM_PROXY_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  14458. transient="false" volatile="false"
  14459. static="true" final="true" visibility="public"
  14460. deprecated="not deprecated">
  14461. </field>
  14462. <field name="DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH" type="java.lang.String[]"
  14463. transient="false" volatile="false"
  14464. static="true" final="true" visibility="public"
  14465. deprecated="not deprecated">
  14466. <doc>
  14467. <![CDATA[Default platform-agnostic CLASSPATH for YARN applications. A
  14468. comma-separated list of CLASSPATH entries. The parameter expansion marker
  14469. will be replaced with real parameter expansion marker ('%' for Windows and
  14470. '$' for Linux) by NodeManager on container launch. For example: {{VAR}}
  14471. will be replaced as $VAR on Linux, and %VAR% on Windows.]]>
  14472. </doc>
  14473. </field>
  14474. <field name="DEFAULT_YARN_APPLICATION_CLASSPATH" type="java.lang.String[]"
  14475. transient="false" volatile="false"
  14476. static="true" final="true" visibility="public"
  14477. deprecated="not deprecated">
  14478. <doc>
  14479. <![CDATA[<p>
  14480. Default platform-specific CLASSPATH for YARN applications. A
  14481. comma-separated list of CLASSPATH entries constructed based on the client
  14482. OS environment expansion syntax.
  14483. </p>
  14484. <p>
  14485. Note: Use {@link #DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH} for
  14486. cross-platform practice i.e. submit an application from a Windows client to
  14487. a Linux/Unix server or vice versa.
  14488. </p>]]>
  14489. </doc>
  14490. </field>
  14491. <field name="DEFAULT_CONTAINER_TEMP_DIR" type="java.lang.String"
  14492. transient="false" volatile="false"
  14493. static="true" final="true" visibility="public"
  14494. deprecated="not deprecated">
  14495. <doc>
  14496. <![CDATA[Container temp directory]]>
  14497. </doc>
  14498. </field>
  14499. <field name="IS_MINI_YARN_CLUSTER" type="java.lang.String"
  14500. transient="false" volatile="false"
  14501. static="true" final="true" visibility="public"
  14502. deprecated="not deprecated">
  14503. </field>
  14504. <field name="YARN_MC_PREFIX" type="java.lang.String"
  14505. transient="false" volatile="false"
  14506. static="true" final="true" visibility="public"
  14507. deprecated="not deprecated">
  14508. </field>
  14509. <field name="YARN_MINICLUSTER_FIXED_PORTS" type="java.lang.String"
  14510. transient="false" volatile="false"
  14511. static="true" final="true" visibility="public"
  14512. deprecated="not deprecated">
  14513. <doc>
  14514. <![CDATA[Whether to use fixed ports with the minicluster.]]>
  14515. </doc>
  14516. </field>
  14517. <field name="DEFAULT_YARN_MINICLUSTER_FIXED_PORTS" type="boolean"
  14518. transient="false" volatile="false"
  14519. static="true" final="true" visibility="public"
  14520. deprecated="not deprecated">
  14521. <doc>
  14522. <![CDATA[Default is false to be able to run tests concurrently without port
  14523. conflicts.]]>
  14524. </doc>
  14525. </field>
  14526. <field name="YARN_MINICLUSTER_USE_RPC" type="java.lang.String"
  14527. transient="false" volatile="false"
  14528. static="true" final="true" visibility="public"
  14529. deprecated="not deprecated">
  14530. <doc>
  14531. <![CDATA[Whether the NM should use RPC to connect to the RM. Default is false.
  14532. Can be set to true only when using fixed ports.]]>
  14533. </doc>
  14534. </field>
  14535. <field name="DEFAULT_YARN_MINICLUSTER_USE_RPC" type="boolean"
  14536. transient="false" volatile="false"
  14537. static="true" final="true" visibility="public"
  14538. deprecated="not deprecated">
  14539. </field>
  14540. <field name="YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="java.lang.String"
  14541. transient="false" volatile="false"
  14542. static="true" final="true" visibility="public"
  14543. deprecated="not deprecated">
  14544. <doc>
  14545. <![CDATA[Whether users are explicitly trying to control resource monitoring
  14546. configuration for the MiniYARNCluster. Disabled by default.]]>
  14547. </doc>
  14548. </field>
  14549. <field name="DEFAULT_YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="boolean"
  14550. transient="false" volatile="false"
  14551. static="true" final="true" visibility="public"
  14552. deprecated="not deprecated">
  14553. </field>
  14554. <field name="YARN_MINICLUSTER_NM_PMEM_MB" type="java.lang.String"
  14555. transient="false" volatile="false"
  14556. static="true" final="true" visibility="public"
  14557. deprecated="not deprecated">
  14558. <doc>
  14559. <![CDATA[Allow changing the memory for the NodeManager in the MiniYARNCluster]]>
  14560. </doc>
  14561. </field>
  14562. <field name="DEFAULT_YARN_MINICLUSTER_NM_PMEM_MB" type="int"
  14563. transient="false" volatile="false"
  14564. static="true" final="true" visibility="public"
  14565. deprecated="not deprecated">
  14566. </field>
  14567. <field name="YARN_APP_CONTAINER_LOG_DIR" type="java.lang.String"
  14568. transient="false" volatile="false"
  14569. static="true" final="true" visibility="public"
  14570. deprecated="not deprecated">
  14571. <doc>
  14572. <![CDATA[The log directory for the containers]]>
  14573. </doc>
  14574. </field>
  14575. <field name="YARN_APP_CONTAINER_LOG_SIZE" type="java.lang.String"
  14576. transient="false" volatile="false"
  14577. static="true" final="true" visibility="public"
  14578. deprecated="not deprecated">
  14579. </field>
  14580. <field name="YARN_APP_CONTAINER_LOG_BACKUPS" type="java.lang.String"
  14581. transient="false" volatile="false"
  14582. static="true" final="true" visibility="public"
  14583. deprecated="not deprecated">
  14584. </field>
  14585. <field name="TIMELINE_SERVICE_PREFIX" type="java.lang.String"
  14586. transient="false" volatile="false"
  14587. static="true" final="true" visibility="public"
  14588. deprecated="not deprecated">
  14589. </field>
  14590. <field name="TIMELINE_SERVICE_VERSION" type="java.lang.String"
  14591. transient="false" volatile="false"
  14592. static="true" final="true" visibility="public"
  14593. deprecated="not deprecated">
  14594. </field>
  14595. <field name="DEFAULT_TIMELINE_SERVICE_VERSION" type="float"
  14596. transient="false" volatile="false"
  14597. static="true" final="true" visibility="public"
  14598. deprecated="not deprecated">
  14599. </field>
  14600. <field name="TIMELINE_SERVICE_UI_NAMES" type="java.lang.String"
  14601. transient="false" volatile="false"
  14602. static="true" final="true" visibility="public"
  14603. deprecated="not deprecated">
  14604. <doc>
  14605. <![CDATA[Comma seperated list of names for UIs hosted in the timeline server
  14606. (For pluggable UIs).]]>
  14607. </doc>
  14608. </field>
  14609. <field name="TIMELINE_SERVICE_UI_WEB_PATH_PREFIX" type="java.lang.String"
  14610. transient="false" volatile="false"
  14611. static="true" final="true" visibility="public"
  14612. deprecated="not deprecated">
  14613. <doc>
  14614. <![CDATA[Relative web path that will serve up this UI (For pluggable UIs).]]>
  14615. </doc>
  14616. </field>
  14617. <field name="TIMELINE_SERVICE_CLIENT_PREFIX" type="java.lang.String"
  14618. transient="false" volatile="false"
  14619. static="true" final="true" visibility="public"
  14620. deprecated="not deprecated">
  14621. <doc>
  14622. <![CDATA[Timeline client settings]]>
  14623. </doc>
  14624. </field>
  14625. <field name="TIMELINE_SERVICE_UI_ON_DISK_PATH_PREFIX" type="java.lang.String"
  14626. transient="false" volatile="false"
  14627. static="true" final="true" visibility="public"
  14628. deprecated="not deprecated">
  14629. <doc>
  14630. <![CDATA[Path to war file or static content directory for this UI
  14631. (For pluggable UIs).]]>
  14632. </doc>
  14633. </field>
  14634. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX" type="java.lang.String"
  14635. transient="false" volatile="false"
  14636. static="true" final="true" visibility="public"
  14637. deprecated="not deprecated">
  14638. <doc>
  14639. <![CDATA[The setting for timeline service v1.5]]>
  14640. </doc>
  14641. </field>
  14642. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_ACTIVE_DIR" type="java.lang.String"
  14643. transient="false" volatile="false"
  14644. static="true" final="true" visibility="public"
  14645. deprecated="not deprecated">
  14646. </field>
  14647. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_ACTIVE_DIR_DEFAULT" type="java.lang.String"
  14648. transient="false" volatile="false"
  14649. static="true" final="true" visibility="public"
  14650. deprecated="not deprecated">
  14651. </field>
  14652. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_DONE_DIR" type="java.lang.String"
  14653. transient="false" volatile="false"
  14654. static="true" final="true" visibility="public"
  14655. deprecated="not deprecated">
  14656. </field>
  14657. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_DONE_DIR_DEFAULT" type="java.lang.String"
  14658. transient="false" volatile="false"
  14659. static="true" final="true" visibility="public"
  14660. deprecated="not deprecated">
  14661. </field>
  14662. <field name="TIMELINE_SERVICE_ENTITY_GROUP_PLUGIN_CLASSES" type="java.lang.String"
  14663. transient="false" volatile="false"
  14664. static="true" final="true" visibility="public"
  14665. deprecated="not deprecated">
  14666. </field>
  14667. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SUMMARY_STORE" type="java.lang.String"
  14668. transient="false" volatile="false"
  14669. static="true" final="true" visibility="public"
  14670. deprecated="not deprecated">
  14671. </field>
  14672. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SUMMARY_ENTITY_TYPES" type="java.lang.String"
  14673. transient="false" volatile="false"
  14674. static="true" final="true" visibility="public"
  14675. deprecated="not deprecated">
  14676. </field>
  14677. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SCAN_INTERVAL_SECONDS" type="java.lang.String"
  14678. transient="false" volatile="false"
  14679. static="true" final="true" visibility="public"
  14680. deprecated="not deprecated">
  14681. </field>
  14682. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SCAN_INTERVAL_SECONDS_DEFAULT" type="long"
  14683. transient="false" volatile="false"
  14684. static="true" final="true" visibility="public"
  14685. deprecated="not deprecated">
  14686. </field>
  14687. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_THREADS" type="java.lang.String"
  14688. transient="false" volatile="false"
  14689. static="true" final="true" visibility="public"
  14690. deprecated="not deprecated">
  14691. </field>
  14692. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_THREADS_DEFAULT" type="int"
  14693. transient="false" volatile="false"
  14694. static="true" final="true" visibility="public"
  14695. deprecated="not deprecated">
  14696. </field>
  14697. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_APP_CACHE_SIZE" type="java.lang.String"
  14698. transient="false" volatile="false"
  14699. static="true" final="true" visibility="public"
  14700. deprecated="not deprecated">
  14701. </field>
  14702. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_APP_CACHE_SIZE_DEFAULT" type="int"
  14703. transient="false" volatile="false"
  14704. static="true" final="true" visibility="public"
  14705. deprecated="not deprecated">
  14706. </field>
  14707. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CLEANER_INTERVAL_SECONDS" type="java.lang.String"
  14708. transient="false" volatile="false"
  14709. static="true" final="true" visibility="public"
  14710. deprecated="not deprecated">
  14711. </field>
  14712. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CLEANER_INTERVAL_SECONDS_DEFAULT" type="int"
  14713. transient="false" volatile="false"
  14714. static="true" final="true" visibility="public"
  14715. deprecated="not deprecated">
  14716. </field>
  14717. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETAIN_SECONDS" type="java.lang.String"
  14718. transient="false" volatile="false"
  14719. static="true" final="true" visibility="public"
  14720. deprecated="not deprecated">
  14721. </field>
  14722. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETAIN_SECONDS_DEFAULT" type="int"
  14723. transient="false" volatile="false"
  14724. static="true" final="true" visibility="public"
  14725. deprecated="not deprecated">
  14726. </field>
  14727. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_UNKNOWN_ACTIVE_SECONDS" type="java.lang.String"
  14728. transient="false" volatile="false"
  14729. static="true" final="true" visibility="public"
  14730. deprecated="not deprecated">
  14731. </field>
  14732. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_UNKNOWN_ACTIVE_SECONDS_DEFAULT" type="int"
  14733. transient="false" volatile="false"
  14734. static="true" final="true" visibility="public"
  14735. deprecated="not deprecated">
  14736. </field>
  14737. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  14738. transient="false" volatile="false"
  14739. static="true" final="true" visibility="public"
  14740. deprecated="not deprecated">
  14741. </field>
  14742. <field name="DEFAULT_TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  14743. transient="false" volatile="false"
  14744. static="true" final="true" visibility="public"
  14745. deprecated="not deprecated">
  14746. </field>
  14747. <field name="TIMELINE_SERVICE_LEVELDB_CACHE_READ_CACHE_SIZE" type="java.lang.String"
  14748. transient="false" volatile="false"
  14749. static="true" final="true" visibility="public"
  14750. deprecated="not deprecated">
  14751. </field>
  14752. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_CACHE_READ_CACHE_SIZE" type="long"
  14753. transient="false" volatile="false"
  14754. static="true" final="true" visibility="public"
  14755. deprecated="not deprecated">
  14756. </field>
  14757. <field name="TIMELINE_SERVICE_CLIENT_FD_FLUSH_INTERVAL_SECS" type="java.lang.String"
  14758. transient="false" volatile="false"
  14759. static="true" final="true" visibility="public"
  14760. deprecated="not deprecated">
  14761. </field>
  14762. <field name="TIMELINE_SERVICE_CLIENT_FD_FLUSH_INTERVAL_SECS_DEFAULT" type="long"
  14763. transient="false" volatile="false"
  14764. static="true" final="true" visibility="public"
  14765. deprecated="not deprecated">
  14766. </field>
  14767. <field name="TIMELINE_SERVICE_CLIENT_FD_CLEAN_INTERVAL_SECS" type="java.lang.String"
  14768. transient="false" volatile="false"
  14769. static="true" final="true" visibility="public"
  14770. deprecated="not deprecated">
  14771. </field>
  14772. <field name="TIMELINE_SERVICE_CLIENT_FD_CLEAN_INTERVAL_SECS_DEFAULT" type="long"
  14773. transient="false" volatile="false"
  14774. static="true" final="true" visibility="public"
  14775. deprecated="not deprecated">
  14776. </field>
  14777. <field name="TIMELINE_SERVICE_CLIENT_FD_RETAIN_SECS" type="java.lang.String"
  14778. transient="false" volatile="false"
  14779. static="true" final="true" visibility="public"
  14780. deprecated="not deprecated">
  14781. </field>
  14782. <field name="TIMELINE_SERVICE_CLIENT_FD_RETAIN_SECS_DEFAULT" type="long"
  14783. transient="false" volatile="false"
  14784. static="true" final="true" visibility="public"
  14785. deprecated="not deprecated">
  14786. </field>
  14787. <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_TIMERS_TTL_SECS" type="java.lang.String"
  14788. transient="false" volatile="false"
  14789. static="true" final="true" visibility="public"
  14790. deprecated="not deprecated">
  14791. </field>
  14792. <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_TIMERS_TTL_SECS_DEFAULT" type="long"
  14793. transient="false" volatile="false"
  14794. static="true" final="true" visibility="public"
  14795. deprecated="not deprecated">
  14796. </field>
  14797. <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_ATTEMPT_DIR_CACHE_SIZE" type="java.lang.String"
  14798. transient="false" volatile="false"
  14799. static="true" final="true" visibility="public"
  14800. deprecated="not deprecated">
  14801. </field>
  14802. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_INTERNAL_ATTEMPT_DIR_CACHE_SIZE" type="int"
  14803. transient="false" volatile="false"
  14804. static="true" final="true" visibility="public"
  14805. deprecated="not deprecated">
  14806. </field>
  14807. <field name="TIMELINE_SERVICE_ENTITYFILE_FS_SUPPORT_APPEND" type="java.lang.String"
  14808. transient="false" volatile="false"
  14809. static="true" final="true" visibility="public"
  14810. deprecated="not deprecated">
  14811. </field>
  14812. <field name="APPLICATION_HISTORY_PREFIX" type="java.lang.String"
  14813. transient="false" volatile="false"
  14814. static="true" final="true" visibility="public"
  14815. deprecated="not deprecated">
  14816. </field>
  14817. <field name="APPLICATION_HISTORY_ENABLED" type="java.lang.String"
  14818. transient="false" volatile="false"
  14819. static="true" final="true" visibility="public"
  14820. deprecated="not deprecated">
  14821. <doc>
  14822. <![CDATA[The setting that controls whether application history service is
  14823. enabled or not.]]>
  14824. </doc>
  14825. </field>
  14826. <field name="DEFAULT_APPLICATION_HISTORY_ENABLED" type="boolean"
  14827. transient="false" volatile="false"
  14828. static="true" final="true" visibility="public"
  14829. deprecated="not deprecated">
  14830. </field>
  14831. <field name="APPLICATION_HISTORY_STORE" type="java.lang.String"
  14832. transient="false" volatile="false"
  14833. static="true" final="true" visibility="public"
  14834. deprecated="not deprecated">
  14835. <doc>
  14836. <![CDATA[Application history store class]]>
  14837. </doc>
  14838. </field>
  14839. <field name="APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="java.lang.String"
  14840. transient="false" volatile="false"
  14841. static="true" final="true" visibility="public"
  14842. deprecated="not deprecated">
  14843. <doc>
  14844. <![CDATA[Save container meta-info in the application history store.]]>
  14845. </doc>
  14846. </field>
  14847. <field name="DEFAULT_APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="boolean"
  14848. transient="false" volatile="false"
  14849. static="true" final="true" visibility="public"
  14850. deprecated="not deprecated">
  14851. </field>
  14852. <field name="FS_APPLICATION_HISTORY_STORE_URI" type="java.lang.String"
  14853. transient="false" volatile="false"
  14854. static="true" final="true" visibility="public"
  14855. deprecated="not deprecated">
  14856. <doc>
  14857. <![CDATA[URI for FileSystemApplicationHistoryStore]]>
  14858. </doc>
  14859. </field>
  14860. <field name="FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
  14861. transient="false" volatile="false"
  14862. static="true" final="true" visibility="public"
  14863. deprecated="not deprecated">
  14864. <doc>
  14865. <![CDATA[T-file compression types used to compress history data.]]>
  14866. </doc>
  14867. </field>
  14868. <field name="DEFAULT_FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
  14869. transient="false" volatile="false"
  14870. static="true" final="true" visibility="public"
  14871. deprecated="not deprecated">
  14872. </field>
  14873. <field name="TIMELINE_SERVICE_ENABLED" type="java.lang.String"
  14874. transient="false" volatile="false"
  14875. static="true" final="true" visibility="public"
  14876. deprecated="not deprecated">
  14877. <doc>
  14878. <![CDATA[The setting that controls whether timeline service is enabled or not.]]>
  14879. </doc>
  14880. </field>
  14881. <field name="DEFAULT_TIMELINE_SERVICE_ENABLED" type="boolean"
  14882. transient="false" volatile="false"
  14883. static="true" final="true" visibility="public"
  14884. deprecated="not deprecated">
  14885. </field>
  14886. <field name="TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
  14887. transient="false" volatile="false"
  14888. static="true" final="true" visibility="public"
  14889. deprecated="not deprecated">
  14890. <doc>
  14891. <![CDATA[host:port address for timeline service RPC APIs.]]>
  14892. </doc>
  14893. </field>
  14894. <field name="DEFAULT_TIMELINE_SERVICE_PORT" type="int"
  14895. transient="false" volatile="false"
  14896. static="true" final="true" visibility="public"
  14897. deprecated="not deprecated">
  14898. </field>
  14899. <field name="DEFAULT_TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
  14900. transient="false" volatile="false"
  14901. static="true" final="true" visibility="public"
  14902. deprecated="not deprecated">
  14903. </field>
  14904. <field name="TIMELINE_SERVICE_BIND_HOST" type="java.lang.String"
  14905. transient="false" volatile="false"
  14906. static="true" final="true" visibility="public"
  14907. deprecated="not deprecated">
  14908. <doc>
  14909. <![CDATA[The listening endpoint for the timeline service application.]]>
  14910. </doc>
  14911. </field>
  14912. <field name="TIMELINE_SERVICE_HANDLER_THREAD_COUNT" type="java.lang.String"
  14913. transient="false" volatile="false"
  14914. static="true" final="true" visibility="public"
  14915. deprecated="not deprecated">
  14916. <doc>
  14917. <![CDATA[The number of threads to handle client RPC API requests.]]>
  14918. </doc>
  14919. </field>
  14920. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_THREAD_COUNT" type="int"
  14921. transient="false" volatile="false"
  14922. static="true" final="true" visibility="public"
  14923. deprecated="not deprecated">
  14924. </field>
  14925. <field name="TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
  14926. transient="false" volatile="false"
  14927. static="true" final="true" visibility="public"
  14928. deprecated="not deprecated">
  14929. <doc>
  14930. <![CDATA[The address of the timeline service web application.]]>
  14931. </doc>
  14932. </field>
  14933. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_PORT" type="int"
  14934. transient="false" volatile="false"
  14935. static="true" final="true" visibility="public"
  14936. deprecated="not deprecated">
  14937. </field>
  14938. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
  14939. transient="false" volatile="false"
  14940. static="true" final="true" visibility="public"
  14941. deprecated="not deprecated">
  14942. </field>
  14943. <field name="TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  14944. transient="false" volatile="false"
  14945. static="true" final="true" visibility="public"
  14946. deprecated="not deprecated">
  14947. <doc>
  14948. <![CDATA[The https address of the timeline service web application.]]>
  14949. </doc>
  14950. </field>
  14951. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_PORT" type="int"
  14952. transient="false" volatile="false"
  14953. static="true" final="true" visibility="public"
  14954. deprecated="not deprecated">
  14955. </field>
  14956. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  14957. transient="false" volatile="false"
  14958. static="true" final="true" visibility="public"
  14959. deprecated="not deprecated">
  14960. </field>
  14961. <field name="APPLICATION_HISTORY_MAX_APPS" type="java.lang.String"
  14962. transient="false" volatile="false"
  14963. static="true" final="true" visibility="public"
  14964. deprecated="not deprecated">
  14965. <doc>
  14966. <![CDATA[Defines the max number of applications could be fetched using
  14967. REST API or application history protocol and shown in timeline
  14968. server web ui.]]>
  14969. </doc>
  14970. </field>
  14971. <field name="DEFAULT_APPLICATION_HISTORY_MAX_APPS" type="long"
  14972. transient="false" volatile="false"
  14973. static="true" final="true" visibility="public"
  14974. deprecated="not deprecated">
  14975. </field>
  14976. <field name="TIMELINE_SERVICE_STORE" type="java.lang.String"
  14977. transient="false" volatile="false"
  14978. static="true" final="true" visibility="public"
  14979. deprecated="not deprecated">
  14980. <doc>
  14981. <![CDATA[Timeline service store class.]]>
  14982. </doc>
  14983. </field>
  14984. <field name="TIMELINE_SERVICE_TTL_ENABLE" type="java.lang.String"
  14985. transient="false" volatile="false"
  14986. static="true" final="true" visibility="public"
  14987. deprecated="not deprecated">
  14988. <doc>
  14989. <![CDATA[Timeline service enable data age off]]>
  14990. </doc>
  14991. </field>
  14992. <field name="TIMELINE_SERVICE_TTL_MS" type="java.lang.String"
  14993. transient="false" volatile="false"
  14994. static="true" final="true" visibility="public"
  14995. deprecated="not deprecated">
  14996. <doc>
  14997. <![CDATA[Timeline service length of time to retain data]]>
  14998. </doc>
  14999. </field>
  15000. <field name="DEFAULT_TIMELINE_SERVICE_TTL_MS" type="long"
  15001. transient="false" volatile="false"
  15002. static="true" final="true" visibility="public"
  15003. deprecated="not deprecated">
  15004. </field>
  15005. <field name="TIMELINE_SERVICE_ROLLING_PERIOD" type="java.lang.String"
  15006. transient="false" volatile="false"
  15007. static="true" final="true" visibility="public"
  15008. deprecated="not deprecated">
  15009. <doc>
  15010. <![CDATA[Timeline service rolling period. Valid values are daily, half_daily,
  15011. quarter_daily, and hourly.]]>
  15012. </doc>
  15013. </field>
  15014. <field name="DEFAULT_TIMELINE_SERVICE_ROLLING_PERIOD" type="java.lang.String"
  15015. transient="false" volatile="false"
  15016. static="true" final="true" visibility="public"
  15017. deprecated="not deprecated">
  15018. <doc>
  15019. <![CDATA[Roll a new database each hour.]]>
  15020. </doc>
  15021. </field>
  15022. <field name="TIMELINE_SERVICE_LEVELDB_PREFIX" type="java.lang.String"
  15023. transient="false" volatile="false"
  15024. static="true" final="true" visibility="public"
  15025. deprecated="not deprecated">
  15026. <doc>
  15027. <![CDATA[Implementation specific configuration prefix for Timeline Service
  15028. leveldb.]]>
  15029. </doc>
  15030. </field>
  15031. <field name="TIMELINE_SERVICE_LEVELDB_PATH" type="java.lang.String"
  15032. transient="false" volatile="false"
  15033. static="true" final="true" visibility="public"
  15034. deprecated="not deprecated">
  15035. <doc>
  15036. <![CDATA[Timeline service leveldb path]]>
  15037. </doc>
  15038. </field>
  15039. <field name="TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="java.lang.String"
  15040. transient="false" volatile="false"
  15041. static="true" final="true" visibility="public"
  15042. deprecated="not deprecated">
  15043. <doc>
  15044. <![CDATA[Timeline service leveldb read cache (uncompressed blocks). This is
  15045. per rolling instance so should be tuned if using rolling leveldb
  15046. timeline store]]>
  15047. </doc>
  15048. </field>
  15049. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="long"
  15050. transient="false" volatile="false"
  15051. static="true" final="true" visibility="public"
  15052. deprecated="not deprecated">
  15053. <doc>
  15054. <![CDATA[Default leveldb read cache size if no configuration is specified.]]>
  15055. </doc>
  15056. </field>
  15057. <field name="TIMELINE_SERVICE_LEVELDB_WRITE_BUFFER_SIZE" type="java.lang.String"
  15058. transient="false" volatile="false"
  15059. static="true" final="true" visibility="public"
  15060. deprecated="not deprecated">
  15061. <doc>
  15062. <![CDATA[Timeline service leveldb write buffer size.]]>
  15063. </doc>
  15064. </field>
  15065. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_WRITE_BUFFER_SIZE" type="int"
  15066. transient="false" volatile="false"
  15067. static="true" final="true" visibility="public"
  15068. deprecated="not deprecated">
  15069. <doc>
  15070. <![CDATA[Default leveldb write buffer size if no configuration is specified. This
  15071. is per rolling instance so should be tuned if using rolling leveldb
  15072. timeline store.]]>
  15073. </doc>
  15074. </field>
  15075. <field name="TIMELINE_SERVICE_LEVELDB_WRITE_BATCH_SIZE" type="java.lang.String"
  15076. transient="false" volatile="false"
  15077. static="true" final="true" visibility="public"
  15078. deprecated="not deprecated">
  15079. <doc>
  15080. <![CDATA[Timeline service leveldb write batch size. This value can be tuned down
  15081. to reduce lock time for ttl eviction.]]>
  15082. </doc>
  15083. </field>
  15084. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_WRITE_BATCH_SIZE" type="int"
  15085. transient="false" volatile="false"
  15086. static="true" final="true" visibility="public"
  15087. deprecated="not deprecated">
  15088. <doc>
  15089. <![CDATA[Default leveldb write batch size is no configuration is specified]]>
  15090. </doc>
  15091. </field>
  15092. <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="java.lang.String"
  15093. transient="false" volatile="false"
  15094. static="true" final="true" visibility="public"
  15095. deprecated="not deprecated">
  15096. <doc>
  15097. <![CDATA[Timeline service leveldb start time read cache (number of entities)]]>
  15098. </doc>
  15099. </field>
  15100. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="int"
  15101. transient="false" volatile="false"
  15102. static="true" final="true" visibility="public"
  15103. deprecated="not deprecated">
  15104. </field>
  15105. <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="java.lang.String"
  15106. transient="false" volatile="false"
  15107. static="true" final="true" visibility="public"
  15108. deprecated="not deprecated">
  15109. <doc>
  15110. <![CDATA[Timeline service leveldb start time write cache (number of entities)]]>
  15111. </doc>
  15112. </field>
  15113. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="int"
  15114. transient="false" volatile="false"
  15115. static="true" final="true" visibility="public"
  15116. deprecated="not deprecated">
  15117. </field>
  15118. <field name="TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="java.lang.String"
  15119. transient="false" volatile="false"
  15120. static="true" final="true" visibility="public"
  15121. deprecated="not deprecated">
  15122. <doc>
  15123. <![CDATA[Timeline service leveldb interval to wait between deletion rounds]]>
  15124. </doc>
  15125. </field>
  15126. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="long"
  15127. transient="false" volatile="false"
  15128. static="true" final="true" visibility="public"
  15129. deprecated="not deprecated">
  15130. </field>
  15131. <field name="TIMELINE_SERVICE_LEVELDB_MAX_OPEN_FILES" type="java.lang.String"
  15132. transient="false" volatile="false"
  15133. static="true" final="true" visibility="public"
  15134. deprecated="not deprecated">
  15135. <doc>
  15136. <![CDATA[Timeline service leveldb number of concurrent open files. Tuned this
  15137. configuration to stay within system limits. This is per rolling instance
  15138. so should be tuned if using rolling leveldb timeline store.]]>
  15139. </doc>
  15140. </field>
  15141. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_MAX_OPEN_FILES" type="int"
  15142. transient="false" volatile="false"
  15143. static="true" final="true" visibility="public"
  15144. deprecated="not deprecated">
  15145. <doc>
  15146. <![CDATA[Default leveldb max open files if no configuration is specified.]]>
  15147. </doc>
  15148. </field>
  15149. <field name="TIMELINE_SERVICE_PRINCIPAL" type="java.lang.String"
  15150. transient="false" volatile="false"
  15151. static="true" final="true" visibility="public"
  15152. deprecated="not deprecated">
  15153. <doc>
  15154. <![CDATA[The Kerberos principal for the timeline server.]]>
  15155. </doc>
  15156. </field>
  15157. <field name="TIMELINE_SERVICE_KEYTAB" type="java.lang.String"
  15158. transient="false" volatile="false"
  15159. static="true" final="true" visibility="public"
  15160. deprecated="not deprecated">
  15161. <doc>
  15162. <![CDATA[The Kerberos keytab for the timeline server.]]>
  15163. </doc>
  15164. </field>
  15165. <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED" type="java.lang.String"
  15166. transient="false" volatile="false"
  15167. static="true" final="true" visibility="public"
  15168. deprecated="not deprecated">
  15169. <doc>
  15170. <![CDATA[Enables cross origin support for timeline server.]]>
  15171. </doc>
  15172. </field>
  15173. <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED_DEFAULT" type="boolean"
  15174. transient="false" volatile="false"
  15175. static="true" final="true" visibility="public"
  15176. deprecated="not deprecated">
  15177. <doc>
  15178. <![CDATA[Default value for cross origin support for timeline server.]]>
  15179. </doc>
  15180. </field>
  15181. <field name="TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="java.lang.String"
  15182. transient="false" volatile="false"
  15183. static="true" final="true" visibility="public"
  15184. deprecated="not deprecated">
  15185. <doc>
  15186. <![CDATA[Timeline client call, max retries (-1 means no limit)]]>
  15187. </doc>
  15188. </field>
  15189. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="int"
  15190. transient="false" volatile="false"
  15191. static="true" final="true" visibility="public"
  15192. deprecated="not deprecated">
  15193. </field>
  15194. <field name="TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="java.lang.String"
  15195. transient="false" volatile="false"
  15196. static="true" final="true" visibility="public"
  15197. deprecated="not deprecated">
  15198. <doc>
  15199. <![CDATA[Timeline client call, retry interval]]>
  15200. </doc>
  15201. </field>
  15202. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="long"
  15203. transient="false" volatile="false"
  15204. static="true" final="true" visibility="public"
  15205. deprecated="not deprecated">
  15206. </field>
  15207. <field name="TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="java.lang.String"
  15208. transient="false" volatile="false"
  15209. static="true" final="true" visibility="public"
  15210. deprecated="not deprecated">
  15211. <doc>
  15212. <![CDATA[Timeline client policy for whether connections are fatal]]>
  15213. </doc>
  15214. </field>
  15215. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="boolean"
  15216. transient="false" volatile="false"
  15217. static="true" final="true" visibility="public"
  15218. deprecated="not deprecated">
  15219. </field>
  15220. <field name="TIMELINE_SERVICE_RECOVERY_ENABLED" type="java.lang.String"
  15221. transient="false" volatile="false"
  15222. static="true" final="true" visibility="public"
  15223. deprecated="not deprecated">
  15224. <doc>
  15225. <![CDATA[Flag to enable recovery of timeline service]]>
  15226. </doc>
  15227. </field>
  15228. <field name="DEFAULT_TIMELINE_SERVICE_RECOVERY_ENABLED" type="boolean"
  15229. transient="false" volatile="false"
  15230. static="true" final="true" visibility="public"
  15231. deprecated="not deprecated">
  15232. </field>
  15233. <field name="TIMELINE_SERVICE_STATE_STORE_CLASS" type="java.lang.String"
  15234. transient="false" volatile="false"
  15235. static="true" final="true" visibility="public"
  15236. deprecated="not deprecated">
  15237. <doc>
  15238. <![CDATA[Timeline service state store class]]>
  15239. </doc>
  15240. </field>
  15241. <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PREFIX" type="java.lang.String"
  15242. transient="false" volatile="false"
  15243. static="true" final="true" visibility="public"
  15244. deprecated="not deprecated">
  15245. </field>
  15246. <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PATH" type="java.lang.String"
  15247. transient="false" volatile="false"
  15248. static="true" final="true" visibility="public"
  15249. deprecated="not deprecated">
  15250. <doc>
  15251. <![CDATA[Timeline service state store leveldb path]]>
  15252. </doc>
  15253. </field>
  15254. <field name="TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="java.lang.String"
  15255. transient="false" volatile="false"
  15256. static="true" final="true" visibility="public"
  15257. deprecated="not deprecated">
  15258. </field>
  15259. <field name="DEFAULT_TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="long"
  15260. transient="false" volatile="false"
  15261. static="true" final="true" visibility="public"
  15262. deprecated="not deprecated">
  15263. </field>
  15264. <field name="TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="java.lang.String"
  15265. transient="false" volatile="false"
  15266. static="true" final="true" visibility="public"
  15267. deprecated="not deprecated">
  15268. </field>
  15269. <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="long"
  15270. transient="false" volatile="false"
  15271. static="true" final="true" visibility="public"
  15272. deprecated="not deprecated">
  15273. </field>
  15274. <field name="TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="java.lang.String"
  15275. transient="false" volatile="false"
  15276. static="true" final="true" visibility="public"
  15277. deprecated="not deprecated">
  15278. </field>
  15279. <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="long"
  15280. transient="false" volatile="false"
  15281. static="true" final="true" visibility="public"
  15282. deprecated="not deprecated">
  15283. </field>
  15284. <field name="SHARED_CACHE_PREFIX" type="java.lang.String"
  15285. transient="false" volatile="false"
  15286. static="true" final="true" visibility="public"
  15287. deprecated="not deprecated">
  15288. </field>
  15289. <field name="SHARED_CACHE_ENABLED" type="java.lang.String"
  15290. transient="false" volatile="false"
  15291. static="true" final="true" visibility="public"
  15292. deprecated="not deprecated">
  15293. <doc>
  15294. <![CDATA[whether the shared cache is enabled/disabled]]>
  15295. </doc>
  15296. </field>
  15297. <field name="DEFAULT_SHARED_CACHE_ENABLED" type="boolean"
  15298. transient="false" volatile="false"
  15299. static="true" final="true" visibility="public"
  15300. deprecated="not deprecated">
  15301. </field>
  15302. <field name="SHARED_CACHE_ROOT" type="java.lang.String"
  15303. transient="false" volatile="false"
  15304. static="true" final="true" visibility="public"
  15305. deprecated="not deprecated">
  15306. <doc>
  15307. <![CDATA[The config key for the shared cache root directory.]]>
  15308. </doc>
  15309. </field>
  15310. <field name="DEFAULT_SHARED_CACHE_ROOT" type="java.lang.String"
  15311. transient="false" volatile="false"
  15312. static="true" final="true" visibility="public"
  15313. deprecated="not deprecated">
  15314. </field>
  15315. <field name="SHARED_CACHE_NESTED_LEVEL" type="java.lang.String"
  15316. transient="false" volatile="false"
  15317. static="true" final="true" visibility="public"
  15318. deprecated="not deprecated">
  15319. <doc>
  15320. <![CDATA[The config key for the level of nested directories before getting to the
  15321. checksum directory.]]>
  15322. </doc>
  15323. </field>
  15324. <field name="DEFAULT_SHARED_CACHE_NESTED_LEVEL" type="int"
  15325. transient="false" volatile="false"
  15326. static="true" final="true" visibility="public"
  15327. deprecated="not deprecated">
  15328. </field>
  15329. <field name="SCM_STORE_PREFIX" type="java.lang.String"
  15330. transient="false" volatile="false"
  15331. static="true" final="true" visibility="public"
  15332. deprecated="not deprecated">
  15333. </field>
  15334. <field name="SCM_STORE_CLASS" type="java.lang.String"
  15335. transient="false" volatile="false"
  15336. static="true" final="true" visibility="public"
  15337. deprecated="not deprecated">
  15338. </field>
  15339. <field name="DEFAULT_SCM_STORE_CLASS" type="java.lang.String"
  15340. transient="false" volatile="false"
  15341. static="true" final="true" visibility="public"
  15342. deprecated="not deprecated">
  15343. </field>
  15344. <field name="SCM_APP_CHECKER_CLASS" type="java.lang.String"
  15345. transient="false" volatile="false"
  15346. static="true" final="true" visibility="public"
  15347. deprecated="not deprecated">
  15348. </field>
  15349. <field name="DEFAULT_SCM_APP_CHECKER_CLASS" type="java.lang.String"
  15350. transient="false" volatile="false"
  15351. static="true" final="true" visibility="public"
  15352. deprecated="not deprecated">
  15353. </field>
  15354. <field name="SCM_ADMIN_ADDRESS" type="java.lang.String"
  15355. transient="false" volatile="false"
  15356. static="true" final="true" visibility="public"
  15357. deprecated="not deprecated">
  15358. <doc>
  15359. <![CDATA[The address of the SCM admin interface.]]>
  15360. </doc>
  15361. </field>
  15362. <field name="DEFAULT_SCM_ADMIN_PORT" type="int"
  15363. transient="false" volatile="false"
  15364. static="true" final="true" visibility="public"
  15365. deprecated="not deprecated">
  15366. </field>
  15367. <field name="DEFAULT_SCM_ADMIN_ADDRESS" type="java.lang.String"
  15368. transient="false" volatile="false"
  15369. static="true" final="true" visibility="public"
  15370. deprecated="not deprecated">
  15371. </field>
  15372. <field name="SCM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
  15373. transient="false" volatile="false"
  15374. static="true" final="true" visibility="public"
  15375. deprecated="not deprecated">
  15376. <doc>
  15377. <![CDATA[Number of threads used to handle SCM admin interface.]]>
  15378. </doc>
  15379. </field>
  15380. <field name="DEFAULT_SCM_ADMIN_CLIENT_THREAD_COUNT" type="int"
  15381. transient="false" volatile="false"
  15382. static="true" final="true" visibility="public"
  15383. deprecated="not deprecated">
  15384. </field>
  15385. <field name="SCM_WEBAPP_ADDRESS" type="java.lang.String"
  15386. transient="false" volatile="false"
  15387. static="true" final="true" visibility="public"
  15388. deprecated="not deprecated">
  15389. <doc>
  15390. <![CDATA[The address of the SCM web application.]]>
  15391. </doc>
  15392. </field>
  15393. <field name="DEFAULT_SCM_WEBAPP_PORT" type="int"
  15394. transient="false" volatile="false"
  15395. static="true" final="true" visibility="public"
  15396. deprecated="not deprecated">
  15397. </field>
  15398. <field name="DEFAULT_SCM_WEBAPP_ADDRESS" type="java.lang.String"
  15399. transient="false" volatile="false"
  15400. static="true" final="true" visibility="public"
  15401. deprecated="not deprecated">
  15402. </field>
  15403. <field name="IN_MEMORY_STORE_PREFIX" type="java.lang.String"
  15404. transient="false" volatile="false"
  15405. static="true" final="true" visibility="public"
  15406. deprecated="not deprecated">
  15407. </field>
  15408. <field name="IN_MEMORY_STALENESS_PERIOD_MINS" type="java.lang.String"
  15409. transient="false" volatile="false"
  15410. static="true" final="true" visibility="public"
  15411. deprecated="not deprecated">
  15412. <doc>
  15413. <![CDATA[A resource in the InMemorySCMStore is considered stale if the time since
  15414. the last reference exceeds the staleness period. This value is specified in
  15415. minutes.]]>
  15416. </doc>
  15417. </field>
  15418. <field name="DEFAULT_IN_MEMORY_STALENESS_PERIOD_MINS" type="int"
  15419. transient="false" volatile="false"
  15420. static="true" final="true" visibility="public"
  15421. deprecated="not deprecated">
  15422. </field>
  15423. <field name="IN_MEMORY_INITIAL_DELAY_MINS" type="java.lang.String"
  15424. transient="false" volatile="false"
  15425. static="true" final="true" visibility="public"
  15426. deprecated="not deprecated">
  15427. <doc>
  15428. <![CDATA[Initial delay before the in-memory store runs its first check to remove
  15429. dead initial applications. Specified in minutes.]]>
  15430. </doc>
  15431. </field>
  15432. <field name="DEFAULT_IN_MEMORY_INITIAL_DELAY_MINS" type="int"
  15433. transient="false" volatile="false"
  15434. static="true" final="true" visibility="public"
  15435. deprecated="not deprecated">
  15436. </field>
  15437. <field name="IN_MEMORY_CHECK_PERIOD_MINS" type="java.lang.String"
  15438. transient="false" volatile="false"
  15439. static="true" final="true" visibility="public"
  15440. deprecated="not deprecated">
  15441. <doc>
  15442. <![CDATA[The frequency at which the in-memory store checks to remove dead initial
  15443. applications. Specified in minutes.]]>
  15444. </doc>
  15445. </field>
  15446. <field name="DEFAULT_IN_MEMORY_CHECK_PERIOD_MINS" type="int"
  15447. transient="false" volatile="false"
  15448. static="true" final="true" visibility="public"
  15449. deprecated="not deprecated">
  15450. </field>
  15451. <field name="SCM_CLEANER_PERIOD_MINS" type="java.lang.String"
  15452. transient="false" volatile="false"
  15453. static="true" final="true" visibility="public"
  15454. deprecated="not deprecated">
  15455. <doc>
  15456. <![CDATA[The frequency at which a cleaner task runs. Specified in minutes.]]>
  15457. </doc>
  15458. </field>
  15459. <field name="DEFAULT_SCM_CLEANER_PERIOD_MINS" type="int"
  15460. transient="false" volatile="false"
  15461. static="true" final="true" visibility="public"
  15462. deprecated="not deprecated">
  15463. </field>
  15464. <field name="SCM_CLEANER_INITIAL_DELAY_MINS" type="java.lang.String"
  15465. transient="false" volatile="false"
  15466. static="true" final="true" visibility="public"
  15467. deprecated="not deprecated">
  15468. <doc>
  15469. <![CDATA[Initial delay before the first cleaner task is scheduled. Specified in
  15470. minutes.]]>
  15471. </doc>
  15472. </field>
  15473. <field name="DEFAULT_SCM_CLEANER_INITIAL_DELAY_MINS" type="int"
  15474. transient="false" volatile="false"
  15475. static="true" final="true" visibility="public"
  15476. deprecated="not deprecated">
  15477. </field>
  15478. <field name="SCM_CLEANER_RESOURCE_SLEEP_MS" type="java.lang.String"
  15479. transient="false" volatile="false"
  15480. static="true" final="true" visibility="public"
  15481. deprecated="not deprecated">
  15482. <doc>
  15483. <![CDATA[The time to sleep between processing each shared cache resource. Specified
  15484. in milliseconds.]]>
  15485. </doc>
  15486. </field>
  15487. <field name="DEFAULT_SCM_CLEANER_RESOURCE_SLEEP_MS" type="long"
  15488. transient="false" volatile="false"
  15489. static="true" final="true" visibility="public"
  15490. deprecated="not deprecated">
  15491. </field>
  15492. <field name="SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
  15493. transient="false" volatile="false"
  15494. static="true" final="true" visibility="public"
  15495. deprecated="not deprecated">
  15496. <doc>
  15497. <![CDATA[The address of the node manager interface in the SCM.]]>
  15498. </doc>
  15499. </field>
  15500. <field name="DEFAULT_SCM_UPLOADER_SERVER_PORT" type="int"
  15501. transient="false" volatile="false"
  15502. static="true" final="true" visibility="public"
  15503. deprecated="not deprecated">
  15504. </field>
  15505. <field name="DEFAULT_SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
  15506. transient="false" volatile="false"
  15507. static="true" final="true" visibility="public"
  15508. deprecated="not deprecated">
  15509. </field>
  15510. <field name="SCM_UPLOADER_SERVER_THREAD_COUNT" type="java.lang.String"
  15511. transient="false" volatile="false"
  15512. static="true" final="true" visibility="public"
  15513. deprecated="not deprecated">
  15514. <doc>
  15515. <![CDATA[The number of SCM threads used to handle notify requests from the node
  15516. manager.]]>
  15517. </doc>
  15518. </field>
  15519. <field name="DEFAULT_SCM_UPLOADER_SERVER_THREAD_COUNT" type="int"
  15520. transient="false" volatile="false"
  15521. static="true" final="true" visibility="public"
  15522. deprecated="not deprecated">
  15523. </field>
  15524. <field name="SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
  15525. transient="false" volatile="false"
  15526. static="true" final="true" visibility="public"
  15527. deprecated="not deprecated">
  15528. <doc>
  15529. <![CDATA[The address of the client interface in the SCM.]]>
  15530. </doc>
  15531. </field>
  15532. <field name="DEFAULT_SCM_CLIENT_SERVER_PORT" type="int"
  15533. transient="false" volatile="false"
  15534. static="true" final="true" visibility="public"
  15535. deprecated="not deprecated">
  15536. </field>
  15537. <field name="DEFAULT_SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
  15538. transient="false" volatile="false"
  15539. static="true" final="true" visibility="public"
  15540. deprecated="not deprecated">
  15541. </field>
  15542. <field name="SCM_CLIENT_SERVER_THREAD_COUNT" type="java.lang.String"
  15543. transient="false" volatile="false"
  15544. static="true" final="true" visibility="public"
  15545. deprecated="not deprecated">
  15546. <doc>
  15547. <![CDATA[The number of threads used to handle shared cache manager requests.]]>
  15548. </doc>
  15549. </field>
  15550. <field name="DEFAULT_SCM_CLIENT_SERVER_THREAD_COUNT" type="int"
  15551. transient="false" volatile="false"
  15552. static="true" final="true" visibility="public"
  15553. deprecated="not deprecated">
  15554. </field>
  15555. <field name="SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
  15556. transient="false" volatile="false"
  15557. static="true" final="true" visibility="public"
  15558. deprecated="not deprecated">
  15559. <doc>
  15560. <![CDATA[the checksum algorithm implementation]]>
  15561. </doc>
  15562. </field>
  15563. <field name="DEFAULT_SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
  15564. transient="false" volatile="false"
  15565. static="true" final="true" visibility="public"
  15566. deprecated="not deprecated">
  15567. </field>
  15568. <field name="SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="java.lang.String"
  15569. transient="false" volatile="false"
  15570. static="true" final="true" visibility="public"
  15571. deprecated="not deprecated">
  15572. <doc>
  15573. <![CDATA[The replication factor for the node manager uploader for the shared cache.]]>
  15574. </doc>
  15575. </field>
  15576. <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="int"
  15577. transient="false" volatile="false"
  15578. static="true" final="true" visibility="public"
  15579. deprecated="not deprecated">
  15580. </field>
  15581. <field name="SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="java.lang.String"
  15582. transient="false" volatile="false"
  15583. static="true" final="true" visibility="public"
  15584. deprecated="not deprecated">
  15585. </field>
  15586. <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="int"
  15587. transient="false" volatile="false"
  15588. static="true" final="true" visibility="public"
  15589. deprecated="not deprecated">
  15590. </field>
  15591. <field name="YARN_CLIENT_APP_SUBMISSION_POLL_INTERVAL_MS" type="java.lang.String"
  15592. transient="false" volatile="false"
  15593. static="true" final="true" visibility="public"
  15594. deprecated="not deprecated">
  15595. <doc>
  15596. <![CDATA[Use YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS instead.
  15597. The interval of the yarn client's querying application state after
  15598. application submission. The unit is millisecond.]]>
  15599. </doc>
  15600. </field>
  15601. <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="java.lang.String"
  15602. transient="false" volatile="false"
  15603. static="true" final="true" visibility="public"
  15604. deprecated="not deprecated">
  15605. <doc>
  15606. <![CDATA[The interval that the yarn client library uses to poll the completion
  15607. status of the asynchronous API of application client protocol.]]>
  15608. </doc>
  15609. </field>
  15610. <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="long"
  15611. transient="false" volatile="false"
  15612. static="true" final="true" visibility="public"
  15613. deprecated="not deprecated">
  15614. </field>
  15615. <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="java.lang.String"
  15616. transient="false" volatile="false"
  15617. static="true" final="true" visibility="public"
  15618. deprecated="not deprecated">
  15619. <doc>
  15620. <![CDATA[The duration that the yarn client library waits, cumulatively across polls,
  15621. for an expected state change to occur. Defaults to -1, which indicates no
  15622. limit.]]>
  15623. </doc>
  15624. </field>
  15625. <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="long"
  15626. transient="false" volatile="false"
  15627. static="true" final="true" visibility="public"
  15628. deprecated="not deprecated">
  15629. </field>
  15630. <field name="NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="java.lang.String"
  15631. transient="false" volatile="false"
  15632. static="true" final="true" visibility="public"
  15633. deprecated="not deprecated">
  15634. <doc>
  15635. <![CDATA[Max number of threads in NMClientAsync to process container management
  15636. events]]>
  15637. </doc>
  15638. </field>
  15639. <field name="DEFAULT_NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="int"
  15640. transient="false" volatile="false"
  15641. static="true" final="true" visibility="public"
  15642. deprecated="not deprecated">
  15643. </field>
  15644. <field name="NM_CLIENT_MAX_NM_PROXIES" type="java.lang.String"
  15645. transient="false" volatile="false"
  15646. static="true" final="true" visibility="public"
  15647. deprecated="not deprecated">
  15648. <doc>
  15649. <![CDATA[Maximum number of proxy connections to cache for node managers. If set
  15650. to a value greater than zero then the cache is enabled and the NMClient
  15651. and MRAppMaster will cache the specified number of node manager proxies.
  15652. There will be at max one proxy per node manager. Ex. configuring it to a
  15653. value of 5 will make sure that client will at max have 5 proxies cached
  15654. with 5 different node managers. These connections for these proxies will
  15655. be timed out if idle for more than the system wide idle timeout period.
  15656. Note that this could cause issues on large clusters as many connections
  15657. could linger simultaneously and lead to a large number of connection
  15658. threads. The token used for authentication will be used only at
  15659. connection creation time. If a new token is received then the earlier
  15660. connection should be closed in order to use the new token. This and
  15661. {@link YarnConfiguration#NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE} are related
  15662. and should be in sync (no need for them to be equal).
  15663. If the value of this property is zero then the connection cache is
  15664. disabled and connections will use a zero idle timeout to prevent too
  15665. many connection threads on large clusters.]]>
  15666. </doc>
  15667. </field>
  15668. <field name="DEFAULT_NM_CLIENT_MAX_NM_PROXIES" type="int"
  15669. transient="false" volatile="false"
  15670. static="true" final="true" visibility="public"
  15671. deprecated="not deprecated">
  15672. </field>
  15673. <field name="CLIENT_NM_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  15674. transient="false" volatile="false"
  15675. static="true" final="true" visibility="public"
  15676. deprecated="not deprecated">
  15677. <doc>
  15678. <![CDATA[Max time to wait to establish a connection to NM]]>
  15679. </doc>
  15680. </field>
  15681. <field name="DEFAULT_CLIENT_NM_CONNECT_MAX_WAIT_MS" type="long"
  15682. transient="false" volatile="false"
  15683. static="true" final="true" visibility="public"
  15684. deprecated="not deprecated">
  15685. </field>
  15686. <field name="CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  15687. transient="false" volatile="false"
  15688. static="true" final="true" visibility="public"
  15689. deprecated="not deprecated">
  15690. <doc>
  15691. <![CDATA[Time interval between each attempt to connect to NM]]>
  15692. </doc>
  15693. </field>
  15694. <field name="DEFAULT_CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="long"
  15695. transient="false" volatile="false"
  15696. static="true" final="true" visibility="public"
  15697. deprecated="not deprecated">
  15698. </field>
  15699. <field name="YARN_HTTP_POLICY_KEY" type="java.lang.String"
  15700. transient="false" volatile="false"
  15701. static="true" final="true" visibility="public"
  15702. deprecated="not deprecated">
  15703. </field>
  15704. <field name="YARN_HTTP_POLICY_DEFAULT" type="java.lang.String"
  15705. transient="false" volatile="false"
  15706. static="true" final="true" visibility="public"
  15707. deprecated="not deprecated">
  15708. </field>
  15709. <field name="NM_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  15710. transient="false" volatile="false"
  15711. static="true" final="true" visibility="public"
  15712. deprecated="not deprecated">
  15713. <doc>
  15714. <![CDATA[Max time to wait for NM to connection to RM.
  15715. When not set, proxy will fall back to use value of
  15716. RESOURCEMANAGER_CONNECT_MAX_WAIT_MS.]]>
  15717. </doc>
  15718. </field>
  15719. <field name="NM_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  15720. transient="false" volatile="false"
  15721. static="true" final="true" visibility="public"
  15722. deprecated="not deprecated">
  15723. <doc>
  15724. <![CDATA[Time interval between each NM attempt to connection to RM.
  15725. When not set, proxy will fall back to use value of
  15726. RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS.]]>
  15727. </doc>
  15728. </field>
  15729. <field name="NODE_LABELS_PREFIX" type="java.lang.String"
  15730. transient="false" volatile="false"
  15731. static="true" final="true" visibility="public"
  15732. deprecated="not deprecated">
  15733. <doc>
  15734. <![CDATA[Node-labels configurations]]>
  15735. </doc>
  15736. </field>
  15737. <field name="FS_NODE_LABELS_STORE_IMPL_CLASS" type="java.lang.String"
  15738. transient="false" volatile="false"
  15739. static="true" final="true" visibility="public"
  15740. deprecated="not deprecated">
  15741. <doc>
  15742. <![CDATA[Node label store implementation class]]>
  15743. </doc>
  15744. </field>
  15745. <field name="DEFAULT_FS_NODE_LABELS_STORE_IMPL_CLASS" type="java.lang.String"
  15746. transient="false" volatile="false"
  15747. static="true" final="true" visibility="public"
  15748. deprecated="not deprecated">
  15749. </field>
  15750. <field name="FS_NODE_LABELS_STORE_ROOT_DIR" type="java.lang.String"
  15751. transient="false" volatile="false"
  15752. static="true" final="true" visibility="public"
  15753. deprecated="not deprecated">
  15754. <doc>
  15755. <![CDATA[URI for NodeLabelManager]]>
  15756. </doc>
  15757. </field>
  15758. <field name="FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  15759. transient="false" volatile="false"
  15760. static="true" final="true" visibility="public"
  15761. deprecated="not deprecated">
  15762. </field>
  15763. <field name="DEFAULT_FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  15764. transient="false" volatile="false"
  15765. static="true" final="true" visibility="public"
  15766. deprecated="not deprecated">
  15767. </field>
  15768. <field name="NODE_LABELS_ENABLED" type="java.lang.String"
  15769. transient="false" volatile="false"
  15770. static="true" final="true" visibility="public"
  15771. deprecated="not deprecated">
  15772. <doc>
  15773. <![CDATA[Flag to indicate if the node labels feature enabled, by default it's
  15774. disabled]]>
  15775. </doc>
  15776. </field>
  15777. <field name="DEFAULT_NODE_LABELS_ENABLED" type="boolean"
  15778. transient="false" volatile="false"
  15779. static="true" final="true" visibility="public"
  15780. deprecated="not deprecated">
  15781. </field>
  15782. <field name="NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  15783. transient="false" volatile="false"
  15784. static="true" final="true" visibility="public"
  15785. deprecated="not deprecated">
  15786. </field>
  15787. <field name="CENTRALIZED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  15788. transient="false" volatile="false"
  15789. static="true" final="true" visibility="public"
  15790. deprecated="not deprecated">
  15791. </field>
  15792. <field name="DELEGATED_CENTALIZED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  15793. transient="false" volatile="false"
  15794. static="true" final="true" visibility="public"
  15795. deprecated="not deprecated">
  15796. </field>
  15797. <field name="DISTRIBUTED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  15798. transient="false" volatile="false"
  15799. static="true" final="true" visibility="public"
  15800. deprecated="not deprecated">
  15801. </field>
  15802. <field name="DEFAULT_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  15803. transient="false" volatile="false"
  15804. static="true" final="true" visibility="public"
  15805. deprecated="not deprecated">
  15806. </field>
  15807. <field name="MAX_CLUSTER_LEVEL_APPLICATION_PRIORITY" type="java.lang.String"
  15808. transient="false" volatile="false"
  15809. static="true" final="true" visibility="public"
  15810. deprecated="not deprecated">
  15811. </field>
  15812. <field name="DEFAULT_CLUSTER_LEVEL_APPLICATION_PRIORITY" type="int"
  15813. transient="false" volatile="false"
  15814. static="true" final="true" visibility="public"
  15815. deprecated="not deprecated">
  15816. </field>
  15817. <field name="NM_NODE_LABELS_PROVIDER_CONFIG" type="java.lang.String"
  15818. transient="false" volatile="false"
  15819. static="true" final="true" visibility="public"
  15820. deprecated="not deprecated">
  15821. </field>
  15822. <field name="CONFIG_NODE_LABELS_PROVIDER" type="java.lang.String"
  15823. transient="false" volatile="false"
  15824. static="true" final="true" visibility="public"
  15825. deprecated="not deprecated">
  15826. </field>
  15827. <field name="SCRIPT_NODE_LABELS_PROVIDER" type="java.lang.String"
  15828. transient="false" volatile="false"
  15829. static="true" final="true" visibility="public"
  15830. deprecated="not deprecated">
  15831. </field>
  15832. <field name="NM_NODE_LABELS_RESYNC_INTERVAL" type="java.lang.String"
  15833. transient="false" volatile="false"
  15834. static="true" final="true" visibility="public"
  15835. deprecated="not deprecated">
  15836. </field>
  15837. <field name="DEFAULT_NM_NODE_LABELS_RESYNC_INTERVAL" type="long"
  15838. transient="false" volatile="false"
  15839. static="true" final="true" visibility="public"
  15840. deprecated="not deprecated">
  15841. </field>
  15842. <field name="NM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="java.lang.String"
  15843. transient="false" volatile="false"
  15844. static="true" final="true" visibility="public"
  15845. deprecated="not deprecated">
  15846. </field>
  15847. <field name="NM_NODE_LABELS_PROVIDER_FETCH_TIMEOUT_MS" type="java.lang.String"
  15848. transient="false" volatile="false"
  15849. static="true" final="true" visibility="public"
  15850. deprecated="not deprecated">
  15851. </field>
  15852. <field name="DEFAULT_NM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="long"
  15853. transient="false" volatile="false"
  15854. static="true" final="true" visibility="public"
  15855. deprecated="not deprecated">
  15856. </field>
  15857. <field name="DEFAULT_NM_NODE_LABELS_PROVIDER_FETCH_TIMEOUT_MS" type="long"
  15858. transient="false" volatile="false"
  15859. static="true" final="true" visibility="public"
  15860. deprecated="not deprecated">
  15861. </field>
  15862. <field name="NM_PROVIDER_CONFIGURED_NODE_PARTITION" type="java.lang.String"
  15863. transient="false" volatile="false"
  15864. static="true" final="true" visibility="public"
  15865. deprecated="not deprecated">
  15866. </field>
  15867. <field name="RM_NODE_LABELS_PROVIDER_CONFIG" type="java.lang.String"
  15868. transient="false" volatile="false"
  15869. static="true" final="true" visibility="public"
  15870. deprecated="not deprecated">
  15871. </field>
  15872. <field name="RM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="java.lang.String"
  15873. transient="false" volatile="false"
  15874. static="true" final="true" visibility="public"
  15875. deprecated="not deprecated">
  15876. </field>
  15877. <field name="DEFAULT_RM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="long"
  15878. transient="false" volatile="false"
  15879. static="true" final="true" visibility="public"
  15880. deprecated="not deprecated">
  15881. </field>
  15882. <field name="AM_SCHEDULING_NODE_BLACKLISTING_ENABLED" type="java.lang.String"
  15883. transient="false" volatile="false"
  15884. static="true" final="true" visibility="public"
  15885. deprecated="not deprecated">
  15886. </field>
  15887. <field name="DEFAULT_AM_SCHEDULING_NODE_BLACKLISTING_ENABLED" type="boolean"
  15888. transient="false" volatile="false"
  15889. static="true" final="true" visibility="public"
  15890. deprecated="not deprecated">
  15891. </field>
  15892. <field name="AM_SCHEDULING_NODE_BLACKLISTING_DISABLE_THRESHOLD" type="java.lang.String"
  15893. transient="false" volatile="false"
  15894. static="true" final="true" visibility="public"
  15895. deprecated="not deprecated">
  15896. </field>
  15897. <field name="DEFAULT_AM_SCHEDULING_NODE_BLACKLISTING_DISABLE_THRESHOLD" type="float"
  15898. transient="false" volatile="false"
  15899. static="true" final="true" visibility="public"
  15900. deprecated="not deprecated">
  15901. </field>
  15902. <field name="NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_PATH" type="java.lang.String"
  15903. transient="false" volatile="false"
  15904. static="true" final="true" visibility="public"
  15905. deprecated="not deprecated">
  15906. </field>
  15907. <field name="NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_SCRIPT_OPTS" type="java.lang.String"
  15908. transient="false" volatile="false"
  15909. static="true" final="true" visibility="public"
  15910. deprecated="not deprecated">
  15911. </field>
  15912. </class>
  15913. <!-- end class org.apache.hadoop.yarn.conf.YarnConfiguration -->
  15914. </package>
  15915. <package name="org.apache.hadoop.yarn.exceptions">
  15916. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
  15917. <class name="ApplicationAttemptNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  15918. abstract="false"
  15919. static="false" final="false" visibility="public"
  15920. deprecated="not deprecated">
  15921. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.Throwable"
  15922. static="false" final="false" visibility="public"
  15923. deprecated="not deprecated">
  15924. </constructor>
  15925. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String"
  15926. static="false" final="false" visibility="public"
  15927. deprecated="not deprecated">
  15928. </constructor>
  15929. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String, java.lang.Throwable"
  15930. static="false" final="false" visibility="public"
  15931. deprecated="not deprecated">
  15932. </constructor>
  15933. <doc>
  15934. <![CDATA[This exception is thrown on
  15935. {@link ApplicationHistoryProtocol#getApplicationAttemptReport (GetApplicationAttemptReportRequest)}
  15936. API when the Application Attempt doesn't exist in Application History Server or
  15937. {@link ApplicationMasterProtocol#allocate(AllocateRequest)} if application
  15938. doesn't exist in RM.]]>
  15939. </doc>
  15940. </class>
  15941. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
  15942. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
  15943. <class name="ApplicationIdNotProvidedException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  15944. abstract="false"
  15945. static="false" final="false" visibility="public"
  15946. deprecated="not deprecated">
  15947. <constructor name="ApplicationIdNotProvidedException" type="java.lang.Throwable"
  15948. static="false" final="false" visibility="public"
  15949. deprecated="not deprecated">
  15950. </constructor>
  15951. <constructor name="ApplicationIdNotProvidedException" type="java.lang.String"
  15952. static="false" final="false" visibility="public"
  15953. deprecated="not deprecated">
  15954. </constructor>
  15955. <constructor name="ApplicationIdNotProvidedException" type="java.lang.String, java.lang.Throwable"
  15956. static="false" final="false" visibility="public"
  15957. deprecated="not deprecated">
  15958. </constructor>
  15959. <doc>
  15960. <![CDATA[Exception to be thrown when Client submit an application without
  15961. providing {@link ApplicationId} in {@link ApplicationSubmissionContext}.]]>
  15962. </doc>
  15963. </class>
  15964. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
  15965. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
  15966. <class name="ApplicationNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  15967. abstract="false"
  15968. static="false" final="false" visibility="public"
  15969. deprecated="not deprecated">
  15970. <constructor name="ApplicationNotFoundException" type="java.lang.Throwable"
  15971. static="false" final="false" visibility="public"
  15972. deprecated="not deprecated">
  15973. </constructor>
  15974. <constructor name="ApplicationNotFoundException" type="java.lang.String"
  15975. static="false" final="false" visibility="public"
  15976. deprecated="not deprecated">
  15977. </constructor>
  15978. <constructor name="ApplicationNotFoundException" type="java.lang.String, java.lang.Throwable"
  15979. static="false" final="false" visibility="public"
  15980. deprecated="not deprecated">
  15981. </constructor>
  15982. <doc>
  15983. <![CDATA[This exception is thrown on
  15984. {@link ApplicationClientProtocol#getApplicationReport
  15985. (GetApplicationReportRequest)} API
  15986. when the Application doesn't exist in RM and AHS]]>
  15987. </doc>
  15988. </class>
  15989. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
  15990. <!-- start class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
  15991. <class name="ContainerNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  15992. abstract="false"
  15993. static="false" final="false" visibility="public"
  15994. deprecated="not deprecated">
  15995. <constructor name="ContainerNotFoundException" type="java.lang.Throwable"
  15996. static="false" final="false" visibility="public"
  15997. deprecated="not deprecated">
  15998. </constructor>
  15999. <constructor name="ContainerNotFoundException" type="java.lang.String"
  16000. static="false" final="false" visibility="public"
  16001. deprecated="not deprecated">
  16002. </constructor>
  16003. <constructor name="ContainerNotFoundException" type="java.lang.String, java.lang.Throwable"
  16004. static="false" final="false" visibility="public"
  16005. deprecated="not deprecated">
  16006. </constructor>
  16007. <doc>
  16008. <![CDATA[This exception is thrown on
  16009. {@link ApplicationHistoryProtocol#getContainerReport (GetContainerReportRequest)}
  16010. API when the container doesn't exist in AHS]]>
  16011. </doc>
  16012. </class>
  16013. <!-- end class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
  16014. <!-- start class org.apache.hadoop.yarn.exceptions.YarnException -->
  16015. <class name="YarnException" extends="java.lang.Exception"
  16016. abstract="false"
  16017. static="false" final="false" visibility="public"
  16018. deprecated="not deprecated">
  16019. <constructor name="YarnException"
  16020. static="false" final="false" visibility="public"
  16021. deprecated="not deprecated">
  16022. </constructor>
  16023. <constructor name="YarnException" type="java.lang.String"
  16024. static="false" final="false" visibility="public"
  16025. deprecated="not deprecated">
  16026. </constructor>
  16027. <constructor name="YarnException" type="java.lang.Throwable"
  16028. static="false" final="false" visibility="public"
  16029. deprecated="not deprecated">
  16030. </constructor>
  16031. <constructor name="YarnException" type="java.lang.String, java.lang.Throwable"
  16032. static="false" final="false" visibility="public"
  16033. deprecated="not deprecated">
  16034. </constructor>
  16035. <doc>
  16036. <![CDATA[YarnException indicates exceptions from yarn servers. On the other hand,
  16037. IOExceptions indicates exceptions from RPC layer.]]>
  16038. </doc>
  16039. </class>
  16040. <!-- end class org.apache.hadoop.yarn.exceptions.YarnException -->
  16041. </package>
  16042. <package name="org.apache.hadoop.yarn.server.api">
  16043. <!-- start class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
  16044. <class name="ApplicationInitializationContext" extends="java.lang.Object"
  16045. abstract="false"
  16046. static="false" final="false" visibility="public"
  16047. deprecated="not deprecated">
  16048. <constructor name="ApplicationInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ApplicationId, java.nio.ByteBuffer"
  16049. static="false" final="false" visibility="public"
  16050. deprecated="not deprecated">
  16051. </constructor>
  16052. <method name="getUser" return="java.lang.String"
  16053. abstract="false" native="false" synchronized="false"
  16054. static="false" final="false" visibility="public"
  16055. deprecated="not deprecated">
  16056. <doc>
  16057. <![CDATA[Get the user-name of the application-submitter
  16058. @return user-name]]>
  16059. </doc>
  16060. </method>
  16061. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  16062. abstract="false" native="false" synchronized="false"
  16063. static="false" final="false" visibility="public"
  16064. deprecated="not deprecated">
  16065. <doc>
  16066. <![CDATA[Get {@link ApplicationId} of the application
  16067. @return applications ID]]>
  16068. </doc>
  16069. </method>
  16070. <method name="getApplicationDataForService" return="java.nio.ByteBuffer"
  16071. abstract="false" native="false" synchronized="false"
  16072. static="false" final="false" visibility="public"
  16073. deprecated="not deprecated">
  16074. <doc>
  16075. <![CDATA[Get the data sent to the NodeManager via
  16076. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  16077. as part of {@link ContainerLaunchContext#getServiceData()}
  16078. @return the servicesData for this application.]]>
  16079. </doc>
  16080. </method>
  16081. <doc>
  16082. <![CDATA[Initialization context for {@link AuxiliaryService} when starting an
  16083. application.]]>
  16084. </doc>
  16085. </class>
  16086. <!-- end class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
  16087. <!-- start class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
  16088. <class name="ApplicationTerminationContext" extends="java.lang.Object"
  16089. abstract="false"
  16090. static="false" final="false" visibility="public"
  16091. deprecated="not deprecated">
  16092. <constructor name="ApplicationTerminationContext" type="org.apache.hadoop.yarn.api.records.ApplicationId"
  16093. static="false" final="false" visibility="public"
  16094. deprecated="not deprecated">
  16095. </constructor>
  16096. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  16097. abstract="false" native="false" synchronized="false"
  16098. static="false" final="false" visibility="public"
  16099. deprecated="not deprecated">
  16100. <doc>
  16101. <![CDATA[Get {@link ApplicationId} of the application being stopped.
  16102. @return applications ID]]>
  16103. </doc>
  16104. </method>
  16105. <doc>
  16106. <![CDATA[Initialization context for {@link AuxiliaryService} when stopping an
  16107. application.]]>
  16108. </doc>
  16109. </class>
  16110. <!-- end class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
  16111. <!-- start class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
  16112. <class name="AuxiliaryService" extends="org.apache.hadoop.service.AbstractService"
  16113. abstract="true"
  16114. static="false" final="false" visibility="public"
  16115. deprecated="not deprecated">
  16116. <constructor name="AuxiliaryService" type="java.lang.String"
  16117. static="false" final="false" visibility="protected"
  16118. deprecated="not deprecated">
  16119. </constructor>
  16120. <method name="getRecoveryPath" return="org.apache.hadoop.fs.Path"
  16121. abstract="false" native="false" synchronized="false"
  16122. static="false" final="false" visibility="protected"
  16123. deprecated="not deprecated">
  16124. <doc>
  16125. <![CDATA[Get the path specific to this auxiliary service to use for recovery.
  16126. @return state storage path or null if recovery is not enabled]]>
  16127. </doc>
  16128. </method>
  16129. <method name="initializeApplication"
  16130. abstract="true" native="false" synchronized="false"
  16131. static="false" final="false" visibility="public"
  16132. deprecated="not deprecated">
  16133. <param name="initAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationInitializationContext"/>
  16134. <doc>
  16135. <![CDATA[A new application is started on this NodeManager. This is a signal to
  16136. this {@link AuxiliaryService} about the application initialization.
  16137. @param initAppContext context for the application's initialization]]>
  16138. </doc>
  16139. </method>
  16140. <method name="stopApplication"
  16141. abstract="true" native="false" synchronized="false"
  16142. static="false" final="false" visibility="public"
  16143. deprecated="not deprecated">
  16144. <param name="stopAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationTerminationContext"/>
  16145. <doc>
  16146. <![CDATA[An application is finishing on this NodeManager. This is a signal to this
  16147. {@link AuxiliaryService} about the same.
  16148. @param stopAppContext context for the application termination]]>
  16149. </doc>
  16150. </method>
  16151. <method name="getMetaData" return="java.nio.ByteBuffer"
  16152. abstract="true" native="false" synchronized="false"
  16153. static="false" final="false" visibility="public"
  16154. deprecated="not deprecated">
  16155. <doc>
  16156. <![CDATA[Retrieve meta-data for this {@link AuxiliaryService}. Applications using
  16157. this {@link AuxiliaryService} SHOULD know the format of the meta-data -
  16158. ideally each service should provide a method to parse out the information
  16159. to the applications. One example of meta-data is contact information so
  16160. that applications can access the service remotely. This will only be called
  16161. after the service's {@link #start()} method has finished. the result may be
  16162. cached.
  16163. <p>
  16164. The information is passed along to applications via
  16165. {@link StartContainersResponse#getAllServicesMetaData()} that is returned by
  16166. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  16167. </p>
  16168. @return meta-data for this service that should be made available to
  16169. applications.]]>
  16170. </doc>
  16171. </method>
  16172. <method name="initializeContainer"
  16173. abstract="false" native="false" synchronized="false"
  16174. static="false" final="false" visibility="public"
  16175. deprecated="not deprecated">
  16176. <param name="initContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerInitializationContext"/>
  16177. <doc>
  16178. <![CDATA[A new container is started on this NodeManager. This is a signal to
  16179. this {@link AuxiliaryService} about the container initialization.
  16180. This method is called when the NodeManager receives the container launch
  16181. command from the ApplicationMaster and before the container process is
  16182. launched.
  16183. @param initContainerContext context for the container's initialization]]>
  16184. </doc>
  16185. </method>
  16186. <method name="stopContainer"
  16187. abstract="false" native="false" synchronized="false"
  16188. static="false" final="false" visibility="public"
  16189. deprecated="not deprecated">
  16190. <param name="stopContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerTerminationContext"/>
  16191. <doc>
  16192. <![CDATA[A container is finishing on this NodeManager. This is a signal to this
  16193. {@link AuxiliaryService} about the same.
  16194. @param stopContainerContext context for the container termination]]>
  16195. </doc>
  16196. </method>
  16197. <method name="setRecoveryPath"
  16198. abstract="false" native="false" synchronized="false"
  16199. static="false" final="false" visibility="public"
  16200. deprecated="not deprecated">
  16201. <param name="recoveryPath" type="org.apache.hadoop.fs.Path"/>
  16202. <doc>
  16203. <![CDATA[Set the path for this auxiliary service to use for storing state
  16204. that will be used during recovery.
  16205. @param recoveryPath where recoverable state should be stored]]>
  16206. </doc>
  16207. </method>
  16208. <doc>
  16209. <![CDATA[A generic service that will be started by the NodeManager. This is a service
  16210. that administrators have to configure on each node by setting
  16211. {@link YarnConfiguration#NM_AUX_SERVICES}.]]>
  16212. </doc>
  16213. </class>
  16214. <!-- end class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
  16215. <!-- start class org.apache.hadoop.yarn.server.api.ContainerContext -->
  16216. <class name="ContainerContext" extends="java.lang.Object"
  16217. abstract="false"
  16218. static="false" final="false" visibility="public"
  16219. deprecated="not deprecated">
  16220. <constructor name="ContainerContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  16221. static="false" final="false" visibility="public"
  16222. deprecated="not deprecated">
  16223. </constructor>
  16224. <constructor name="ContainerContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource, org.apache.hadoop.yarn.server.api.ContainerType"
  16225. static="false" final="false" visibility="public"
  16226. deprecated="not deprecated">
  16227. </constructor>
  16228. <method name="getUser" return="java.lang.String"
  16229. abstract="false" native="false" synchronized="false"
  16230. static="false" final="false" visibility="public"
  16231. deprecated="not deprecated">
  16232. <doc>
  16233. <![CDATA[Get user of the container being initialized or stopped.
  16234. @return the user]]>
  16235. </doc>
  16236. </method>
  16237. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  16238. abstract="false" native="false" synchronized="false"
  16239. static="false" final="false" visibility="public"
  16240. deprecated="not deprecated">
  16241. <doc>
  16242. <![CDATA[Get {@link ContainerId} of the container being initialized or stopped.
  16243. @return the container ID]]>
  16244. </doc>
  16245. </method>
  16246. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  16247. abstract="false" native="false" synchronized="false"
  16248. static="false" final="false" visibility="public"
  16249. deprecated="not deprecated">
  16250. <doc>
  16251. <![CDATA[Get {@link Resource} the resource capability allocated to the container
  16252. being initialized or stopped.
  16253. @return the resource capability.]]>
  16254. </doc>
  16255. </method>
  16256. <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
  16257. abstract="false" native="false" synchronized="false"
  16258. static="false" final="false" visibility="public"
  16259. deprecated="not deprecated">
  16260. <doc>
  16261. <![CDATA[Get {@link ContainerType} the type of the container
  16262. being initialized or stopped.
  16263. @return the type of the container]]>
  16264. </doc>
  16265. </method>
  16266. <doc>
  16267. <![CDATA[Base context class for {@link AuxiliaryService} initializing and stopping a
  16268. container.]]>
  16269. </doc>
  16270. </class>
  16271. <!-- end class org.apache.hadoop.yarn.server.api.ContainerContext -->
  16272. <!-- start class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
  16273. <class name="ContainerInitializationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
  16274. abstract="false"
  16275. static="false" final="false" visibility="public"
  16276. deprecated="not deprecated">
  16277. <constructor name="ContainerInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  16278. static="false" final="false" visibility="public"
  16279. deprecated="not deprecated">
  16280. </constructor>
  16281. <constructor name="ContainerInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource, org.apache.hadoop.yarn.server.api.ContainerType"
  16282. static="false" final="false" visibility="public"
  16283. deprecated="not deprecated">
  16284. </constructor>
  16285. <doc>
  16286. <![CDATA[Initialization context for {@link AuxiliaryService} when starting a
  16287. container.]]>
  16288. </doc>
  16289. </class>
  16290. <!-- end class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
  16291. <!-- start interface org.apache.hadoop.yarn.server.api.ContainerLogAggregationPolicy -->
  16292. <interface name="ContainerLogAggregationPolicy" abstract="true"
  16293. static="false" final="false" visibility="public"
  16294. deprecated="not deprecated">
  16295. <method name="parseParameters"
  16296. abstract="true" native="false" synchronized="false"
  16297. static="false" final="false" visibility="public"
  16298. deprecated="not deprecated">
  16299. <param name="parameters" type="java.lang.String"/>
  16300. <doc>
  16301. <![CDATA[<p>
  16302. The method used by the NodeManager log aggregation service
  16303. to initial the policy object with parameters specified by the application
  16304. or the cluster-wide setting.
  16305. </p>
  16306. @param parameters parameters with scheme defined by the policy class.]]>
  16307. </doc>
  16308. </method>
  16309. <method name="shouldDoLogAggregation" return="boolean"
  16310. abstract="true" native="false" synchronized="false"
  16311. static="false" final="false" visibility="public"
  16312. deprecated="not deprecated">
  16313. <param name="logContext" type="org.apache.hadoop.yarn.server.api.ContainerLogContext"/>
  16314. <doc>
  16315. <![CDATA[<p>
  16316. The method used by the NodeManager log aggregation service
  16317. to ask the policy object if a given container's logs should be aggregated.
  16318. </p>
  16319. @param logContext ContainerLogContext
  16320. @return Whether or not the container's logs should be aggregated.]]>
  16321. </doc>
  16322. </method>
  16323. <doc>
  16324. <![CDATA[This API is used by NodeManager to decide if a given container's logs
  16325. should be aggregated at run time.]]>
  16326. </doc>
  16327. </interface>
  16328. <!-- end interface org.apache.hadoop.yarn.server.api.ContainerLogAggregationPolicy -->
  16329. <!-- start class org.apache.hadoop.yarn.server.api.ContainerLogContext -->
  16330. <class name="ContainerLogContext" extends="java.lang.Object"
  16331. abstract="false"
  16332. static="false" final="false" visibility="public"
  16333. deprecated="not deprecated">
  16334. <constructor name="ContainerLogContext" type="org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.server.api.ContainerType, int"
  16335. static="false" final="false" visibility="public"
  16336. deprecated="not deprecated">
  16337. </constructor>
  16338. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  16339. abstract="false" native="false" synchronized="false"
  16340. static="false" final="false" visibility="public"
  16341. deprecated="not deprecated">
  16342. <doc>
  16343. <![CDATA[Get {@link ContainerId} of the container.
  16344. @return the container ID]]>
  16345. </doc>
  16346. </method>
  16347. <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
  16348. abstract="false" native="false" synchronized="false"
  16349. static="false" final="false" visibility="public"
  16350. deprecated="not deprecated">
  16351. <doc>
  16352. <![CDATA[Get {@link ContainerType} the type of the container.
  16353. @return the type of the container]]>
  16354. </doc>
  16355. </method>
  16356. <method name="getExitCode" return="int"
  16357. abstract="false" native="false" synchronized="false"
  16358. static="false" final="false" visibility="public"
  16359. deprecated="not deprecated">
  16360. <doc>
  16361. <![CDATA[Get the exit code of the container.
  16362. @return the exit code]]>
  16363. </doc>
  16364. </method>
  16365. <doc>
  16366. <![CDATA[Context class for {@link ContainerLogAggregationPolicy}.]]>
  16367. </doc>
  16368. </class>
  16369. <!-- end class org.apache.hadoop.yarn.server.api.ContainerLogContext -->
  16370. <!-- start class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
  16371. <class name="ContainerTerminationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
  16372. abstract="false"
  16373. static="false" final="false" visibility="public"
  16374. deprecated="not deprecated">
  16375. <constructor name="ContainerTerminationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  16376. static="false" final="false" visibility="public"
  16377. deprecated="not deprecated">
  16378. </constructor>
  16379. <constructor name="ContainerTerminationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource, org.apache.hadoop.yarn.server.api.ContainerType"
  16380. static="false" final="false" visibility="public"
  16381. deprecated="not deprecated">
  16382. </constructor>
  16383. <doc>
  16384. <![CDATA[Termination context for {@link AuxiliaryService} when stopping a
  16385. container.]]>
  16386. </doc>
  16387. </class>
  16388. <!-- end class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
  16389. <!-- start interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
  16390. <interface name="SCMAdminProtocol" abstract="true"
  16391. static="false" final="false" visibility="public"
  16392. deprecated="not deprecated">
  16393. <method name="runCleanerTask" return="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskResponse"
  16394. abstract="true" native="false" synchronized="false"
  16395. static="false" final="false" visibility="public"
  16396. deprecated="not deprecated">
  16397. <param name="request" type="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskRequest"/>
  16398. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  16399. <exception name="IOException" type="java.io.IOException"/>
  16400. <doc>
  16401. <![CDATA[<p>
  16402. The method used by administrators to ask SCM to run cleaner task right away
  16403. </p>
  16404. @param request request <code>SharedCacheManager</code> to run a cleaner task
  16405. @return <code>SharedCacheManager</code> returns an empty response
  16406. on success and throws an exception on rejecting the request
  16407. @throws YarnException
  16408. @throws IOException]]>
  16409. </doc>
  16410. </method>
  16411. <doc>
  16412. <![CDATA[<p>
  16413. The protocol between administrators and the <code>SharedCacheManager</code>
  16414. </p>]]>
  16415. </doc>
  16416. </interface>
  16417. <!-- end interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
  16418. </package>
  16419. <package name="org.apache.hadoop.yarn.util">
  16420. </package>
  16421. </api>