Apache_Hadoop_YARN_API_3.2.4.xml 1.0 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332
  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 Tue Jul 12 12:53:54 GMT 2022 -->
  5. <api
  6. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  7. xsi:noNamespaceSchemaLocation='api.xsd'
  8. name="Apache Hadoop YARN API 3.2.4"
  9. jdversion="1.0.9">
  10. <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-annotations.jar:/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/jdiff.jar -verbose -classpath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/classes:/maven/com/google/guava/guava/27.0-jre/guava-27.0-jre.jar:/maven/com/google/guava/failureaccess/1.0/failureaccess-1.0.jar:/maven/com/google/guava/listenablefuture/9999.0-empty-to-avoid-conflict-with-guava/listenablefuture-9999.0-empty-to-avoid-conflict-with-guava.jar:/maven/com/google/code/findbugs/jsr305/3.0.2/jsr305-3.0.2.jar:/maven/org/checkerframework/checker-qual/2.5.2/checker-qual-2.5.2.jar:/maven/com/google/errorprone/error_prone_annotations/2.2.0/error_prone_annotations-2.2.0.jar:/maven/com/google/j2objc/j2objc-annotations/1.1/j2objc-annotations-1.1.jar:/maven/org/codehaus/mojo/animal-sniffer-annotations/1.17/animal-sniffer-annotations-1.17.jar:/maven/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/maven/javax/xml/bind/jaxb-api/2.2.11/jaxb-api-2.2.11.jar:/build/source/hadoop-common-project/hadoop-common/target/hadoop-common-3.2.4.jar:/maven/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/maven/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/maven/org/apache/httpcomponents/httpclient/4.5.13/httpclient-4.5.13.jar:/maven/org/apache/httpcomponents/httpcore/4.4.13/httpcore-4.4.13.jar:/maven/commons-codec/commons-codec/1.11/commons-codec-1.11.jar:/maven/commons-io/commons-io/2.8.0/commons-io-2.8.0.jar:/maven/commons-net/commons-net/3.6/commons-net-3.6.jar:/maven/commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar:/maven/javax/servlet/javax.servlet-api/3.1.0/javax.servlet-api-3.1.0.jar:/maven/javax/activation/javax.activation-api/1.2.0/javax.activation-api-1.2.0.jar:/maven/org/eclipse/jetty/jetty-server/9.4.43.v20210629/jetty-server-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-http/9.4.43.v20210629/jetty-http-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-io/9.4.43.v20210629/jetty-io-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-util/9.4.43.v20210629/jetty-util-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-servlet/9.4.43.v20210629/jetty-servlet-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-security/9.4.43.v20210629/jetty-security-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-util-ajax/9.4.43.v20210629/jetty-util-ajax-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-webapp/9.4.43.v20210629/jetty-webapp-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-xml/9.4.43.v20210629/jetty-xml-9.4.43.v20210629.jar:/maven/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/maven/com/sun/jersey/jersey-core/1.19/jersey-core-1.19.jar:/maven/javax/ws/rs/jsr311-api/1.1.1/jsr311-api-1.1.1.jar:/maven/com/sun/jersey/jersey-servlet/1.19/jersey-servlet-1.19.jar:/maven/com/sun/jersey/jersey-json/1.19/jersey-json-1.19.jar:/maven/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/maven/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/maven/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/maven/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/maven/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/maven/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/maven/com/sun/jersey/jersey-server/1.19/jersey-server-1.19.jar:/maven/ch/qos/reload4j/reload4j/1.2.18.3/reload4j-1.2.18.3.jar:/maven/commons-beanutils/commons-beanutils/1.9.4/commons-beanutils-1.9.4.jar:/maven/org/apache/commons/commons-configuration2/2.1.1/commons-configuration2-2.1.1.jar:/maven/org/apache/commons/commons-lang3/3.7/commons-lang3-3.7.jar:/maven/org/apache/commons/commons-text/1.4/commons-text-1.4.jar:/maven/org/slf4j/slf4j-api/1.7.35/slf4j-api-1.7.35.jar:/maven/org/apache/avro/avro/1.7.7/avro-1.7.7.jar:/maven/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/maven/org/xerial/snappy/snappy-java/1.0.5/snappy-java-1.0.5.jar:/maven/com/google/re2j/re2j/1.1/re2j-1.1.jar:/maven/com/google/code/gson/gson/2.9.0/gson-2.9.0.jar:/build/source/hadoop-common-project/hadoop-auth/target/hadoop-auth-3.2.4.jar:/maven/com/nimbusds/nimbus-jose-jwt/9.8.1/nimbus-jose-jwt-9.8.1.jar:/maven/com/github/stephenc/jcip/jcip-annotations/1.0-1/jcip-annotations-1.0-1.jar:/maven/net/minidev/json-smart/2.4.7/json-smart-2.4.7.jar:/maven/net/minidev/accessors-smart/2.4.7/accessors-smart-2.4.7.jar:/maven/org/ow2/asm/asm/5.0.4/asm-5.0.4.jar:/maven/org/apache/curator/curator-framework/2.13.0/curator-framework-2.13.0.jar:/maven/com/jcraft/jsch/0.1.55/jsch-0.1.55.jar:/maven/org/apache/curator/curator-client/2.13.0/curator-client-2.13.0.jar:/maven/org/apache/curator/curator-recipes/2.13.0/curator-recipes-2.13.0.jar:/maven/org/apache/htrace/htrace-core4/4.1.0-incubating/htrace-core4-4.1.0-incubating.jar:/maven/org/apache/zookeeper/zookeeper/3.4.14/zookeeper-3.4.14.jar:/maven/com/github/spotbugs/spotbugs-annotations/3.1.9/spotbugs-annotations-3.1.9.jar:/maven/org/apache/yetus/audience-annotations/0.5.0/audience-annotations-0.5.0.jar:/maven/io/netty/netty/3.10.6.Final/netty-3.10.6.Final.jar:/maven/org/apache/commons/commons-compress/1.21/commons-compress-1.21.jar:/maven/org/apache/kerby/kerb-simplekdc/1.0.1/kerb-simplekdc-1.0.1.jar:/maven/org/apache/kerby/kerb-client/1.0.1/kerb-client-1.0.1.jar:/maven/org/apache/kerby/kerby-config/1.0.1/kerby-config-1.0.1.jar:/maven/org/apache/kerby/kerb-core/1.0.1/kerb-core-1.0.1.jar:/maven/org/apache/kerby/kerby-pkix/1.0.1/kerby-pkix-1.0.1.jar:/maven/org/apache/kerby/kerby-asn1/1.0.1/kerby-asn1-1.0.1.jar:/maven/org/apache/kerby/kerby-util/1.0.1/kerby-util-1.0.1.jar:/maven/org/apache/kerby/kerb-common/1.0.1/kerb-common-1.0.1.jar:/maven/org/apache/kerby/kerb-crypto/1.0.1/kerb-crypto-1.0.1.jar:/maven/org/apache/kerby/kerb-util/1.0.1/kerb-util-1.0.1.jar:/maven/org/apache/kerby/token-provider/1.0.1/token-provider-1.0.1.jar:/maven/org/apache/kerby/kerb-admin/1.0.1/kerb-admin-1.0.1.jar:/maven/org/apache/kerby/kerb-server/1.0.1/kerb-server-1.0.1.jar:/maven/org/apache/kerby/kerb-identity/1.0.1/kerb-identity-1.0.1.jar:/maven/org/apache/kerby/kerby-xdr/1.0.1/kerby-xdr-1.0.1.jar:/maven/com/fasterxml/jackson/core/jackson-databind/2.10.5.1/jackson-databind-2.10.5.1.jar:/maven/com/fasterxml/jackson/core/jackson-core/2.10.5/jackson-core-2.10.5.jar:/maven/org/codehaus/woodstox/stax2-api/4.2.1/stax2-api-4.2.1.jar:/maven/com/fasterxml/woodstox/woodstox-core/5.3.0/woodstox-core-5.3.0.jar:/maven/dnsjava/dnsjava/2.1.7/dnsjava-2.1.7.jar:/build/source/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-3.2.4.jar:/usr/lib/jvm/java-8-openjdk-amd64/lib/tools.jar:/maven/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar:/maven/com/fasterxml/jackson/core/jackson-annotations/2.10.5/jackson-annotations-2.10.5.jar:/maven/xerces/xercesImpl/2.11.0/xercesImpl-2.11.0.jar:/maven/xml-apis/xml-apis/1.4.01/xml-apis-1.4.01.jar -sourcepath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-annotations.jar:/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/jdiff.jar -apidir /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/jdiff/xml -apiname Apache Hadoop YARN API 3.2.4 -->
  11. <package name="org.apache.hadoop.yarn.ams">
  12. </package>
  13. <package name="org.apache.hadoop.yarn.api">
  14. <!-- start interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
  15. <interface name="ApplicationClientProtocol" abstract="true"
  16. static="false" final="false" visibility="public"
  17. deprecated="not deprecated">
  18. <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
  19. <method name="getNewApplication" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse"
  20. abstract="true" native="false" synchronized="false"
  21. static="false" final="false" visibility="public"
  22. deprecated="not deprecated">
  23. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"/>
  24. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  25. <exception name="IOException" type="java.io.IOException"/>
  26. <doc>
  27. <![CDATA[<p>The interface used by clients to obtain a new {@link ApplicationId} for
  28. submitting new applications.</p>
  29. <p>The <code>ResourceManager</code> responds with a new, monotonically
  30. increasing, {@link ApplicationId} which is used by the client to submit
  31. a new application.</p>
  32. <p>The <code>ResourceManager</code> also responds with details such
  33. as maximum resource capabilities in the cluster as specified in
  34. {@link GetNewApplicationResponse}.</p>
  35. @param request request to get a new <code>ApplicationId</code>
  36. @return response containing the new <code>ApplicationId</code> to be used
  37. to submit an application
  38. @throws YarnException
  39. @throws IOException
  40. @see #submitApplication(SubmitApplicationRequest)]]>
  41. </doc>
  42. </method>
  43. <method name="submitApplication" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse"
  44. abstract="true" native="false" synchronized="false"
  45. static="false" final="false" visibility="public"
  46. deprecated="not deprecated">
  47. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"/>
  48. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  49. <exception name="IOException" type="java.io.IOException"/>
  50. <doc>
  51. <![CDATA[<p>The interface used by clients to submit a new application to the
  52. <code>ResourceManager.</code></p>
  53. <p>The client is required to provide details such as queue,
  54. {@link Resource} required to run the <code>ApplicationMaster</code>,
  55. the equivalent of {@link ContainerLaunchContext} for launching
  56. the <code>ApplicationMaster</code> etc. via the
  57. {@link SubmitApplicationRequest}.</p>
  58. <p>Currently the <code>ResourceManager</code> sends an immediate (empty)
  59. {@link SubmitApplicationResponse} on accepting the submission and throws
  60. an exception if it rejects the submission. However, this call needs to be
  61. followed by {@link #getApplicationReport(GetApplicationReportRequest)}
  62. to make sure that the application gets properly submitted - obtaining a
  63. {@link SubmitApplicationResponse} from ResourceManager doesn't guarantee
  64. that RM 'remembers' this application beyond failover or restart. If RM
  65. failover or RM restart happens before ResourceManager saves the
  66. application's state successfully, the subsequent
  67. {@link #getApplicationReport(GetApplicationReportRequest)} will throw
  68. a {@link ApplicationNotFoundException}. The Clients need to re-submit
  69. the application with the same {@link ApplicationSubmissionContext} when
  70. it encounters the {@link ApplicationNotFoundException} on the
  71. {@link #getApplicationReport(GetApplicationReportRequest)} call.</p>
  72. <p>During the submission process, it checks whether the application
  73. already exists. If the application exists, it will simply return
  74. SubmitApplicationResponse</p>
  75. <p> In secure mode,the <code>ResourceManager</code> verifies access to
  76. queues etc. before accepting the application submission.</p>
  77. @param request request to submit a new application
  78. @return (empty) response on accepting the submission
  79. @throws YarnException
  80. @throws IOException
  81. @see #getNewApplication(GetNewApplicationRequest)]]>
  82. </doc>
  83. </method>
  84. <method name="failApplicationAttempt" return="org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptResponse"
  85. abstract="true" native="false" synchronized="false"
  86. static="false" final="false" visibility="public"
  87. deprecated="not deprecated">
  88. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest"/>
  89. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  90. <exception name="IOException" type="java.io.IOException"/>
  91. <doc>
  92. <![CDATA[<p>The interface used by clients to request the
  93. <code>ResourceManager</code> to fail an application attempt.</p>
  94. <p>The client, via {@link FailApplicationAttemptRequest} provides the
  95. {@link ApplicationAttemptId} of the attempt to be failed.</p>
  96. <p> In secure mode,the <code>ResourceManager</code> verifies access to the
  97. application, queue etc. before failing the attempt.</p>
  98. <p>Currently, the <code>ResourceManager</code> returns an empty response
  99. on success and throws an exception on rejecting the request.</p>
  100. @param request request to fail an attempt
  101. @return <code>ResourceManager</code> returns an empty response
  102. on success and throws an exception on rejecting the request
  103. @throws YarnException
  104. @throws IOException
  105. @see #getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  106. </doc>
  107. </method>
  108. <method name="forceKillApplication" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse"
  109. abstract="true" native="false" synchronized="false"
  110. static="false" final="false" visibility="public"
  111. deprecated="not deprecated">
  112. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"/>
  113. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  114. <exception name="IOException" type="java.io.IOException"/>
  115. <doc>
  116. <![CDATA[<p>The interface used by clients to request the
  117. <code>ResourceManager</code> to abort submitted application.</p>
  118. <p>The client, via {@link KillApplicationRequest} provides the
  119. {@link ApplicationId} of the application to be aborted.</p>
  120. <p> In secure mode,the <code>ResourceManager</code> verifies access to the
  121. application, queue etc. before terminating the application.</p>
  122. <p>Currently, the <code>ResourceManager</code> returns an empty response
  123. on success and throws an exception on rejecting the request.</p>
  124. @param request request to abort a submitted application
  125. @return <code>ResourceManager</code> returns an empty response
  126. on success and throws an exception on rejecting the request
  127. @throws YarnException
  128. @throws IOException
  129. @see #getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  130. </doc>
  131. </method>
  132. <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse"
  133. abstract="true" native="false" synchronized="false"
  134. static="false" final="false" visibility="public"
  135. deprecated="not deprecated">
  136. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"/>
  137. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  138. <exception name="IOException" type="java.io.IOException"/>
  139. <doc>
  140. <![CDATA[<p>The interface used by clients to get metrics about the cluster from
  141. the <code>ResourceManager</code>.</p>
  142. <p>The <code>ResourceManager</code> responds with a
  143. {@link GetClusterMetricsResponse} which includes the
  144. {@link YarnClusterMetrics} with details such as number of current
  145. nodes in the cluster.</p>
  146. @param request request for cluster metrics
  147. @return cluster metrics
  148. @throws YarnException
  149. @throws IOException]]>
  150. </doc>
  151. </method>
  152. <method name="getClusterNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse"
  153. abstract="true" native="false" synchronized="false"
  154. static="false" final="false" visibility="public"
  155. deprecated="not deprecated">
  156. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"/>
  157. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  158. <exception name="IOException" type="java.io.IOException"/>
  159. <doc>
  160. <![CDATA[<p>The interface used by clients to get a report of all nodes
  161. in the cluster from the <code>ResourceManager</code>.</p>
  162. <p>The <code>ResourceManager</code> responds with a
  163. {@link GetClusterNodesResponse} which includes the
  164. {@link NodeReport} for all the nodes in the cluster.</p>
  165. @param request request for report on all nodes
  166. @return report on all nodes
  167. @throws YarnException
  168. @throws IOException]]>
  169. </doc>
  170. </method>
  171. <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse"
  172. abstract="true" native="false" synchronized="false"
  173. static="false" final="false" visibility="public"
  174. deprecated="not deprecated">
  175. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"/>
  176. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  177. <exception name="IOException" type="java.io.IOException"/>
  178. <doc>
  179. <![CDATA[<p>The interface used by clients to get information about <em>queues</em>
  180. from the <code>ResourceManager</code>.</p>
  181. <p>The client, via {@link GetQueueInfoRequest}, can ask for details such
  182. as used/total resources, child queues, running applications etc.</p>
  183. <p> In secure mode,the <code>ResourceManager</code> verifies access before
  184. providing the information.</p>
  185. @param request request to get queue information
  186. @return queue information
  187. @throws YarnException
  188. @throws IOException]]>
  189. </doc>
  190. </method>
  191. <method name="getQueueUserAcls" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse"
  192. abstract="true" native="false" synchronized="false"
  193. static="false" final="false" visibility="public"
  194. deprecated="not deprecated">
  195. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"/>
  196. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  197. <exception name="IOException" type="java.io.IOException"/>
  198. <doc>
  199. <![CDATA[<p>The interface used by clients to get information about <em>queue
  200. acls</em> for <em>current user</em> from the <code>ResourceManager</code>.
  201. </p>
  202. <p>The <code>ResourceManager</code> responds with queue acls for all
  203. existing queues.</p>
  204. @param request request to get queue acls for <em>current user</em>
  205. @return queue acls for <em>current user</em>
  206. @throws YarnException
  207. @throws IOException]]>
  208. </doc>
  209. </method>
  210. <method name="moveApplicationAcrossQueues" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse"
  211. abstract="true" native="false" synchronized="false"
  212. static="false" final="false" visibility="public"
  213. deprecated="not deprecated">
  214. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"/>
  215. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  216. <exception name="IOException" type="java.io.IOException"/>
  217. <doc>
  218. <![CDATA[Move an application to a new queue.
  219. @param request the application ID and the target queue
  220. @return an empty response
  221. @throws YarnException
  222. @throws IOException]]>
  223. </doc>
  224. </method>
  225. <method name="getNewReservation" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse"
  226. abstract="true" native="false" synchronized="false"
  227. static="false" final="false" visibility="public"
  228. deprecated="not deprecated">
  229. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest"/>
  230. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  231. <exception name="IOException" type="java.io.IOException"/>
  232. <doc>
  233. <![CDATA[<p>The interface used by clients to obtain a new {@link ReservationId} for
  234. submitting new reservations.</p>
  235. <p>The <code>ResourceManager</code> responds with a new, unique,
  236. {@link ReservationId} which is used by the client to submit
  237. a new reservation.</p>
  238. @param request to get a new <code>ReservationId</code>
  239. @return response containing the new <code>ReservationId</code> to be used
  240. to submit a new reservation
  241. @throws YarnException if the reservation system is not enabled.
  242. @throws IOException on IO failures.
  243. @see #submitReservation(ReservationSubmissionRequest)]]>
  244. </doc>
  245. </method>
  246. <method name="submitReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse"
  247. abstract="true" native="false" synchronized="false"
  248. static="false" final="false" visibility="public"
  249. deprecated="not deprecated">
  250. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"/>
  251. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  252. <exception name="IOException" type="java.io.IOException"/>
  253. <doc>
  254. <![CDATA[<p>
  255. The interface used by clients to submit a new reservation to the
  256. {@code ResourceManager}.
  257. </p>
  258. <p>
  259. The client packages all details of its request in a
  260. {@link ReservationSubmissionRequest} object. This contains information
  261. about the amount of capacity, temporal constraints, and concurrency needs.
  262. Furthermore, the reservation might be composed of multiple stages, with
  263. ordering dependencies among them.
  264. </p>
  265. <p>
  266. In order to respond, a new admission control component in the
  267. {@code ResourceManager} performs an analysis of the resources that have
  268. been committed over the period of time the user is requesting, verify that
  269. the user requests can be fulfilled, and that it respect a sharing policy
  270. (e.g., {@code CapacityOverTimePolicy}). Once it has positively determined
  271. that the ReservationSubmissionRequest is satisfiable the
  272. {@code ResourceManager} answers with a
  273. {@link ReservationSubmissionResponse} that include a non-null
  274. {@link ReservationId}. Upon failure to find a valid allocation the response
  275. is an exception with the reason.
  276. On application submission the client can use this {@link ReservationId} to
  277. obtain access to the reserved resources.
  278. </p>
  279. <p>
  280. The system guarantees that during the time-range specified by the user, the
  281. reservationID will be corresponding to a valid reservation. The amount of
  282. capacity dedicated to such queue can vary overtime, depending of the
  283. allocation that has been determined. But it is guaranteed to satisfy all
  284. the constraint expressed by the user in the
  285. {@link ReservationSubmissionRequest}.
  286. </p>
  287. @param request the request to submit a new Reservation
  288. @return response the {@link ReservationId} on accepting the submission
  289. @throws YarnException if the request is invalid or reservation cannot be
  290. created successfully
  291. @throws IOException]]>
  292. </doc>
  293. </method>
  294. <method name="updateReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse"
  295. abstract="true" native="false" synchronized="false"
  296. static="false" final="false" visibility="public"
  297. deprecated="not deprecated">
  298. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"/>
  299. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  300. <exception name="IOException" type="java.io.IOException"/>
  301. <doc>
  302. <![CDATA[<p>
  303. The interface used by clients to update an existing Reservation. This is
  304. referred to as a re-negotiation process, in which a user that has
  305. previously submitted a Reservation.
  306. </p>
  307. <p>
  308. The allocation is attempted by virtually substituting all previous
  309. allocations related to this Reservation with new ones, that satisfy the new
  310. {@link ReservationUpdateRequest}. Upon success the previous allocation is
  311. substituted by the new one, and on failure (i.e., if the system cannot find
  312. a valid allocation for the updated request), the previous allocation
  313. remains valid.
  314. The {@link ReservationId} is not changed, and applications currently
  315. running within this reservation will automatically receive the resources
  316. based on the new allocation.
  317. </p>
  318. @param request to update an existing Reservation (the ReservationRequest
  319. should refer to an existing valid {@link ReservationId})
  320. @return response empty on successfully updating the existing reservation
  321. @throws YarnException if the request is invalid or reservation cannot be
  322. updated successfully
  323. @throws IOException]]>
  324. </doc>
  325. </method>
  326. <method name="deleteReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse"
  327. abstract="true" native="false" synchronized="false"
  328. static="false" final="false" visibility="public"
  329. deprecated="not deprecated">
  330. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"/>
  331. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  332. <exception name="IOException" type="java.io.IOException"/>
  333. <doc>
  334. <![CDATA[<p>
  335. The interface used by clients to remove an existing Reservation.
  336. Upon deletion of a reservation applications running with this reservation,
  337. are automatically downgraded to normal jobs running without any dedicated
  338. reservation.
  339. </p>
  340. @param request to remove an existing Reservation (the ReservationRequest
  341. should refer to an existing valid {@link ReservationId})
  342. @return response empty on successfully deleting the existing reservation
  343. @throws YarnException if the request is invalid or reservation cannot be
  344. deleted successfully
  345. @throws IOException]]>
  346. </doc>
  347. </method>
  348. <method name="listReservations" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse"
  349. abstract="true" native="false" synchronized="false"
  350. static="false" final="false" visibility="public"
  351. deprecated="not deprecated">
  352. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"/>
  353. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  354. <exception name="IOException" type="java.io.IOException"/>
  355. <doc>
  356. <![CDATA[<p>
  357. The interface used by clients to get the list of reservations in a plan.
  358. The reservationId will be used to search for reservations to list if it is
  359. provided. Otherwise, it will select active reservations within the
  360. startTime and endTime (inclusive).
  361. </p>
  362. @param request to list reservations in a plan. Contains fields to select
  363. String queue, ReservationId reservationId, long startTime,
  364. long endTime, and a bool includeReservationAllocations.
  365. queue: Required. Cannot be null or empty. Refers to the
  366. reservable queue in the scheduler that was selected when
  367. creating a reservation submission
  368. {@link ReservationSubmissionRequest}.
  369. reservationId: Optional. If provided, other fields will
  370. be ignored.
  371. startTime: Optional. If provided, only reservations that
  372. end after the startTime will be selected. This defaults
  373. to 0 if an invalid number is used.
  374. endTime: Optional. If provided, only reservations that
  375. start on or before endTime will be selected. This defaults
  376. to Long.MAX_VALUE if an invalid number is used.
  377. includeReservationAllocations: Optional. Flag that
  378. determines whether the entire reservation allocations are
  379. to be returned. Reservation allocations are subject to
  380. change in the event of re-planning as described by
  381. {@code ReservationDefinition}.
  382. @return response that contains information about reservations that are
  383. being searched for.
  384. @throws YarnException if the request is invalid
  385. @throws IOException on IO failures]]>
  386. </doc>
  387. </method>
  388. <method name="getNodeToLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse"
  389. abstract="true" native="false" synchronized="false"
  390. static="false" final="false" visibility="public"
  391. deprecated="not deprecated">
  392. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest"/>
  393. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  394. <exception name="IOException" type="java.io.IOException"/>
  395. <doc>
  396. <![CDATA[<p>
  397. The interface used by client to get node to labels mappings in existing cluster
  398. </p>
  399. @param request
  400. @return node to labels mappings
  401. @throws YarnException
  402. @throws IOException]]>
  403. </doc>
  404. </method>
  405. <method name="getLabelsToNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesResponse"
  406. abstract="true" native="false" synchronized="false"
  407. static="false" final="false" visibility="public"
  408. deprecated="not deprecated">
  409. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest"/>
  410. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  411. <exception name="IOException" type="java.io.IOException"/>
  412. <doc>
  413. <![CDATA[<p>
  414. The interface used by client to get labels to nodes mappings
  415. in existing cluster
  416. </p>
  417. @param request
  418. @return labels to nodes mappings
  419. @throws YarnException
  420. @throws IOException]]>
  421. </doc>
  422. </method>
  423. <method name="getClusterNodeLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  424. abstract="true" native="false" synchronized="false"
  425. static="false" final="false" visibility="public"
  426. deprecated="not deprecated">
  427. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"/>
  428. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  429. <exception name="IOException" type="java.io.IOException"/>
  430. <doc>
  431. <![CDATA[<p>
  432. The interface used by client to get node labels in the cluster
  433. </p>
  434. @param request to get node labels collection of this cluster
  435. @return node labels collection of this cluster
  436. @throws YarnException
  437. @throws IOException]]>
  438. </doc>
  439. </method>
  440. <method name="updateApplicationPriority" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse"
  441. abstract="true" native="false" synchronized="false"
  442. static="false" final="false" visibility="public"
  443. deprecated="not deprecated">
  444. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest"/>
  445. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  446. <exception name="IOException" type="java.io.IOException"/>
  447. <doc>
  448. <![CDATA[<p>
  449. The interface used by client to set priority of an application.
  450. </p>
  451. @param request to set priority of an application
  452. @return an empty response
  453. @throws YarnException
  454. @throws IOException]]>
  455. </doc>
  456. </method>
  457. <method name="signalToContainer" return="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse"
  458. abstract="true" native="false" synchronized="false"
  459. static="false" final="false" visibility="public"
  460. deprecated="not deprecated">
  461. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest"/>
  462. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  463. <exception name="IOException" type="java.io.IOException"/>
  464. <doc>
  465. <![CDATA[<p>The interface used by clients to request the
  466. <code>ResourceManager</code> to signal a container. For example,
  467. the client can send command OUTPUT_THREAD_DUMP to dump threads of the
  468. container.</p>
  469. <p>The client, via {@link SignalContainerRequest} provides the
  470. id of the container and the signal command. </p>
  471. <p> In secure mode,the <code>ResourceManager</code> verifies access to the
  472. application before signaling the container.
  473. The user needs to have <code>MODIFY_APP</code> permission.</p>
  474. <p>Currently, the <code>ResourceManager</code> returns an empty response
  475. on success and throws an exception on rejecting the request.</p>
  476. @param request request to signal a container
  477. @return <code>ResourceManager</code> returns an empty response
  478. on success and throws an exception on rejecting the request
  479. @throws YarnException
  480. @throws IOException]]>
  481. </doc>
  482. </method>
  483. <method name="updateApplicationTimeouts" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse"
  484. abstract="true" native="false" synchronized="false"
  485. static="false" final="false" visibility="public"
  486. deprecated="not deprecated">
  487. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest"/>
  488. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  489. <exception name="IOException" type="java.io.IOException"/>
  490. <doc>
  491. <![CDATA[<p>
  492. The interface used by client to set ApplicationTimeouts of an application.
  493. The UpdateApplicationTimeoutsRequest should have timeout value with
  494. absolute time with ISO8601 format <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.
  495. </p>
  496. <b>Note:</b> If application timeout value is less than or equal to current
  497. time then update application throws YarnException.
  498. @param request to set ApplicationTimeouts of an application
  499. @return a response with updated timeouts.
  500. @throws YarnException if update request has empty values or application is
  501. in completing states.
  502. @throws IOException on IO failures]]>
  503. </doc>
  504. </method>
  505. <method name="getResourceProfiles" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesResponse"
  506. abstract="true" native="false" synchronized="false"
  507. static="false" final="false" visibility="public"
  508. deprecated="not deprecated">
  509. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesRequest"/>
  510. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  511. <exception name="IOException" type="java.io.IOException"/>
  512. <doc>
  513. <![CDATA[<p>
  514. The interface used by clients to get all the resource profiles that are
  515. available on the ResourceManager.
  516. </p>
  517. @param request request to get all the resource profiles
  518. @return Response containing a map of the profile name to Resource
  519. capabilities
  520. @throws YARNFeatureNotEnabledException if resource-profile is disabled
  521. @throws YarnException if any error happens inside YARN
  522. @throws IOException in case of other errors]]>
  523. </doc>
  524. </method>
  525. <method name="getResourceProfile" return="org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileResponse"
  526. abstract="true" native="false" synchronized="false"
  527. static="false" final="false" visibility="public"
  528. deprecated="not deprecated">
  529. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileRequest"/>
  530. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  531. <exception name="IOException" type="java.io.IOException"/>
  532. <doc>
  533. <![CDATA[<p>
  534. The interface to get the details for a specific resource profile.
  535. </p>
  536. @param request request to get the details of a resource profile
  537. @return Response containing the details for a particular resource profile
  538. @throws YARNFeatureNotEnabledException if resource-profile is disabled
  539. @throws YarnException if any error happens inside YARN
  540. @throws IOException in case of other errors]]>
  541. </doc>
  542. </method>
  543. <method name="getResourceTypeInfo" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse"
  544. abstract="true" native="false" synchronized="false"
  545. static="false" final="false" visibility="public"
  546. deprecated="not deprecated">
  547. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest"/>
  548. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  549. <exception name="IOException" type="java.io.IOException"/>
  550. <doc>
  551. <![CDATA[<p>
  552. The interface to get the details for a specific resource profile.
  553. </p>
  554. @param request request to get the details of a resource profile
  555. @return Response containing the details for a particular resource profile
  556. @throws YarnException if any error happens inside YARN
  557. @throws IOException in case of other errors]]>
  558. </doc>
  559. </method>
  560. <method name="getAttributesToNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesResponse"
  561. abstract="true" native="false" synchronized="false"
  562. static="false" final="false" visibility="public"
  563. deprecated="not deprecated">
  564. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesRequest"/>
  565. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  566. <exception name="IOException" type="java.io.IOException"/>
  567. <doc>
  568. <![CDATA[<p>
  569. The interface used by client to get attributes to nodes mappings
  570. available in ResourceManager.
  571. </p>
  572. @param request request to get details of attributes to nodes mapping.
  573. @return Response containing the details of attributes to nodes mappings.
  574. @throws YarnException if any error happens inside YARN
  575. @throws IOException incase of other errors]]>
  576. </doc>
  577. </method>
  578. <method name="getClusterNodeAttributes" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesResponse"
  579. abstract="true" native="false" synchronized="false"
  580. static="false" final="false" visibility="public"
  581. deprecated="not deprecated">
  582. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesRequest"/>
  583. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  584. <exception name="IOException" type="java.io.IOException"/>
  585. <doc>
  586. <![CDATA[<p>
  587. The interface used by client to get node attributes available in
  588. ResourceManager.
  589. </p>
  590. @param request request to get node attributes collection of this cluster.
  591. @return Response containing node attributes collection.
  592. @throws YarnException if any error happens inside YARN.
  593. @throws IOException incase of other errors.]]>
  594. </doc>
  595. </method>
  596. <method name="getNodesToAttributes" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesResponse"
  597. abstract="true" native="false" synchronized="false"
  598. static="false" final="false" visibility="public"
  599. deprecated="not deprecated">
  600. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesRequest"/>
  601. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  602. <exception name="IOException" type="java.io.IOException"/>
  603. <doc>
  604. <![CDATA[<p>
  605. The interface used by client to get node to attributes mappings.
  606. in existing cluster.
  607. </p>
  608. @param request request to get nodes to attributes mapping.
  609. @return nodes to attributes mappings.
  610. @throws YarnException if any error happens inside YARN.
  611. @throws IOException]]>
  612. </doc>
  613. </method>
  614. <doc>
  615. <![CDATA[<p>The protocol between clients and the <code>ResourceManager</code>
  616. to submit/abort jobs and to get information on applications, cluster metrics,
  617. nodes, queues and ACLs.</p>]]>
  618. </doc>
  619. </interface>
  620. <!-- end interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
  621. <!-- start interface org.apache.hadoop.yarn.api.ApplicationConstants -->
  622. <interface name="ApplicationConstants" abstract="true"
  623. static="false" final="false" visibility="public"
  624. deprecated="not deprecated">
  625. <field name="APP_SUBMIT_TIME_ENV" type="java.lang.String"
  626. transient="false" volatile="false"
  627. static="true" final="true" visibility="public"
  628. deprecated="not deprecated">
  629. <doc>
  630. <![CDATA[The environment variable for APP_SUBMIT_TIME. Set in AppMaster environment
  631. only]]>
  632. </doc>
  633. </field>
  634. <field name="CONTAINER_TOKEN_FILE_ENV_NAME" type="java.lang.String"
  635. transient="false" volatile="false"
  636. static="true" final="true" visibility="public"
  637. deprecated="not deprecated">
  638. <doc>
  639. <![CDATA[The cache file into which container token is written]]>
  640. </doc>
  641. </field>
  642. <field name="APPLICATION_WEB_PROXY_BASE_ENV" type="java.lang.String"
  643. transient="false" volatile="false"
  644. static="true" final="true" visibility="public"
  645. deprecated="not deprecated">
  646. <doc>
  647. <![CDATA[The environmental variable for APPLICATION_WEB_PROXY_BASE. Set in
  648. ApplicationMaster's environment only. This states that for all non-relative
  649. web URLs in the app masters web UI what base should they have.]]>
  650. </doc>
  651. </field>
  652. <field name="LOG_DIR_EXPANSION_VAR" type="java.lang.String"
  653. transient="false" volatile="false"
  654. static="true" final="true" visibility="public"
  655. deprecated="not deprecated">
  656. <doc>
  657. <![CDATA[The temporary environmental variable for container log directory. This
  658. should be replaced by real container log directory on container launch.]]>
  659. </doc>
  660. </field>
  661. <field name="CLASS_PATH_SEPARATOR" type="java.lang.String"
  662. transient="false" volatile="false"
  663. static="true" final="true" visibility="public"
  664. deprecated="not deprecated">
  665. <doc>
  666. <![CDATA[This constant is used to construct class path and it will be replaced with
  667. real class path separator(':' for Linux and ';' for Windows) by
  668. NodeManager on container launch. User has to use this constant to construct
  669. class path if user wants cross-platform practice i.e. submit an application
  670. from a Windows client to a Linux/Unix server or vice versa.]]>
  671. </doc>
  672. </field>
  673. <field name="PARAMETER_EXPANSION_LEFT" type="java.lang.String"
  674. transient="false" volatile="false"
  675. static="true" final="true" visibility="public"
  676. deprecated="not deprecated">
  677. <doc>
  678. <![CDATA[The following two constants are used to expand parameter and it will be
  679. replaced with real parameter expansion marker ('%' for Windows and '$' for
  680. Linux) by NodeManager on container launch. For example: {{VAR}} will be
  681. replaced as $VAR on Linux, and %VAR% on Windows. User has to use this
  682. constant to construct class path if user wants cross-platform practice i.e.
  683. submit an application from a Windows client to a Linux/Unix server or vice
  684. versa.]]>
  685. </doc>
  686. </field>
  687. <field name="PARAMETER_EXPANSION_RIGHT" type="java.lang.String"
  688. transient="false" volatile="false"
  689. static="true" final="true" visibility="public"
  690. deprecated="not deprecated">
  691. <doc>
  692. <![CDATA[User has to use this constant to construct class path if user wants
  693. cross-platform practice i.e. submit an application from a Windows client to
  694. a Linux/Unix server or vice versa.]]>
  695. </doc>
  696. </field>
  697. <field name="STDERR" type="java.lang.String"
  698. transient="false" volatile="false"
  699. static="true" final="true" visibility="public"
  700. deprecated="not deprecated">
  701. </field>
  702. <field name="STDOUT" type="java.lang.String"
  703. transient="false" volatile="false"
  704. static="true" final="true" visibility="public"
  705. deprecated="not deprecated">
  706. </field>
  707. <doc>
  708. <![CDATA[This is the API for the applications comprising of constants that YARN sets
  709. up for the applications and the containers.
  710. TODO: Investigate the semantics and security of each cross-boundary refs.]]>
  711. </doc>
  712. </interface>
  713. <!-- end interface org.apache.hadoop.yarn.api.ApplicationConstants -->
  714. <!-- start class org.apache.hadoop.yarn.api.ApplicationConstants.ContainerLaunchType -->
  715. <class name="ApplicationConstants.ContainerLaunchType" extends="java.lang.Enum"
  716. abstract="false"
  717. static="true" final="true" visibility="public"
  718. deprecated="not deprecated">
  719. <method name="values" return="org.apache.hadoop.yarn.api.ApplicationConstants.ContainerLaunchType[]"
  720. abstract="false" native="false" synchronized="false"
  721. static="true" final="false" visibility="public"
  722. deprecated="not deprecated">
  723. </method>
  724. <method name="valueOf" return="org.apache.hadoop.yarn.api.ApplicationConstants.ContainerLaunchType"
  725. abstract="false" native="false" synchronized="false"
  726. static="true" final="false" visibility="public"
  727. deprecated="not deprecated">
  728. <param name="name" type="java.lang.String"/>
  729. </method>
  730. <doc>
  731. <![CDATA[The type of launch for the container.]]>
  732. </doc>
  733. </class>
  734. <!-- end class org.apache.hadoop.yarn.api.ApplicationConstants.ContainerLaunchType -->
  735. <!-- start interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
  736. <interface name="ApplicationHistoryProtocol" abstract="true"
  737. static="false" final="false" visibility="public"
  738. deprecated="not deprecated">
  739. <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
  740. <doc>
  741. <![CDATA[<p>
  742. The protocol between clients and the <code>ApplicationHistoryServer</code> to
  743. get the information of completed applications etc.
  744. </p>]]>
  745. </doc>
  746. </interface>
  747. <!-- end interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
  748. <!-- start interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
  749. <interface name="ApplicationMasterProtocol" abstract="true"
  750. static="false" final="false" visibility="public"
  751. deprecated="not deprecated">
  752. <method name="registerApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse"
  753. abstract="true" native="false" synchronized="false"
  754. static="false" final="false" visibility="public"
  755. deprecated="not deprecated">
  756. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"/>
  757. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  758. <exception name="IOException" type="java.io.IOException"/>
  759. <doc>
  760. <![CDATA[<p>
  761. The interface used by a new <code>ApplicationMaster</code> to register with
  762. the <code>ResourceManager</code>.
  763. </p>
  764. <p>
  765. The <code>ApplicationMaster</code> needs to provide details such as RPC
  766. Port, HTTP tracking url etc. as specified in
  767. {@link RegisterApplicationMasterRequest}.
  768. </p>
  769. <p>
  770. The <code>ResourceManager</code> responds with critical details such as
  771. maximum resource capabilities in the cluster as specified in
  772. {@link RegisterApplicationMasterResponse}.
  773. </p>
  774. <p>
  775. Re-register is only allowed for <code>Unmanaged Application Master</code>
  776. (UAM) HA, with
  777. {@link org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext#getKeepContainersAcrossApplicationAttempts()}
  778. set to true.
  779. </p>
  780. @param request registration request
  781. @return registration respose
  782. @throws YarnException
  783. @throws IOException
  784. @throws InvalidApplicationMasterRequestException The exception is thrown
  785. when an ApplicationMaster tries to register more then once.
  786. @see RegisterApplicationMasterRequest
  787. @see RegisterApplicationMasterResponse]]>
  788. </doc>
  789. </method>
  790. <method name="finishApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse"
  791. abstract="true" native="false" synchronized="false"
  792. static="false" final="false" visibility="public"
  793. deprecated="not deprecated">
  794. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"/>
  795. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  796. <exception name="IOException" type="java.io.IOException"/>
  797. <doc>
  798. <![CDATA[<p>The interface used by an <code>ApplicationMaster</code> to notify the
  799. <code>ResourceManager</code> about its completion (success or failed).</p>
  800. <p>The <code>ApplicationMaster</code> has to provide details such as
  801. final state, diagnostics (in case of failures) etc. as specified in
  802. {@link FinishApplicationMasterRequest}.</p>
  803. <p>The <code>ResourceManager</code> responds with
  804. {@link FinishApplicationMasterResponse}.</p>
  805. @param request completion request
  806. @return completion response
  807. @throws YarnException
  808. @throws IOException
  809. @see FinishApplicationMasterRequest
  810. @see FinishApplicationMasterResponse]]>
  811. </doc>
  812. </method>
  813. <method name="allocate" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  814. abstract="true" native="false" synchronized="false"
  815. static="false" final="false" visibility="public"
  816. deprecated="not deprecated">
  817. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"/>
  818. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  819. <exception name="IOException" type="java.io.IOException"/>
  820. <doc>
  821. <![CDATA[<p>
  822. The main interface between an <code>ApplicationMaster</code> and the
  823. <code>ResourceManager</code>.
  824. </p>
  825. <p>
  826. The <code>ApplicationMaster</code> uses this interface to provide a list of
  827. {@link ResourceRequest} and returns unused {@link Container} allocated to
  828. it via {@link AllocateRequest}. Optionally, the
  829. <code>ApplicationMaster</code> can also <em>blacklist</em> resources which
  830. it doesn't want to use.
  831. </p>
  832. <p>
  833. This also doubles up as a <em>heartbeat</em> to let the
  834. <code>ResourceManager</code> know that the <code>ApplicationMaster</code>
  835. is alive. Thus, applications should periodically make this call to be kept
  836. alive. The frequency depends on
  837. {@link YarnConfiguration#RM_AM_EXPIRY_INTERVAL_MS} which defaults to
  838. {@link YarnConfiguration#DEFAULT_RM_AM_EXPIRY_INTERVAL_MS}.
  839. </p>
  840. <p>
  841. The <code>ResourceManager</code> responds with list of allocated
  842. {@link Container}, status of completed containers and headroom information
  843. for the application.
  844. </p>
  845. <p>
  846. The <code>ApplicationMaster</code> can use the available headroom
  847. (resources) to decide how to utilized allocated resources and make informed
  848. decisions about future resource requests.
  849. </p>
  850. @param request
  851. allocation request
  852. @return allocation response
  853. @throws YarnException
  854. @throws IOException
  855. @throws InvalidApplicationMasterRequestException
  856. This exception is thrown when an ApplicationMaster calls allocate
  857. without registering first.
  858. @throws InvalidResourceBlacklistRequestException
  859. This exception is thrown when an application provides an invalid
  860. specification for blacklist of resources.
  861. @throws InvalidResourceRequestException
  862. This exception is thrown when a {@link ResourceRequest} is out of
  863. the range of the configured lower and upper limits on the
  864. resources.
  865. @see AllocateRequest
  866. @see AllocateResponse]]>
  867. </doc>
  868. </method>
  869. <doc>
  870. <![CDATA[<p>The protocol between a live instance of <code>ApplicationMaster</code>
  871. and the <code>ResourceManager</code>.</p>
  872. <p>This is used by the <code>ApplicationMaster</code> to register/unregister
  873. and to request and obtain resources in the cluster from the
  874. <code>ResourceManager</code>.</p>]]>
  875. </doc>
  876. </interface>
  877. <!-- end interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
  878. <!-- start interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
  879. <interface name="ClientSCMProtocol" abstract="true"
  880. static="false" final="false" visibility="public"
  881. deprecated="not deprecated">
  882. <method name="use" return="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse"
  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.UseSharedCacheResourceRequest"/>
  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 interface used by clients to claim a resource with the
  892. <code>SharedCacheManager.</code> The client uses a checksum to identify the
  893. resource and an {@link ApplicationId} to identify which application will be
  894. using the resource.
  895. </p>
  896. <p>
  897. The <code>SharedCacheManager</code> responds with whether or not the
  898. resource exists in the cache. If the resource exists, a <code>Path</code>
  899. to the resource in the shared cache is returned. If the resource does not
  900. exist, the response is empty.
  901. </p>
  902. @param request request to claim a resource in the shared cache
  903. @return response indicating if the resource is already in the cache
  904. @throws YarnException
  905. @throws IOException]]>
  906. </doc>
  907. </method>
  908. <method name="release" return="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse"
  909. abstract="true" native="false" synchronized="false"
  910. static="false" final="false" visibility="public"
  911. deprecated="not deprecated">
  912. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest"/>
  913. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  914. <exception name="IOException" type="java.io.IOException"/>
  915. <doc>
  916. <![CDATA[<p>
  917. The interface used by clients to release a resource with the
  918. <code>SharedCacheManager.</code> This method is called once an application
  919. is no longer using a claimed resource in the shared cache. The client uses
  920. a checksum to identify the resource and an {@link ApplicationId} to
  921. identify which application is releasing the resource.
  922. </p>
  923. <p>
  924. Note: This method is an optimization and the client is not required to call
  925. it for correctness.
  926. </p>
  927. <p>
  928. Currently the <code>SharedCacheManager</code> sends an empty response.
  929. </p>
  930. @param request request to release a resource in the shared cache
  931. @return (empty) response on releasing the resource
  932. @throws YarnException
  933. @throws IOException]]>
  934. </doc>
  935. </method>
  936. <doc>
  937. <![CDATA[<p>
  938. The protocol between clients and the <code>SharedCacheManager</code> to claim
  939. and release resources in the shared cache.
  940. </p>]]>
  941. </doc>
  942. </interface>
  943. <!-- end interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
  944. <!-- start interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
  945. <interface name="ContainerManagementProtocol" abstract="true"
  946. static="false" final="false" visibility="public"
  947. deprecated="not deprecated">
  948. <method name="startContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse"
  949. abstract="true" native="false" synchronized="false"
  950. static="false" final="false" visibility="public"
  951. deprecated="not deprecated">
  952. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"/>
  953. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  954. <exception name="IOException" type="java.io.IOException"/>
  955. <doc>
  956. <![CDATA[<p>
  957. The <code>ApplicationMaster</code> provides a list of
  958. {@link StartContainerRequest}s to a <code>NodeManager</code> to
  959. <em>start</em> {@link Container}s allocated to it using this interface.
  960. </p>
  961. <p>
  962. The <code>ApplicationMaster</code> has to provide details such as allocated
  963. resource capability, security tokens (if enabled), command to be executed
  964. to start the container, environment for the process, necessary
  965. binaries/jar/shared-objects etc. via the {@link ContainerLaunchContext} in
  966. the {@link StartContainerRequest}.
  967. </p>
  968. <p>
  969. The <code>NodeManager</code> sends a response via
  970. {@link StartContainersResponse} which includes a list of
  971. {@link Container}s of successfully launched {@link Container}s, a
  972. containerId-to-exception map for each failed {@link StartContainerRequest} in
  973. which the exception indicates errors from per container and a
  974. allServicesMetaData map between the names of auxiliary services and their
  975. corresponding meta-data. Note: None-container-specific exceptions will
  976. still be thrown by the API method itself.
  977. </p>
  978. <p>
  979. The <code>ApplicationMaster</code> can use
  980. {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
  981. statuses of the to-be-launched or launched containers.
  982. </p>
  983. @param request
  984. request to start a list of containers
  985. @return response including conatinerIds of all successfully launched
  986. containers, a containerId-to-exception map for failed requests and
  987. a allServicesMetaData map.
  988. @throws YarnException
  989. @throws IOException]]>
  990. </doc>
  991. </method>
  992. <method name="stopContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse"
  993. abstract="true" native="false" synchronized="false"
  994. static="false" final="false" visibility="public"
  995. deprecated="not deprecated">
  996. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"/>
  997. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  998. <exception name="IOException" type="java.io.IOException"/>
  999. <doc>
  1000. <![CDATA[<p>
  1001. The <code>ApplicationMaster</code> requests a <code>NodeManager</code> to
  1002. <em>stop</em> a list of {@link Container}s allocated to it using this
  1003. interface.
  1004. </p>
  1005. <p>
  1006. The <code>ApplicationMaster</code> sends a {@link StopContainersRequest}
  1007. which includes the {@link ContainerId}s of the containers to be stopped.
  1008. </p>
  1009. <p>
  1010. The <code>NodeManager</code> sends a response via
  1011. {@link StopContainersResponse} which includes a list of {@link ContainerId}
  1012. s of successfully stopped containers, a containerId-to-exception map for
  1013. each failed request in which the exception indicates errors from per
  1014. container. Note: None-container-specific exceptions will still be thrown by
  1015. the API method itself. <code>ApplicationMaster</code> can use
  1016. {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
  1017. statuses of the containers.
  1018. </p>
  1019. @param request
  1020. request to stop a list of containers
  1021. @return response which includes a list of containerIds of successfully
  1022. stopped containers, a containerId-to-exception map for failed
  1023. requests.
  1024. @throws YarnException
  1025. @throws IOException]]>
  1026. </doc>
  1027. </method>
  1028. <method name="getContainerStatuses" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse"
  1029. abstract="true" native="false" synchronized="false"
  1030. static="false" final="false" visibility="public"
  1031. deprecated="not deprecated">
  1032. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"/>
  1033. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1034. <exception name="IOException" type="java.io.IOException"/>
  1035. <doc>
  1036. <![CDATA[<p>
  1037. The API used by the <code>ApplicationMaster</code> to request for current
  1038. statuses of <code>Container</code>s from the <code>NodeManager</code>.
  1039. </p>
  1040. <p>
  1041. The <code>ApplicationMaster</code> sends a
  1042. {@link GetContainerStatusesRequest} which includes the {@link ContainerId}s
  1043. of all containers whose statuses are needed.
  1044. </p>
  1045. <p>
  1046. The <code>NodeManager</code> responds with
  1047. {@link GetContainerStatusesResponse} which includes a list of
  1048. {@link ContainerStatus} of the successfully queried containers and a
  1049. containerId-to-exception map for each failed request in which the exception
  1050. indicates errors from per container. Note: None-container-specific
  1051. exceptions will still be thrown by the API method itself.
  1052. </p>
  1053. @param request
  1054. request to get <code>ContainerStatus</code>es of containers with
  1055. the specified <code>ContainerId</code>s
  1056. @return response containing the list of <code>ContainerStatus</code> of the
  1057. successfully queried containers and a containerId-to-exception map
  1058. for failed requests.
  1059. @throws YarnException
  1060. @throws IOException]]>
  1061. </doc>
  1062. </method>
  1063. <method name="increaseContainersResource" return="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse"
  1064. abstract="true" native="false" synchronized="false"
  1065. static="false" final="false" visibility="public"
  1066. deprecated="not deprecated">
  1067. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest"/>
  1068. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1069. <exception name="IOException" type="java.io.IOException"/>
  1070. <doc>
  1071. <![CDATA[<p>
  1072. The API used by the <code>ApplicationMaster</code> to request for
  1073. resource increase of running containers on the <code>NodeManager</code>.
  1074. </p>
  1075. @param request
  1076. request to increase resource of a list of containers
  1077. @return response which includes a list of containerIds of containers
  1078. whose resource has been successfully increased and a
  1079. containerId-to-exception map for failed requests.
  1080. @throws YarnException
  1081. @throws IOException]]>
  1082. </doc>
  1083. </method>
  1084. <method name="updateContainer" return="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse"
  1085. abstract="true" native="false" synchronized="false"
  1086. static="false" final="false" visibility="public"
  1087. deprecated="not deprecated">
  1088. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest"/>
  1089. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1090. <exception name="IOException" type="java.io.IOException"/>
  1091. <doc>
  1092. <![CDATA[<p>
  1093. The API used by the <code>ApplicationMaster</code> to request for
  1094. resource update of running containers on the <code>NodeManager</code>.
  1095. </p>
  1096. @param request
  1097. request to update resource of a list of containers
  1098. @return response which includes a list of containerIds of containers
  1099. whose resource has been successfully updated and a
  1100. containerId-to-exception map for failed requests.
  1101. @throws YarnException Exception specific to YARN
  1102. @throws IOException IOException thrown from NodeManager]]>
  1103. </doc>
  1104. </method>
  1105. <method name="signalToContainer" return="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse"
  1106. abstract="true" native="false" synchronized="false"
  1107. static="false" final="false" visibility="public"
  1108. deprecated="not deprecated">
  1109. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest"/>
  1110. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1111. <exception name="IOException" type="java.io.IOException"/>
  1112. </method>
  1113. <method name="localize" return="org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationResponse"
  1114. abstract="true" native="false" synchronized="false"
  1115. static="false" final="false" visibility="public"
  1116. deprecated="not deprecated">
  1117. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest"/>
  1118. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1119. <exception name="IOException" type="java.io.IOException"/>
  1120. <doc>
  1121. <![CDATA[Localize resources required by the container.
  1122. Currently, this API only works for running containers.
  1123. @param request Specify the resources to be localized.
  1124. @return Response that the localize request is accepted.
  1125. @throws YarnException Exception specific to YARN
  1126. @throws IOException IOException thrown from the RPC layer.]]>
  1127. </doc>
  1128. </method>
  1129. <method name="reInitializeContainer" return="org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerResponse"
  1130. abstract="true" native="false" synchronized="false"
  1131. static="false" final="false" visibility="public"
  1132. deprecated="not deprecated">
  1133. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest"/>
  1134. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1135. <exception name="IOException" type="java.io.IOException"/>
  1136. <doc>
  1137. <![CDATA[ReInitialize the Container with a new Launch Context.
  1138. @param request Specify the new ContainerLaunchContext.
  1139. @return Response that the ReInitialize request is accepted.
  1140. @throws YarnException Exception specific to YARN.
  1141. @throws IOException IOException thrown from the RPC layer.]]>
  1142. </doc>
  1143. </method>
  1144. <method name="restartContainer" return="org.apache.hadoop.yarn.api.protocolrecords.RestartContainerResponse"
  1145. abstract="true" native="false" synchronized="false"
  1146. static="false" final="false" visibility="public"
  1147. deprecated="not deprecated">
  1148. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  1149. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1150. <exception name="IOException" type="java.io.IOException"/>
  1151. <doc>
  1152. <![CDATA[Restart the container.
  1153. @param containerId Container Id.
  1154. @return Response that the restart request is accepted.
  1155. @throws YarnException Exception specific to YARN.
  1156. @throws IOException IOException thrown from the RPC layer.]]>
  1157. </doc>
  1158. </method>
  1159. <method name="rollbackLastReInitialization" return="org.apache.hadoop.yarn.api.protocolrecords.RollbackResponse"
  1160. abstract="true" native="false" synchronized="false"
  1161. static="false" final="false" visibility="public"
  1162. deprecated="not deprecated">
  1163. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  1164. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1165. <exception name="IOException" type="java.io.IOException"/>
  1166. <doc>
  1167. <![CDATA[Rollback the Last ReInitialization if possible.
  1168. @param containerId Container Id.
  1169. @return Response that the rollback request is accepted.
  1170. @throws YarnException Exception specific to YARN.
  1171. @throws IOException IOException thrown from the RPC layer.]]>
  1172. </doc>
  1173. </method>
  1174. <method name="commitLastReInitialization" return="org.apache.hadoop.yarn.api.protocolrecords.CommitResponse"
  1175. abstract="true" native="false" synchronized="false"
  1176. static="false" final="false" visibility="public"
  1177. deprecated="not deprecated">
  1178. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  1179. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1180. <exception name="IOException" type="java.io.IOException"/>
  1181. <doc>
  1182. <![CDATA[Commit the Last ReInitialization if possible. Once the reinitialization
  1183. has been committed, It cannot be rolled back.
  1184. @param containerId Container Id.
  1185. @return Response that the commit request is accepted.
  1186. @throws YarnException Exception specific to YARN.
  1187. @throws IOException IOException thrown from the RPC layer.]]>
  1188. </doc>
  1189. </method>
  1190. <doc>
  1191. <![CDATA[<p>The protocol between an <code>ApplicationMaster</code> and a
  1192. <code>NodeManager</code> to start/stop and increase resource of containers
  1193. and to get status of running containers.</p>
  1194. <p>If security is enabled the <code>NodeManager</code> verifies that the
  1195. <code>ApplicationMaster</code> has truly been allocated the container
  1196. by the <code>ResourceManager</code> and also verifies all interactions such
  1197. as stopping the container or obtaining status information for the container.
  1198. </p>]]>
  1199. </doc>
  1200. </interface>
  1201. <!-- end interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
  1202. </package>
  1203. <package name="org.apache.hadoop.yarn.api.protocolrecords">
  1204. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
  1205. <class name="AllocateRequest" extends="java.lang.Object"
  1206. abstract="true"
  1207. static="false" final="false" visibility="public"
  1208. deprecated="not deprecated">
  1209. <constructor name="AllocateRequest"
  1210. static="false" final="false" visibility="public"
  1211. deprecated="not deprecated">
  1212. </constructor>
  1213. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1214. abstract="false" native="false" synchronized="false"
  1215. static="true" final="false" visibility="public"
  1216. deprecated="not deprecated">
  1217. <param name="responseID" type="int"/>
  1218. <param name="appProgress" type="float"/>
  1219. <param name="resourceAsk" type="java.util.List"/>
  1220. <param name="containersToBeReleased" type="java.util.List"/>
  1221. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1222. </method>
  1223. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1224. abstract="false" native="false" synchronized="false"
  1225. static="true" final="false" visibility="public"
  1226. deprecated="not deprecated">
  1227. <param name="responseID" type="int"/>
  1228. <param name="appProgress" type="float"/>
  1229. <param name="resourceAsk" type="java.util.List"/>
  1230. <param name="containersToBeReleased" type="java.util.List"/>
  1231. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1232. <param name="trackingUrl" type="java.lang.String"/>
  1233. </method>
  1234. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1235. abstract="false" native="false" synchronized="false"
  1236. static="true" final="false" visibility="public"
  1237. deprecated="not deprecated">
  1238. <param name="responseID" type="int"/>
  1239. <param name="appProgress" type="float"/>
  1240. <param name="resourceAsk" type="java.util.List"/>
  1241. <param name="containersToBeReleased" type="java.util.List"/>
  1242. <param name="updateRequests" type="java.util.List"/>
  1243. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1244. </method>
  1245. <method name="getResponseId" return="int"
  1246. abstract="true" native="false" synchronized="false"
  1247. static="false" final="false" visibility="public"
  1248. deprecated="not deprecated">
  1249. <doc>
  1250. <![CDATA[Get the <em>response id</em> used to track duplicate responses.
  1251. @return <em>response id</em>]]>
  1252. </doc>
  1253. </method>
  1254. <method name="setResponseId"
  1255. abstract="true" native="false" synchronized="false"
  1256. static="false" final="false" visibility="public"
  1257. deprecated="not deprecated">
  1258. <param name="id" type="int"/>
  1259. <doc>
  1260. <![CDATA[Set the <em>response id</em> used to track duplicate responses.
  1261. @param id <em>response id</em>]]>
  1262. </doc>
  1263. </method>
  1264. <method name="getProgress" return="float"
  1265. abstract="true" native="false" synchronized="false"
  1266. static="false" final="false" visibility="public"
  1267. deprecated="not deprecated">
  1268. <doc>
  1269. <![CDATA[Get the <em>current progress</em> of application.
  1270. @return <em>current progress</em> of application]]>
  1271. </doc>
  1272. </method>
  1273. <method name="setProgress"
  1274. abstract="true" native="false" synchronized="false"
  1275. static="false" final="false" visibility="public"
  1276. deprecated="not deprecated">
  1277. <param name="progress" type="float"/>
  1278. <doc>
  1279. <![CDATA[Set the <em>current progress</em> of application
  1280. @param progress <em>current progress</em> of application]]>
  1281. </doc>
  1282. </method>
  1283. <method name="getAskList" return="java.util.List"
  1284. abstract="true" native="false" synchronized="false"
  1285. static="false" final="false" visibility="public"
  1286. deprecated="not deprecated">
  1287. <doc>
  1288. <![CDATA[Get the list of <code>ResourceRequest</code> to update the
  1289. <code>ResourceManager</code> about the application's resource requirements.
  1290. @return the list of <code>ResourceRequest</code>
  1291. @see ResourceRequest]]>
  1292. </doc>
  1293. </method>
  1294. <method name="setAskList"
  1295. abstract="true" native="false" synchronized="false"
  1296. static="false" final="false" visibility="public"
  1297. deprecated="not deprecated">
  1298. <param name="resourceRequests" type="java.util.List"/>
  1299. <doc>
  1300. <![CDATA[Set list of <code>ResourceRequest</code> to update the
  1301. <code>ResourceManager</code> about the application's resource requirements.
  1302. @param resourceRequests list of <code>ResourceRequest</code> to update the
  1303. <code>ResourceManager</code> about the application's
  1304. resource requirements
  1305. @see ResourceRequest]]>
  1306. </doc>
  1307. </method>
  1308. <method name="getReleaseList" return="java.util.List"
  1309. abstract="true" native="false" synchronized="false"
  1310. static="false" final="false" visibility="public"
  1311. deprecated="not deprecated">
  1312. <doc>
  1313. <![CDATA[Get the list of <code>ContainerId</code> of containers being
  1314. released by the <code>ApplicationMaster</code>.
  1315. @return list of <code>ContainerId</code> of containers being
  1316. released by the <code>ApplicationMaster</code>]]>
  1317. </doc>
  1318. </method>
  1319. <method name="setReleaseList"
  1320. abstract="true" native="false" synchronized="false"
  1321. static="false" final="false" visibility="public"
  1322. deprecated="not deprecated">
  1323. <param name="releaseContainers" type="java.util.List"/>
  1324. <doc>
  1325. <![CDATA[Set the list of <code>ContainerId</code> of containers being
  1326. released by the <code>ApplicationMaster</code>
  1327. @param releaseContainers list of <code>ContainerId</code> of
  1328. containers being released by the
  1329. <code>ApplicationMaster</code>]]>
  1330. </doc>
  1331. </method>
  1332. <method name="getResourceBlacklistRequest" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
  1333. abstract="true" native="false" synchronized="false"
  1334. static="false" final="false" visibility="public"
  1335. deprecated="not deprecated">
  1336. <doc>
  1337. <![CDATA[Get the <code>ResourceBlacklistRequest</code> being sent by the
  1338. <code>ApplicationMaster</code>.
  1339. @return the <code>ResourceBlacklistRequest</code> being sent by the
  1340. <code>ApplicationMaster</code>
  1341. @see ResourceBlacklistRequest]]>
  1342. </doc>
  1343. </method>
  1344. <method name="setResourceBlacklistRequest"
  1345. abstract="true" native="false" synchronized="false"
  1346. static="false" final="false" visibility="public"
  1347. deprecated="not deprecated">
  1348. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1349. <doc>
  1350. <![CDATA[Set the <code>ResourceBlacklistRequest</code> to inform the
  1351. <code>ResourceManager</code> about the blacklist additions and removals
  1352. per the <code>ApplicationMaster</code>.
  1353. @param resourceBlacklistRequest the <code>ResourceBlacklistRequest</code>
  1354. to inform the <code>ResourceManager</code> about
  1355. the blacklist additions and removals
  1356. per the <code>ApplicationMaster</code>
  1357. @see ResourceBlacklistRequest]]>
  1358. </doc>
  1359. </method>
  1360. <method name="getUpdateRequests" return="java.util.List"
  1361. abstract="true" native="false" synchronized="false"
  1362. static="false" final="false" visibility="public"
  1363. deprecated="not deprecated">
  1364. <doc>
  1365. <![CDATA[Get the list of container update requests being sent by the
  1366. <code>ApplicationMaster</code>.
  1367. @return list of {@link UpdateContainerRequest}
  1368. being sent by the
  1369. <code>ApplicationMaster</code>.]]>
  1370. </doc>
  1371. </method>
  1372. <method name="setUpdateRequests"
  1373. abstract="true" native="false" synchronized="false"
  1374. static="false" final="false" visibility="public"
  1375. deprecated="not deprecated">
  1376. <param name="updateRequests" type="java.util.List"/>
  1377. <doc>
  1378. <![CDATA[Set the list of container update requests to inform the
  1379. <code>ResourceManager</code> about the containers that need to be
  1380. updated.
  1381. @param updateRequests list of <code>UpdateContainerRequest</code> for
  1382. containers to be updated]]>
  1383. </doc>
  1384. </method>
  1385. <method name="getSchedulingRequests" return="java.util.List"
  1386. abstract="false" native="false" synchronized="false"
  1387. static="false" final="false" visibility="public"
  1388. deprecated="not deprecated">
  1389. <doc>
  1390. <![CDATA[Get the list of Scheduling requests being sent by the
  1391. <code>ApplicationMaster</code>.
  1392. @return list of {@link SchedulingRequest} being sent by the
  1393. <code>ApplicationMaster</code>.]]>
  1394. </doc>
  1395. </method>
  1396. <method name="setSchedulingRequests"
  1397. abstract="false" native="false" synchronized="false"
  1398. static="false" final="false" visibility="public"
  1399. deprecated="not deprecated">
  1400. <param name="schedulingRequests" type="java.util.List"/>
  1401. <doc>
  1402. <![CDATA[Set the list of Scheduling requests to inform the
  1403. <code>ResourceManager</code> about the application's resource requirements
  1404. (potentially including allocation tags and placement constraints).
  1405. @param schedulingRequests list of {@link SchedulingRequest} to update
  1406. the <code>ResourceManager</code> about the application's resource
  1407. requirements.]]>
  1408. </doc>
  1409. </method>
  1410. <method name="getTrackingUrl" return="java.lang.String"
  1411. abstract="true" native="false" synchronized="false"
  1412. static="false" final="false" visibility="public"
  1413. deprecated="not deprecated">
  1414. <doc>
  1415. <![CDATA[Get the tracking url update for this heartbeat.
  1416. @return tracking url to update this application with]]>
  1417. </doc>
  1418. </method>
  1419. <method name="setTrackingUrl"
  1420. abstract="true" native="false" synchronized="false"
  1421. static="false" final="false" visibility="public"
  1422. deprecated="not deprecated">
  1423. <param name="trackingUrl" type="java.lang.String"/>
  1424. <doc>
  1425. <![CDATA[Set the new tracking url for this application.
  1426. @param trackingUrl the new tracking url]]>
  1427. </doc>
  1428. </method>
  1429. <method name="newBuilder" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1430. abstract="false" native="false" synchronized="false"
  1431. static="true" final="false" visibility="public"
  1432. deprecated="not deprecated">
  1433. </method>
  1434. <doc>
  1435. <![CDATA[<p>The core request sent by the <code>ApplicationMaster</code> to the
  1436. <code>ResourceManager</code> to obtain resources in the cluster.</p>
  1437. <p>The request includes:
  1438. <ul>
  1439. <li>A response id to track duplicate responses.</li>
  1440. <li>Progress information.</li>
  1441. <li>
  1442. A list of {@link ResourceRequest} to inform the
  1443. <code>ResourceManager</code> about the application's
  1444. resource requirements.
  1445. </li>
  1446. <li>
  1447. A list of unused {@link Container} which are being returned.
  1448. </li>
  1449. <li>
  1450. A list of {@link UpdateContainerRequest} to inform
  1451. the <code>ResourceManager</code> about the change in
  1452. requirements of running containers.
  1453. </li>
  1454. </ul>
  1455. @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
  1456. </doc>
  1457. </class>
  1458. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
  1459. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder -->
  1460. <class name="AllocateRequest.AllocateRequestBuilder" extends="java.lang.Object"
  1461. abstract="false"
  1462. static="true" final="true" visibility="public"
  1463. deprecated="not deprecated">
  1464. <method name="responseId" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1465. abstract="false" native="false" synchronized="false"
  1466. static="false" final="false" visibility="public"
  1467. deprecated="not deprecated">
  1468. <param name="responseId" type="int"/>
  1469. <doc>
  1470. <![CDATA[Set the <code>responseId</code> of the request.
  1471. @see AllocateRequest#setResponseId(int)
  1472. @param responseId <code>responseId</code> of the request
  1473. @return {@link AllocateRequestBuilder}]]>
  1474. </doc>
  1475. </method>
  1476. <method name="progress" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1477. abstract="false" native="false" synchronized="false"
  1478. static="false" final="false" visibility="public"
  1479. deprecated="not deprecated">
  1480. <param name="progress" type="float"/>
  1481. <doc>
  1482. <![CDATA[Set the <code>progress</code> of the request.
  1483. @see AllocateRequest#setProgress(float)
  1484. @param progress <code>progress</code> of the request
  1485. @return {@link AllocateRequestBuilder}]]>
  1486. </doc>
  1487. </method>
  1488. <method name="askList" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1489. abstract="false" native="false" synchronized="false"
  1490. static="false" final="false" visibility="public"
  1491. deprecated="not deprecated">
  1492. <param name="askList" type="java.util.List"/>
  1493. <doc>
  1494. <![CDATA[Set the <code>askList</code> of the request.
  1495. @see AllocateRequest#setAskList(List)
  1496. @param askList <code>askList</code> of the request
  1497. @return {@link AllocateRequestBuilder}]]>
  1498. </doc>
  1499. </method>
  1500. <method name="releaseList" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1501. abstract="false" native="false" synchronized="false"
  1502. static="false" final="false" visibility="public"
  1503. deprecated="not deprecated">
  1504. <param name="releaseList" type="java.util.List"/>
  1505. <doc>
  1506. <![CDATA[Set the <code>releaseList</code> of the request.
  1507. @see AllocateRequest#setReleaseList(List)
  1508. @param releaseList <code>releaseList</code> of the request
  1509. @return {@link AllocateRequestBuilder}]]>
  1510. </doc>
  1511. </method>
  1512. <method name="resourceBlacklistRequest" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1513. abstract="false" native="false" synchronized="false"
  1514. static="false" final="false" visibility="public"
  1515. deprecated="not deprecated">
  1516. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1517. <doc>
  1518. <![CDATA[Set the <code>resourceBlacklistRequest</code> of the request.
  1519. @see AllocateRequest#setResourceBlacklistRequest(
  1520. ResourceBlacklistRequest)
  1521. @param resourceBlacklistRequest
  1522. <code>resourceBlacklistRequest</code> of the request
  1523. @return {@link AllocateRequestBuilder}]]>
  1524. </doc>
  1525. </method>
  1526. <method name="updateRequests" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1527. abstract="false" native="false" synchronized="false"
  1528. static="false" final="false" visibility="public"
  1529. deprecated="not deprecated">
  1530. <param name="updateRequests" type="java.util.List"/>
  1531. <doc>
  1532. <![CDATA[Set the <code>updateRequests</code> of the request.
  1533. @see AllocateRequest#setUpdateRequests(List)
  1534. @param updateRequests <code>updateRequests</code> of the request
  1535. @return {@link AllocateRequestBuilder}]]>
  1536. </doc>
  1537. </method>
  1538. <method name="schedulingRequests" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1539. abstract="false" native="false" synchronized="false"
  1540. static="false" final="false" visibility="public"
  1541. deprecated="not deprecated">
  1542. <param name="schedulingRequests" type="java.util.List"/>
  1543. <doc>
  1544. <![CDATA[Set the <code>schedulingRequests</code> of the request.
  1545. @see AllocateRequest#setSchedulingRequests(List)
  1546. @param schedulingRequests <code>SchedulingRequest</code> of the request
  1547. @return {@link AllocateRequestBuilder}]]>
  1548. </doc>
  1549. </method>
  1550. <method name="trackingUrl" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1551. abstract="false" native="false" synchronized="false"
  1552. static="false" final="false" visibility="public"
  1553. deprecated="not deprecated">
  1554. <param name="trackingUrl" type="java.lang.String"/>
  1555. <doc>
  1556. <![CDATA[Set the <code>trackingUrl</code> of the request.
  1557. @see AllocateRequest#setTrackingUrl(String)
  1558. @param trackingUrl new tracking url
  1559. @return {@link AllocateRequestBuilder}]]>
  1560. </doc>
  1561. </method>
  1562. <method name="build" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1563. abstract="false" native="false" synchronized="false"
  1564. static="false" final="false" visibility="public"
  1565. deprecated="not deprecated">
  1566. <doc>
  1567. <![CDATA[Return generated {@link AllocateRequest} object.
  1568. @return {@link AllocateRequest}]]>
  1569. </doc>
  1570. </method>
  1571. <doc>
  1572. <![CDATA[Class to construct instances of {@link AllocateRequest} with specific
  1573. options.]]>
  1574. </doc>
  1575. </class>
  1576. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder -->
  1577. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
  1578. <class name="AllocateResponse" extends="java.lang.Object"
  1579. abstract="true"
  1580. static="false" final="false" visibility="public"
  1581. deprecated="not deprecated">
  1582. <constructor name="AllocateResponse"
  1583. static="false" final="false" visibility="public"
  1584. deprecated="not deprecated">
  1585. </constructor>
  1586. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1587. abstract="false" native="false" synchronized="false"
  1588. static="true" final="false" visibility="public"
  1589. deprecated="not deprecated">
  1590. <param name="responseId" type="int"/>
  1591. <param name="completedContainers" type="java.util.List"/>
  1592. <param name="allocatedContainers" type="java.util.List"/>
  1593. <param name="updatedNodes" type="java.util.List"/>
  1594. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1595. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1596. <param name="numClusterNodes" type="int"/>
  1597. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1598. <param name="nmTokens" type="java.util.List"/>
  1599. </method>
  1600. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1601. abstract="false" native="false" synchronized="false"
  1602. static="true" final="false" visibility="public"
  1603. deprecated="not deprecated">
  1604. <param name="responseId" type="int"/>
  1605. <param name="completedContainers" type="java.util.List"/>
  1606. <param name="allocatedContainers" type="java.util.List"/>
  1607. <param name="updatedNodes" type="java.util.List"/>
  1608. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1609. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1610. <param name="numClusterNodes" type="int"/>
  1611. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1612. <param name="nmTokens" type="java.util.List"/>
  1613. <param name="amRMToken" type="org.apache.hadoop.yarn.api.records.Token"/>
  1614. <param name="updatedContainers" type="java.util.List"/>
  1615. <param name="collectorInfo" type="org.apache.hadoop.yarn.api.records.CollectorInfo"/>
  1616. </method>
  1617. <method name="getAMCommand" return="org.apache.hadoop.yarn.api.records.AMCommand"
  1618. abstract="true" native="false" synchronized="false"
  1619. static="false" final="false" visibility="public"
  1620. deprecated="not deprecated">
  1621. <doc>
  1622. <![CDATA[If the <code>ResourceManager</code> needs the
  1623. <code>ApplicationMaster</code> to take some action then it will send an
  1624. AMCommand to the <code>ApplicationMaster</code>. See <code>AMCommand</code>
  1625. for details on commands and actions for them.
  1626. @return <code>AMCommand</code> if the <code>ApplicationMaster</code> should
  1627. take action, <code>null</code> otherwise
  1628. @see AMCommand]]>
  1629. </doc>
  1630. </method>
  1631. <method name="getResponseId" return="int"
  1632. abstract="true" native="false" synchronized="false"
  1633. static="false" final="false" visibility="public"
  1634. deprecated="not deprecated">
  1635. <doc>
  1636. <![CDATA[Get the <em>last response id</em>.
  1637. @return <em>last response id</em>]]>
  1638. </doc>
  1639. </method>
  1640. <method name="getAllocatedContainers" return="java.util.List"
  1641. abstract="true" native="false" synchronized="false"
  1642. static="false" final="false" visibility="public"
  1643. deprecated="not deprecated">
  1644. <doc>
  1645. <![CDATA[Get the list of <em>newly allocated</em> <code>Container</code> by the
  1646. <code>ResourceManager</code>.
  1647. @return list of <em>newly allocated</em> <code>Container</code>]]>
  1648. </doc>
  1649. </method>
  1650. <method name="getAvailableResources" return="org.apache.hadoop.yarn.api.records.Resource"
  1651. abstract="true" native="false" synchronized="false"
  1652. static="false" final="false" visibility="public"
  1653. deprecated="not deprecated">
  1654. <doc>
  1655. <![CDATA[Get the <em>available headroom</em> for resources in the cluster for the
  1656. application.
  1657. @return limit of available headroom for resources in the cluster for the
  1658. application]]>
  1659. </doc>
  1660. </method>
  1661. <method name="getCompletedContainersStatuses" return="java.util.List"
  1662. abstract="true" native="false" synchronized="false"
  1663. static="false" final="false" visibility="public"
  1664. deprecated="not deprecated">
  1665. <doc>
  1666. <![CDATA[Get the list of <em>completed containers' statuses</em>.
  1667. @return the list of <em>completed containers' statuses</em>]]>
  1668. </doc>
  1669. </method>
  1670. <method name="getUpdatedNodes" return="java.util.List"
  1671. abstract="true" native="false" synchronized="false"
  1672. static="false" final="false" visibility="public"
  1673. deprecated="not deprecated">
  1674. <doc>
  1675. <![CDATA[Get the list of <em>updated <code>NodeReport</code>s</em>. Updates could
  1676. be changes in health, availability etc of the nodes.
  1677. @return The delta of updated nodes since the last response]]>
  1678. </doc>
  1679. </method>
  1680. <method name="getNumClusterNodes" return="int"
  1681. abstract="true" native="false" synchronized="false"
  1682. static="false" final="false" visibility="public"
  1683. deprecated="not deprecated">
  1684. <doc>
  1685. <![CDATA[Get the number of hosts available on the cluster.
  1686. @return the available host count.]]>
  1687. </doc>
  1688. </method>
  1689. <method name="getPreemptionMessage" return="org.apache.hadoop.yarn.api.records.PreemptionMessage"
  1690. abstract="true" native="false" synchronized="false"
  1691. static="false" final="false" visibility="public"
  1692. deprecated="not deprecated">
  1693. <doc>
  1694. <![CDATA[Get the description of containers owned by the AM, but requested back by
  1695. the cluster. Note that the RM may have an inconsistent view of the
  1696. resources owned by the AM. These messages are advisory, and the AM may
  1697. elect to ignore them.
  1698. <p>
  1699. The message is a snapshot of the resources the RM wants back from the AM.
  1700. While demand persists, the RM will repeat its request; applications should
  1701. not interpret each message as a request for <em>additional</em>
  1702. resources on top of previous messages. Resources requested consistently
  1703. over some duration may be forcibly killed by the RM.
  1704. @return A specification of the resources to reclaim from this AM.]]>
  1705. </doc>
  1706. </method>
  1707. <method name="getNMTokens" return="java.util.List"
  1708. abstract="true" native="false" synchronized="false"
  1709. static="false" final="false" visibility="public"
  1710. deprecated="not deprecated">
  1711. <doc>
  1712. <![CDATA[Get the list of NMTokens required for communicating with NM. New NMTokens
  1713. issued only if
  1714. <p>
  1715. 1) AM is receiving first container on underlying NodeManager.<br>
  1716. OR<br>
  1717. 2) NMToken master key rolled over in ResourceManager and AM is getting new
  1718. container on the same underlying NodeManager.
  1719. <p>
  1720. AM will receive one NMToken per NM irrespective of the number of containers
  1721. issued on same NM. AM is expected to store these tokens until issued a
  1722. new token for the same NM.
  1723. @return list of NMTokens required for communicating with NM]]>
  1724. </doc>
  1725. </method>
  1726. <method name="getUpdatedContainers" return="java.util.List"
  1727. abstract="true" native="false" synchronized="false"
  1728. static="false" final="false" visibility="public"
  1729. deprecated="not deprecated">
  1730. <doc>
  1731. <![CDATA[Get the list of newly updated containers by
  1732. <code>ResourceManager</code>.
  1733. @return list of newly increased containers]]>
  1734. </doc>
  1735. </method>
  1736. <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
  1737. abstract="true" native="false" synchronized="false"
  1738. static="false" final="false" visibility="public"
  1739. deprecated="not deprecated">
  1740. <doc>
  1741. <![CDATA[The AMRMToken that belong to this attempt
  1742. @return The AMRMToken that belong to this attempt]]>
  1743. </doc>
  1744. </method>
  1745. <method name="getApplicationPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  1746. abstract="true" native="false" synchronized="false"
  1747. static="false" final="false" visibility="public"
  1748. deprecated="not deprecated">
  1749. <doc>
  1750. <![CDATA[Priority of the application
  1751. @return get application priority]]>
  1752. </doc>
  1753. </method>
  1754. <method name="getCollectorInfo" return="org.apache.hadoop.yarn.api.records.CollectorInfo"
  1755. abstract="true" native="false" synchronized="false"
  1756. static="false" final="false" visibility="public"
  1757. deprecated="not deprecated">
  1758. <doc>
  1759. <![CDATA[The data associated with the collector that belongs to this app. Contains
  1760. address and token alongwith identification information.
  1761. @return The data of collector that belong to this attempt]]>
  1762. </doc>
  1763. </method>
  1764. <method name="getUpdateErrors" return="java.util.List"
  1765. abstract="false" native="false" synchronized="false"
  1766. static="false" final="false" visibility="public"
  1767. deprecated="not deprecated">
  1768. <doc>
  1769. <![CDATA[Get the list of container update errors to inform the
  1770. Application Master about the container updates that could not be
  1771. satisfied due to error.
  1772. @return List of Update Container Errors.]]>
  1773. </doc>
  1774. </method>
  1775. <method name="setUpdateErrors"
  1776. abstract="false" native="false" synchronized="false"
  1777. static="false" final="false" visibility="public"
  1778. deprecated="not deprecated">
  1779. <param name="updateErrors" type="java.util.List"/>
  1780. <doc>
  1781. <![CDATA[Set the list of container update errors to inform the
  1782. Application Master about the container updates that could not be
  1783. satisfied due to error.
  1784. @param updateErrors list of <code>UpdateContainerError</code> for
  1785. containers updates requests that were in error]]>
  1786. </doc>
  1787. </method>
  1788. <method name="getContainersFromPreviousAttempts" return="java.util.List"
  1789. abstract="true" native="false" synchronized="false"
  1790. static="false" final="false" visibility="public"
  1791. deprecated="not deprecated">
  1792. <doc>
  1793. <![CDATA[Get the list of running containers as viewed by
  1794. <code>ResourceManager</code> from previous application attempts which
  1795. have not been reported to the Application Master yet.
  1796. <br>
  1797. These containers were recovered by the RM after the application master
  1798. had already registered. This may happen after RM restart when some NMs get
  1799. delayed in connecting to the RM and reporting the active containers.
  1800. Since they were not reported in the registration
  1801. response, they are reported in the response to the AM heartbeat.
  1802. @return the list of running containers as viewed by
  1803. <code>ResourceManager</code> from previous application attempts.]]>
  1804. </doc>
  1805. </method>
  1806. <method name="getRejectedSchedulingRequests" return="java.util.List"
  1807. abstract="false" native="false" synchronized="false"
  1808. static="false" final="false" visibility="public"
  1809. deprecated="not deprecated">
  1810. <doc>
  1811. <![CDATA[Get a list of all SchedulingRequests that the RM has rejected between
  1812. this allocate call and the previous one.
  1813. @return List of RejectedSchedulingRequests.]]>
  1814. </doc>
  1815. </method>
  1816. <doc>
  1817. <![CDATA[The response sent by the <code>ResourceManager</code> the
  1818. <code>ApplicationMaster</code> during resource negotiation.
  1819. <p>
  1820. The response, includes:
  1821. <ul>
  1822. <li>Response ID to track duplicate responses.</li>
  1823. <li>
  1824. An AMCommand sent by ResourceManager to let the
  1825. {@code ApplicationMaster} take some actions (resync, shutdown etc.).
  1826. </li>
  1827. <li>A list of newly allocated {@link Container}.</li>
  1828. <li>A list of completed {@link Container}s' statuses.</li>
  1829. <li>
  1830. The available headroom for resources in the cluster for the
  1831. application.
  1832. </li>
  1833. <li>A list of nodes whose status has been updated.</li>
  1834. <li>The number of available nodes in a cluster.</li>
  1835. <li>A description of resources requested back by the cluster</li>
  1836. <li>AMRMToken, if AMRMToken has been rolled over</li>
  1837. <li>
  1838. A list of {@link Container} representing the containers
  1839. whose resource has been increased.
  1840. </li>
  1841. <li>
  1842. A list of {@link Container} representing the containers
  1843. whose resource has been decreased.
  1844. </li>
  1845. </ul>
  1846. @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
  1847. </doc>
  1848. </class>
  1849. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
  1850. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
  1851. <class name="ApplicationsRequestScope" extends="java.lang.Enum"
  1852. abstract="false"
  1853. static="false" final="true" visibility="public"
  1854. deprecated="not deprecated">
  1855. <method name="values" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope[]"
  1856. abstract="false" native="false" synchronized="false"
  1857. static="true" final="false" visibility="public"
  1858. deprecated="not deprecated">
  1859. </method>
  1860. <method name="valueOf" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"
  1861. abstract="false" native="false" synchronized="false"
  1862. static="true" final="false" visibility="public"
  1863. deprecated="not deprecated">
  1864. <param name="name" type="java.lang.String"/>
  1865. </method>
  1866. <doc>
  1867. <![CDATA[Enumeration that controls the scope of applications fetched]]>
  1868. </doc>
  1869. </class>
  1870. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
  1871. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.CommitResponse -->
  1872. <class name="CommitResponse" extends="java.lang.Object"
  1873. abstract="true"
  1874. static="false" final="false" visibility="public"
  1875. deprecated="not deprecated">
  1876. <constructor name="CommitResponse"
  1877. static="false" final="false" visibility="public"
  1878. deprecated="not deprecated">
  1879. </constructor>
  1880. <doc>
  1881. <![CDATA[Response to Commit Container Request.]]>
  1882. </doc>
  1883. </class>
  1884. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.CommitResponse -->
  1885. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest -->
  1886. <class name="ContainerUpdateRequest" extends="java.lang.Object"
  1887. abstract="true"
  1888. static="false" final="false" visibility="public"
  1889. deprecated="not deprecated">
  1890. <constructor name="ContainerUpdateRequest"
  1891. static="false" final="false" visibility="public"
  1892. deprecated="not deprecated">
  1893. </constructor>
  1894. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest"
  1895. abstract="false" native="false" synchronized="false"
  1896. static="true" final="false" visibility="public"
  1897. deprecated="not deprecated">
  1898. <param name="containersToIncrease" type="java.util.List"/>
  1899. </method>
  1900. <method name="getContainersToUpdate" return="java.util.List"
  1901. abstract="true" native="false" synchronized="false"
  1902. static="false" final="false" visibility="public"
  1903. deprecated="not deprecated">
  1904. <doc>
  1905. <![CDATA[Get a list of container tokens to be used for authorization during
  1906. container resource update.
  1907. <p>
  1908. Note: {@link NMToken} will be used for authenticating communication with
  1909. {@code NodeManager}.
  1910. @return the list of container tokens to be used for authorization during
  1911. container resource update.
  1912. @see NMToken]]>
  1913. </doc>
  1914. </method>
  1915. <method name="setContainersToUpdate"
  1916. abstract="true" native="false" synchronized="false"
  1917. static="false" final="false" visibility="public"
  1918. deprecated="not deprecated">
  1919. <param name="containersToUpdate" type="java.util.List"/>
  1920. <doc>
  1921. <![CDATA[Set container tokens to be used during container resource increase.
  1922. The token is acquired from
  1923. <code>AllocateResponse.getUpdatedContainers</code>.
  1924. The token contains the container id and resource capability required for
  1925. container resource update.
  1926. @param containersToUpdate the list of container tokens to be used
  1927. for container resource increase.]]>
  1928. </doc>
  1929. </method>
  1930. <doc>
  1931. <![CDATA[<p>The request sent by <code>Application Master</code> to the
  1932. <code>Node Manager</code> to change the resource quota of a container.</p>
  1933. @see ContainerManagementProtocol#updateContainer(ContainerUpdateRequest)]]>
  1934. </doc>
  1935. </class>
  1936. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest -->
  1937. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse -->
  1938. <class name="ContainerUpdateResponse" extends="java.lang.Object"
  1939. abstract="true"
  1940. static="false" final="false" visibility="public"
  1941. deprecated="not deprecated">
  1942. <constructor name="ContainerUpdateResponse"
  1943. static="false" final="false" visibility="public"
  1944. deprecated="not deprecated">
  1945. </constructor>
  1946. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse"
  1947. abstract="false" native="false" synchronized="false"
  1948. static="true" final="false" visibility="public"
  1949. deprecated="not deprecated">
  1950. <param name="successfullyUpdatedContainers" type="java.util.List"/>
  1951. <param name="failedRequests" type="java.util.Map"/>
  1952. </method>
  1953. <method name="getSuccessfullyUpdatedContainers" return="java.util.List"
  1954. abstract="true" native="false" synchronized="false"
  1955. static="false" final="false" visibility="public"
  1956. deprecated="not deprecated">
  1957. <doc>
  1958. <![CDATA[Get the list of containerIds of containers whose resource
  1959. have been successfully update.
  1960. @return the list of containerIds of containers whose resource have
  1961. been successfully updated.]]>
  1962. </doc>
  1963. </method>
  1964. <method name="getFailedRequests" return="java.util.Map"
  1965. abstract="true" native="false" synchronized="false"
  1966. static="false" final="false" visibility="public"
  1967. deprecated="not deprecated">
  1968. <doc>
  1969. <![CDATA[Get the containerId-to-exception map in which the exception indicates
  1970. error from each container for failed requests.
  1971. @return map of containerId-to-exception]]>
  1972. </doc>
  1973. </method>
  1974. <doc>
  1975. <![CDATA[<p>
  1976. The response sent by the <code>NodeManager</code> to the
  1977. <code>ApplicationMaster</code> when asked to update container resource.
  1978. </p>
  1979. @see ContainerManagementProtocol#updateContainer(ContainerUpdateRequest)]]>
  1980. </doc>
  1981. </class>
  1982. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse -->
  1983. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest -->
  1984. <class name="FailApplicationAttemptRequest" extends="java.lang.Object"
  1985. abstract="true"
  1986. static="false" final="false" visibility="public"
  1987. deprecated="not deprecated">
  1988. <constructor name="FailApplicationAttemptRequest"
  1989. static="false" final="false" visibility="public"
  1990. deprecated="not deprecated">
  1991. </constructor>
  1992. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest"
  1993. abstract="false" native="false" synchronized="false"
  1994. static="true" final="false" visibility="public"
  1995. deprecated="not deprecated">
  1996. <param name="attemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1997. </method>
  1998. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  1999. abstract="true" native="false" synchronized="false"
  2000. static="false" final="false" visibility="public"
  2001. deprecated="not deprecated">
  2002. <doc>
  2003. <![CDATA[Get the <code>ApplicationAttemptId</code> of the attempt to be failed.
  2004. @return <code>ApplicationAttemptId</code> of the attempt.]]>
  2005. </doc>
  2006. </method>
  2007. <method name="setApplicationAttemptId"
  2008. abstract="true" native="false" synchronized="false"
  2009. static="false" final="false" visibility="public"
  2010. deprecated="not deprecated">
  2011. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2012. </method>
  2013. <doc>
  2014. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  2015. to fail an application attempt.</p>
  2016. <p>The request includes the {@link ApplicationAttemptId} of the attempt to
  2017. be failed.</p>
  2018. @see ApplicationClientProtocol#failApplicationAttempt(FailApplicationAttemptRequest)]]>
  2019. </doc>
  2020. </class>
  2021. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest -->
  2022. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptResponse -->
  2023. <class name="FailApplicationAttemptResponse" extends="java.lang.Object"
  2024. abstract="true"
  2025. static="false" final="false" visibility="public"
  2026. deprecated="not deprecated">
  2027. <constructor name="FailApplicationAttemptResponse"
  2028. static="false" final="false" visibility="public"
  2029. deprecated="not deprecated">
  2030. </constructor>
  2031. <doc>
  2032. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client
  2033. failing an application attempt.</p>
  2034. <p>Currently it's empty.</p>
  2035. @see ApplicationClientProtocol#failApplicationAttempt(FailApplicationAttemptRequest)]]>
  2036. </doc>
  2037. </class>
  2038. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptResponse -->
  2039. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
  2040. <class name="FinishApplicationMasterRequest" extends="java.lang.Object"
  2041. abstract="true"
  2042. static="false" final="false" visibility="public"
  2043. deprecated="not deprecated">
  2044. <constructor name="FinishApplicationMasterRequest"
  2045. static="false" final="false" visibility="public"
  2046. deprecated="not deprecated">
  2047. </constructor>
  2048. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"
  2049. abstract="false" native="false" synchronized="false"
  2050. static="true" final="false" visibility="public"
  2051. deprecated="not deprecated">
  2052. <param name="finalAppStatus" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
  2053. <param name="diagnostics" type="java.lang.String"/>
  2054. <param name="url" type="java.lang.String"/>
  2055. </method>
  2056. <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  2057. abstract="true" native="false" synchronized="false"
  2058. static="false" final="false" visibility="public"
  2059. deprecated="not deprecated">
  2060. <doc>
  2061. <![CDATA[Get <em>final state</em> of the <code>ApplicationMaster</code>.
  2062. @return <em>final state</em> of the <code>ApplicationMaster</code>]]>
  2063. </doc>
  2064. </method>
  2065. <method name="setFinalApplicationStatus"
  2066. abstract="true" native="false" synchronized="false"
  2067. static="false" final="false" visibility="public"
  2068. deprecated="not deprecated">
  2069. <param name="finalState" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
  2070. <doc>
  2071. <![CDATA[Set the <em>final state</em> of the <code>ApplicationMaster</code>
  2072. @param finalState <em>final state</em> of the <code>ApplicationMaster</code>]]>
  2073. </doc>
  2074. </method>
  2075. <method name="getDiagnostics" return="java.lang.String"
  2076. abstract="true" native="false" synchronized="false"
  2077. static="false" final="false" visibility="public"
  2078. deprecated="not deprecated">
  2079. <doc>
  2080. <![CDATA[Get <em>diagnostic information</em> on application failure.
  2081. @return <em>diagnostic information</em> on application failure]]>
  2082. </doc>
  2083. </method>
  2084. <method name="setDiagnostics"
  2085. abstract="true" native="false" synchronized="false"
  2086. static="false" final="false" visibility="public"
  2087. deprecated="not deprecated">
  2088. <param name="diagnostics" type="java.lang.String"/>
  2089. <doc>
  2090. <![CDATA[Set <em>diagnostic information</em> on application failure.
  2091. @param diagnostics <em>diagnostic information</em> on application failure]]>
  2092. </doc>
  2093. </method>
  2094. <method name="getTrackingUrl" return="java.lang.String"
  2095. abstract="true" native="false" synchronized="false"
  2096. static="false" final="false" visibility="public"
  2097. deprecated="not deprecated">
  2098. <doc>
  2099. <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
  2100. This url if contains scheme then that will be used by resource manager
  2101. web application proxy otherwise it will default to http.
  2102. @return <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  2103. </doc>
  2104. </method>
  2105. <method name="setTrackingUrl"
  2106. abstract="true" native="false" synchronized="false"
  2107. static="false" final="false" visibility="public"
  2108. deprecated="not deprecated">
  2109. <param name="url" type="java.lang.String"/>
  2110. <doc>
  2111. <![CDATA[Set the <em>final tracking URL</em>for the <code>ApplicationMaster</code>.
  2112. This is the web-URL to which ResourceManager or web-application proxy will
  2113. redirect client/users once the application is finished and the
  2114. <code>ApplicationMaster</code> is gone.
  2115. <p>
  2116. If the passed url has a scheme then that will be used by the
  2117. ResourceManager and web-application proxy, otherwise the scheme will
  2118. default to http.
  2119. </p>
  2120. <p>
  2121. Empty, null, "N/A" strings are all valid besides a real URL. In case an url
  2122. isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
  2123. <p>
  2124. @param url
  2125. <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  2126. </doc>
  2127. </method>
  2128. <doc>
  2129. <![CDATA[The finalization request sent by the {@code ApplicationMaster} to
  2130. inform the {@code ResourceManager} about its completion.
  2131. <p>
  2132. The final request includes details such:
  2133. <ul>
  2134. <li>Final state of the {@code ApplicationMaster}</li>
  2135. <li>
  2136. Diagnostic information in case of failure of the
  2137. {@code ApplicationMaster}
  2138. </li>
  2139. <li>Tracking URL</li>
  2140. </ul>
  2141. @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
  2142. </doc>
  2143. </class>
  2144. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
  2145. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
  2146. <class name="FinishApplicationMasterResponse" extends="java.lang.Object"
  2147. abstract="true"
  2148. static="false" final="false" visibility="public"
  2149. deprecated="not deprecated">
  2150. <constructor name="FinishApplicationMasterResponse"
  2151. static="false" final="false" visibility="public"
  2152. deprecated="not deprecated">
  2153. </constructor>
  2154. <method name="getIsUnregistered" return="boolean"
  2155. abstract="true" native="false" synchronized="false"
  2156. static="false" final="false" visibility="public"
  2157. deprecated="not deprecated">
  2158. <doc>
  2159. <![CDATA[Get the flag which indicates that the application has successfully
  2160. unregistered with the RM and the application can safely stop.
  2161. @return true if the application has unregistered with the RM,
  2162. false otherwise]]>
  2163. </doc>
  2164. </method>
  2165. <doc>
  2166. <![CDATA[The response sent by the <code>ResourceManager</code> to a
  2167. <code>ApplicationMaster</code> on it's completion.
  2168. <p>
  2169. The response, includes:
  2170. <ul>
  2171. <li>A flag which indicates that the application has successfully unregistered
  2172. with the RM and the application can safely stop.</li>
  2173. </ul>
  2174. <p>
  2175. Note: The flag indicates whether the application has successfully
  2176. unregistered and is safe to stop. The application may stop after the flag is
  2177. true. If the application stops before the flag is true then the RM may retry
  2178. the application.
  2179. @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
  2180. </doc>
  2181. </class>
  2182. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
  2183. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesRequest -->
  2184. <class name="GetAllResourceProfilesRequest" extends="java.lang.Object"
  2185. abstract="true"
  2186. static="false" final="false" visibility="public"
  2187. deprecated="not deprecated">
  2188. <constructor name="GetAllResourceProfilesRequest"
  2189. static="false" final="false" visibility="public"
  2190. deprecated="not deprecated">
  2191. </constructor>
  2192. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesRequest"
  2193. abstract="false" native="false" synchronized="false"
  2194. static="true" final="false" visibility="public"
  2195. deprecated="not deprecated">
  2196. </method>
  2197. <doc>
  2198. <![CDATA[Request class for getting all the resource profiles from the RM.]]>
  2199. </doc>
  2200. </class>
  2201. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesRequest -->
  2202. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesResponse -->
  2203. <class name="GetAllResourceProfilesResponse" extends="java.lang.Object"
  2204. abstract="true"
  2205. static="false" final="false" visibility="public"
  2206. deprecated="not deprecated">
  2207. <constructor name="GetAllResourceProfilesResponse"
  2208. static="false" final="false" visibility="public"
  2209. deprecated="not deprecated">
  2210. </constructor>
  2211. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesResponse"
  2212. abstract="false" native="false" synchronized="false"
  2213. static="true" final="false" visibility="public"
  2214. deprecated="not deprecated">
  2215. </method>
  2216. <method name="setResourceProfiles"
  2217. abstract="true" native="false" synchronized="false"
  2218. static="false" final="false" visibility="public"
  2219. deprecated="not deprecated">
  2220. <param name="profiles" type="java.util.Map"/>
  2221. </method>
  2222. <method name="getResourceProfiles" return="java.util.Map"
  2223. abstract="true" native="false" synchronized="false"
  2224. static="false" final="false" visibility="public"
  2225. deprecated="not deprecated">
  2226. </method>
  2227. <method name="equals" return="boolean"
  2228. abstract="false" native="false" synchronized="false"
  2229. static="false" final="false" visibility="public"
  2230. deprecated="not deprecated">
  2231. <param name="other" type="java.lang.Object"/>
  2232. </method>
  2233. <method name="hashCode" return="int"
  2234. abstract="false" native="false" synchronized="false"
  2235. static="false" final="false" visibility="public"
  2236. deprecated="not deprecated">
  2237. </method>
  2238. <doc>
  2239. <![CDATA[Response class for getting all the resource profiles from the RM.]]>
  2240. </doc>
  2241. </class>
  2242. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesResponse -->
  2243. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest -->
  2244. <class name="GetAllResourceTypeInfoRequest" extends="java.lang.Object"
  2245. abstract="true"
  2246. static="false" final="false" visibility="public"
  2247. deprecated="not deprecated">
  2248. <constructor name="GetAllResourceTypeInfoRequest"
  2249. static="false" final="false" visibility="public"
  2250. deprecated="not deprecated">
  2251. </constructor>
  2252. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest"
  2253. abstract="false" native="false" synchronized="false"
  2254. static="true" final="false" visibility="public"
  2255. deprecated="not deprecated">
  2256. </method>
  2257. <doc>
  2258. <![CDATA[Request class for getting all the resource profiles from the RM.]]>
  2259. </doc>
  2260. </class>
  2261. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest -->
  2262. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse -->
  2263. <class name="GetAllResourceTypeInfoResponse" extends="java.lang.Object"
  2264. abstract="true"
  2265. static="false" final="false" visibility="public"
  2266. deprecated="not deprecated">
  2267. <constructor name="GetAllResourceTypeInfoResponse"
  2268. static="false" final="false" visibility="public"
  2269. deprecated="not deprecated">
  2270. </constructor>
  2271. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse"
  2272. abstract="false" native="false" synchronized="false"
  2273. static="true" final="false" visibility="public"
  2274. deprecated="not deprecated">
  2275. </method>
  2276. <method name="setResourceTypeInfo"
  2277. abstract="true" native="false" synchronized="false"
  2278. static="false" final="false" visibility="public"
  2279. deprecated="not deprecated">
  2280. <param name="resourceTypes" type="java.util.List"/>
  2281. </method>
  2282. <method name="getResourceTypeInfo" return="java.util.List"
  2283. abstract="true" native="false" synchronized="false"
  2284. static="false" final="false" visibility="public"
  2285. deprecated="not deprecated">
  2286. </method>
  2287. <method name="equals" return="boolean"
  2288. abstract="false" native="false" synchronized="false"
  2289. static="false" final="false" visibility="public"
  2290. deprecated="not deprecated">
  2291. <param name="other" type="java.lang.Object"/>
  2292. </method>
  2293. <method name="hashCode" return="int"
  2294. abstract="false" native="false" synchronized="false"
  2295. static="false" final="false" visibility="public"
  2296. deprecated="not deprecated">
  2297. </method>
  2298. <doc>
  2299. <![CDATA[Response class for getting all the resource profiles from the RM.]]>
  2300. </doc>
  2301. </class>
  2302. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse -->
  2303. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
  2304. <class name="GetApplicationAttemptReportRequest" extends="java.lang.Object"
  2305. abstract="true"
  2306. static="false" final="false" visibility="public"
  2307. deprecated="not deprecated">
  2308. <constructor name="GetApplicationAttemptReportRequest"
  2309. static="false" final="false" visibility="public"
  2310. deprecated="not deprecated">
  2311. </constructor>
  2312. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"
  2313. abstract="false" native="false" synchronized="false"
  2314. static="true" final="false" visibility="public"
  2315. deprecated="not deprecated">
  2316. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2317. </method>
  2318. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2319. abstract="true" native="false" synchronized="false"
  2320. static="false" final="false" visibility="public"
  2321. deprecated="not deprecated">
  2322. <doc>
  2323. <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
  2324. @return <code>ApplicationAttemptId</code> of an application attempt]]>
  2325. </doc>
  2326. </method>
  2327. <method name="setApplicationAttemptId"
  2328. abstract="true" native="false" synchronized="false"
  2329. static="false" final="false" visibility="public"
  2330. deprecated="not deprecated">
  2331. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2332. <doc>
  2333. <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
  2334. @param applicationAttemptId
  2335. <code>ApplicationAttemptId</code> of an application attempt]]>
  2336. </doc>
  2337. </method>
  2338. <doc>
  2339. <![CDATA[<p>
  2340. The request sent by a client to the <code>ResourceManager</code> to get an
  2341. {@link ApplicationAttemptReport} for an application attempt.
  2342. </p>
  2343. <p>
  2344. The request should include the {@link ApplicationAttemptId} of the
  2345. application attempt.
  2346. </p>
  2347. @see ApplicationAttemptReport
  2348. @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
  2349. </doc>
  2350. </class>
  2351. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
  2352. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
  2353. <class name="GetApplicationAttemptReportResponse" extends="java.lang.Object"
  2354. abstract="true"
  2355. static="false" final="false" visibility="public"
  2356. deprecated="not deprecated">
  2357. <constructor name="GetApplicationAttemptReportResponse"
  2358. static="false" final="false" visibility="public"
  2359. deprecated="not deprecated">
  2360. </constructor>
  2361. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
  2362. abstract="false" native="false" synchronized="false"
  2363. static="true" final="false" visibility="public"
  2364. deprecated="not deprecated">
  2365. <param name="ApplicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
  2366. </method>
  2367. <method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
  2368. abstract="true" native="false" synchronized="false"
  2369. static="false" final="false" visibility="public"
  2370. deprecated="not deprecated">
  2371. <doc>
  2372. <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
  2373. @return <code>ApplicationAttemptReport</code> for the application attempt]]>
  2374. </doc>
  2375. </method>
  2376. <method name="setApplicationAttemptReport"
  2377. abstract="true" native="false" synchronized="false"
  2378. static="false" final="false" visibility="public"
  2379. deprecated="not deprecated">
  2380. <param name="applicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
  2381. <doc>
  2382. <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
  2383. @param applicationAttemptReport
  2384. <code>ApplicationAttemptReport</code> for the application attempt]]>
  2385. </doc>
  2386. </method>
  2387. <doc>
  2388. <![CDATA[<p>
  2389. The response sent by the <code>ResourceManager</code> to a client requesting
  2390. an application attempt report.
  2391. </p>
  2392. <p>
  2393. The response includes an {@link ApplicationAttemptReport} which has the
  2394. details about the particular application attempt
  2395. </p>
  2396. @see ApplicationAttemptReport
  2397. @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
  2398. </doc>
  2399. </class>
  2400. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
  2401. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
  2402. <class name="GetApplicationAttemptsRequest" extends="java.lang.Object"
  2403. abstract="true"
  2404. static="false" final="false" visibility="public"
  2405. deprecated="not deprecated">
  2406. <constructor name="GetApplicationAttemptsRequest"
  2407. static="false" final="false" visibility="public"
  2408. deprecated="not deprecated">
  2409. </constructor>
  2410. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"
  2411. abstract="false" native="false" synchronized="false"
  2412. static="true" final="false" visibility="public"
  2413. deprecated="not deprecated">
  2414. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2415. </method>
  2416. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2417. abstract="true" native="false" synchronized="false"
  2418. static="false" final="false" visibility="public"
  2419. deprecated="not deprecated">
  2420. <doc>
  2421. <![CDATA[Get the <code>ApplicationId</code> of an application
  2422. @return <code>ApplicationId</code> of an application]]>
  2423. </doc>
  2424. </method>
  2425. <method name="setApplicationId"
  2426. abstract="true" native="false" synchronized="false"
  2427. static="false" final="false" visibility="public"
  2428. deprecated="not deprecated">
  2429. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2430. <doc>
  2431. <![CDATA[Set the <code>ApplicationId</code> of an application
  2432. @param applicationId
  2433. <code>ApplicationId</code> of an application]]>
  2434. </doc>
  2435. </method>
  2436. <doc>
  2437. <![CDATA[<p>
  2438. The request from clients to get a list of application attempt reports of an
  2439. application from the <code>ResourceManager</code>.
  2440. </p>
  2441. @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
  2442. </doc>
  2443. </class>
  2444. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
  2445. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
  2446. <class name="GetApplicationAttemptsResponse" extends="java.lang.Object"
  2447. abstract="true"
  2448. static="false" final="false" visibility="public"
  2449. deprecated="not deprecated">
  2450. <constructor name="GetApplicationAttemptsResponse"
  2451. static="false" final="false" visibility="public"
  2452. deprecated="not deprecated">
  2453. </constructor>
  2454. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
  2455. abstract="false" native="false" synchronized="false"
  2456. static="true" final="false" visibility="public"
  2457. deprecated="not deprecated">
  2458. <param name="applicationAttempts" type="java.util.List"/>
  2459. </method>
  2460. <method name="getApplicationAttemptList" return="java.util.List"
  2461. abstract="true" native="false" synchronized="false"
  2462. static="false" final="false" visibility="public"
  2463. deprecated="not deprecated">
  2464. <doc>
  2465. <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
  2466. @return a list of <code>ApplicationReport</code> of an application]]>
  2467. </doc>
  2468. </method>
  2469. <method name="setApplicationAttemptList"
  2470. abstract="true" native="false" synchronized="false"
  2471. static="false" final="false" visibility="public"
  2472. deprecated="not deprecated">
  2473. <param name="applicationAttempts" type="java.util.List"/>
  2474. <doc>
  2475. <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
  2476. @param applicationAttempts
  2477. a list of <code>ApplicationReport</code> of an application]]>
  2478. </doc>
  2479. </method>
  2480. <doc>
  2481. <![CDATA[<p>
  2482. The response sent by the <code>ResourceManager</code> to a client requesting
  2483. a list of {@link ApplicationAttemptReport} for application attempts.
  2484. </p>
  2485. <p>
  2486. The <code>ApplicationAttemptReport</code> for each application includes the
  2487. details of an application attempt.
  2488. </p>
  2489. @see ApplicationAttemptReport
  2490. @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
  2491. </doc>
  2492. </class>
  2493. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
  2494. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
  2495. <class name="GetApplicationReportRequest" extends="java.lang.Object"
  2496. abstract="true"
  2497. static="false" final="false" visibility="public"
  2498. deprecated="not deprecated">
  2499. <constructor name="GetApplicationReportRequest"
  2500. static="false" final="false" visibility="public"
  2501. deprecated="not deprecated">
  2502. </constructor>
  2503. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"
  2504. abstract="false" native="false" synchronized="false"
  2505. static="true" final="false" visibility="public"
  2506. deprecated="not deprecated">
  2507. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2508. </method>
  2509. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2510. abstract="true" native="false" synchronized="false"
  2511. static="false" final="false" visibility="public"
  2512. deprecated="not deprecated">
  2513. <doc>
  2514. <![CDATA[Get the <code>ApplicationId</code> of the application.
  2515. @return <code>ApplicationId</code> of the application]]>
  2516. </doc>
  2517. </method>
  2518. <method name="setApplicationId"
  2519. abstract="true" native="false" synchronized="false"
  2520. static="false" final="false" visibility="public"
  2521. deprecated="not deprecated">
  2522. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2523. <doc>
  2524. <![CDATA[Set the <code>ApplicationId</code> of the application
  2525. @param applicationId <code>ApplicationId</code> of the application]]>
  2526. </doc>
  2527. </method>
  2528. <doc>
  2529. <![CDATA[<p>The request sent by a client to the <code>ResourceManager</code> to
  2530. get an {@link ApplicationReport} for an application.</p>
  2531. <p>The request should include the {@link ApplicationId} of the
  2532. application.</p>
  2533. @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)
  2534. @see ApplicationReport]]>
  2535. </doc>
  2536. </class>
  2537. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
  2538. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
  2539. <class name="GetApplicationReportResponse" extends="java.lang.Object"
  2540. abstract="true"
  2541. static="false" final="false" visibility="public"
  2542. deprecated="not deprecated">
  2543. <constructor name="GetApplicationReportResponse"
  2544. static="false" final="false" visibility="public"
  2545. deprecated="not deprecated">
  2546. </constructor>
  2547. <method name="getApplicationReport" return="org.apache.hadoop.yarn.api.records.ApplicationReport"
  2548. abstract="true" native="false" synchronized="false"
  2549. static="false" final="false" visibility="public"
  2550. deprecated="not deprecated">
  2551. <doc>
  2552. <![CDATA[Get the <code>ApplicationReport</code> for the application.
  2553. @return <code>ApplicationReport</code> for the application]]>
  2554. </doc>
  2555. </method>
  2556. <doc>
  2557. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  2558. requesting an application report.</p>
  2559. <p>The response includes an {@link ApplicationReport} which has details such
  2560. as user, queue, name, host on which the <code>ApplicationMaster</code> is
  2561. running, RPC port, tracking URL, diagnostics, start time etc.</p>
  2562. @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)]]>
  2563. </doc>
  2564. </class>
  2565. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
  2566. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
  2567. <class name="GetApplicationsRequest" extends="java.lang.Object"
  2568. abstract="true"
  2569. static="false" final="false" visibility="public"
  2570. deprecated="not deprecated">
  2571. <constructor name="GetApplicationsRequest"
  2572. static="false" final="false" visibility="public"
  2573. deprecated="not deprecated">
  2574. </constructor>
  2575. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2576. abstract="false" native="false" synchronized="false"
  2577. static="true" final="false" visibility="public"
  2578. deprecated="not deprecated">
  2579. </method>
  2580. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2581. abstract="false" native="false" synchronized="false"
  2582. static="true" final="false" visibility="public"
  2583. deprecated="not deprecated">
  2584. <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
  2585. <param name="users" type="java.util.Set"/>
  2586. <param name="queues" type="java.util.Set"/>
  2587. <param name="applicationTypes" type="java.util.Set"/>
  2588. <param name="applicationTags" type="java.util.Set"/>
  2589. <param name="applicationStates" type="java.util.EnumSet"/>
  2590. <param name="startRange" type="org.apache.commons.lang3.Range"/>
  2591. <param name="finishRange" type="org.apache.commons.lang3.Range"/>
  2592. <param name="limit" type="java.lang.Long"/>
  2593. <doc>
  2594. <![CDATA[<p>
  2595. The request from clients to get a report of Applications matching the
  2596. giving application types in the cluster from the
  2597. <code>ResourceManager</code>.
  2598. </p>
  2599. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2600. <p>Setting any of the parameters to null, would just disable that
  2601. filter</p>
  2602. @param scope {@link ApplicationsRequestScope} to filter by
  2603. @param users list of users to filter by
  2604. @param queues list of scheduler queues to filter by
  2605. @param applicationTypes types of applications
  2606. @param applicationTags application tags to filter by
  2607. @param applicationStates application states to filter by
  2608. @param startRange range of application start times to filter by
  2609. @param finishRange range of application finish times to filter by
  2610. @param limit number of applications to limit to
  2611. @return {@link GetApplicationsRequest} to be used with
  2612. {@link ApplicationClientProtocol#getApplications(GetApplicationsRequest)}]]>
  2613. </doc>
  2614. </method>
  2615. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2616. abstract="false" native="false" synchronized="false"
  2617. static="true" final="false" visibility="public"
  2618. deprecated="not deprecated">
  2619. <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
  2620. <doc>
  2621. <![CDATA[<p>
  2622. The request from clients to get a report of Applications matching the
  2623. giving application types in the cluster from the
  2624. <code>ResourceManager</code>.
  2625. </p>
  2626. @param scope {@link ApplicationsRequestScope} to filter by
  2627. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2628. @return a report of Applications in {@link GetApplicationsRequest}]]>
  2629. </doc>
  2630. </method>
  2631. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2632. abstract="false" native="false" synchronized="false"
  2633. static="true" final="false" visibility="public"
  2634. deprecated="not deprecated">
  2635. <param name="applicationTypes" type="java.util.Set"/>
  2636. <doc>
  2637. <![CDATA[<p>
  2638. The request from clients to get a report of Applications matching the
  2639. giving application types in the cluster from the
  2640. <code>ResourceManager</code>.
  2641. </p>
  2642. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2643. @return a report of Applications in {@link GetApplicationsRequest}]]>
  2644. </doc>
  2645. </method>
  2646. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2647. abstract="false" native="false" synchronized="false"
  2648. static="true" final="false" visibility="public"
  2649. deprecated="not deprecated">
  2650. <param name="applicationStates" type="java.util.EnumSet"/>
  2651. <doc>
  2652. <![CDATA[<p>
  2653. The request from clients to get a report of Applications matching the
  2654. giving application states in the cluster from the
  2655. <code>ResourceManager</code>.
  2656. </p>
  2657. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2658. @return a report of Applications in {@link GetApplicationsRequest}]]>
  2659. </doc>
  2660. </method>
  2661. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2662. abstract="false" native="false" synchronized="false"
  2663. static="true" final="false" visibility="public"
  2664. deprecated="not deprecated">
  2665. <param name="applicationTypes" type="java.util.Set"/>
  2666. <param name="applicationStates" type="java.util.EnumSet"/>
  2667. <doc>
  2668. <![CDATA[<p>
  2669. The request from clients to get a report of Applications matching the
  2670. giving and application types and application types in the cluster from the
  2671. <code>ResourceManager</code>.
  2672. </p>
  2673. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2674. @return a report of Applications in <code>GetApplicationsRequest</code>]]>
  2675. </doc>
  2676. </method>
  2677. <method name="getApplicationTypes" return="java.util.Set"
  2678. abstract="true" native="false" synchronized="false"
  2679. static="false" final="false" visibility="public"
  2680. deprecated="not deprecated">
  2681. <doc>
  2682. <![CDATA[Get the application types to filter applications on
  2683. @return Set of Application Types to filter on]]>
  2684. </doc>
  2685. </method>
  2686. <method name="getApplicationStates" return="java.util.EnumSet"
  2687. abstract="true" native="false" synchronized="false"
  2688. static="false" final="false" visibility="public"
  2689. deprecated="not deprecated">
  2690. <doc>
  2691. <![CDATA[Get the application states to filter applications on
  2692. @return Set of Application states to filter on]]>
  2693. </doc>
  2694. </method>
  2695. <doc>
  2696. <![CDATA[<p>The request from clients to get a report of Applications
  2697. in the cluster from the <code>ResourceManager</code>.</p>
  2698. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2699. </doc>
  2700. </class>
  2701. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
  2702. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
  2703. <class name="GetApplicationsResponse" extends="java.lang.Object"
  2704. abstract="true"
  2705. static="false" final="false" visibility="public"
  2706. deprecated="not deprecated">
  2707. <constructor name="GetApplicationsResponse"
  2708. static="false" final="false" visibility="public"
  2709. deprecated="not deprecated">
  2710. </constructor>
  2711. <method name="getApplicationList" return="java.util.List"
  2712. abstract="true" native="false" synchronized="false"
  2713. static="false" final="false" visibility="public"
  2714. deprecated="not deprecated">
  2715. <doc>
  2716. <![CDATA[Get <code>ApplicationReport</code> for applications.
  2717. @return <code>ApplicationReport</code> for applications]]>
  2718. </doc>
  2719. </method>
  2720. <doc>
  2721. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  2722. requesting an {@link ApplicationReport} for applications.</p>
  2723. <p>The <code>ApplicationReport</code> for each application includes details
  2724. such as user, queue, name, host on which the <code>ApplicationMaster</code>
  2725. is running, RPC port, tracking URL, diagnostics, start time etc.</p>
  2726. @see ApplicationReport
  2727. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2728. </doc>
  2729. </class>
  2730. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
  2731. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesRequest -->
  2732. <class name="GetAttributesToNodesRequest" extends="java.lang.Object"
  2733. abstract="true"
  2734. static="false" final="false" visibility="public"
  2735. deprecated="not deprecated">
  2736. <constructor name="GetAttributesToNodesRequest"
  2737. static="false" final="false" visibility="public"
  2738. deprecated="not deprecated">
  2739. </constructor>
  2740. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesRequest"
  2741. abstract="false" native="false" synchronized="false"
  2742. static="true" final="false" visibility="public"
  2743. deprecated="not deprecated">
  2744. </method>
  2745. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesRequest"
  2746. abstract="false" native="false" synchronized="false"
  2747. static="true" final="false" visibility="public"
  2748. deprecated="not deprecated">
  2749. <param name="attributes" type="java.util.Set"/>
  2750. </method>
  2751. <method name="setNodeAttributes"
  2752. abstract="true" native="false" synchronized="false"
  2753. static="false" final="false" visibility="public"
  2754. deprecated="not deprecated">
  2755. <param name="attributes" type="java.util.Set"/>
  2756. <doc>
  2757. <![CDATA[Set node attributeKeys for which the mapping of hostname to attribute value
  2758. is required.
  2759. @param attributes Set of NodeAttributeKey provided.]]>
  2760. </doc>
  2761. </method>
  2762. <method name="getNodeAttributes" return="java.util.Set"
  2763. abstract="true" native="false" synchronized="false"
  2764. static="false" final="false" visibility="public"
  2765. deprecated="not deprecated">
  2766. <doc>
  2767. <![CDATA[Get node attributeKeys for which mapping of hostname to attribute value is
  2768. required.
  2769. @return Set of NodeAttributeKey]]>
  2770. </doc>
  2771. </method>
  2772. <doc>
  2773. <![CDATA[<p>
  2774. The request from clients to get node to attribute value mapping for all or
  2775. given set of Node AttributeKey's in the cluster from the
  2776. <code>ResourceManager</code>.
  2777. </p>
  2778. @see ApplicationClientProtocol#getAttributesToNodes
  2779. (GetAttributesToNodesRequest)]]>
  2780. </doc>
  2781. </class>
  2782. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesRequest -->
  2783. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesResponse -->
  2784. <class name="GetAttributesToNodesResponse" extends="java.lang.Object"
  2785. abstract="true"
  2786. static="false" final="false" visibility="public"
  2787. deprecated="not deprecated">
  2788. <constructor name="GetAttributesToNodesResponse"
  2789. static="false" final="false" visibility="public"
  2790. deprecated="not deprecated">
  2791. </constructor>
  2792. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesResponse"
  2793. abstract="false" native="false" synchronized="false"
  2794. static="true" final="false" visibility="public"
  2795. deprecated="not deprecated">
  2796. <param name="map" type="java.util.Map"/>
  2797. </method>
  2798. <method name="setAttributeToNodes"
  2799. abstract="true" native="false" synchronized="false"
  2800. static="false" final="false" visibility="public"
  2801. deprecated="not deprecated">
  2802. <param name="map" type="java.util.Map"/>
  2803. </method>
  2804. <method name="getAttributesToNodes" return="java.util.Map"
  2805. abstract="true" native="false" synchronized="false"
  2806. static="false" final="false" visibility="public"
  2807. deprecated="not deprecated">
  2808. <doc>
  2809. <![CDATA[Get mapping of NodeAttributeKey to its associated mapping of list of
  2810. NodeToAttributeValue associated with attribute.
  2811. @return Map of node attributes to list of NodeToAttributeValue.]]>
  2812. </doc>
  2813. </method>
  2814. <doc>
  2815. <![CDATA[<p>
  2816. The response sent by the <code>ResourceManager</code> to a client requesting
  2817. node to attribute value mapping for all or given set of Node AttributeKey's.
  2818. </p>
  2819. @see ApplicationClientProtocol#getAttributesToNodes
  2820. (GetAttributesToNodesRequest)]]>
  2821. </doc>
  2822. </class>
  2823. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesResponse -->
  2824. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
  2825. <class name="GetClusterMetricsRequest" extends="java.lang.Object"
  2826. abstract="true"
  2827. static="false" final="false" visibility="public"
  2828. deprecated="not deprecated">
  2829. <constructor name="GetClusterMetricsRequest"
  2830. static="false" final="false" visibility="public"
  2831. deprecated="not deprecated">
  2832. </constructor>
  2833. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"
  2834. abstract="false" native="false" synchronized="false"
  2835. static="true" final="false" visibility="public"
  2836. deprecated="not deprecated">
  2837. </method>
  2838. <doc>
  2839. <![CDATA[<p>The request sent by clients to get cluster metrics from the
  2840. <code>ResourceManager</code>.</p>
  2841. <p>Currently, this is empty.</p>
  2842. @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
  2843. </doc>
  2844. </class>
  2845. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
  2846. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
  2847. <class name="GetClusterMetricsResponse" extends="java.lang.Object"
  2848. abstract="true"
  2849. static="false" final="false" visibility="public"
  2850. deprecated="not deprecated">
  2851. <constructor name="GetClusterMetricsResponse"
  2852. static="false" final="false" visibility="public"
  2853. deprecated="not deprecated">
  2854. </constructor>
  2855. <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.records.YarnClusterMetrics"
  2856. abstract="true" native="false" synchronized="false"
  2857. static="false" final="false" visibility="public"
  2858. deprecated="not deprecated">
  2859. <doc>
  2860. <![CDATA[Get the <code>YarnClusterMetrics</code> for the cluster.
  2861. @return <code>YarnClusterMetrics</code> for the cluster]]>
  2862. </doc>
  2863. </method>
  2864. <doc>
  2865. <![CDATA[The response sent by the <code>ResourceManager</code> to a client
  2866. requesting cluster metrics.
  2867. @see YarnClusterMetrics
  2868. @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
  2869. </doc>
  2870. </class>
  2871. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
  2872. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesRequest -->
  2873. <class name="GetClusterNodeAttributesRequest" extends="java.lang.Object"
  2874. abstract="true"
  2875. static="false" final="false" visibility="public"
  2876. deprecated="not deprecated">
  2877. <constructor name="GetClusterNodeAttributesRequest"
  2878. static="false" final="false" visibility="public"
  2879. deprecated="not deprecated">
  2880. </constructor>
  2881. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesRequest"
  2882. abstract="false" native="false" synchronized="false"
  2883. static="true" final="false" visibility="public"
  2884. deprecated="not deprecated">
  2885. <doc>
  2886. <![CDATA[Create new instance of GetClusterNodeAttributesRequest.
  2887. @return GetClusterNodeAttributesRequest is returned.]]>
  2888. </doc>
  2889. </method>
  2890. <doc>
  2891. <![CDATA[<p>
  2892. The request from clients to get node attributes in the cluster from the
  2893. <code>ResourceManager</code>.
  2894. </p>
  2895. @see ApplicationClientProtocol#getClusterNodeAttributes
  2896. (GetClusterNodeAttributesRequest)]]>
  2897. </doc>
  2898. </class>
  2899. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesRequest -->
  2900. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesResponse -->
  2901. <class name="GetClusterNodeAttributesResponse" extends="java.lang.Object"
  2902. abstract="true"
  2903. static="false" final="false" visibility="public"
  2904. deprecated="not deprecated">
  2905. <constructor name="GetClusterNodeAttributesResponse"
  2906. static="false" final="false" visibility="public"
  2907. deprecated="not deprecated">
  2908. </constructor>
  2909. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesResponse"
  2910. abstract="false" native="false" synchronized="false"
  2911. static="true" final="false" visibility="public"
  2912. deprecated="not deprecated">
  2913. <param name="attributes" type="java.util.Set"/>
  2914. <doc>
  2915. <![CDATA[Create instance of GetClusterNodeAttributesResponse.
  2916. @param attributes
  2917. @return GetClusterNodeAttributesResponse.]]>
  2918. </doc>
  2919. </method>
  2920. <method name="setNodeAttributes"
  2921. abstract="true" native="false" synchronized="false"
  2922. static="false" final="false" visibility="public"
  2923. deprecated="not deprecated">
  2924. <param name="attributes" type="java.util.Set"/>
  2925. <doc>
  2926. <![CDATA[Set node attributes to the response.
  2927. @param attributes Map of Node attributeKey to Type.]]>
  2928. </doc>
  2929. </method>
  2930. <method name="getNodeAttributes" return="java.util.Set"
  2931. abstract="true" native="false" synchronized="false"
  2932. static="false" final="false" visibility="public"
  2933. deprecated="not deprecated">
  2934. <doc>
  2935. <![CDATA[Get node attributes from the response.
  2936. @return Node attributes.]]>
  2937. </doc>
  2938. </method>
  2939. <doc>
  2940. <![CDATA[<p>
  2941. The response sent by the <code>ResourceManager</code> to a client requesting
  2942. a node attributes in cluster.
  2943. </p>
  2944. @see ApplicationClientProtocol#getClusterNodeAttributes
  2945. (GetClusterNodeAttributesRequest)]]>
  2946. </doc>
  2947. </class>
  2948. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesResponse -->
  2949. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
  2950. <class name="GetClusterNodeLabelsRequest" extends="java.lang.Object"
  2951. abstract="true"
  2952. static="false" final="false" visibility="public"
  2953. deprecated="not deprecated">
  2954. <constructor name="GetClusterNodeLabelsRequest"
  2955. static="false" final="false" visibility="public"
  2956. deprecated="not deprecated">
  2957. </constructor>
  2958. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"
  2959. abstract="false" native="false" synchronized="false"
  2960. static="true" final="false" visibility="public"
  2961. deprecated="not deprecated">
  2962. </method>
  2963. </class>
  2964. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
  2965. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
  2966. <class name="GetClusterNodeLabelsResponse" extends="java.lang.Object"
  2967. abstract="true"
  2968. static="false" final="false" visibility="public"
  2969. deprecated="not deprecated">
  2970. <constructor name="GetClusterNodeLabelsResponse"
  2971. static="false" final="false" visibility="public"
  2972. deprecated="not deprecated">
  2973. </constructor>
  2974. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  2975. abstract="false" native="false" synchronized="false"
  2976. static="true" final="false" visibility="public"
  2977. deprecated="Use {@link #newInstance(List)} instead.">
  2978. <param name="labels" type="java.util.Set"/>
  2979. <doc>
  2980. <![CDATA[Creates a new instance.
  2981. @param labels Node labels
  2982. @return response
  2983. @deprecated Use {@link #newInstance(List)} instead.]]>
  2984. </doc>
  2985. </method>
  2986. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  2987. abstract="false" native="false" synchronized="false"
  2988. static="true" final="false" visibility="public"
  2989. deprecated="not deprecated">
  2990. <param name="labels" type="java.util.List"/>
  2991. </method>
  2992. <method name="setNodeLabelList"
  2993. abstract="true" native="false" synchronized="false"
  2994. static="false" final="false" visibility="public"
  2995. deprecated="not deprecated">
  2996. <param name="labels" type="java.util.List"/>
  2997. </method>
  2998. <method name="getNodeLabelList" return="java.util.List"
  2999. abstract="true" native="false" synchronized="false"
  3000. static="false" final="false" visibility="public"
  3001. deprecated="not deprecated">
  3002. </method>
  3003. <method name="setNodeLabels"
  3004. abstract="true" native="false" synchronized="false"
  3005. static="false" final="false" visibility="public"
  3006. deprecated="Use {@link #setNodeLabelList(List)} instead.">
  3007. <param name="labels" type="java.util.Set"/>
  3008. <doc>
  3009. <![CDATA[Set node labels to the response.
  3010. @param labels Node labels
  3011. @deprecated Use {@link #setNodeLabelList(List)} instead.]]>
  3012. </doc>
  3013. </method>
  3014. <method name="getNodeLabels" return="java.util.Set"
  3015. abstract="true" native="false" synchronized="false"
  3016. static="false" final="false" visibility="public"
  3017. deprecated="Use {@link #getNodeLabelList()} instead.">
  3018. <doc>
  3019. <![CDATA[Get node labels of the response.
  3020. @return Node labels
  3021. @deprecated Use {@link #getNodeLabelList()} instead.]]>
  3022. </doc>
  3023. </method>
  3024. </class>
  3025. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
  3026. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
  3027. <class name="GetClusterNodesRequest" extends="java.lang.Object"
  3028. abstract="true"
  3029. static="false" final="false" visibility="public"
  3030. deprecated="not deprecated">
  3031. <constructor name="GetClusterNodesRequest"
  3032. static="false" final="false" visibility="public"
  3033. deprecated="not deprecated">
  3034. </constructor>
  3035. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
  3036. abstract="false" native="false" synchronized="false"
  3037. static="true" final="false" visibility="public"
  3038. deprecated="not deprecated">
  3039. <param name="states" type="java.util.EnumSet"/>
  3040. </method>
  3041. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
  3042. abstract="false" native="false" synchronized="false"
  3043. static="true" final="false" visibility="public"
  3044. deprecated="not deprecated">
  3045. </method>
  3046. <method name="getNodeStates" return="java.util.EnumSet"
  3047. abstract="true" native="false" synchronized="false"
  3048. static="false" final="false" visibility="public"
  3049. deprecated="not deprecated">
  3050. <doc>
  3051. <![CDATA[The state to filter the cluster nodes with.
  3052. @return the set of {@link NodeState}]]>
  3053. </doc>
  3054. </method>
  3055. <method name="setNodeStates"
  3056. abstract="true" native="false" synchronized="false"
  3057. static="false" final="false" visibility="public"
  3058. deprecated="not deprecated">
  3059. <param name="states" type="java.util.EnumSet"/>
  3060. <doc>
  3061. <![CDATA[The state to filter the cluster nodes with.
  3062. @param states the set of {@link NodeState}]]>
  3063. </doc>
  3064. </method>
  3065. <doc>
  3066. <![CDATA[<p>The request from clients to get a report of all nodes
  3067. in the cluster from the <code>ResourceManager</code>.</p>
  3068. The request will ask for all nodes in the given {@link NodeState}s.
  3069. @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
  3070. </doc>
  3071. </class>
  3072. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
  3073. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
  3074. <class name="GetClusterNodesResponse" extends="java.lang.Object"
  3075. abstract="true"
  3076. static="false" final="false" visibility="public"
  3077. deprecated="not deprecated">
  3078. <constructor name="GetClusterNodesResponse"
  3079. static="false" final="false" visibility="public"
  3080. deprecated="not deprecated">
  3081. </constructor>
  3082. <method name="getNodeReports" return="java.util.List"
  3083. abstract="true" native="false" synchronized="false"
  3084. static="false" final="false" visibility="public"
  3085. deprecated="not deprecated">
  3086. <doc>
  3087. <![CDATA[Get <code>NodeReport</code> for all nodes in the cluster.
  3088. @return <code>NodeReport</code> for all nodes in the cluster]]>
  3089. </doc>
  3090. </method>
  3091. <doc>
  3092. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  3093. requesting a {@link NodeReport} for all nodes.</p>
  3094. <p>The <code>NodeReport</code> contains per-node information such as
  3095. available resources, number of containers, tracking url, rack name, health
  3096. status etc.
  3097. @see NodeReport
  3098. @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
  3099. </doc>
  3100. </class>
  3101. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
  3102. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
  3103. <class name="GetContainerReportRequest" extends="java.lang.Object"
  3104. abstract="true"
  3105. static="false" final="false" visibility="public"
  3106. deprecated="not deprecated">
  3107. <constructor name="GetContainerReportRequest"
  3108. static="false" final="false" visibility="public"
  3109. deprecated="not deprecated">
  3110. </constructor>
  3111. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"
  3112. abstract="false" native="false" synchronized="false"
  3113. static="true" final="false" visibility="public"
  3114. deprecated="not deprecated">
  3115. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  3116. </method>
  3117. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  3118. abstract="true" native="false" synchronized="false"
  3119. static="false" final="false" visibility="public"
  3120. deprecated="not deprecated">
  3121. <doc>
  3122. <![CDATA[Get the <code>ContainerId</code> of the Container.
  3123. @return <code>ContainerId</code> of the Container]]>
  3124. </doc>
  3125. </method>
  3126. <method name="setContainerId"
  3127. abstract="true" native="false" synchronized="false"
  3128. static="false" final="false" visibility="public"
  3129. deprecated="not deprecated">
  3130. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  3131. <doc>
  3132. <![CDATA[Set the <code>ContainerId</code> of the container
  3133. @param containerId
  3134. <code>ContainerId</code> of the container]]>
  3135. </doc>
  3136. </method>
  3137. <doc>
  3138. <![CDATA[<p>
  3139. The request sent by a client to the <code>ResourceManager</code> to get an
  3140. {@link ContainerReport} for a container.
  3141. </p>]]>
  3142. </doc>
  3143. </class>
  3144. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
  3145. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
  3146. <class name="GetContainerReportResponse" extends="java.lang.Object"
  3147. abstract="true"
  3148. static="false" final="false" visibility="public"
  3149. deprecated="not deprecated">
  3150. <constructor name="GetContainerReportResponse"
  3151. static="false" final="false" visibility="public"
  3152. deprecated="not deprecated">
  3153. </constructor>
  3154. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
  3155. abstract="false" native="false" synchronized="false"
  3156. static="true" final="false" visibility="public"
  3157. deprecated="not deprecated">
  3158. <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
  3159. </method>
  3160. <method name="getContainerReport" return="org.apache.hadoop.yarn.api.records.ContainerReport"
  3161. abstract="true" native="false" synchronized="false"
  3162. static="false" final="false" visibility="public"
  3163. deprecated="not deprecated">
  3164. <doc>
  3165. <![CDATA[Get the <code>ContainerReport</code> for the container.
  3166. @return <code>ContainerReport</code> for the container]]>
  3167. </doc>
  3168. </method>
  3169. <method name="setContainerReport"
  3170. abstract="true" native="false" synchronized="false"
  3171. static="false" final="false" visibility="public"
  3172. deprecated="not deprecated">
  3173. <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
  3174. </method>
  3175. <doc>
  3176. <![CDATA[<p>
  3177. The response sent by the <code>ResourceManager</code> to a client requesting
  3178. a container report.
  3179. </p>
  3180. <p>
  3181. The response includes a {@link ContainerReport} which has details of a
  3182. container.
  3183. </p>]]>
  3184. </doc>
  3185. </class>
  3186. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
  3187. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
  3188. <class name="GetContainersRequest" extends="java.lang.Object"
  3189. abstract="true"
  3190. static="false" final="false" visibility="public"
  3191. deprecated="not deprecated">
  3192. <constructor name="GetContainersRequest"
  3193. static="false" final="false" visibility="public"
  3194. deprecated="not deprecated">
  3195. </constructor>
  3196. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"
  3197. abstract="false" native="false" synchronized="false"
  3198. static="true" final="false" visibility="public"
  3199. deprecated="not deprecated">
  3200. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  3201. </method>
  3202. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  3203. abstract="true" native="false" synchronized="false"
  3204. static="false" final="false" visibility="public"
  3205. deprecated="not deprecated">
  3206. <doc>
  3207. <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
  3208. @return <code>ApplicationAttemptId</code> of an application attempt]]>
  3209. </doc>
  3210. </method>
  3211. <method name="setApplicationAttemptId"
  3212. abstract="true" native="false" synchronized="false"
  3213. static="false" final="false" visibility="public"
  3214. deprecated="not deprecated">
  3215. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  3216. <doc>
  3217. <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
  3218. @param applicationAttemptId
  3219. <code>ApplicationAttemptId</code> of an application attempt]]>
  3220. </doc>
  3221. </method>
  3222. <doc>
  3223. <![CDATA[<p>
  3224. The request from clients to get a list of container reports, which belong to
  3225. an application attempt from the <code>ResourceManager</code>.
  3226. </p>
  3227. @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
  3228. </doc>
  3229. </class>
  3230. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
  3231. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
  3232. <class name="GetContainersResponse" extends="java.lang.Object"
  3233. abstract="true"
  3234. static="false" final="false" visibility="public"
  3235. deprecated="not deprecated">
  3236. <constructor name="GetContainersResponse"
  3237. static="false" final="false" visibility="public"
  3238. deprecated="not deprecated">
  3239. </constructor>
  3240. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
  3241. abstract="false" native="false" synchronized="false"
  3242. static="true" final="false" visibility="public"
  3243. deprecated="not deprecated">
  3244. <param name="containers" type="java.util.List"/>
  3245. </method>
  3246. <method name="getContainerList" return="java.util.List"
  3247. abstract="true" native="false" synchronized="false"
  3248. static="false" final="false" visibility="public"
  3249. deprecated="not deprecated">
  3250. <doc>
  3251. <![CDATA[Get a list of <code>ContainerReport</code> for all the containers of an
  3252. application attempt.
  3253. @return a list of <code>ContainerReport</code> for all the containers of an
  3254. application attempt]]>
  3255. </doc>
  3256. </method>
  3257. <method name="setContainerList"
  3258. abstract="true" native="false" synchronized="false"
  3259. static="false" final="false" visibility="public"
  3260. deprecated="not deprecated">
  3261. <param name="containers" type="java.util.List"/>
  3262. <doc>
  3263. <![CDATA[Set a list of <code>ContainerReport</code> for all the containers of an
  3264. application attempt.
  3265. @param containers
  3266. a list of <code>ContainerReport</code> for all the containers of
  3267. an application attempt]]>
  3268. </doc>
  3269. </method>
  3270. <doc>
  3271. <![CDATA[<p>
  3272. The response sent by the <code>ResourceManager</code> to a client requesting
  3273. a list of {@link ContainerReport} for containers.
  3274. </p>
  3275. <p>
  3276. The <code>ContainerReport</code> for each container includes the container
  3277. details.
  3278. </p>
  3279. @see ContainerReport
  3280. @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
  3281. </doc>
  3282. </class>
  3283. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
  3284. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
  3285. <class name="GetContainerStatusesRequest" extends="java.lang.Object"
  3286. abstract="true"
  3287. static="false" final="false" visibility="public"
  3288. deprecated="not deprecated">
  3289. <constructor name="GetContainerStatusesRequest"
  3290. static="false" final="false" visibility="public"
  3291. deprecated="not deprecated">
  3292. </constructor>
  3293. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"
  3294. abstract="false" native="false" synchronized="false"
  3295. static="true" final="false" visibility="public"
  3296. deprecated="not deprecated">
  3297. <param name="containerIds" type="java.util.List"/>
  3298. </method>
  3299. <method name="getContainerIds" return="java.util.List"
  3300. abstract="true" native="false" synchronized="false"
  3301. static="false" final="false" visibility="public"
  3302. deprecated="not deprecated">
  3303. <doc>
  3304. <![CDATA[Get the list of <code>ContainerId</code>s of containers for which to obtain
  3305. the <code>ContainerStatus</code>.
  3306. @return the list of <code>ContainerId</code>s of containers for which to
  3307. obtain the <code>ContainerStatus</code>.]]>
  3308. </doc>
  3309. </method>
  3310. <method name="setContainerIds"
  3311. abstract="true" native="false" synchronized="false"
  3312. static="false" final="false" visibility="public"
  3313. deprecated="not deprecated">
  3314. <param name="containerIds" type="java.util.List"/>
  3315. <doc>
  3316. <![CDATA[Set a list of <code>ContainerId</code>s of containers for which to obtain
  3317. the <code>ContainerStatus</code>
  3318. @param containerIds
  3319. a list of <code>ContainerId</code>s of containers for which to
  3320. obtain the <code>ContainerStatus</code>]]>
  3321. </doc>
  3322. </method>
  3323. <doc>
  3324. <![CDATA[The request sent by the <code>ApplicationMaster</code> to the
  3325. <code>NodeManager</code> to get {@link ContainerStatus} of requested
  3326. containers.
  3327. @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
  3328. </doc>
  3329. </class>
  3330. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
  3331. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
  3332. <class name="GetContainerStatusesResponse" extends="java.lang.Object"
  3333. abstract="true"
  3334. static="false" final="false" visibility="public"
  3335. deprecated="not deprecated">
  3336. <constructor name="GetContainerStatusesResponse"
  3337. static="false" final="false" visibility="public"
  3338. deprecated="not deprecated">
  3339. </constructor>
  3340. <method name="getContainerStatuses" return="java.util.List"
  3341. abstract="true" native="false" synchronized="false"
  3342. static="false" final="false" visibility="public"
  3343. deprecated="not deprecated">
  3344. <doc>
  3345. <![CDATA[Get the <code>ContainerStatus</code>es of the requested containers.
  3346. @return <code>ContainerStatus</code>es of the requested containers.]]>
  3347. </doc>
  3348. </method>
  3349. <method name="getFailedRequests" return="java.util.Map"
  3350. abstract="true" native="false" synchronized="false"
  3351. static="false" final="false" visibility="public"
  3352. deprecated="not deprecated">
  3353. <doc>
  3354. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  3355. from per container for failed requests
  3356. @return map of containerId-to-exception]]>
  3357. </doc>
  3358. </method>
  3359. <doc>
  3360. <![CDATA[The response sent by the <code>NodeManager</code> to the
  3361. <code>ApplicationMaster</code> when asked to obtain the
  3362. <code>ContainerStatus</code> of requested containers.
  3363. @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
  3364. </doc>
  3365. </class>
  3366. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
  3367. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
  3368. <class name="GetDelegationTokenRequest" extends="java.lang.Object"
  3369. abstract="true"
  3370. static="false" final="false" visibility="public"
  3371. deprecated="not deprecated">
  3372. <constructor name="GetDelegationTokenRequest"
  3373. static="false" final="false" visibility="public"
  3374. deprecated="not deprecated">
  3375. </constructor>
  3376. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"
  3377. abstract="false" native="false" synchronized="false"
  3378. static="true" final="false" visibility="public"
  3379. deprecated="not deprecated">
  3380. <param name="renewer" type="java.lang.String"/>
  3381. </method>
  3382. <method name="getRenewer" return="java.lang.String"
  3383. abstract="true" native="false" synchronized="false"
  3384. static="false" final="false" visibility="public"
  3385. deprecated="not deprecated">
  3386. </method>
  3387. <method name="setRenewer"
  3388. abstract="true" native="false" synchronized="false"
  3389. static="false" final="false" visibility="public"
  3390. deprecated="not deprecated">
  3391. <param name="renewer" type="java.lang.String"/>
  3392. </method>
  3393. <doc>
  3394. <![CDATA[The request issued by the client to get a delegation token from
  3395. the {@code ResourceManager}.
  3396. for more information.]]>
  3397. </doc>
  3398. </class>
  3399. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
  3400. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
  3401. <class name="GetDelegationTokenResponse" extends="java.lang.Object"
  3402. abstract="true"
  3403. static="false" final="false" visibility="public"
  3404. deprecated="not deprecated">
  3405. <constructor name="GetDelegationTokenResponse"
  3406. static="false" final="false" visibility="public"
  3407. deprecated="not deprecated">
  3408. </constructor>
  3409. <method name="getRMDelegationToken" return="org.apache.hadoop.yarn.api.records.Token"
  3410. abstract="true" native="false" synchronized="false"
  3411. static="false" final="false" visibility="public"
  3412. deprecated="not deprecated">
  3413. <doc>
  3414. <![CDATA[The Delegation tokens have a identifier which maps to
  3415. {@link AbstractDelegationTokenIdentifier}.
  3416. @return the delegation tokens]]>
  3417. </doc>
  3418. </method>
  3419. <doc>
  3420. <![CDATA[Response to a {@link GetDelegationTokenRequest} request
  3421. from the client. The response contains the token that
  3422. can be used by the containers to talk to ClientRMService.]]>
  3423. </doc>
  3424. </class>
  3425. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
  3426. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
  3427. <class name="GetNewApplicationRequest" extends="java.lang.Object"
  3428. abstract="true"
  3429. static="false" final="false" visibility="public"
  3430. deprecated="not deprecated">
  3431. <constructor name="GetNewApplicationRequest"
  3432. static="false" final="false" visibility="public"
  3433. deprecated="not deprecated">
  3434. </constructor>
  3435. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"
  3436. abstract="false" native="false" synchronized="false"
  3437. static="true" final="false" visibility="public"
  3438. deprecated="not deprecated">
  3439. </method>
  3440. <doc>
  3441. <![CDATA[<p>The request sent by clients to get a new {@link ApplicationId} for
  3442. submitting an application.</p>
  3443. <p>Currently, this is empty.</p>
  3444. @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
  3445. </doc>
  3446. </class>
  3447. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
  3448. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
  3449. <class name="GetNewApplicationResponse" extends="java.lang.Object"
  3450. abstract="true"
  3451. static="false" final="false" visibility="public"
  3452. deprecated="not deprecated">
  3453. <constructor name="GetNewApplicationResponse"
  3454. static="false" final="false" visibility="public"
  3455. deprecated="not deprecated">
  3456. </constructor>
  3457. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3458. abstract="true" native="false" synchronized="false"
  3459. static="false" final="false" visibility="public"
  3460. deprecated="not deprecated">
  3461. <doc>
  3462. <![CDATA[Get the <em>new</em> <code>ApplicationId</code> allocated by the
  3463. <code>ResourceManager</code>.
  3464. @return <em>new</em> <code>ApplicationId</code> allocated by the
  3465. <code>ResourceManager</code>]]>
  3466. </doc>
  3467. </method>
  3468. <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  3469. abstract="true" native="false" synchronized="false"
  3470. static="false" final="false" visibility="public"
  3471. deprecated="not deprecated">
  3472. <doc>
  3473. <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
  3474. <code>ResourceManager</code> in the cluster.
  3475. @return maximum capability of allocated resources in the cluster]]>
  3476. </doc>
  3477. </method>
  3478. <doc>
  3479. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client for
  3480. a request to get a new {@link ApplicationId} for submitting applications.</p>
  3481. <p>Clients can submit an application with the returned
  3482. {@link ApplicationId}.</p>
  3483. @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
  3484. </doc>
  3485. </class>
  3486. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
  3487. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest -->
  3488. <class name="GetNewReservationRequest" extends="java.lang.Object"
  3489. abstract="true"
  3490. static="false" final="false" visibility="public"
  3491. deprecated="not deprecated">
  3492. <constructor name="GetNewReservationRequest"
  3493. static="false" final="false" visibility="public"
  3494. deprecated="not deprecated">
  3495. </constructor>
  3496. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest"
  3497. abstract="false" native="false" synchronized="false"
  3498. static="true" final="false" visibility="public"
  3499. deprecated="not deprecated">
  3500. </method>
  3501. <doc>
  3502. <![CDATA[<p>The request sent by clients to get a new {@code ReservationId} for
  3503. submitting an reservation.</p>
  3504. {@code ApplicationClientProtocol#getNewReservation(GetNewReservationRequest)}]]>
  3505. </doc>
  3506. </class>
  3507. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest -->
  3508. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse -->
  3509. <class name="GetNewReservationResponse" extends="java.lang.Object"
  3510. abstract="true"
  3511. static="false" final="false" visibility="public"
  3512. deprecated="not deprecated">
  3513. <constructor name="GetNewReservationResponse"
  3514. static="false" final="false" visibility="public"
  3515. deprecated="not deprecated">
  3516. </constructor>
  3517. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  3518. abstract="true" native="false" synchronized="false"
  3519. static="false" final="false" visibility="public"
  3520. deprecated="not deprecated">
  3521. <doc>
  3522. <![CDATA[Get a new {@link ReservationId} to be used to submit a reservation.
  3523. @return a {@link ReservationId} representing the unique id to identify
  3524. a reservation with which it was submitted.]]>
  3525. </doc>
  3526. </method>
  3527. <doc>
  3528. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client for
  3529. a request to get a new {@link ReservationId} for submitting reservations.</p>
  3530. <p>Clients can submit an reservation with the returned
  3531. {@link ReservationId}.</p>
  3532. {@code ApplicationClientProtocol#getNewReservation(GetNewReservationRequest)}]]>
  3533. </doc>
  3534. </class>
  3535. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse -->
  3536. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesRequest -->
  3537. <class name="GetNodesToAttributesRequest" extends="java.lang.Object"
  3538. abstract="true"
  3539. static="false" final="false" visibility="public"
  3540. deprecated="not deprecated">
  3541. <constructor name="GetNodesToAttributesRequest"
  3542. static="false" final="false" visibility="public"
  3543. deprecated="not deprecated">
  3544. </constructor>
  3545. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesRequest"
  3546. abstract="false" native="false" synchronized="false"
  3547. static="true" final="false" visibility="public"
  3548. deprecated="not deprecated">
  3549. <param name="hostNames" type="java.util.Set"/>
  3550. </method>
  3551. <method name="setHostNames"
  3552. abstract="true" native="false" synchronized="false"
  3553. static="false" final="false" visibility="public"
  3554. deprecated="not deprecated">
  3555. <param name="hostnames" type="java.util.Set"/>
  3556. <doc>
  3557. <![CDATA[Set hostnames for which mapping is required.
  3558. @param hostnames]]>
  3559. </doc>
  3560. </method>
  3561. <method name="getHostNames" return="java.util.Set"
  3562. abstract="true" native="false" synchronized="false"
  3563. static="false" final="false" visibility="public"
  3564. deprecated="not deprecated">
  3565. <doc>
  3566. <![CDATA[Get hostnames for which mapping is required.
  3567. @return Set of hostnames.]]>
  3568. </doc>
  3569. </method>
  3570. <doc>
  3571. <![CDATA[<p>
  3572. The request from clients to get nodes to attributes mapping
  3573. in the cluster from the <code>ResourceManager</code>.
  3574. </p>
  3575. @see ApplicationClientProtocol#getNodesToAttributes
  3576. (GetNodesToAttributesRequest)]]>
  3577. </doc>
  3578. </class>
  3579. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesRequest -->
  3580. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesResponse -->
  3581. <class name="GetNodesToAttributesResponse" extends="java.lang.Object"
  3582. abstract="true"
  3583. static="false" final="false" visibility="public"
  3584. deprecated="not deprecated">
  3585. <constructor name="GetNodesToAttributesResponse"
  3586. static="false" final="false" visibility="public"
  3587. deprecated="not deprecated">
  3588. </constructor>
  3589. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesResponse"
  3590. abstract="false" native="false" synchronized="false"
  3591. static="true" final="false" visibility="public"
  3592. deprecated="not deprecated">
  3593. <param name="map" type="java.util.Map"/>
  3594. </method>
  3595. <method name="setNodeToAttributes"
  3596. abstract="true" native="false" synchronized="false"
  3597. static="false" final="false" visibility="public"
  3598. deprecated="not deprecated">
  3599. <param name="map" type="java.util.Map"/>
  3600. </method>
  3601. <method name="getNodeToAttributes" return="java.util.Map"
  3602. abstract="true" native="false" synchronized="false"
  3603. static="false" final="false" visibility="public"
  3604. deprecated="not deprecated">
  3605. <doc>
  3606. <![CDATA[Get hostnames to NodeAttributes mapping.
  3607. @return Map of host to attributes.]]>
  3608. </doc>
  3609. </method>
  3610. <doc>
  3611. <![CDATA[<p>
  3612. The response sent by the <code>ResourceManager</code> to a client requesting
  3613. nodes to attributes mapping.
  3614. </p>
  3615. @see ApplicationClientProtocol#getNodesToAttributes
  3616. (GetNodesToAttributesRequest)]]>
  3617. </doc>
  3618. </class>
  3619. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesResponse -->
  3620. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
  3621. <class name="GetQueueInfoRequest" extends="java.lang.Object"
  3622. abstract="true"
  3623. static="false" final="false" visibility="public"
  3624. deprecated="not deprecated">
  3625. <constructor name="GetQueueInfoRequest"
  3626. static="false" final="false" visibility="public"
  3627. deprecated="not deprecated">
  3628. </constructor>
  3629. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"
  3630. abstract="false" native="false" synchronized="false"
  3631. static="true" final="false" visibility="public"
  3632. deprecated="not deprecated">
  3633. <param name="queueName" type="java.lang.String"/>
  3634. <param name="includeApplications" type="boolean"/>
  3635. <param name="includeChildQueues" type="boolean"/>
  3636. <param name="recursive" type="boolean"/>
  3637. </method>
  3638. <method name="getQueueName" return="java.lang.String"
  3639. abstract="true" native="false" synchronized="false"
  3640. static="false" final="false" visibility="public"
  3641. deprecated="not deprecated">
  3642. <doc>
  3643. <![CDATA[Get the <em>queue name</em> for which to get queue information.
  3644. @return <em>queue name</em> for which to get queue information]]>
  3645. </doc>
  3646. </method>
  3647. <method name="setQueueName"
  3648. abstract="true" native="false" synchronized="false"
  3649. static="false" final="false" visibility="public"
  3650. deprecated="not deprecated">
  3651. <param name="queueName" type="java.lang.String"/>
  3652. <doc>
  3653. <![CDATA[Set the <em>queue name</em> for which to get queue information
  3654. @param queueName <em>queue name</em> for which to get queue information]]>
  3655. </doc>
  3656. </method>
  3657. <method name="getIncludeApplications" return="boolean"
  3658. abstract="true" native="false" synchronized="false"
  3659. static="false" final="false" visibility="public"
  3660. deprecated="not deprecated">
  3661. <doc>
  3662. <![CDATA[Is information about <em>active applications</em> required?
  3663. @return <code>true</code> if applications' information is to be included,
  3664. else <code>false</code>]]>
  3665. </doc>
  3666. </method>
  3667. <method name="setIncludeApplications"
  3668. abstract="true" native="false" synchronized="false"
  3669. static="false" final="false" visibility="public"
  3670. deprecated="not deprecated">
  3671. <param name="includeApplications" type="boolean"/>
  3672. <doc>
  3673. <![CDATA[Should we get fetch information about <em>active applications</em>?
  3674. @param includeApplications fetch information about <em>active
  3675. applications</em>?]]>
  3676. </doc>
  3677. </method>
  3678. <method name="getIncludeChildQueues" return="boolean"
  3679. abstract="true" native="false" synchronized="false"
  3680. static="false" final="false" visibility="public"
  3681. deprecated="not deprecated">
  3682. <doc>
  3683. <![CDATA[Is information about <em>child queues</em> required?
  3684. @return <code>true</code> if information about child queues is required,
  3685. else <code>false</code>]]>
  3686. </doc>
  3687. </method>
  3688. <method name="setIncludeChildQueues"
  3689. abstract="true" native="false" synchronized="false"
  3690. static="false" final="false" visibility="public"
  3691. deprecated="not deprecated">
  3692. <param name="includeChildQueues" type="boolean"/>
  3693. <doc>
  3694. <![CDATA[Should we fetch information about <em>child queues</em>?
  3695. @param includeChildQueues fetch information about <em>child queues</em>?]]>
  3696. </doc>
  3697. </method>
  3698. <method name="getRecursive" return="boolean"
  3699. abstract="true" native="false" synchronized="false"
  3700. static="false" final="false" visibility="public"
  3701. deprecated="not deprecated">
  3702. <doc>
  3703. <![CDATA[Is information on the entire <em>child queue hierarchy</em> required?
  3704. @return <code>true</code> if information about entire hierarchy is
  3705. required, <code>false</code> otherwise]]>
  3706. </doc>
  3707. </method>
  3708. <method name="setRecursive"
  3709. abstract="true" native="false" synchronized="false"
  3710. static="false" final="false" visibility="public"
  3711. deprecated="not deprecated">
  3712. <param name="recursive" type="boolean"/>
  3713. <doc>
  3714. <![CDATA[Should we fetch information on the entire <em>child queue hierarchy</em>?
  3715. @param recursive fetch information on the entire <em>child queue
  3716. hierarchy</em>?]]>
  3717. </doc>
  3718. </method>
  3719. <doc>
  3720. <![CDATA[<p>The request sent by clients to get <em>queue information</em>
  3721. from the <code>ResourceManager</code>.</p>
  3722. @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
  3723. </doc>
  3724. </class>
  3725. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
  3726. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
  3727. <class name="GetQueueInfoResponse" extends="java.lang.Object"
  3728. abstract="true"
  3729. static="false" final="false" visibility="public"
  3730. deprecated="not deprecated">
  3731. <constructor name="GetQueueInfoResponse"
  3732. static="false" final="false" visibility="public"
  3733. deprecated="not deprecated">
  3734. </constructor>
  3735. <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.records.QueueInfo"
  3736. abstract="true" native="false" synchronized="false"
  3737. static="false" final="false" visibility="public"
  3738. deprecated="not deprecated">
  3739. <doc>
  3740. <![CDATA[Get the <code>QueueInfo</code> for the specified queue.
  3741. @return <code>QueueInfo</code> for the specified queue]]>
  3742. </doc>
  3743. </method>
  3744. <doc>
  3745. <![CDATA[The response sent by the {@code ResourceManager} to a client
  3746. requesting information about queues in the system.
  3747. <p>
  3748. The response includes a {@link QueueInfo} which has details such as
  3749. queue name, used/total capacities, running applications, child queues etc.
  3750. @see QueueInfo
  3751. @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
  3752. </doc>
  3753. </class>
  3754. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
  3755. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
  3756. <class name="GetQueueUserAclsInfoRequest" extends="java.lang.Object"
  3757. abstract="true"
  3758. static="false" final="false" visibility="public"
  3759. deprecated="not deprecated">
  3760. <constructor name="GetQueueUserAclsInfoRequest"
  3761. static="false" final="false" visibility="public"
  3762. deprecated="not deprecated">
  3763. </constructor>
  3764. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"
  3765. abstract="false" native="false" synchronized="false"
  3766. static="true" final="false" visibility="public"
  3767. deprecated="not deprecated">
  3768. </method>
  3769. <doc>
  3770. <![CDATA[<p>The request sent by clients to the <code>ResourceManager</code> to
  3771. get queue acls for the <em>current user</em>.</p>
  3772. <p>Currently, this is empty.</p>
  3773. @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  3774. </doc>
  3775. </class>
  3776. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
  3777. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
  3778. <class name="GetQueueUserAclsInfoResponse" extends="java.lang.Object"
  3779. abstract="true"
  3780. static="false" final="false" visibility="public"
  3781. deprecated="not deprecated">
  3782. <constructor name="GetQueueUserAclsInfoResponse"
  3783. static="false" final="false" visibility="public"
  3784. deprecated="not deprecated">
  3785. </constructor>
  3786. <method name="getUserAclsInfoList" return="java.util.List"
  3787. abstract="true" native="false" synchronized="false"
  3788. static="false" final="false" visibility="public"
  3789. deprecated="not deprecated">
  3790. <doc>
  3791. <![CDATA[Get the <code>QueueUserACLInfo</code> per queue for the user.
  3792. @return <code>QueueUserACLInfo</code> per queue for the user]]>
  3793. </doc>
  3794. </method>
  3795. <doc>
  3796. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to clients
  3797. seeking queue acls for the user.</p>
  3798. <p>The response contains a list of {@link QueueUserACLInfo} which
  3799. provides information about {@link QueueACL} per queue.</p>
  3800. @see QueueACL
  3801. @see QueueUserACLInfo
  3802. @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  3803. </doc>
  3804. </class>
  3805. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
  3806. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileRequest -->
  3807. <class name="GetResourceProfileRequest" extends="java.lang.Object"
  3808. abstract="true"
  3809. static="false" final="false" visibility="public"
  3810. deprecated="not deprecated">
  3811. <constructor name="GetResourceProfileRequest"
  3812. static="false" final="false" visibility="public"
  3813. deprecated="not deprecated">
  3814. </constructor>
  3815. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileRequest"
  3816. abstract="false" native="false" synchronized="false"
  3817. static="true" final="false" visibility="public"
  3818. deprecated="not deprecated">
  3819. <param name="profile" type="java.lang.String"/>
  3820. </method>
  3821. <method name="setProfileName"
  3822. abstract="true" native="false" synchronized="false"
  3823. static="false" final="false" visibility="public"
  3824. deprecated="not deprecated">
  3825. <param name="profileName" type="java.lang.String"/>
  3826. </method>
  3827. <method name="getProfileName" return="java.lang.String"
  3828. abstract="true" native="false" synchronized="false"
  3829. static="false" final="false" visibility="public"
  3830. deprecated="not deprecated">
  3831. </method>
  3832. <method name="equals" return="boolean"
  3833. abstract="false" native="false" synchronized="false"
  3834. static="false" final="false" visibility="public"
  3835. deprecated="not deprecated">
  3836. <param name="other" type="java.lang.Object"/>
  3837. </method>
  3838. <method name="hashCode" return="int"
  3839. abstract="false" native="false" synchronized="false"
  3840. static="false" final="false" visibility="public"
  3841. deprecated="not deprecated">
  3842. </method>
  3843. <doc>
  3844. <![CDATA[Request class for getting the details for a particular resource profile.]]>
  3845. </doc>
  3846. </class>
  3847. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileRequest -->
  3848. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileResponse -->
  3849. <class name="GetResourceProfileResponse" extends="java.lang.Object"
  3850. abstract="true"
  3851. static="false" final="false" visibility="public"
  3852. deprecated="not deprecated">
  3853. <constructor name="GetResourceProfileResponse"
  3854. static="false" final="false" visibility="public"
  3855. deprecated="not deprecated">
  3856. </constructor>
  3857. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileResponse"
  3858. abstract="false" native="false" synchronized="false"
  3859. static="true" final="false" visibility="public"
  3860. deprecated="not deprecated">
  3861. </method>
  3862. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  3863. abstract="true" native="false" synchronized="false"
  3864. static="false" final="false" visibility="public"
  3865. deprecated="not deprecated">
  3866. <doc>
  3867. <![CDATA[Get the resources that will be allocated if the profile was used.
  3868. @return the resources that will be allocated if the profile was used.]]>
  3869. </doc>
  3870. </method>
  3871. <method name="setResource"
  3872. abstract="true" native="false" synchronized="false"
  3873. static="false" final="false" visibility="public"
  3874. deprecated="not deprecated">
  3875. <param name="r" type="org.apache.hadoop.yarn.api.records.Resource"/>
  3876. <doc>
  3877. <![CDATA[Set the resources that will be allocated if the profile is used.
  3878. @param r Set the resources that will be allocated if the profile is used.]]>
  3879. </doc>
  3880. </method>
  3881. <method name="equals" return="boolean"
  3882. abstract="false" native="false" synchronized="false"
  3883. static="false" final="false" visibility="public"
  3884. deprecated="not deprecated">
  3885. <param name="other" type="java.lang.Object"/>
  3886. </method>
  3887. <method name="hashCode" return="int"
  3888. abstract="false" native="false" synchronized="false"
  3889. static="false" final="false" visibility="public"
  3890. deprecated="not deprecated">
  3891. </method>
  3892. <doc>
  3893. <![CDATA[Response class for getting the details for a particular resource profile.]]>
  3894. </doc>
  3895. </class>
  3896. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileResponse -->
  3897. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest -->
  3898. <class name="IncreaseContainersResourceRequest" extends="java.lang.Object"
  3899. abstract="true"
  3900. static="false" final="false" visibility="public"
  3901. deprecated="not deprecated">
  3902. <constructor name="IncreaseContainersResourceRequest"
  3903. static="false" final="false" visibility="public"
  3904. deprecated="not deprecated">
  3905. </constructor>
  3906. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest"
  3907. abstract="false" native="false" synchronized="false"
  3908. static="true" final="false" visibility="public"
  3909. deprecated="not deprecated">
  3910. <param name="containersToIncrease" type="java.util.List"/>
  3911. </method>
  3912. <method name="getContainersToIncrease" return="java.util.List"
  3913. abstract="true" native="false" synchronized="false"
  3914. static="false" final="false" visibility="public"
  3915. deprecated="not deprecated">
  3916. <doc>
  3917. <![CDATA[Get a list of container tokens to be used for authorization during
  3918. container resource increase.
  3919. <p>
  3920. Note: {@link NMToken} will be used for authenticating communication with
  3921. {@code NodeManager}.
  3922. @return the list of container tokens to be used for authorization during
  3923. container resource increase.
  3924. @see NMToken]]>
  3925. </doc>
  3926. </method>
  3927. <method name="setContainersToIncrease"
  3928. abstract="true" native="false" synchronized="false"
  3929. static="false" final="false" visibility="public"
  3930. deprecated="not deprecated">
  3931. <param name="containersToIncrease" type="java.util.List"/>
  3932. <doc>
  3933. <![CDATA[Set container tokens to be used during container resource increase.
  3934. The token is acquired from
  3935. <code>AllocateResponse.getIncreasedContainers</code>.
  3936. The token contains the container id and resource capability required for
  3937. container resource increase.
  3938. @param containersToIncrease the list of container tokens to be used
  3939. for container resource increase.]]>
  3940. </doc>
  3941. </method>
  3942. <doc>
  3943. <![CDATA[<p>The request sent by <code>Application Master</code> to the
  3944. <code>Node Manager</code> to change the resource quota of a container.</p>
  3945. @see ContainerManagementProtocol#increaseContainersResource(IncreaseContainersResourceRequest)]]>
  3946. </doc>
  3947. </class>
  3948. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest -->
  3949. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse -->
  3950. <class name="IncreaseContainersResourceResponse" extends="java.lang.Object"
  3951. abstract="true"
  3952. static="false" final="false" visibility="public"
  3953. deprecated="not deprecated">
  3954. <constructor name="IncreaseContainersResourceResponse"
  3955. static="false" final="false" visibility="public"
  3956. deprecated="not deprecated">
  3957. </constructor>
  3958. <method name="getSuccessfullyIncreasedContainers" return="java.util.List"
  3959. abstract="true" native="false" synchronized="false"
  3960. static="false" final="false" visibility="public"
  3961. deprecated="not deprecated">
  3962. <doc>
  3963. <![CDATA[Get the list of containerIds of containers whose resource
  3964. have been successfully increased.
  3965. @return the list of containerIds of containers whose resource have
  3966. been successfully increased.]]>
  3967. </doc>
  3968. </method>
  3969. <method name="getFailedRequests" return="java.util.Map"
  3970. abstract="true" native="false" synchronized="false"
  3971. static="false" final="false" visibility="public"
  3972. deprecated="not deprecated">
  3973. <doc>
  3974. <![CDATA[Get the containerId-to-exception map in which the exception indicates
  3975. error from each container for failed requests.
  3976. @return map of containerId-to-exception]]>
  3977. </doc>
  3978. </method>
  3979. <doc>
  3980. <![CDATA[<p>
  3981. The response sent by the <code>NodeManager</code> to the
  3982. <code>ApplicationMaster</code> when asked to increase container resource.
  3983. </p>
  3984. @see ContainerManagementProtocol#increaseContainersResource(IncreaseContainersResourceRequest)]]>
  3985. </doc>
  3986. </class>
  3987. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse -->
  3988. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
  3989. <class name="KillApplicationRequest" extends="java.lang.Object"
  3990. abstract="true"
  3991. static="false" final="false" visibility="public"
  3992. deprecated="not deprecated">
  3993. <constructor name="KillApplicationRequest"
  3994. static="false" final="false" visibility="public"
  3995. deprecated="not deprecated">
  3996. </constructor>
  3997. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"
  3998. abstract="false" native="false" synchronized="false"
  3999. static="true" final="false" visibility="public"
  4000. deprecated="not deprecated">
  4001. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4002. </method>
  4003. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4004. abstract="true" native="false" synchronized="false"
  4005. static="false" final="false" visibility="public"
  4006. deprecated="not deprecated">
  4007. <doc>
  4008. <![CDATA[Get the <code>ApplicationId</code> of the application to be aborted.
  4009. @return <code>ApplicationId</code> of the application to be aborted]]>
  4010. </doc>
  4011. </method>
  4012. <method name="setApplicationId"
  4013. abstract="true" native="false" synchronized="false"
  4014. static="false" final="false" visibility="public"
  4015. deprecated="not deprecated">
  4016. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4017. </method>
  4018. <method name="getDiagnostics" return="java.lang.String"
  4019. abstract="true" native="false" synchronized="false"
  4020. static="false" final="false" visibility="public"
  4021. deprecated="not deprecated">
  4022. <doc>
  4023. <![CDATA[Get the <em>diagnostics</em> to which the application is being killed.
  4024. @return <em>diagnostics</em> to which the application is being killed]]>
  4025. </doc>
  4026. </method>
  4027. <method name="setDiagnostics"
  4028. abstract="true" native="false" synchronized="false"
  4029. static="false" final="false" visibility="public"
  4030. deprecated="not deprecated">
  4031. <param name="diagnostics" type="java.lang.String"/>
  4032. <doc>
  4033. <![CDATA[Set the <em>diagnostics</em> to which the application is being killed.
  4034. @param diagnostics <em>diagnostics</em> to which the application is being
  4035. killed]]>
  4036. </doc>
  4037. </method>
  4038. <doc>
  4039. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  4040. to abort a submitted application.</p>
  4041. <p>The request includes the {@link ApplicationId} of the application to be
  4042. aborted.</p>
  4043. @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
  4044. </doc>
  4045. </class>
  4046. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
  4047. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
  4048. <class name="KillApplicationResponse" extends="java.lang.Object"
  4049. abstract="true"
  4050. static="false" final="false" visibility="public"
  4051. deprecated="not deprecated">
  4052. <constructor name="KillApplicationResponse"
  4053. static="false" final="false" visibility="public"
  4054. deprecated="not deprecated">
  4055. </constructor>
  4056. <method name="getIsKillCompleted" return="boolean"
  4057. abstract="true" native="false" synchronized="false"
  4058. static="false" final="false" visibility="public"
  4059. deprecated="not deprecated">
  4060. <doc>
  4061. <![CDATA[Get the flag which indicates that the process of killing application is completed or not.
  4062. @return true if the process of killing application has completed,
  4063. false otherwise]]>
  4064. </doc>
  4065. </method>
  4066. <doc>
  4067. <![CDATA[The response sent by the <code>ResourceManager</code> to the client aborting
  4068. a submitted application.
  4069. <p>
  4070. The response, includes:
  4071. <ul>
  4072. <li>
  4073. A flag which indicates that the process of killing the application is
  4074. completed or not.
  4075. </li>
  4076. </ul>
  4077. Note: user is recommended to wait until this flag becomes true, otherwise if
  4078. the <code>ResourceManager</code> crashes before the process of killing the
  4079. application is completed, the <code>ResourceManager</code> may retry this
  4080. application on recovery.
  4081. @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
  4082. </doc>
  4083. </class>
  4084. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
  4085. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
  4086. <class name="MoveApplicationAcrossQueuesRequest" extends="java.lang.Object"
  4087. abstract="true"
  4088. static="false" final="false" visibility="public"
  4089. deprecated="not deprecated">
  4090. <constructor name="MoveApplicationAcrossQueuesRequest"
  4091. static="false" final="false" visibility="public"
  4092. deprecated="not deprecated">
  4093. </constructor>
  4094. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"
  4095. abstract="false" native="false" synchronized="false"
  4096. static="true" final="false" visibility="public"
  4097. deprecated="not deprecated">
  4098. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4099. <param name="queue" type="java.lang.String"/>
  4100. </method>
  4101. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4102. abstract="true" native="false" synchronized="false"
  4103. static="false" final="false" visibility="public"
  4104. deprecated="not deprecated">
  4105. <doc>
  4106. <![CDATA[Get the <code>ApplicationId</code> of the application to be moved.
  4107. @return <code>ApplicationId</code> of the application to be moved]]>
  4108. </doc>
  4109. </method>
  4110. <method name="setApplicationId"
  4111. abstract="true" native="false" synchronized="false"
  4112. static="false" final="false" visibility="public"
  4113. deprecated="not deprecated">
  4114. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4115. <doc>
  4116. <![CDATA[Set the <code>ApplicationId</code> of the application to be moved.
  4117. @param appId <code>ApplicationId</code> of the application to be moved]]>
  4118. </doc>
  4119. </method>
  4120. <method name="getTargetQueue" return="java.lang.String"
  4121. abstract="true" native="false" synchronized="false"
  4122. static="false" final="false" visibility="public"
  4123. deprecated="not deprecated">
  4124. <doc>
  4125. <![CDATA[Get the queue to place the application in.
  4126. @return the name of the queue to place the application in]]>
  4127. </doc>
  4128. </method>
  4129. <method name="setTargetQueue"
  4130. abstract="true" native="false" synchronized="false"
  4131. static="false" final="false" visibility="public"
  4132. deprecated="not deprecated">
  4133. <param name="queue" type="java.lang.String"/>
  4134. <doc>
  4135. <![CDATA[Get the queue to place the application in.
  4136. @param queue the name of the queue to place the application in]]>
  4137. </doc>
  4138. </method>
  4139. <doc>
  4140. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  4141. to move a submitted application to a different queue.</p>
  4142. <p>The request includes the {@link ApplicationId} of the application to be
  4143. moved and the queue to place it in.</p>
  4144. @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
  4145. </doc>
  4146. </class>
  4147. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
  4148. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
  4149. <class name="MoveApplicationAcrossQueuesResponse" extends="java.lang.Object"
  4150. abstract="true"
  4151. static="false" final="false" visibility="public"
  4152. deprecated="not deprecated">
  4153. <constructor name="MoveApplicationAcrossQueuesResponse"
  4154. static="false" final="false" visibility="public"
  4155. deprecated="not deprecated">
  4156. </constructor>
  4157. <doc>
  4158. <![CDATA[<p>
  4159. The response sent by the <code>ResourceManager</code> to the client moving
  4160. a submitted application to a different queue.
  4161. </p>
  4162. <p>
  4163. A response without exception means that the move has completed successfully.
  4164. </p>
  4165. @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
  4166. </doc>
  4167. </class>
  4168. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
  4169. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
  4170. <class name="RegisterApplicationMasterRequest" extends="java.lang.Object"
  4171. abstract="true"
  4172. static="false" final="false" visibility="public"
  4173. deprecated="not deprecated">
  4174. <constructor name="RegisterApplicationMasterRequest"
  4175. static="false" final="false" visibility="public"
  4176. deprecated="not deprecated">
  4177. </constructor>
  4178. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"
  4179. abstract="false" native="false" synchronized="false"
  4180. static="true" final="false" visibility="public"
  4181. deprecated="not deprecated">
  4182. <param name="host" type="java.lang.String"/>
  4183. <param name="port" type="int"/>
  4184. <param name="trackingUrl" type="java.lang.String"/>
  4185. <doc>
  4186. <![CDATA[Create a new instance of <code>RegisterApplicationMasterRequest</code>.
  4187. If <em>port, trackingUrl</em> is not used, use the following default value:
  4188. <ul>
  4189. <li>port: -1</li>
  4190. <li>trackingUrl: null</li>
  4191. </ul>
  4192. The port is allowed to be any integer larger than or equal to -1.
  4193. @return the new instance of <code>RegisterApplicationMasterRequest</code>]]>
  4194. </doc>
  4195. </method>
  4196. <method name="getHost" return="java.lang.String"
  4197. abstract="true" native="false" synchronized="false"
  4198. static="false" final="false" visibility="public"
  4199. deprecated="not deprecated">
  4200. <doc>
  4201. <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code> is
  4202. running.
  4203. @return <em>host</em> on which the <code>ApplicationMaster</code> is running]]>
  4204. </doc>
  4205. </method>
  4206. <method name="setHost"
  4207. abstract="true" native="false" synchronized="false"
  4208. static="false" final="false" visibility="public"
  4209. deprecated="not deprecated">
  4210. <param name="host" type="java.lang.String"/>
  4211. <doc>
  4212. <![CDATA[Set the <em>host</em> on which the <code>ApplicationMaster</code> is
  4213. running.
  4214. @param host <em>host</em> on which the <code>ApplicationMaster</code>
  4215. is running]]>
  4216. </doc>
  4217. </method>
  4218. <method name="getRpcPort" return="int"
  4219. abstract="true" native="false" synchronized="false"
  4220. static="false" final="false" visibility="public"
  4221. deprecated="not deprecated">
  4222. <doc>
  4223. <![CDATA[Get the <em>RPC port</em> on which the {@code ApplicationMaster} is
  4224. responding.
  4225. @return the <em>RPC port</em> on which the {@code ApplicationMaster}
  4226. is responding]]>
  4227. </doc>
  4228. </method>
  4229. <method name="setRpcPort"
  4230. abstract="true" native="false" synchronized="false"
  4231. static="false" final="false" visibility="public"
  4232. deprecated="not deprecated">
  4233. <param name="port" type="int"/>
  4234. <doc>
  4235. <![CDATA[Set the <em>RPC port</em> on which the {@code ApplicationMaster} is
  4236. responding.
  4237. @param port <em>RPC port</em> on which the {@code ApplicationMaster}
  4238. is responding]]>
  4239. </doc>
  4240. </method>
  4241. <method name="getTrackingUrl" return="java.lang.String"
  4242. abstract="true" native="false" synchronized="false"
  4243. static="false" final="false" visibility="public"
  4244. deprecated="not deprecated">
  4245. <doc>
  4246. <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
  4247. This url if contains scheme then that will be used by resource manager
  4248. web application proxy otherwise it will default to http.
  4249. @return <em>tracking URL</em> for the <code>ApplicationMaster</code>]]>
  4250. </doc>
  4251. </method>
  4252. <method name="setTrackingUrl"
  4253. abstract="true" native="false" synchronized="false"
  4254. static="false" final="false" visibility="public"
  4255. deprecated="not deprecated">
  4256. <param name="trackingUrl" type="java.lang.String"/>
  4257. <doc>
  4258. <![CDATA[Set the <em>tracking URL</em>for the <code>ApplicationMaster</code> while
  4259. it is running. This is the web-URL to which ResourceManager or
  4260. web-application proxy will redirect client/users while the application and
  4261. the <code>ApplicationMaster</code> are still running.
  4262. <p>
  4263. If the passed url has a scheme then that will be used by the
  4264. ResourceManager and web-application proxy, otherwise the scheme will
  4265. default to http.
  4266. </p>
  4267. <p>
  4268. Empty, null, "N/A" strings are all valid besides a real URL. In case an url
  4269. isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
  4270. <p>
  4271. @param trackingUrl
  4272. <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  4273. </doc>
  4274. </method>
  4275. <method name="getPlacementConstraints" return="java.util.Map"
  4276. abstract="false" native="false" synchronized="false"
  4277. static="false" final="false" visibility="public"
  4278. deprecated="not deprecated">
  4279. <doc>
  4280. <![CDATA[Return all Placement Constraints specified at the Application level. The
  4281. mapping is from a set of allocation tags to a
  4282. <code>PlacementConstraint</code> associated with the tags, i.e., each
  4283. {@link org.apache.hadoop.yarn.api.records.SchedulingRequest} that has those
  4284. tags will be placed taking into account the corresponding constraint.
  4285. @return A map of Placement Constraints.]]>
  4286. </doc>
  4287. </method>
  4288. <method name="setPlacementConstraints"
  4289. abstract="false" native="false" synchronized="false"
  4290. static="false" final="false" visibility="public"
  4291. deprecated="not deprecated">
  4292. <param name="placementConstraints" type="java.util.Map"/>
  4293. <doc>
  4294. <![CDATA[Set Placement Constraints applicable to the
  4295. {@link org.apache.hadoop.yarn.api.records.SchedulingRequest}s
  4296. of this application.
  4297. The mapping is from a set of allocation tags to a
  4298. <code>PlacementConstraint</code> associated with the tags.
  4299. For example:
  4300. Map &lt;
  4301. &lt;hb_regionserver&gt; -&gt; node_anti_affinity,
  4302. &lt;hb_regionserver, hb_master&gt; -&gt; rack_affinity,
  4303. ...
  4304. &gt;
  4305. @param placementConstraints Placement Constraint Mapping.]]>
  4306. </doc>
  4307. </method>
  4308. <doc>
  4309. <![CDATA[The request sent by the {@code ApplicationMaster} to {@code ResourceManager}
  4310. on registration.
  4311. <p>
  4312. The registration includes details such as:
  4313. <ul>
  4314. <li>Hostname on which the AM is running.</li>
  4315. <li>RPC Port</li>
  4316. <li>Tracking URL</li>
  4317. </ul>
  4318. @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
  4319. </doc>
  4320. </class>
  4321. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
  4322. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
  4323. <class name="RegisterApplicationMasterResponse" extends="java.lang.Object"
  4324. abstract="true"
  4325. static="false" final="false" visibility="public"
  4326. deprecated="not deprecated">
  4327. <constructor name="RegisterApplicationMasterResponse"
  4328. static="false" final="false" visibility="public"
  4329. deprecated="not deprecated">
  4330. </constructor>
  4331. <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  4332. abstract="true" native="false" synchronized="false"
  4333. static="false" final="false" visibility="public"
  4334. deprecated="not deprecated">
  4335. <doc>
  4336. <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
  4337. <code>ResourceManager</code> in the cluster.
  4338. @return maximum capability of allocated resources in the cluster]]>
  4339. </doc>
  4340. </method>
  4341. <method name="getApplicationACLs" return="java.util.Map"
  4342. abstract="true" native="false" synchronized="false"
  4343. static="false" final="false" visibility="public"
  4344. deprecated="not deprecated">
  4345. <doc>
  4346. <![CDATA[Get the <code>ApplicationACL</code>s for the application.
  4347. @return all the <code>ApplicationACL</code>s]]>
  4348. </doc>
  4349. </method>
  4350. <method name="getClientToAMTokenMasterKey" return="java.nio.ByteBuffer"
  4351. abstract="true" native="false" synchronized="false"
  4352. static="false" final="false" visibility="public"
  4353. deprecated="not deprecated">
  4354. <doc>
  4355. <![CDATA[<p>Get ClientToAMToken master key.</p>
  4356. <p>The ClientToAMToken master key is sent to <code>ApplicationMaster</code>
  4357. by <code>ResourceManager</code> via {@link RegisterApplicationMasterResponse}
  4358. , used to verify corresponding ClientToAMToken.</p>
  4359. @return ClientToAMToken master key]]>
  4360. </doc>
  4361. </method>
  4362. <method name="setClientToAMTokenMasterKey"
  4363. abstract="true" native="false" synchronized="false"
  4364. static="false" final="false" visibility="public"
  4365. deprecated="not deprecated">
  4366. <param name="key" type="java.nio.ByteBuffer"/>
  4367. <doc>
  4368. <![CDATA[Set ClientToAMToken master key.]]>
  4369. </doc>
  4370. </method>
  4371. <method name="getQueue" return="java.lang.String"
  4372. abstract="true" native="false" synchronized="false"
  4373. static="false" final="false" visibility="public"
  4374. deprecated="not deprecated">
  4375. <doc>
  4376. <![CDATA[<p>Get the queue that the application was placed in.<p>
  4377. @return the queue that the application was placed in.]]>
  4378. </doc>
  4379. </method>
  4380. <method name="setQueue"
  4381. abstract="true" native="false" synchronized="false"
  4382. static="false" final="false" visibility="public"
  4383. deprecated="not deprecated">
  4384. <param name="queue" type="java.lang.String"/>
  4385. <doc>
  4386. <![CDATA[<p>Set the queue that the application was placed in.<p>]]>
  4387. </doc>
  4388. </method>
  4389. <method name="getContainersFromPreviousAttempts" return="java.util.List"
  4390. abstract="true" native="false" synchronized="false"
  4391. static="false" final="false" visibility="public"
  4392. deprecated="not deprecated">
  4393. <doc>
  4394. <![CDATA[<p>
  4395. Get the list of running containers as viewed by
  4396. <code>ResourceManager</code> from previous application attempts.
  4397. </p>
  4398. @return the list of running containers as viewed by
  4399. <code>ResourceManager</code> from previous application attempts
  4400. @see RegisterApplicationMasterResponse#getNMTokensFromPreviousAttempts()]]>
  4401. </doc>
  4402. </method>
  4403. <method name="getNMTokensFromPreviousAttempts" return="java.util.List"
  4404. abstract="true" native="false" synchronized="false"
  4405. static="false" final="false" visibility="public"
  4406. deprecated="not deprecated">
  4407. <doc>
  4408. <![CDATA[Get the list of NMTokens for communicating with the NMs where the
  4409. containers of previous application attempts are running.
  4410. @return the list of NMTokens for communicating with the NMs where the
  4411. containers of previous application attempts are running.
  4412. @see RegisterApplicationMasterResponse#getContainersFromPreviousAttempts()]]>
  4413. </doc>
  4414. </method>
  4415. <method name="getSchedulerResourceTypes" return="java.util.EnumSet"
  4416. abstract="true" native="false" synchronized="false"
  4417. static="false" final="false" visibility="public"
  4418. deprecated="not deprecated">
  4419. <doc>
  4420. <![CDATA[Get a set of the resource types considered by the scheduler.
  4421. @return a Map of RM settings]]>
  4422. </doc>
  4423. </method>
  4424. <method name="getResourceProfiles" return="java.util.Map"
  4425. abstract="true" native="false" synchronized="false"
  4426. static="false" final="false" visibility="public"
  4427. deprecated="not deprecated">
  4428. <doc>
  4429. <![CDATA[Get list of supported resource profiles from RM.
  4430. @return a map of resource profiles and its capabilities.]]>
  4431. </doc>
  4432. </method>
  4433. <method name="getResourceTypes" return="java.util.List"
  4434. abstract="true" native="false" synchronized="false"
  4435. static="false" final="false" visibility="public"
  4436. deprecated="not deprecated">
  4437. <doc>
  4438. <![CDATA[Get available resource types supported by RM.
  4439. @return a Map of RM settings]]>
  4440. </doc>
  4441. </method>
  4442. <doc>
  4443. <![CDATA[The response sent by the {@code ResourceManager} to a new
  4444. {@code ApplicationMaster} on registration.
  4445. <p>
  4446. The response contains critical details such as:
  4447. <ul>
  4448. <li>Maximum capability for allocated resources in the cluster.</li>
  4449. <li>{@code ApplicationACL}s for the application.</li>
  4450. <li>ClientToAMToken master key.</li>
  4451. </ul>
  4452. @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
  4453. </doc>
  4454. </class>
  4455. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
  4456. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest -->
  4457. <class name="ReInitializeContainerRequest" extends="java.lang.Object"
  4458. abstract="true"
  4459. static="false" final="false" visibility="public"
  4460. deprecated="not deprecated">
  4461. <constructor name="ReInitializeContainerRequest"
  4462. static="false" final="false" visibility="public"
  4463. deprecated="not deprecated">
  4464. </constructor>
  4465. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest"
  4466. abstract="false" native="false" synchronized="false"
  4467. static="true" final="false" visibility="public"
  4468. deprecated="not deprecated">
  4469. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  4470. <param name="containerLaunchContext" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4471. <param name="autoCommit" type="boolean"/>
  4472. <doc>
  4473. <![CDATA[Creates a new instance of the ReInitializationContainerRequest.
  4474. @param containerId Container Id.
  4475. @param containerLaunchContext Container Launch Context.
  4476. @param autoCommit AutoCommit.
  4477. @return ReInitializationContainerRequest.]]>
  4478. </doc>
  4479. </method>
  4480. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  4481. abstract="true" native="false" synchronized="false"
  4482. static="false" final="false" visibility="public"
  4483. deprecated="not deprecated">
  4484. <doc>
  4485. <![CDATA[Get the <code>ContainerId</code> of the container to re-initialize.
  4486. @return <code>ContainerId</code> of the container to re-initialize.]]>
  4487. </doc>
  4488. </method>
  4489. <method name="getContainerLaunchContext" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  4490. abstract="true" native="false" synchronized="false"
  4491. static="false" final="false" visibility="public"
  4492. deprecated="not deprecated">
  4493. <doc>
  4494. <![CDATA[Get the <code>ContainerLaunchContext</code> to re-initialize the container
  4495. with.
  4496. @return <code>ContainerLaunchContext</code> of to re-initialize the
  4497. container with.]]>
  4498. </doc>
  4499. </method>
  4500. <method name="getAutoCommit" return="boolean"
  4501. abstract="true" native="false" synchronized="false"
  4502. static="false" final="false" visibility="public"
  4503. deprecated="not deprecated">
  4504. <doc>
  4505. <![CDATA[Check if AutoCommit is set for this ReInitialization.
  4506. @return If AutoCommit is set for this ReInitialization.]]>
  4507. </doc>
  4508. </method>
  4509. <doc>
  4510. <![CDATA[This encapsulates all the required fields needed for a Container
  4511. ReInitialization.]]>
  4512. </doc>
  4513. </class>
  4514. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest -->
  4515. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerResponse -->
  4516. <class name="ReInitializeContainerResponse" extends="java.lang.Object"
  4517. abstract="true"
  4518. static="false" final="false" visibility="public"
  4519. deprecated="not deprecated">
  4520. <constructor name="ReInitializeContainerResponse"
  4521. static="false" final="false" visibility="public"
  4522. deprecated="not deprecated">
  4523. </constructor>
  4524. <doc>
  4525. <![CDATA[The response to the {@link ReInitializeContainerRequest}.]]>
  4526. </doc>
  4527. </class>
  4528. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerResponse -->
  4529. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
  4530. <class name="ReleaseSharedCacheResourceRequest" extends="java.lang.Object"
  4531. abstract="true"
  4532. static="false" final="false" visibility="public"
  4533. deprecated="not deprecated">
  4534. <constructor name="ReleaseSharedCacheResourceRequest"
  4535. static="false" final="false" visibility="public"
  4536. deprecated="not deprecated">
  4537. </constructor>
  4538. <method name="getAppId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4539. abstract="true" native="false" synchronized="false"
  4540. static="false" final="false" visibility="public"
  4541. deprecated="not deprecated">
  4542. <doc>
  4543. <![CDATA[Get the <code>ApplicationId</code> of the resource to be released.
  4544. @return <code>ApplicationId</code>]]>
  4545. </doc>
  4546. </method>
  4547. <method name="setAppId"
  4548. abstract="true" native="false" synchronized="false"
  4549. static="false" final="false" visibility="public"
  4550. deprecated="not deprecated">
  4551. <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4552. <doc>
  4553. <![CDATA[Set the <code>ApplicationId</code> of the resource to be released.
  4554. @param id <code>ApplicationId</code>]]>
  4555. </doc>
  4556. </method>
  4557. <method name="getResourceKey" return="java.lang.String"
  4558. abstract="true" native="false" synchronized="false"
  4559. static="false" final="false" visibility="public"
  4560. deprecated="not deprecated">
  4561. <doc>
  4562. <![CDATA[Get the <code>key</code> of the resource to be released.
  4563. @return <code>key</code>]]>
  4564. </doc>
  4565. </method>
  4566. <method name="setResourceKey"
  4567. abstract="true" native="false" synchronized="false"
  4568. static="false" final="false" visibility="public"
  4569. deprecated="not deprecated">
  4570. <param name="key" type="java.lang.String"/>
  4571. <doc>
  4572. <![CDATA[Set the <code>key</code> of the resource to be released.
  4573. @param key unique identifier for the resource]]>
  4574. </doc>
  4575. </method>
  4576. <doc>
  4577. <![CDATA[<p>The request from clients to release a resource in the shared cache.</p>]]>
  4578. </doc>
  4579. </class>
  4580. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
  4581. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
  4582. <class name="ReleaseSharedCacheResourceResponse" extends="java.lang.Object"
  4583. abstract="true"
  4584. static="false" final="false" visibility="public"
  4585. deprecated="not deprecated">
  4586. <constructor name="ReleaseSharedCacheResourceResponse"
  4587. static="false" final="false" visibility="public"
  4588. deprecated="not deprecated">
  4589. </constructor>
  4590. <doc>
  4591. <![CDATA[<p>
  4592. The response to clients from the <code>SharedCacheManager</code> when
  4593. releasing a resource in the shared cache.
  4594. </p>
  4595. <p>
  4596. Currently, this is empty.
  4597. </p>]]>
  4598. </doc>
  4599. </class>
  4600. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
  4601. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
  4602. <class name="ReservationDeleteRequest" extends="java.lang.Object"
  4603. abstract="true"
  4604. static="false" final="false" visibility="public"
  4605. deprecated="not deprecated">
  4606. <constructor name="ReservationDeleteRequest"
  4607. static="false" final="false" visibility="public"
  4608. deprecated="not deprecated">
  4609. </constructor>
  4610. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"
  4611. abstract="false" native="false" synchronized="false"
  4612. static="true" final="false" visibility="public"
  4613. deprecated="not deprecated">
  4614. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  4615. </method>
  4616. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  4617. abstract="true" native="false" synchronized="false"
  4618. static="false" final="false" visibility="public"
  4619. deprecated="not deprecated">
  4620. <doc>
  4621. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  4622. allocation in the scheduler (between start and end time of this
  4623. reservation)
  4624. @return the {@link ReservationId} representing the unique id of the
  4625. corresponding reserved resource allocation in the scheduler]]>
  4626. </doc>
  4627. </method>
  4628. <method name="setReservationId"
  4629. abstract="true" native="false" synchronized="false"
  4630. static="false" final="false" visibility="public"
  4631. deprecated="not deprecated">
  4632. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  4633. <doc>
  4634. <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
  4635. allocation in the scheduler (between start and end time of this
  4636. reservation)
  4637. @param reservationId the {@link ReservationId} representing the the unique
  4638. id of the corresponding reserved resource allocation in the
  4639. scheduler]]>
  4640. </doc>
  4641. </method>
  4642. <doc>
  4643. <![CDATA[{@link ReservationDeleteRequest} captures the set of requirements the user
  4644. has to delete an existing reservation.
  4645. @see ReservationDefinition]]>
  4646. </doc>
  4647. </class>
  4648. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
  4649. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
  4650. <class name="ReservationDeleteResponse" extends="java.lang.Object"
  4651. abstract="true"
  4652. static="false" final="false" visibility="public"
  4653. deprecated="not deprecated">
  4654. <constructor name="ReservationDeleteResponse"
  4655. static="false" final="false" visibility="public"
  4656. deprecated="not deprecated">
  4657. </constructor>
  4658. <doc>
  4659. <![CDATA[{@link ReservationDeleteResponse} contains the answer of the admission
  4660. control system in the {@code ResourceManager} to a reservation delete
  4661. operation. Currently response is empty if the operation was successful, if
  4662. not an exception reporting reason for a failure.
  4663. @see ReservationDefinition]]>
  4664. </doc>
  4665. </class>
  4666. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
  4667. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest -->
  4668. <class name="ReservationListRequest" extends="java.lang.Object"
  4669. abstract="true"
  4670. static="false" final="false" visibility="public"
  4671. deprecated="not deprecated">
  4672. <constructor name="ReservationListRequest"
  4673. static="false" final="false" visibility="public"
  4674. deprecated="not deprecated">
  4675. </constructor>
  4676. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
  4677. abstract="false" native="false" synchronized="false"
  4678. static="true" final="false" visibility="public"
  4679. deprecated="not deprecated">
  4680. <param name="queue" type="java.lang.String"/>
  4681. <param name="reservationId" type="java.lang.String"/>
  4682. <param name="startTime" type="long"/>
  4683. <param name="endTime" type="long"/>
  4684. <param name="includeReservationAllocations" type="boolean"/>
  4685. <doc>
  4686. <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
  4687. reservations to list if it is provided. Otherwise, it will select active
  4688. reservations within the startTime and endTime (inclusive).
  4689. @param queue Required. Cannot be null or empty. Refers to the reservable
  4690. queue in the scheduler that was selected when creating a
  4691. reservation submission {@link ReservationSubmissionRequest}.
  4692. @param reservationId Optional. String representation of
  4693. {@code ReservationId} If provided, other fields will
  4694. be ignored.
  4695. @param startTime Optional. If provided, only reservations that
  4696. end after the startTime will be selected. This defaults
  4697. to 0 if an invalid number is used.
  4698. @param endTime Optional. If provided, only reservations that
  4699. start on or before endTime will be selected. This defaults
  4700. to Long.MAX_VALUE if an invalid number is used.
  4701. @param includeReservationAllocations Optional. Flag that
  4702. determines whether the entire reservation allocations are
  4703. to be returned. Reservation allocations are subject to
  4704. change in the event of re-planning as described by
  4705. {@code ReservationDefinition}.
  4706. @return the list of reservations via {@link ReservationListRequest}]]>
  4707. </doc>
  4708. </method>
  4709. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
  4710. abstract="false" native="false" synchronized="false"
  4711. static="true" final="false" visibility="public"
  4712. deprecated="not deprecated">
  4713. <param name="queue" type="java.lang.String"/>
  4714. <param name="reservationId" type="java.lang.String"/>
  4715. <param name="includeReservationAllocations" type="boolean"/>
  4716. <doc>
  4717. <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
  4718. reservations to list if it is provided. Otherwise, it will select active
  4719. reservations within the startTime and endTime (inclusive).
  4720. @param queue Required. Cannot be null or empty. Refers to the reservable
  4721. queue in the scheduler that was selected when creating a
  4722. reservation submission {@link ReservationSubmissionRequest}.
  4723. @param reservationId Optional. String representation of
  4724. {@code ReservationId} If provided, other fields will
  4725. be ignored.
  4726. @param includeReservationAllocations Optional. Flag that
  4727. determines whether the entire reservation allocations are
  4728. to be returned. Reservation allocations are subject to
  4729. change in the event of re-planning as described by
  4730. {@code ReservationDefinition}.
  4731. @return the list of reservations via {@link ReservationListRequest}]]>
  4732. </doc>
  4733. </method>
  4734. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
  4735. abstract="false" native="false" synchronized="false"
  4736. static="true" final="false" visibility="public"
  4737. deprecated="not deprecated">
  4738. <param name="queue" type="java.lang.String"/>
  4739. <param name="reservationId" type="java.lang.String"/>
  4740. <doc>
  4741. <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
  4742. reservations to list if it is provided. Otherwise, it will select active
  4743. reservations within the startTime and endTime (inclusive).
  4744. @param queue Required. Cannot be null or empty. Refers to the reservable
  4745. queue in the scheduler that was selected when creating a
  4746. reservation submission {@link ReservationSubmissionRequest}.
  4747. @param reservationId Optional. String representation of
  4748. {@code ReservationId} If provided, other fields will
  4749. be ignored.
  4750. @return the list of reservations via {@link ReservationListRequest}]]>
  4751. </doc>
  4752. </method>
  4753. <method name="getQueue" return="java.lang.String"
  4754. abstract="true" native="false" synchronized="false"
  4755. static="false" final="false" visibility="public"
  4756. deprecated="not deprecated">
  4757. <doc>
  4758. <![CDATA[Get queue name to use to find reservations.
  4759. @return the queue name to use to find reservations.]]>
  4760. </doc>
  4761. </method>
  4762. <method name="setQueue"
  4763. abstract="true" native="false" synchronized="false"
  4764. static="false" final="false" visibility="public"
  4765. deprecated="not deprecated">
  4766. <param name="queue" type="java.lang.String"/>
  4767. <doc>
  4768. <![CDATA[Set queue name to use to find resource allocations.
  4769. @param queue Required. Cannot be null or empty.]]>
  4770. </doc>
  4771. </method>
  4772. <method name="getReservationId" return="java.lang.String"
  4773. abstract="true" native="false" synchronized="false"
  4774. static="false" final="false" visibility="public"
  4775. deprecated="not deprecated">
  4776. <doc>
  4777. <![CDATA[Get the reservation id to use to find a reservation.
  4778. @return the reservation id of the reservation.]]>
  4779. </doc>
  4780. </method>
  4781. <method name="setReservationId"
  4782. abstract="true" native="false" synchronized="false"
  4783. static="false" final="false" visibility="public"
  4784. deprecated="not deprecated">
  4785. <param name="reservationId" type="java.lang.String"/>
  4786. <doc>
  4787. <![CDATA[Set the reservation id to use to find a reservation.
  4788. @param reservationId Optional. String representation of
  4789. {@code ReservationId} If provided, other fields will
  4790. be ignored.]]>
  4791. </doc>
  4792. </method>
  4793. <method name="getStartTime" return="long"
  4794. abstract="true" native="false" synchronized="false"
  4795. static="false" final="false" visibility="public"
  4796. deprecated="not deprecated">
  4797. <doc>
  4798. <![CDATA[Get the start time to use to search for reservations.
  4799. When this is set, reservations that start before this start
  4800. time are ignored.
  4801. @return the start time to use to search for reservations.]]>
  4802. </doc>
  4803. </method>
  4804. <method name="setStartTime"
  4805. abstract="true" native="false" synchronized="false"
  4806. static="false" final="false" visibility="public"
  4807. deprecated="not deprecated">
  4808. <param name="startTime" type="long"/>
  4809. <doc>
  4810. <![CDATA[Set the start time to use to search for reservations.
  4811. When this is set, reservations that start before this start
  4812. time are ignored.
  4813. @param startTime Optional. If provided, only reservations that
  4814. end after the startTime will be selected. This defaults
  4815. to 0 if an invalid number is used.]]>
  4816. </doc>
  4817. </method>
  4818. <method name="getEndTime" return="long"
  4819. abstract="true" native="false" synchronized="false"
  4820. static="false" final="false" visibility="public"
  4821. deprecated="not deprecated">
  4822. <doc>
  4823. <![CDATA[Get the end time to use to search for reservations.
  4824. When this is set, reservations that start after this end
  4825. time are ignored.
  4826. @return the end time to use to search for reservations.]]>
  4827. </doc>
  4828. </method>
  4829. <method name="setEndTime"
  4830. abstract="true" native="false" synchronized="false"
  4831. static="false" final="false" visibility="public"
  4832. deprecated="not deprecated">
  4833. <param name="endTime" type="long"/>
  4834. <doc>
  4835. <![CDATA[Set the end time to use to search for reservations.
  4836. When this is set, reservations that start after this end
  4837. time are ignored.
  4838. @param endTime Optional. If provided, only reservations that
  4839. start before endTime will be selected. This defaults
  4840. to Long.MAX_VALUE if an invalid number is used.]]>
  4841. </doc>
  4842. </method>
  4843. <method name="getIncludeResourceAllocations" return="boolean"
  4844. abstract="true" native="false" synchronized="false"
  4845. static="false" final="false" visibility="public"
  4846. deprecated="not deprecated">
  4847. <doc>
  4848. <![CDATA[Get the boolean representing whether or not the user
  4849. is requesting the full resource allocation.
  4850. If this is true, the full resource allocation will
  4851. be included in the response.
  4852. @return the end time to use to search for reservations.]]>
  4853. </doc>
  4854. </method>
  4855. <method name="setIncludeResourceAllocations"
  4856. abstract="true" native="false" synchronized="false"
  4857. static="false" final="false" visibility="public"
  4858. deprecated="not deprecated">
  4859. <param name="includeReservationAllocations" type="boolean"/>
  4860. <doc>
  4861. <![CDATA[Set the boolean representing whether or not the user
  4862. is requesting the full resource allocation.
  4863. If this is true, the full resource allocation will
  4864. be included in the response.
  4865. @param includeReservationAllocations Optional. Flag that
  4866. determines whether the entire list of
  4867. {@code ResourceAllocationRequest} will be returned.]]>
  4868. </doc>
  4869. </method>
  4870. <doc>
  4871. <![CDATA[{@link ReservationListRequest} captures the set of requirements the
  4872. user has to list reservations.]]>
  4873. </doc>
  4874. </class>
  4875. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest -->
  4876. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse -->
  4877. <class name="ReservationListResponse" extends="java.lang.Object"
  4878. abstract="true"
  4879. static="false" final="false" visibility="public"
  4880. deprecated="not deprecated">
  4881. <constructor name="ReservationListResponse"
  4882. static="false" final="false" visibility="public"
  4883. deprecated="not deprecated">
  4884. </constructor>
  4885. <method name="getReservationAllocationState" return="java.util.List"
  4886. abstract="true" native="false" synchronized="false"
  4887. static="false" final="false" visibility="public"
  4888. deprecated="not deprecated">
  4889. <doc>
  4890. <![CDATA[Get the list of {@link ReservationAllocationState}, that corresponds
  4891. to a reservation in the scheduler.
  4892. @return the list of {@link ReservationAllocationState} which holds
  4893. information of a particular reservation]]>
  4894. </doc>
  4895. </method>
  4896. <doc>
  4897. <![CDATA[{@link ReservationListResponse} captures the list of reservations that the
  4898. user has queried.
  4899. The resulting list of {@link ReservationAllocationState} contains a list of
  4900. {@code ResourceAllocationRequest} representing the current state of the
  4901. reservation resource allocations will be returned. This is subject to change
  4902. in the event of re-planning a described by {@code ReservationDefinition}
  4903. @see ReservationAllocationState]]>
  4904. </doc>
  4905. </class>
  4906. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse -->
  4907. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
  4908. <class name="ReservationSubmissionRequest" extends="java.lang.Object"
  4909. abstract="true"
  4910. static="false" final="false" visibility="public"
  4911. deprecated="not deprecated">
  4912. <constructor name="ReservationSubmissionRequest"
  4913. static="false" final="false" visibility="public"
  4914. deprecated="not deprecated">
  4915. </constructor>
  4916. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"
  4917. abstract="false" native="false" synchronized="false"
  4918. static="true" final="false" visibility="public"
  4919. deprecated="not deprecated">
  4920. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  4921. <param name="queueName" type="java.lang.String"/>
  4922. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  4923. </method>
  4924. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  4925. abstract="true" native="false" synchronized="false"
  4926. static="false" final="false" visibility="public"
  4927. deprecated="not deprecated">
  4928. <doc>
  4929. <![CDATA[Get the {@link ReservationDefinition} representing the user constraints for
  4930. this reservation
  4931. @return the reservation definition representing user constraints]]>
  4932. </doc>
  4933. </method>
  4934. <method name="setReservationDefinition"
  4935. abstract="true" native="false" synchronized="false"
  4936. static="false" final="false" visibility="public"
  4937. deprecated="not deprecated">
  4938. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  4939. <doc>
  4940. <![CDATA[Set the {@link ReservationDefinition} representing the user constraints for
  4941. this reservation
  4942. @param reservationDefinition the reservation request representing the
  4943. reservation]]>
  4944. </doc>
  4945. </method>
  4946. <method name="getQueue" return="java.lang.String"
  4947. abstract="true" native="false" synchronized="false"
  4948. static="false" final="false" visibility="public"
  4949. deprecated="not deprecated">
  4950. <doc>
  4951. <![CDATA[Get the name of the {@code Plan} that corresponds to the name of the
  4952. {@link QueueInfo} in the scheduler to which the reservation will be
  4953. submitted to.
  4954. @return the name of the {@code Plan} that corresponds to the name of the
  4955. {@link QueueInfo} in the scheduler to which the reservation will be
  4956. submitted to]]>
  4957. </doc>
  4958. </method>
  4959. <method name="setQueue"
  4960. abstract="true" native="false" synchronized="false"
  4961. static="false" final="false" visibility="public"
  4962. deprecated="not deprecated">
  4963. <param name="queueName" type="java.lang.String"/>
  4964. <doc>
  4965. <![CDATA[Set the name of the {@code Plan} that corresponds to the name of the
  4966. {@link QueueInfo} in the scheduler to which the reservation will be
  4967. submitted to
  4968. @param queueName the name of the parent {@code Plan} that corresponds to
  4969. the name of the {@link QueueInfo} in the scheduler to which the
  4970. reservation will be submitted to]]>
  4971. </doc>
  4972. </method>
  4973. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  4974. abstract="true" native="false" synchronized="false"
  4975. static="false" final="false" visibility="public"
  4976. deprecated="not deprecated">
  4977. <doc>
  4978. <![CDATA[Get the reservation id that corresponds to the reservation submission.
  4979. @return reservation id that will be used to identify the reservation
  4980. submission.]]>
  4981. </doc>
  4982. </method>
  4983. <method name="setReservationId"
  4984. abstract="true" native="false" synchronized="false"
  4985. static="false" final="false" visibility="public"
  4986. deprecated="not deprecated">
  4987. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  4988. <doc>
  4989. <![CDATA[Set the reservation id that corresponds to the reservation submission.
  4990. @param reservationId reservation id that will be used to identify the
  4991. reservation submission.]]>
  4992. </doc>
  4993. </method>
  4994. <doc>
  4995. <![CDATA[{@link ReservationSubmissionRequest} captures the set of requirements the
  4996. user has to create a reservation.
  4997. @see ReservationDefinition]]>
  4998. </doc>
  4999. </class>
  5000. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
  5001. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
  5002. <class name="ReservationSubmissionResponse" extends="java.lang.Object"
  5003. abstract="true"
  5004. static="false" final="false" visibility="public"
  5005. deprecated="not deprecated">
  5006. <constructor name="ReservationSubmissionResponse"
  5007. static="false" final="false" visibility="public"
  5008. deprecated="not deprecated">
  5009. </constructor>
  5010. <doc>
  5011. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client on
  5012. reservation submission.</p>
  5013. <p>Currently, this is empty.</p>
  5014. {@code ApplicationClientProtocol#submitReservation(
  5015. ReservationSubmissionRequest)}]]>
  5016. </doc>
  5017. </class>
  5018. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
  5019. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
  5020. <class name="ReservationUpdateRequest" extends="java.lang.Object"
  5021. abstract="true"
  5022. static="false" final="false" visibility="public"
  5023. deprecated="not deprecated">
  5024. <constructor name="ReservationUpdateRequest"
  5025. static="false" final="false" visibility="public"
  5026. deprecated="not deprecated">
  5027. </constructor>
  5028. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"
  5029. abstract="false" native="false" synchronized="false"
  5030. static="true" final="false" visibility="public"
  5031. deprecated="not deprecated">
  5032. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  5033. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  5034. </method>
  5035. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  5036. abstract="true" native="false" synchronized="false"
  5037. static="false" final="false" visibility="public"
  5038. deprecated="not deprecated">
  5039. <doc>
  5040. <![CDATA[Get the {@link ReservationDefinition} representing the updated user
  5041. constraints for this reservation
  5042. @return the reservation definition representing user constraints]]>
  5043. </doc>
  5044. </method>
  5045. <method name="setReservationDefinition"
  5046. abstract="true" native="false" synchronized="false"
  5047. static="false" final="false" visibility="public"
  5048. deprecated="not deprecated">
  5049. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  5050. <doc>
  5051. <![CDATA[Set the {@link ReservationDefinition} representing the updated user
  5052. constraints for this reservation
  5053. @param reservationDefinition the reservation request representing the
  5054. reservation]]>
  5055. </doc>
  5056. </method>
  5057. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  5058. abstract="true" native="false" synchronized="false"
  5059. static="false" final="false" visibility="public"
  5060. deprecated="not deprecated">
  5061. <doc>
  5062. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  5063. allocation in the scheduler (between start and end time of this
  5064. reservation)
  5065. @return the {@link ReservationId} representing the unique id of the
  5066. corresponding reserved resource allocation in the scheduler]]>
  5067. </doc>
  5068. </method>
  5069. <method name="setReservationId"
  5070. abstract="true" native="false" synchronized="false"
  5071. static="false" final="false" visibility="public"
  5072. deprecated="not deprecated">
  5073. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  5074. <doc>
  5075. <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
  5076. allocation in the scheduler (between start and end time of this
  5077. reservation)
  5078. @param reservationId the {@link ReservationId} representing the the unique
  5079. id of the corresponding reserved resource allocation in the
  5080. scheduler]]>
  5081. </doc>
  5082. </method>
  5083. <doc>
  5084. <![CDATA[{@link ReservationUpdateRequest} captures the set of requirements the user
  5085. has to update an existing reservation.
  5086. @see ReservationDefinition]]>
  5087. </doc>
  5088. </class>
  5089. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
  5090. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
  5091. <class name="ReservationUpdateResponse" extends="java.lang.Object"
  5092. abstract="true"
  5093. static="false" final="false" visibility="public"
  5094. deprecated="not deprecated">
  5095. <constructor name="ReservationUpdateResponse"
  5096. static="false" final="false" visibility="public"
  5097. deprecated="not deprecated">
  5098. </constructor>
  5099. <doc>
  5100. <![CDATA[{@link ReservationUpdateResponse} contains the answer of the admission
  5101. control system in the {@code ResourceManager} to a reservation update
  5102. operation. Currently response is empty if the operation was successful, if
  5103. not an exception reporting reason for a failure.
  5104. @see ReservationDefinition]]>
  5105. </doc>
  5106. </class>
  5107. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
  5108. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest -->
  5109. <class name="ResourceLocalizationRequest" extends="java.lang.Object"
  5110. abstract="true"
  5111. static="false" final="false" visibility="public"
  5112. deprecated="not deprecated">
  5113. <constructor name="ResourceLocalizationRequest"
  5114. static="false" final="false" visibility="public"
  5115. deprecated="not deprecated">
  5116. </constructor>
  5117. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest"
  5118. abstract="false" native="false" synchronized="false"
  5119. static="true" final="false" visibility="public"
  5120. deprecated="not deprecated">
  5121. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5122. <param name="localResources" type="java.util.Map"/>
  5123. </method>
  5124. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5125. abstract="true" native="false" synchronized="false"
  5126. static="false" final="false" visibility="public"
  5127. deprecated="not deprecated">
  5128. <doc>
  5129. <![CDATA[Get the <code>ContainerId</code> of the container to localize resources.
  5130. @return <code>ContainerId</code> of the container to localize resources.]]>
  5131. </doc>
  5132. </method>
  5133. <method name="getLocalResources" return="java.util.Map"
  5134. abstract="true" native="false" synchronized="false"
  5135. static="false" final="false" visibility="public"
  5136. deprecated="not deprecated">
  5137. <doc>
  5138. <![CDATA[Get <code>LocalResource</code> required by the container.
  5139. @return all <code>LocalResource</code> required by the container]]>
  5140. </doc>
  5141. </method>
  5142. <doc>
  5143. <![CDATA[The request sent by the ApplicationMaster to ask for localizing resources.]]>
  5144. </doc>
  5145. </class>
  5146. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest -->
  5147. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationResponse -->
  5148. <class name="ResourceLocalizationResponse" extends="java.lang.Object"
  5149. abstract="true"
  5150. static="false" final="false" visibility="public"
  5151. deprecated="not deprecated">
  5152. <constructor name="ResourceLocalizationResponse"
  5153. static="false" final="false" visibility="public"
  5154. deprecated="not deprecated">
  5155. </constructor>
  5156. <doc>
  5157. <![CDATA[The response to the {@link ResourceLocalizationRequest}]]>
  5158. </doc>
  5159. </class>
  5160. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationResponse -->
  5161. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RestartContainerResponse -->
  5162. <class name="RestartContainerResponse" extends="java.lang.Object"
  5163. abstract="true"
  5164. static="false" final="false" visibility="public"
  5165. deprecated="not deprecated">
  5166. <constructor name="RestartContainerResponse"
  5167. static="false" final="false" visibility="public"
  5168. deprecated="not deprecated">
  5169. </constructor>
  5170. <doc>
  5171. <![CDATA[The response to a restart Container request.]]>
  5172. </doc>
  5173. </class>
  5174. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RestartContainerResponse -->
  5175. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RollbackResponse -->
  5176. <class name="RollbackResponse" extends="java.lang.Object"
  5177. abstract="true"
  5178. static="false" final="false" visibility="public"
  5179. deprecated="not deprecated">
  5180. <constructor name="RollbackResponse"
  5181. static="false" final="false" visibility="public"
  5182. deprecated="not deprecated">
  5183. </constructor>
  5184. <doc>
  5185. <![CDATA[Response to a Rollback request.]]>
  5186. </doc>
  5187. </class>
  5188. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RollbackResponse -->
  5189. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest -->
  5190. <class name="SignalContainerRequest" extends="java.lang.Object"
  5191. abstract="true"
  5192. static="false" final="false" visibility="public"
  5193. deprecated="not deprecated">
  5194. <constructor name="SignalContainerRequest"
  5195. static="false" final="false" visibility="public"
  5196. deprecated="not deprecated">
  5197. </constructor>
  5198. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest"
  5199. abstract="false" native="false" synchronized="false"
  5200. static="true" final="false" visibility="public"
  5201. deprecated="not deprecated">
  5202. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5203. <param name="signalContainerCommand" type="org.apache.hadoop.yarn.api.records.SignalContainerCommand"/>
  5204. </method>
  5205. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5206. abstract="true" native="false" synchronized="false"
  5207. static="false" final="false" visibility="public"
  5208. deprecated="not deprecated">
  5209. <doc>
  5210. <![CDATA[Get the <code>ContainerId</code> of the container to signal.
  5211. @return <code>ContainerId</code> of the container to signal.]]>
  5212. </doc>
  5213. </method>
  5214. <method name="setContainerId"
  5215. abstract="true" native="false" synchronized="false"
  5216. static="false" final="false" visibility="public"
  5217. deprecated="not deprecated">
  5218. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5219. <doc>
  5220. <![CDATA[Set the <code>ContainerId</code> of the container to signal.]]>
  5221. </doc>
  5222. </method>
  5223. <method name="getCommand" return="org.apache.hadoop.yarn.api.records.SignalContainerCommand"
  5224. abstract="true" native="false" synchronized="false"
  5225. static="false" final="false" visibility="public"
  5226. deprecated="not deprecated">
  5227. <doc>
  5228. <![CDATA[Get the <code>SignalContainerCommand</code> of the signal request.
  5229. @return <code>SignalContainerCommand</code> of the signal request.]]>
  5230. </doc>
  5231. </method>
  5232. <method name="setCommand"
  5233. abstract="true" native="false" synchronized="false"
  5234. static="false" final="false" visibility="public"
  5235. deprecated="not deprecated">
  5236. <param name="command" type="org.apache.hadoop.yarn.api.records.SignalContainerCommand"/>
  5237. <doc>
  5238. <![CDATA[Set the <code>SignalContainerCommand</code> of the signal request.]]>
  5239. </doc>
  5240. </method>
  5241. <doc>
  5242. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  5243. or by the <code>ApplicationMaster</code> to the <code>NodeManager</code>
  5244. to signal a container.
  5245. @see SignalContainerCommand </p>]]>
  5246. </doc>
  5247. </class>
  5248. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest -->
  5249. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse -->
  5250. <class name="SignalContainerResponse" extends="java.lang.Object"
  5251. abstract="true"
  5252. static="false" final="false" visibility="public"
  5253. deprecated="not deprecated">
  5254. <constructor name="SignalContainerResponse"
  5255. static="false" final="false" visibility="public"
  5256. deprecated="not deprecated">
  5257. </constructor>
  5258. <doc>
  5259. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client
  5260. signalling a container.</p>
  5261. <p>Currently it's empty.</p>
  5262. @see ApplicationClientProtocol#signalToContainer(SignalContainerRequest)]]>
  5263. </doc>
  5264. </class>
  5265. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse -->
  5266. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
  5267. <class name="StartContainerRequest" extends="java.lang.Object"
  5268. abstract="true"
  5269. static="false" final="false" visibility="public"
  5270. deprecated="not deprecated">
  5271. <constructor name="StartContainerRequest"
  5272. static="false" final="false" visibility="public"
  5273. deprecated="not deprecated">
  5274. </constructor>
  5275. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest"
  5276. abstract="false" native="false" synchronized="false"
  5277. static="true" final="false" visibility="public"
  5278. deprecated="not deprecated">
  5279. <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  5280. <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
  5281. </method>
  5282. <method name="getContainerLaunchContext" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  5283. abstract="true" native="false" synchronized="false"
  5284. static="false" final="false" visibility="public"
  5285. deprecated="not deprecated">
  5286. <doc>
  5287. <![CDATA[Get the <code>ContainerLaunchContext</code> for the container to be started
  5288. by the <code>NodeManager</code>.
  5289. @return <code>ContainerLaunchContext</code> for the container to be started
  5290. by the <code>NodeManager</code>]]>
  5291. </doc>
  5292. </method>
  5293. <method name="setContainerLaunchContext"
  5294. abstract="true" native="false" synchronized="false"
  5295. static="false" final="false" visibility="public"
  5296. deprecated="not deprecated">
  5297. <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  5298. <doc>
  5299. <![CDATA[Set the <code>ContainerLaunchContext</code> for the container to be started
  5300. by the <code>NodeManager</code>
  5301. @param context <code>ContainerLaunchContext</code> for the container to be
  5302. started by the <code>NodeManager</code>]]>
  5303. </doc>
  5304. </method>
  5305. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  5306. abstract="true" native="false" synchronized="false"
  5307. static="false" final="false" visibility="public"
  5308. deprecated="not deprecated">
  5309. <doc>
  5310. <![CDATA[Get the container token to be used for authorization during starting
  5311. container.
  5312. <p>
  5313. Note: {@link NMToken} will be used for authenticating communication with
  5314. {@code NodeManager}.
  5315. @return the container token to be used for authorization during starting
  5316. container.
  5317. @see NMToken
  5318. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  5319. </doc>
  5320. </method>
  5321. <method name="setContainerToken"
  5322. abstract="true" native="false" synchronized="false"
  5323. static="false" final="false" visibility="public"
  5324. deprecated="not deprecated">
  5325. <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
  5326. </method>
  5327. <doc>
  5328. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
  5329. <code>NodeManager</code> to <em>start</em> a container.</p>
  5330. <p>The <code>ApplicationMaster</code> has to provide details such as
  5331. allocated resource capability, security tokens (if enabled), command
  5332. to be executed to start the container, environment for the process,
  5333. necessary binaries/jar/shared-objects etc. via the
  5334. {@link ContainerLaunchContext}.</p>
  5335. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  5336. </doc>
  5337. </class>
  5338. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
  5339. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
  5340. <class name="StartContainersRequest" extends="java.lang.Object"
  5341. abstract="true"
  5342. static="false" final="false" visibility="public"
  5343. deprecated="not deprecated">
  5344. <constructor name="StartContainersRequest"
  5345. static="false" final="false" visibility="public"
  5346. deprecated="not deprecated">
  5347. </constructor>
  5348. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"
  5349. abstract="false" native="false" synchronized="false"
  5350. static="true" final="false" visibility="public"
  5351. deprecated="not deprecated">
  5352. <param name="requests" type="java.util.List"/>
  5353. </method>
  5354. <method name="getStartContainerRequests" return="java.util.List"
  5355. abstract="true" native="false" synchronized="false"
  5356. static="false" final="false" visibility="public"
  5357. deprecated="not deprecated">
  5358. <doc>
  5359. <![CDATA[Get a list of {@link StartContainerRequest} to start containers.
  5360. @return a list of {@link StartContainerRequest} to start containers.]]>
  5361. </doc>
  5362. </method>
  5363. <method name="setStartContainerRequests"
  5364. abstract="true" native="false" synchronized="false"
  5365. static="false" final="false" visibility="public"
  5366. deprecated="not deprecated">
  5367. <param name="request" type="java.util.List"/>
  5368. <doc>
  5369. <![CDATA[Set a list of {@link StartContainerRequest} to start containers.
  5370. @param request a list of {@link StartContainerRequest} to start containers]]>
  5371. </doc>
  5372. </method>
  5373. <doc>
  5374. <![CDATA[<p>
  5375. The request which contains a list of {@link StartContainerRequest} sent by
  5376. the <code>ApplicationMaster</code> to the <code>NodeManager</code> to
  5377. <em>start</em> containers.
  5378. </p>
  5379. <p>
  5380. In each {@link StartContainerRequest}, the <code>ApplicationMaster</code> has
  5381. to provide details such as allocated resource capability, security tokens (if
  5382. enabled), command to be executed to start the container, environment for the
  5383. process, necessary binaries/jar/shared-objects etc. via the
  5384. {@link ContainerLaunchContext}.
  5385. </p>
  5386. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  5387. </doc>
  5388. </class>
  5389. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
  5390. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
  5391. <class name="StartContainersResponse" extends="java.lang.Object"
  5392. abstract="true"
  5393. static="false" final="false" visibility="public"
  5394. deprecated="not deprecated">
  5395. <constructor name="StartContainersResponse"
  5396. static="false" final="false" visibility="public"
  5397. deprecated="not deprecated">
  5398. </constructor>
  5399. <method name="getSuccessfullyStartedContainers" return="java.util.List"
  5400. abstract="true" native="false" synchronized="false"
  5401. static="false" final="false" visibility="public"
  5402. deprecated="not deprecated">
  5403. <doc>
  5404. <![CDATA[Get the list of <code>ContainerId</code> s of the containers that are
  5405. started successfully.
  5406. @return the list of <code>ContainerId</code> s of the containers that are
  5407. started successfully.
  5408. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  5409. </doc>
  5410. </method>
  5411. <method name="getFailedRequests" return="java.util.Map"
  5412. abstract="true" native="false" synchronized="false"
  5413. static="false" final="false" visibility="public"
  5414. deprecated="not deprecated">
  5415. <doc>
  5416. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  5417. from per container for failed requests
  5418. @return map of containerId-to-exception]]>
  5419. </doc>
  5420. </method>
  5421. <method name="getAllServicesMetaData" return="java.util.Map"
  5422. abstract="true" native="false" synchronized="false"
  5423. static="false" final="false" visibility="public"
  5424. deprecated="not deprecated">
  5425. <doc>
  5426. <![CDATA[<p>
  5427. Get the meta-data from all auxiliary services running on the
  5428. <code>NodeManager</code>.
  5429. </p>
  5430. <p>
  5431. The meta-data is returned as a Map between the auxiliary service names and
  5432. their corresponding per service meta-data as an opaque blob
  5433. <code>ByteBuffer</code>
  5434. </p>
  5435. <p>
  5436. To be able to interpret the per-service meta-data, you should consult the
  5437. documentation for the Auxiliary-service configured on the NodeManager
  5438. </p>
  5439. @return a Map between the names of auxiliary services and their
  5440. corresponding meta-data]]>
  5441. </doc>
  5442. </method>
  5443. <doc>
  5444. <![CDATA[<p>
  5445. The response sent by the <code>NodeManager</code> to the
  5446. <code>ApplicationMaster</code> when asked to <em>start</em> an allocated
  5447. container.
  5448. </p>
  5449. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  5450. </doc>
  5451. </class>
  5452. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
  5453. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
  5454. <class name="StopContainersRequest" extends="java.lang.Object"
  5455. abstract="true"
  5456. static="false" final="false" visibility="public"
  5457. deprecated="not deprecated">
  5458. <constructor name="StopContainersRequest"
  5459. static="false" final="false" visibility="public"
  5460. deprecated="not deprecated">
  5461. </constructor>
  5462. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"
  5463. abstract="false" native="false" synchronized="false"
  5464. static="true" final="false" visibility="public"
  5465. deprecated="not deprecated">
  5466. <param name="containerIds" type="java.util.List"/>
  5467. </method>
  5468. <method name="getContainerIds" return="java.util.List"
  5469. abstract="true" native="false" synchronized="false"
  5470. static="false" final="false" visibility="public"
  5471. deprecated="not deprecated">
  5472. <doc>
  5473. <![CDATA[Get the <code>ContainerId</code>s of the containers to be stopped.
  5474. @return <code>ContainerId</code>s of containers to be stopped]]>
  5475. </doc>
  5476. </method>
  5477. <method name="setContainerIds"
  5478. abstract="true" native="false" synchronized="false"
  5479. static="false" final="false" visibility="public"
  5480. deprecated="not deprecated">
  5481. <param name="containerIds" type="java.util.List"/>
  5482. <doc>
  5483. <![CDATA[Set the <code>ContainerId</code>s of the containers to be stopped.
  5484. @param containerIds <code>ContainerId</code>s of the containers to be stopped]]>
  5485. </doc>
  5486. </method>
  5487. <doc>
  5488. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
  5489. <code>NodeManager</code> to <em>stop</em> containers.</p>
  5490. @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
  5491. </doc>
  5492. </class>
  5493. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
  5494. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
  5495. <class name="StopContainersResponse" extends="java.lang.Object"
  5496. abstract="true"
  5497. static="false" final="false" visibility="public"
  5498. deprecated="not deprecated">
  5499. <constructor name="StopContainersResponse"
  5500. static="false" final="false" visibility="public"
  5501. deprecated="not deprecated">
  5502. </constructor>
  5503. <method name="getSuccessfullyStoppedContainers" return="java.util.List"
  5504. abstract="true" native="false" synchronized="false"
  5505. static="false" final="false" visibility="public"
  5506. deprecated="not deprecated">
  5507. <doc>
  5508. <![CDATA[Get the list of containerIds of successfully stopped containers.
  5509. @return the list of containerIds of successfully stopped containers.]]>
  5510. </doc>
  5511. </method>
  5512. <method name="getFailedRequests" return="java.util.Map"
  5513. abstract="true" native="false" synchronized="false"
  5514. static="false" final="false" visibility="public"
  5515. deprecated="not deprecated">
  5516. <doc>
  5517. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  5518. from per container for failed requests
  5519. @return map of containerId-to-exception]]>
  5520. </doc>
  5521. </method>
  5522. <doc>
  5523. <![CDATA[<p>
  5524. The response sent by the <code>NodeManager</code> to the
  5525. <code>ApplicationMaster</code> when asked to <em>stop</em> allocated
  5526. containers.
  5527. </p>
  5528. @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
  5529. </doc>
  5530. </class>
  5531. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
  5532. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
  5533. <class name="SubmitApplicationRequest" extends="java.lang.Object"
  5534. abstract="true"
  5535. static="false" final="false" visibility="public"
  5536. deprecated="not deprecated">
  5537. <constructor name="SubmitApplicationRequest"
  5538. static="false" final="false" visibility="public"
  5539. deprecated="not deprecated">
  5540. </constructor>
  5541. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"
  5542. abstract="false" native="false" synchronized="false"
  5543. static="true" final="false" visibility="public"
  5544. deprecated="not deprecated">
  5545. <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
  5546. </method>
  5547. <method name="getApplicationSubmissionContext" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  5548. abstract="true" native="false" synchronized="false"
  5549. static="false" final="false" visibility="public"
  5550. deprecated="not deprecated">
  5551. <doc>
  5552. <![CDATA[Get the <code>ApplicationSubmissionContext</code> for the application.
  5553. @return <code>ApplicationSubmissionContext</code> for the application]]>
  5554. </doc>
  5555. </method>
  5556. <method name="setApplicationSubmissionContext"
  5557. abstract="true" native="false" synchronized="false"
  5558. static="false" final="false" visibility="public"
  5559. deprecated="not deprecated">
  5560. <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
  5561. <doc>
  5562. <![CDATA[Set the <code>ApplicationSubmissionContext</code> for the application.
  5563. @param context <code>ApplicationSubmissionContext</code> for the
  5564. application]]>
  5565. </doc>
  5566. </method>
  5567. <doc>
  5568. <![CDATA[<p>The request sent by a client to <em>submit an application</em> to the
  5569. <code>ResourceManager</code>.</p>
  5570. <p>The request, via {@link ApplicationSubmissionContext}, contains
  5571. details such as queue, {@link Resource} required to run the
  5572. <code>ApplicationMaster</code>, the equivalent of
  5573. {@link ContainerLaunchContext} for launching the
  5574. <code>ApplicationMaster</code> etc.
  5575. @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
  5576. </doc>
  5577. </class>
  5578. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
  5579. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
  5580. <class name="SubmitApplicationResponse" extends="java.lang.Object"
  5581. abstract="true"
  5582. static="false" final="false" visibility="public"
  5583. deprecated="not deprecated">
  5584. <constructor name="SubmitApplicationResponse"
  5585. static="false" final="false" visibility="public"
  5586. deprecated="not deprecated">
  5587. </constructor>
  5588. <doc>
  5589. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client on
  5590. application submission.</p>
  5591. <p>Currently, this is empty.</p>
  5592. @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
  5593. </doc>
  5594. </class>
  5595. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
  5596. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest -->
  5597. <class name="UpdateApplicationPriorityRequest" extends="java.lang.Object"
  5598. abstract="true"
  5599. static="false" final="false" visibility="public"
  5600. deprecated="not deprecated">
  5601. <constructor name="UpdateApplicationPriorityRequest"
  5602. static="false" final="false" visibility="public"
  5603. deprecated="not deprecated">
  5604. </constructor>
  5605. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest"
  5606. abstract="false" native="false" synchronized="false"
  5607. static="true" final="false" visibility="public"
  5608. deprecated="not deprecated">
  5609. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5610. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5611. </method>
  5612. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5613. abstract="true" native="false" synchronized="false"
  5614. static="false" final="false" visibility="public"
  5615. deprecated="not deprecated">
  5616. <doc>
  5617. <![CDATA[Get the <code>ApplicationId</code> of the application.
  5618. @return <code>ApplicationId</code> of the application]]>
  5619. </doc>
  5620. </method>
  5621. <method name="setApplicationId"
  5622. abstract="true" native="false" synchronized="false"
  5623. static="false" final="false" visibility="public"
  5624. deprecated="not deprecated">
  5625. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5626. <doc>
  5627. <![CDATA[Set the <code>ApplicationId</code> of the application.
  5628. @param applicationId <code>ApplicationId</code> of the application]]>
  5629. </doc>
  5630. </method>
  5631. <method name="getApplicationPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  5632. abstract="true" native="false" synchronized="false"
  5633. static="false" final="false" visibility="public"
  5634. deprecated="not deprecated">
  5635. <doc>
  5636. <![CDATA[Get the <code>Priority</code> of the application to be set.
  5637. @return <code>Priority</code> of the application to be set.]]>
  5638. </doc>
  5639. </method>
  5640. <method name="setApplicationPriority"
  5641. abstract="true" native="false" synchronized="false"
  5642. static="false" final="false" visibility="public"
  5643. deprecated="not deprecated">
  5644. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5645. <doc>
  5646. <![CDATA[Set the <code>Priority</code> of the application.
  5647. @param priority <code>Priority</code> of the application]]>
  5648. </doc>
  5649. </method>
  5650. <doc>
  5651. <![CDATA[<p>
  5652. The request sent by the client to the <code>ResourceManager</code> to set or
  5653. update the application priority.
  5654. </p>
  5655. <p>
  5656. The request includes the {@link ApplicationId} of the application and
  5657. {@link Priority} to be set for an application
  5658. </p>
  5659. @see ApplicationClientProtocol#updateApplicationPriority(UpdateApplicationPriorityRequest)]]>
  5660. </doc>
  5661. </class>
  5662. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest -->
  5663. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse -->
  5664. <class name="UpdateApplicationPriorityResponse" extends="java.lang.Object"
  5665. abstract="true"
  5666. static="false" final="false" visibility="public"
  5667. deprecated="not deprecated">
  5668. <constructor name="UpdateApplicationPriorityResponse"
  5669. static="false" final="false" visibility="public"
  5670. deprecated="not deprecated">
  5671. </constructor>
  5672. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse"
  5673. abstract="false" native="false" synchronized="false"
  5674. static="true" final="false" visibility="public"
  5675. deprecated="not deprecated">
  5676. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5677. </method>
  5678. <method name="getApplicationPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  5679. abstract="true" native="false" synchronized="false"
  5680. static="false" final="false" visibility="public"
  5681. deprecated="not deprecated">
  5682. <doc>
  5683. <![CDATA[Get the <code>Priority</code> of the application to be set.
  5684. @return Updated <code>Priority</code> of the application.]]>
  5685. </doc>
  5686. </method>
  5687. <method name="setApplicationPriority"
  5688. abstract="true" native="false" synchronized="false"
  5689. static="false" final="false" visibility="public"
  5690. deprecated="not deprecated">
  5691. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5692. <doc>
  5693. <![CDATA[Set the <code>Priority</code> of the application.
  5694. @param priority <code>Priority</code> of the application]]>
  5695. </doc>
  5696. </method>
  5697. <doc>
  5698. <![CDATA[<p>
  5699. The response sent by the <code>ResourceManager</code> to the client on update
  5700. the application priority.
  5701. </p>
  5702. <p>
  5703. A response without exception means that the move has completed successfully.
  5704. </p>
  5705. @see ApplicationClientProtocol#updateApplicationPriority(UpdateApplicationPriorityRequest)]]>
  5706. </doc>
  5707. </class>
  5708. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse -->
  5709. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest -->
  5710. <class name="UpdateApplicationTimeoutsRequest" extends="java.lang.Object"
  5711. abstract="true"
  5712. static="false" final="false" visibility="public"
  5713. deprecated="not deprecated">
  5714. <constructor name="UpdateApplicationTimeoutsRequest"
  5715. static="false" final="false" visibility="public"
  5716. deprecated="not deprecated">
  5717. </constructor>
  5718. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest"
  5719. abstract="false" native="false" synchronized="false"
  5720. static="true" final="false" visibility="public"
  5721. deprecated="not deprecated">
  5722. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5723. <param name="applicationTimeouts" type="java.util.Map"/>
  5724. </method>
  5725. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5726. abstract="true" native="false" synchronized="false"
  5727. static="false" final="false" visibility="public"
  5728. deprecated="not deprecated">
  5729. <doc>
  5730. <![CDATA[Get the <code>ApplicationId</code> of the application.
  5731. @return <code>ApplicationId</code> of the application]]>
  5732. </doc>
  5733. </method>
  5734. <method name="setApplicationId"
  5735. abstract="true" native="false" synchronized="false"
  5736. static="false" final="false" visibility="public"
  5737. deprecated="not deprecated">
  5738. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5739. <doc>
  5740. <![CDATA[Set the <code>ApplicationId</code> of the application.
  5741. @param applicationId <code>ApplicationId</code> of the application]]>
  5742. </doc>
  5743. </method>
  5744. <method name="getApplicationTimeouts" return="java.util.Map"
  5745. abstract="true" native="false" synchronized="false"
  5746. static="false" final="false" visibility="public"
  5747. deprecated="not deprecated">
  5748. <doc>
  5749. <![CDATA[Get <code>ApplicationTimeouts</code> of the application. Timeout value is
  5750. in ISO8601 standard with format <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.
  5751. @return all <code>ApplicationTimeouts</code> of the application.]]>
  5752. </doc>
  5753. </method>
  5754. <method name="setApplicationTimeouts"
  5755. abstract="true" native="false" synchronized="false"
  5756. static="false" final="false" visibility="public"
  5757. deprecated="not deprecated">
  5758. <param name="applicationTimeouts" type="java.util.Map"/>
  5759. <doc>
  5760. <![CDATA[Set the <code>ApplicationTimeouts</code> for the application. Timeout value
  5761. is absolute. Timeout value should meet ISO8601 format. Support ISO8601
  5762. format is <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>. All pre-existing Map entries
  5763. are cleared before adding the new Map.
  5764. @param applicationTimeouts <code>ApplicationTimeouts</code>s for the
  5765. application]]>
  5766. </doc>
  5767. </method>
  5768. <doc>
  5769. <![CDATA[<p>
  5770. The request sent by the client to the <code>ResourceManager</code> to set or
  5771. update the application timeout.
  5772. </p>
  5773. <p>
  5774. The request includes the {@link ApplicationId} of the application and timeout
  5775. to be set for an application
  5776. </p>]]>
  5777. </doc>
  5778. </class>
  5779. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest -->
  5780. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse -->
  5781. <class name="UpdateApplicationTimeoutsResponse" extends="java.lang.Object"
  5782. abstract="true"
  5783. static="false" final="false" visibility="public"
  5784. deprecated="not deprecated">
  5785. <constructor name="UpdateApplicationTimeoutsResponse"
  5786. static="false" final="false" visibility="public"
  5787. deprecated="not deprecated">
  5788. </constructor>
  5789. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse"
  5790. abstract="false" native="false" synchronized="false"
  5791. static="true" final="false" visibility="public"
  5792. deprecated="not deprecated">
  5793. </method>
  5794. <method name="getApplicationTimeouts" return="java.util.Map"
  5795. abstract="true" native="false" synchronized="false"
  5796. static="false" final="false" visibility="public"
  5797. deprecated="not deprecated">
  5798. <doc>
  5799. <![CDATA[Get <code>ApplicationTimeouts</code> of the application. Timeout value is
  5800. in ISO8601 standard with format <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.
  5801. @return all <code>ApplicationTimeouts</code> of the application.]]>
  5802. </doc>
  5803. </method>
  5804. <method name="setApplicationTimeouts"
  5805. abstract="true" native="false" synchronized="false"
  5806. static="false" final="false" visibility="public"
  5807. deprecated="not deprecated">
  5808. <param name="applicationTimeouts" type="java.util.Map"/>
  5809. <doc>
  5810. <![CDATA[Set the <code>ApplicationTimeouts</code> for the application. Timeout value
  5811. is absolute. Timeout value should meet ISO8601 format. Support ISO8601
  5812. format is <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>. All pre-existing Map entries
  5813. are cleared before adding the new Map.
  5814. @param applicationTimeouts <code>ApplicationTimeouts</code>s for the
  5815. application]]>
  5816. </doc>
  5817. </method>
  5818. <doc>
  5819. <![CDATA[<p>
  5820. The response sent by the <code>ResourceManager</code> to the client on update
  5821. application timeout.
  5822. </p>
  5823. <p>
  5824. A response without exception means that the update has completed
  5825. successfully.
  5826. </p>]]>
  5827. </doc>
  5828. </class>
  5829. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse -->
  5830. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
  5831. <class name="UseSharedCacheResourceRequest" extends="java.lang.Object"
  5832. abstract="true"
  5833. static="false" final="false" visibility="public"
  5834. deprecated="not deprecated">
  5835. <constructor name="UseSharedCacheResourceRequest"
  5836. static="false" final="false" visibility="public"
  5837. deprecated="not deprecated">
  5838. </constructor>
  5839. <method name="getAppId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5840. abstract="true" native="false" synchronized="false"
  5841. static="false" final="false" visibility="public"
  5842. deprecated="not deprecated">
  5843. <doc>
  5844. <![CDATA[Get the <code>ApplicationId</code> of the resource to be used.
  5845. @return <code>ApplicationId</code>]]>
  5846. </doc>
  5847. </method>
  5848. <method name="setAppId"
  5849. abstract="true" native="false" synchronized="false"
  5850. static="false" final="false" visibility="public"
  5851. deprecated="not deprecated">
  5852. <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5853. <doc>
  5854. <![CDATA[Set the <code>ApplicationId</code> of the resource to be used.
  5855. @param id <code>ApplicationId</code>]]>
  5856. </doc>
  5857. </method>
  5858. <method name="getResourceKey" return="java.lang.String"
  5859. abstract="true" native="false" synchronized="false"
  5860. static="false" final="false" visibility="public"
  5861. deprecated="not deprecated">
  5862. <doc>
  5863. <![CDATA[Get the <code>key</code> of the resource to be used.
  5864. @return <code>key</code>]]>
  5865. </doc>
  5866. </method>
  5867. <method name="setResourceKey"
  5868. abstract="true" native="false" synchronized="false"
  5869. static="false" final="false" visibility="public"
  5870. deprecated="not deprecated">
  5871. <param name="key" type="java.lang.String"/>
  5872. <doc>
  5873. <![CDATA[Set the <code>key</code> of the resource to be used.
  5874. @param key unique identifier for the resource]]>
  5875. </doc>
  5876. </method>
  5877. <doc>
  5878. <![CDATA[<p>
  5879. The request from clients to the <code>SharedCacheManager</code> that claims a
  5880. resource in the shared cache.
  5881. </p>]]>
  5882. </doc>
  5883. </class>
  5884. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
  5885. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
  5886. <class name="UseSharedCacheResourceResponse" extends="java.lang.Object"
  5887. abstract="true"
  5888. static="false" final="false" visibility="public"
  5889. deprecated="not deprecated">
  5890. <constructor name="UseSharedCacheResourceResponse"
  5891. static="false" final="false" visibility="public"
  5892. deprecated="not deprecated">
  5893. </constructor>
  5894. <method name="getPath" return="java.lang.String"
  5895. abstract="true" native="false" synchronized="false"
  5896. static="false" final="false" visibility="public"
  5897. deprecated="not deprecated">
  5898. <doc>
  5899. <![CDATA[Get the <code>Path</code> corresponding to the requested resource in the
  5900. shared cache.
  5901. @return String A <code>Path</code> if the resource exists in the shared
  5902. cache, <code>null</code> otherwise]]>
  5903. </doc>
  5904. </method>
  5905. <method name="setPath"
  5906. abstract="true" native="false" synchronized="false"
  5907. static="false" final="false" visibility="public"
  5908. deprecated="not deprecated">
  5909. <param name="p" type="java.lang.String"/>
  5910. <doc>
  5911. <![CDATA[Set the <code>Path</code> corresponding to a resource in the shared cache.
  5912. @param p A <code>Path</code> corresponding to a resource in the shared
  5913. cache]]>
  5914. </doc>
  5915. </method>
  5916. <doc>
  5917. <![CDATA[<p>
  5918. The response from the SharedCacheManager to the client that indicates whether
  5919. a requested resource exists in the cache.
  5920. </p>]]>
  5921. </doc>
  5922. </class>
  5923. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
  5924. </package>
  5925. <package name="org.apache.hadoop.yarn.api.records">
  5926. <!-- start class org.apache.hadoop.yarn.api.records.AMCommand -->
  5927. <class name="AMCommand" extends="java.lang.Enum"
  5928. abstract="false"
  5929. static="false" final="true" visibility="public"
  5930. deprecated="not deprecated">
  5931. <method name="values" return="org.apache.hadoop.yarn.api.records.AMCommand[]"
  5932. abstract="false" native="false" synchronized="false"
  5933. static="true" final="false" visibility="public"
  5934. deprecated="not deprecated">
  5935. </method>
  5936. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.AMCommand"
  5937. abstract="false" native="false" synchronized="false"
  5938. static="true" final="false" visibility="public"
  5939. deprecated="not deprecated">
  5940. <param name="name" type="java.lang.String"/>
  5941. </method>
  5942. <doc>
  5943. <![CDATA[Command sent by the Resource Manager to the Application Master in the
  5944. AllocateResponse
  5945. @see AllocateResponse]]>
  5946. </doc>
  5947. </class>
  5948. <!-- end class org.apache.hadoop.yarn.api.records.AMCommand -->
  5949. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
  5950. <class name="ApplicationAccessType" extends="java.lang.Enum"
  5951. abstract="false"
  5952. static="false" final="true" visibility="public"
  5953. deprecated="not deprecated">
  5954. <method name="values" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType[]"
  5955. abstract="false" native="false" synchronized="false"
  5956. static="true" final="false" visibility="public"
  5957. deprecated="not deprecated">
  5958. </method>
  5959. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType"
  5960. abstract="false" native="false" synchronized="false"
  5961. static="true" final="false" visibility="public"
  5962. deprecated="not deprecated">
  5963. <param name="name" type="java.lang.String"/>
  5964. </method>
  5965. <doc>
  5966. <![CDATA[Application access types.]]>
  5967. </doc>
  5968. </class>
  5969. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
  5970. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
  5971. <class name="ApplicationAttemptId" extends="java.lang.Object"
  5972. abstract="true"
  5973. static="false" final="false" visibility="public"
  5974. deprecated="not deprecated">
  5975. <implements name="java.lang.Comparable"/>
  5976. <constructor name="ApplicationAttemptId"
  5977. static="false" final="false" visibility="public"
  5978. deprecated="not deprecated">
  5979. </constructor>
  5980. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  5981. abstract="false" native="false" synchronized="false"
  5982. static="true" final="false" visibility="public"
  5983. deprecated="not deprecated">
  5984. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5985. <param name="attemptId" type="int"/>
  5986. </method>
  5987. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5988. abstract="true" native="false" synchronized="false"
  5989. static="false" final="false" visibility="public"
  5990. deprecated="not deprecated">
  5991. <doc>
  5992. <![CDATA[Get the <code>ApplicationId</code> of the <code>ApplicationAttempId</code>.
  5993. @return <code>ApplicationId</code> of the <code>ApplicationAttempId</code>]]>
  5994. </doc>
  5995. </method>
  5996. <method name="getAttemptId" return="int"
  5997. abstract="true" native="false" synchronized="false"
  5998. static="false" final="false" visibility="public"
  5999. deprecated="not deprecated">
  6000. <doc>
  6001. <![CDATA[Get the <code>attempt id</code> of the <code>Application</code>.
  6002. @return <code>attempt id</code> of the <code>Application</code>]]>
  6003. </doc>
  6004. </method>
  6005. <method name="hashCode" return="int"
  6006. abstract="false" native="false" synchronized="false"
  6007. static="false" final="false" visibility="public"
  6008. deprecated="not deprecated">
  6009. </method>
  6010. <method name="equals" return="boolean"
  6011. abstract="false" native="false" synchronized="false"
  6012. static="false" final="false" visibility="public"
  6013. deprecated="not deprecated">
  6014. <param name="obj" type="java.lang.Object"/>
  6015. </method>
  6016. <method name="compareTo" return="int"
  6017. abstract="false" native="false" synchronized="false"
  6018. static="false" final="false" visibility="public"
  6019. deprecated="not deprecated">
  6020. <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  6021. </method>
  6022. <method name="toString" return="java.lang.String"
  6023. abstract="false" native="false" synchronized="false"
  6024. static="false" final="false" visibility="public"
  6025. deprecated="not deprecated">
  6026. </method>
  6027. <method name="build"
  6028. abstract="true" native="false" synchronized="false"
  6029. static="false" final="false" visibility="protected"
  6030. deprecated="not deprecated">
  6031. </method>
  6032. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  6033. abstract="false" native="false" synchronized="false"
  6034. static="true" final="false" visibility="public"
  6035. deprecated="not deprecated">
  6036. <param name="appAttemptIdStr" type="java.lang.String"/>
  6037. </method>
  6038. <field name="appAttemptIdStrPrefix" type="java.lang.String"
  6039. transient="false" volatile="false"
  6040. static="true" final="true" visibility="public"
  6041. deprecated="not deprecated">
  6042. </field>
  6043. <doc>
  6044. <![CDATA[<p><code>ApplicationAttemptId</code> denotes the particular <em>attempt</em>
  6045. of an <code>ApplicationMaster</code> for a given {@link ApplicationId}.</p>
  6046. <p>Multiple attempts might be needed to run an application to completion due
  6047. to temporal failures of the <code>ApplicationMaster</code> such as hardware
  6048. failures, connectivity issues etc. on the node on which it was scheduled.</p>]]>
  6049. </doc>
  6050. </class>
  6051. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
  6052. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
  6053. <class name="ApplicationAttemptReport" extends="java.lang.Object"
  6054. abstract="true"
  6055. static="false" final="false" visibility="public"
  6056. deprecated="not deprecated">
  6057. <constructor name="ApplicationAttemptReport"
  6058. static="false" final="false" visibility="public"
  6059. deprecated="not deprecated">
  6060. </constructor>
  6061. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
  6062. abstract="false" native="false" synchronized="false"
  6063. static="true" final="false" visibility="public"
  6064. deprecated="not deprecated">
  6065. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  6066. <param name="host" type="java.lang.String"/>
  6067. <param name="rpcPort" type="int"/>
  6068. <param name="url" type="java.lang.String"/>
  6069. <param name="oUrl" type="java.lang.String"/>
  6070. <param name="diagnostics" type="java.lang.String"/>
  6071. <param name="state" type="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"/>
  6072. <param name="amContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  6073. </method>
  6074. <method name="getYarnApplicationAttemptState" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
  6075. abstract="true" native="false" synchronized="false"
  6076. static="false" final="false" visibility="public"
  6077. deprecated="not deprecated">
  6078. <doc>
  6079. <![CDATA[Get the <em>YarnApplicationAttemptState</em> of the application attempt.
  6080. @return <em>YarnApplicationAttemptState</em> of the application attempt]]>
  6081. </doc>
  6082. </method>
  6083. <method name="getRpcPort" return="int"
  6084. abstract="true" native="false" synchronized="false"
  6085. static="false" final="false" visibility="public"
  6086. deprecated="not deprecated">
  6087. <doc>
  6088. <![CDATA[Get the <em>RPC port</em> of this attempt <code>ApplicationMaster</code>.
  6089. @return <em>RPC port</em> of this attempt <code>ApplicationMaster</code>]]>
  6090. </doc>
  6091. </method>
  6092. <method name="getHost" return="java.lang.String"
  6093. abstract="true" native="false" synchronized="false"
  6094. static="false" final="false" visibility="public"
  6095. deprecated="not deprecated">
  6096. <doc>
  6097. <![CDATA[Get the <em>host</em> on which this attempt of
  6098. <code>ApplicationMaster</code> is running.
  6099. @return <em>host</em> on which this attempt of
  6100. <code>ApplicationMaster</code> is running]]>
  6101. </doc>
  6102. </method>
  6103. <method name="getDiagnostics" return="java.lang.String"
  6104. abstract="true" native="false" synchronized="false"
  6105. static="false" final="false" visibility="public"
  6106. deprecated="not deprecated">
  6107. <doc>
  6108. <![CDATA[Get the <em>diagnositic information</em> of the application attempt in case
  6109. of errors.
  6110. @return <em>diagnositic information</em> of the application attempt in case
  6111. of errors]]>
  6112. </doc>
  6113. </method>
  6114. <method name="getTrackingUrl" return="java.lang.String"
  6115. abstract="true" native="false" synchronized="false"
  6116. static="false" final="false" visibility="public"
  6117. deprecated="not deprecated">
  6118. <doc>
  6119. <![CDATA[Get the <em>tracking url</em> for the application attempt.
  6120. @return <em>tracking url</em> for the application attempt]]>
  6121. </doc>
  6122. </method>
  6123. <method name="getOriginalTrackingUrl" return="java.lang.String"
  6124. abstract="true" native="false" synchronized="false"
  6125. static="false" final="false" visibility="public"
  6126. deprecated="not deprecated">
  6127. <doc>
  6128. <![CDATA[Get the <em>original tracking url</em> for the application attempt.
  6129. @return <em>original tracking url</em> for the application attempt]]>
  6130. </doc>
  6131. </method>
  6132. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  6133. abstract="true" native="false" synchronized="false"
  6134. static="false" final="false" visibility="public"
  6135. deprecated="not deprecated">
  6136. <doc>
  6137. <![CDATA[Get the <code>ApplicationAttemptId</code> of this attempt of the
  6138. application
  6139. @return <code>ApplicationAttemptId</code> of the attempt]]>
  6140. </doc>
  6141. </method>
  6142. <method name="getAMContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  6143. abstract="true" native="false" synchronized="false"
  6144. static="false" final="false" visibility="public"
  6145. deprecated="not deprecated">
  6146. <doc>
  6147. <![CDATA[Get the <code>ContainerId</code> of AMContainer for this attempt
  6148. @return <code>ContainerId</code> of the attempt]]>
  6149. </doc>
  6150. </method>
  6151. <method name="getStartTime" return="long"
  6152. abstract="true" native="false" synchronized="false"
  6153. static="false" final="false" visibility="public"
  6154. deprecated="not deprecated">
  6155. </method>
  6156. <method name="getFinishTime" return="long"
  6157. abstract="true" native="false" synchronized="false"
  6158. static="false" final="false" visibility="public"
  6159. deprecated="not deprecated">
  6160. <doc>
  6161. <![CDATA[Get the <em>finish time</em> of the application.
  6162. @return <em>finish time</em> of the application]]>
  6163. </doc>
  6164. </method>
  6165. <doc>
  6166. <![CDATA[{@code ApplicationAttemptReport} is a report of an application attempt.
  6167. <p>
  6168. It includes details such as:
  6169. <ul>
  6170. <li>{@link ApplicationAttemptId} of the application.</li>
  6171. <li>Host on which the <code>ApplicationMaster</code> of this attempt is
  6172. running.</li>
  6173. <li>RPC port of the <code>ApplicationMaster</code> of this attempt.</li>
  6174. <li>Tracking URL.</li>
  6175. <li>Diagnostic information in case of errors.</li>
  6176. <li>{@link YarnApplicationAttemptState} of the application attempt.</li>
  6177. <li>{@link ContainerId} of the master Container.</li>
  6178. </ul>]]>
  6179. </doc>
  6180. </class>
  6181. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
  6182. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationId -->
  6183. <class name="ApplicationId" extends="java.lang.Object"
  6184. abstract="true"
  6185. static="false" final="false" visibility="public"
  6186. deprecated="not deprecated">
  6187. <implements name="java.lang.Comparable"/>
  6188. <constructor name="ApplicationId"
  6189. static="false" final="false" visibility="public"
  6190. deprecated="not deprecated">
  6191. </constructor>
  6192. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  6193. abstract="false" native="false" synchronized="false"
  6194. static="true" final="false" visibility="public"
  6195. deprecated="not deprecated">
  6196. <param name="clusterTimestamp" type="long"/>
  6197. <param name="id" type="int"/>
  6198. </method>
  6199. <method name="getId" return="int"
  6200. abstract="true" native="false" synchronized="false"
  6201. static="false" final="false" visibility="public"
  6202. deprecated="not deprecated">
  6203. <doc>
  6204. <![CDATA[Get the short integer identifier of the <code>ApplicationId</code>
  6205. which is unique for all applications started by a particular instance
  6206. of the <code>ResourceManager</code>.
  6207. @return short integer identifier of the <code>ApplicationId</code>]]>
  6208. </doc>
  6209. </method>
  6210. <method name="getClusterTimestamp" return="long"
  6211. abstract="true" native="false" synchronized="false"
  6212. static="false" final="false" visibility="public"
  6213. deprecated="not deprecated">
  6214. <doc>
  6215. <![CDATA[Get the <em>start time</em> of the <code>ResourceManager</code> which is
  6216. used to generate globally unique <code>ApplicationId</code>.
  6217. @return <em>start time</em> of the <code>ResourceManager</code>]]>
  6218. </doc>
  6219. </method>
  6220. <method name="build"
  6221. abstract="true" native="false" synchronized="false"
  6222. static="false" final="false" visibility="protected"
  6223. deprecated="not deprecated">
  6224. </method>
  6225. <method name="compareTo" return="int"
  6226. abstract="false" native="false" synchronized="false"
  6227. static="false" final="false" visibility="public"
  6228. deprecated="not deprecated">
  6229. <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6230. </method>
  6231. <method name="toString" return="java.lang.String"
  6232. abstract="false" native="false" synchronized="false"
  6233. static="false" final="false" visibility="public"
  6234. deprecated="not deprecated">
  6235. </method>
  6236. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  6237. abstract="false" native="false" synchronized="false"
  6238. static="true" final="false" visibility="public"
  6239. deprecated="not deprecated">
  6240. <param name="appIdStr" type="java.lang.String"/>
  6241. </method>
  6242. <method name="hashCode" return="int"
  6243. abstract="false" native="false" synchronized="false"
  6244. static="false" final="false" visibility="public"
  6245. deprecated="not deprecated">
  6246. </method>
  6247. <method name="equals" return="boolean"
  6248. abstract="false" native="false" synchronized="false"
  6249. static="false" final="false" visibility="public"
  6250. deprecated="not deprecated">
  6251. <param name="obj" type="java.lang.Object"/>
  6252. </method>
  6253. <field name="appIdStrPrefix" type="java.lang.String"
  6254. transient="false" volatile="false"
  6255. static="true" final="true" visibility="public"
  6256. deprecated="not deprecated">
  6257. </field>
  6258. <doc>
  6259. <![CDATA[<p><code>ApplicationId</code> represents the <em>globally unique</em>
  6260. identifier for an application.</p>
  6261. <p>The globally unique nature of the identifier is achieved by using the
  6262. <em>cluster timestamp</em> i.e. start-time of the
  6263. <code>ResourceManager</code> along with a monotonically increasing counter
  6264. for the application.</p>]]>
  6265. </doc>
  6266. </class>
  6267. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationId -->
  6268. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationReport -->
  6269. <class name="ApplicationReport" extends="java.lang.Object"
  6270. abstract="true"
  6271. static="false" final="false" visibility="public"
  6272. deprecated="not deprecated">
  6273. <constructor name="ApplicationReport"
  6274. static="false" final="false" visibility="public"
  6275. deprecated="not deprecated">
  6276. </constructor>
  6277. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  6278. abstract="true" native="false" synchronized="false"
  6279. static="false" final="false" visibility="public"
  6280. deprecated="not deprecated">
  6281. <doc>
  6282. <![CDATA[Get the <code>ApplicationId</code> of the application.
  6283. @return <code>ApplicationId</code> of the application]]>
  6284. </doc>
  6285. </method>
  6286. <method name="getCurrentApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  6287. abstract="true" native="false" synchronized="false"
  6288. static="false" final="false" visibility="public"
  6289. deprecated="not deprecated">
  6290. <doc>
  6291. <![CDATA[Get the <code>ApplicationAttemptId</code> of the current
  6292. attempt of the application
  6293. @return <code>ApplicationAttemptId</code> of the attempt]]>
  6294. </doc>
  6295. </method>
  6296. <method name="getUser" return="java.lang.String"
  6297. abstract="true" native="false" synchronized="false"
  6298. static="false" final="false" visibility="public"
  6299. deprecated="not deprecated">
  6300. <doc>
  6301. <![CDATA[Get the <em>user</em> who submitted the application.
  6302. @return <em>user</em> who submitted the application]]>
  6303. </doc>
  6304. </method>
  6305. <method name="getQueue" return="java.lang.String"
  6306. abstract="true" native="false" synchronized="false"
  6307. static="false" final="false" visibility="public"
  6308. deprecated="not deprecated">
  6309. <doc>
  6310. <![CDATA[Get the <em>queue</em> to which the application was submitted.
  6311. @return <em>queue</em> to which the application was submitted]]>
  6312. </doc>
  6313. </method>
  6314. <method name="getName" return="java.lang.String"
  6315. abstract="true" native="false" synchronized="false"
  6316. static="false" final="false" visibility="public"
  6317. deprecated="not deprecated">
  6318. <doc>
  6319. <![CDATA[Get the user-defined <em>name</em> of the application.
  6320. @return <em>name</em> of the application]]>
  6321. </doc>
  6322. </method>
  6323. <method name="getHost" return="java.lang.String"
  6324. abstract="true" native="false" synchronized="false"
  6325. static="false" final="false" visibility="public"
  6326. deprecated="not deprecated">
  6327. <doc>
  6328. <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code>
  6329. is running.
  6330. @return <em>host</em> on which the <code>ApplicationMaster</code>
  6331. is running]]>
  6332. </doc>
  6333. </method>
  6334. <method name="getRpcPort" return="int"
  6335. abstract="true" native="false" synchronized="false"
  6336. static="false" final="false" visibility="public"
  6337. deprecated="not deprecated">
  6338. <doc>
  6339. <![CDATA[Get the <em>RPC port</em> of the <code>ApplicationMaster</code>.
  6340. @return <em>RPC port</em> of the <code>ApplicationMaster</code>]]>
  6341. </doc>
  6342. </method>
  6343. <method name="getClientToAMToken" return="org.apache.hadoop.yarn.api.records.Token"
  6344. abstract="true" native="false" synchronized="false"
  6345. static="false" final="false" visibility="public"
  6346. deprecated="not deprecated">
  6347. <doc>
  6348. <![CDATA[Get the <em>client token</em> for communicating with the
  6349. <code>ApplicationMaster</code>.
  6350. <p>
  6351. <em>ClientToAMToken</em> is the security token used by the AMs to verify
  6352. authenticity of any <code>client</code>.
  6353. </p>
  6354. <p>
  6355. The <code>ResourceManager</code>, provides a secure token (via
  6356. {@link ApplicationReport#getClientToAMToken()}) which is verified by the
  6357. ApplicationMaster when the client directly talks to an AM.
  6358. </p>
  6359. @return <em>client token</em> for communicating with the
  6360. <code>ApplicationMaster</code>]]>
  6361. </doc>
  6362. </method>
  6363. <method name="getYarnApplicationState" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
  6364. abstract="true" native="false" synchronized="false"
  6365. static="false" final="false" visibility="public"
  6366. deprecated="not deprecated">
  6367. <doc>
  6368. <![CDATA[Get the <code>YarnApplicationState</code> of the application.
  6369. @return <code>YarnApplicationState</code> of the application]]>
  6370. </doc>
  6371. </method>
  6372. <method name="getDiagnostics" return="java.lang.String"
  6373. abstract="true" native="false" synchronized="false"
  6374. static="false" final="false" visibility="public"
  6375. deprecated="not deprecated">
  6376. <doc>
  6377. <![CDATA[Get the <em>diagnositic information</em> of the application in case of
  6378. errors.
  6379. @return <em>diagnositic information</em> of the application in case
  6380. of errors]]>
  6381. </doc>
  6382. </method>
  6383. <method name="getTrackingUrl" return="java.lang.String"
  6384. abstract="true" native="false" synchronized="false"
  6385. static="false" final="false" visibility="public"
  6386. deprecated="not deprecated">
  6387. <doc>
  6388. <![CDATA[Get the <em>tracking url</em> for the application.
  6389. @return <em>tracking url</em> for the application]]>
  6390. </doc>
  6391. </method>
  6392. <method name="getStartTime" return="long"
  6393. abstract="true" native="false" synchronized="false"
  6394. static="false" final="false" visibility="public"
  6395. deprecated="not deprecated">
  6396. <doc>
  6397. <![CDATA[Get the <em>start time</em> of the application.
  6398. @return <em>start time</em> of the application]]>
  6399. </doc>
  6400. </method>
  6401. <method name="getSubmitTime" return="long"
  6402. abstract="true" native="false" synchronized="false"
  6403. static="false" final="false" visibility="public"
  6404. deprecated="not deprecated">
  6405. </method>
  6406. <method name="getLaunchTime" return="long"
  6407. abstract="true" native="false" synchronized="false"
  6408. static="false" final="false" visibility="public"
  6409. deprecated="not deprecated">
  6410. </method>
  6411. <method name="getFinishTime" return="long"
  6412. abstract="true" native="false" synchronized="false"
  6413. static="false" final="false" visibility="public"
  6414. deprecated="not deprecated">
  6415. <doc>
  6416. <![CDATA[Get the <em>finish time</em> of the application.
  6417. @return <em>finish time</em> of the application]]>
  6418. </doc>
  6419. </method>
  6420. <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  6421. abstract="true" native="false" synchronized="false"
  6422. static="false" final="false" visibility="public"
  6423. deprecated="not deprecated">
  6424. <doc>
  6425. <![CDATA[Get the <em>final finish status</em> of the application.
  6426. @return <em>final finish status</em> of the application]]>
  6427. </doc>
  6428. </method>
  6429. <method name="getApplicationResourceUsageReport" return="org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport"
  6430. abstract="true" native="false" synchronized="false"
  6431. static="false" final="false" visibility="public"
  6432. deprecated="not deprecated">
  6433. <doc>
  6434. <![CDATA[Retrieve the structure containing the job resources for this application
  6435. @return the job resources structure for this application]]>
  6436. </doc>
  6437. </method>
  6438. <method name="getProgress" return="float"
  6439. abstract="true" native="false" synchronized="false"
  6440. static="false" final="false" visibility="public"
  6441. deprecated="not deprecated">
  6442. <doc>
  6443. <![CDATA[Get the application's progress ( range 0.0 to 1.0 )
  6444. @return application's progress]]>
  6445. </doc>
  6446. </method>
  6447. <method name="getApplicationType" return="java.lang.String"
  6448. abstract="true" native="false" synchronized="false"
  6449. static="false" final="false" visibility="public"
  6450. deprecated="not deprecated">
  6451. <doc>
  6452. <![CDATA[Get the application's Type
  6453. @return application's Type]]>
  6454. </doc>
  6455. </method>
  6456. <method name="getApplicationTags" return="java.util.Set"
  6457. abstract="true" native="false" synchronized="false"
  6458. static="false" final="false" visibility="public"
  6459. deprecated="not deprecated">
  6460. <doc>
  6461. <![CDATA[Get all tags corresponding to the application
  6462. @return Application's tags]]>
  6463. </doc>
  6464. </method>
  6465. <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
  6466. abstract="true" native="false" synchronized="false"
  6467. static="false" final="false" visibility="public"
  6468. deprecated="not deprecated">
  6469. <doc>
  6470. <![CDATA[Get the AMRM token of the application.
  6471. <p>
  6472. The AMRM token is required for AM to RM scheduling operations. For
  6473. managed Application Masters YARN takes care of injecting it. For unmanaged
  6474. Applications Masters, the token must be obtained via this method and set
  6475. in the {@link org.apache.hadoop.security.UserGroupInformation} of the
  6476. current user.
  6477. <p>
  6478. The AMRM token will be returned only if all the following conditions are
  6479. met:
  6480. <ul>
  6481. <li>the requester is the owner of the ApplicationMaster</li>
  6482. <li>the application master is an unmanaged ApplicationMaster</li>
  6483. <li>the application master is in ACCEPTED state</li>
  6484. </ul>
  6485. Else this method returns NULL.
  6486. @return the AM to RM token if available.]]>
  6487. </doc>
  6488. </method>
  6489. <method name="getLogAggregationStatus" return="org.apache.hadoop.yarn.api.records.LogAggregationStatus"
  6490. abstract="true" native="false" synchronized="false"
  6491. static="false" final="false" visibility="public"
  6492. deprecated="not deprecated">
  6493. <doc>
  6494. <![CDATA[Get log aggregation status for the application
  6495. @return Application's log aggregation status]]>
  6496. </doc>
  6497. </method>
  6498. <method name="isUnmanagedApp" return="boolean"
  6499. abstract="true" native="false" synchronized="false"
  6500. static="false" final="false" visibility="public"
  6501. deprecated="not deprecated">
  6502. <doc>
  6503. <![CDATA[@return true if the AM is not managed by the RM]]>
  6504. </doc>
  6505. </method>
  6506. <method name="setUnmanagedApp"
  6507. abstract="true" native="false" synchronized="false"
  6508. static="false" final="false" visibility="public"
  6509. deprecated="not deprecated">
  6510. <param name="unmanagedApplication" type="boolean"/>
  6511. <doc>
  6512. <![CDATA[@param unmanagedApplication true if RM should not manage the AM]]>
  6513. </doc>
  6514. </method>
  6515. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  6516. abstract="true" native="false" synchronized="false"
  6517. static="false" final="false" visibility="public"
  6518. deprecated="not deprecated">
  6519. <doc>
  6520. <![CDATA[Get priority of the application
  6521. @return Application's priority]]>
  6522. </doc>
  6523. </method>
  6524. <method name="getAppNodeLabelExpression" return="java.lang.String"
  6525. abstract="true" native="false" synchronized="false"
  6526. static="false" final="false" visibility="public"
  6527. deprecated="not deprecated">
  6528. <doc>
  6529. <![CDATA[Get the default Node Label expression for all the application's containers
  6530. @return Application's NodeLabelExpression]]>
  6531. </doc>
  6532. </method>
  6533. <method name="setAppNodeLabelExpression"
  6534. abstract="true" native="false" synchronized="false"
  6535. static="false" final="false" visibility="public"
  6536. deprecated="not deprecated">
  6537. <param name="appNodeLabelExpression" type="java.lang.String"/>
  6538. </method>
  6539. <method name="getAmNodeLabelExpression" return="java.lang.String"
  6540. abstract="true" native="false" synchronized="false"
  6541. static="false" final="false" visibility="public"
  6542. deprecated="not deprecated">
  6543. <doc>
  6544. <![CDATA[Get the default Node Label expression for all the application's containers
  6545. @return Application's NodeLabelExpression]]>
  6546. </doc>
  6547. </method>
  6548. <method name="setAmNodeLabelExpression"
  6549. abstract="true" native="false" synchronized="false"
  6550. static="false" final="false" visibility="public"
  6551. deprecated="not deprecated">
  6552. <param name="amNodeLabelExpression" type="java.lang.String"/>
  6553. </method>
  6554. <method name="getApplicationTimeouts" return="java.util.Map"
  6555. abstract="true" native="false" synchronized="false"
  6556. static="false" final="false" visibility="public"
  6557. deprecated="not deprecated">
  6558. </method>
  6559. <doc>
  6560. <![CDATA[{@code ApplicationReport} is a report of an application.
  6561. <p>
  6562. It includes details such as:
  6563. <ul>
  6564. <li>{@link ApplicationId} of the application.</li>
  6565. <li>Applications user.</li>
  6566. <li>Application queue.</li>
  6567. <li>Application name.</li>
  6568. <li>Host on which the <code>ApplicationMaster</code> is running.</li>
  6569. <li>RPC port of the <code>ApplicationMaster</code>.</li>
  6570. <li>Tracking URL.</li>
  6571. <li>{@link YarnApplicationState} of the application.</li>
  6572. <li>Diagnostic information in case of errors.</li>
  6573. <li>Start time of the application.</li>
  6574. <li>Client {@link Token} of the application (if security is enabled).</li>
  6575. </ul>
  6576. @see ApplicationClientProtocol#getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest)]]>
  6577. </doc>
  6578. </class>
  6579. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationReport -->
  6580. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
  6581. <class name="ApplicationResourceUsageReport" extends="java.lang.Object"
  6582. abstract="true"
  6583. static="false" final="false" visibility="public"
  6584. deprecated="not deprecated">
  6585. <constructor name="ApplicationResourceUsageReport"
  6586. static="false" final="false" visibility="public"
  6587. deprecated="not deprecated">
  6588. </constructor>
  6589. <method name="getNumUsedContainers" return="int"
  6590. abstract="true" native="false" synchronized="false"
  6591. static="false" final="false" visibility="public"
  6592. deprecated="not deprecated">
  6593. <doc>
  6594. <![CDATA[Get the number of used containers. -1 for invalid/inaccessible reports.
  6595. @return the number of used containers]]>
  6596. </doc>
  6597. </method>
  6598. <method name="getUsedResources" return="org.apache.hadoop.yarn.api.records.Resource"
  6599. abstract="true" native="false" synchronized="false"
  6600. static="false" final="false" visibility="public"
  6601. deprecated="not deprecated">
  6602. <doc>
  6603. <![CDATA[Get the used <code>Resource</code>. -1 for invalid/inaccessible reports.
  6604. @return the used <code>Resource</code>]]>
  6605. </doc>
  6606. </method>
  6607. <method name="getReservedResources" return="org.apache.hadoop.yarn.api.records.Resource"
  6608. abstract="true" native="false" synchronized="false"
  6609. static="false" final="false" visibility="public"
  6610. deprecated="not deprecated">
  6611. <doc>
  6612. <![CDATA[Get the reserved <code>Resource</code>. -1 for invalid/inaccessible reports.
  6613. @return the reserved <code>Resource</code>]]>
  6614. </doc>
  6615. </method>
  6616. <method name="getNeededResources" return="org.apache.hadoop.yarn.api.records.Resource"
  6617. abstract="true" native="false" synchronized="false"
  6618. static="false" final="false" visibility="public"
  6619. deprecated="not deprecated">
  6620. <doc>
  6621. <![CDATA[Get the needed <code>Resource</code>. -1 for invalid/inaccessible reports.
  6622. @return the needed <code>Resource</code>]]>
  6623. </doc>
  6624. </method>
  6625. <method name="getMemorySeconds" return="long"
  6626. abstract="true" native="false" synchronized="false"
  6627. static="false" final="false" visibility="public"
  6628. deprecated="not deprecated">
  6629. <doc>
  6630. <![CDATA[Get the aggregated amount of memory (in megabytes) the application has
  6631. allocated times the number of seconds the application has been running.
  6632. @return the aggregated amount of memory seconds]]>
  6633. </doc>
  6634. </method>
  6635. <method name="getVcoreSeconds" return="long"
  6636. abstract="true" native="false" synchronized="false"
  6637. static="false" final="false" visibility="public"
  6638. deprecated="not deprecated">
  6639. <doc>
  6640. <![CDATA[Get the aggregated number of vcores that the application has allocated
  6641. times the number of seconds the application has been running.
  6642. @return the aggregated number of vcore seconds]]>
  6643. </doc>
  6644. </method>
  6645. <method name="getQueueUsagePercentage" return="float"
  6646. abstract="true" native="false" synchronized="false"
  6647. static="false" final="false" visibility="public"
  6648. deprecated="not deprecated">
  6649. <doc>
  6650. <![CDATA[Get the percentage of resources of the queue that the app is using.
  6651. @return the percentage of resources of the queue that the app is using.]]>
  6652. </doc>
  6653. </method>
  6654. <method name="getClusterUsagePercentage" return="float"
  6655. abstract="true" native="false" synchronized="false"
  6656. static="false" final="false" visibility="public"
  6657. deprecated="not deprecated">
  6658. <doc>
  6659. <![CDATA[Get the percentage of resources of the cluster that the app is using.
  6660. @return the percentage of resources of the cluster that the app is using.]]>
  6661. </doc>
  6662. </method>
  6663. <method name="getPreemptedMemorySeconds" return="long"
  6664. abstract="true" native="false" synchronized="false"
  6665. static="false" final="false" visibility="public"
  6666. deprecated="not deprecated">
  6667. <doc>
  6668. <![CDATA[Get the aggregated amount of memory preempted(in megabytes)
  6669. the application has allocated times the number of
  6670. seconds the application has been running.
  6671. @return the aggregated amount of memory seconds]]>
  6672. </doc>
  6673. </method>
  6674. <method name="getPreemptedVcoreSeconds" return="long"
  6675. abstract="true" native="false" synchronized="false"
  6676. static="false" final="false" visibility="public"
  6677. deprecated="not deprecated">
  6678. <doc>
  6679. <![CDATA[Get the aggregated number of vcores preempted that the application has
  6680. allocated times the number of seconds the application has been running.
  6681. @return the aggregated number of vcore seconds]]>
  6682. </doc>
  6683. </method>
  6684. <method name="getResourceSecondsMap" return="java.util.Map"
  6685. abstract="true" native="false" synchronized="false"
  6686. static="false" final="false" visibility="public"
  6687. deprecated="not deprecated">
  6688. <doc>
  6689. <![CDATA[Get the aggregated number of resources that the application has
  6690. allocated times the number of seconds the application has been running.
  6691. @return map containing the resource name and aggregated resource-seconds]]>
  6692. </doc>
  6693. </method>
  6694. <method name="getPreemptedResourceSecondsMap" return="java.util.Map"
  6695. abstract="true" native="false" synchronized="false"
  6696. static="false" final="false" visibility="public"
  6697. deprecated="not deprecated">
  6698. <doc>
  6699. <![CDATA[Get the aggregated number of resources preempted that the application has
  6700. allocated times the number of seconds the application has been running.
  6701. @return map containing the resource name and aggregated preempted
  6702. resource-seconds]]>
  6703. </doc>
  6704. </method>
  6705. <doc>
  6706. <![CDATA[Contains various scheduling metrics to be reported by UI and CLI.]]>
  6707. </doc>
  6708. </class>
  6709. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
  6710. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
  6711. <class name="ApplicationSubmissionContext" extends="java.lang.Object"
  6712. abstract="true"
  6713. static="false" final="false" visibility="public"
  6714. deprecated="not deprecated">
  6715. <constructor name="ApplicationSubmissionContext"
  6716. static="false" final="false" visibility="public"
  6717. deprecated="not deprecated">
  6718. </constructor>
  6719. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6720. abstract="false" native="false" synchronized="false"
  6721. static="true" final="false" visibility="public"
  6722. deprecated="not deprecated">
  6723. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6724. <param name="applicationName" type="java.lang.String"/>
  6725. <param name="queue" type="java.lang.String"/>
  6726. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6727. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6728. <param name="isUnmanagedAM" type="boolean"/>
  6729. <param name="cancelTokensWhenComplete" type="boolean"/>
  6730. <param name="maxAppAttempts" type="int"/>
  6731. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6732. <param name="applicationType" type="java.lang.String"/>
  6733. <param name="keepContainers" type="boolean"/>
  6734. <param name="appLabelExpression" type="java.lang.String"/>
  6735. <param name="amContainerLabelExpression" type="java.lang.String"/>
  6736. </method>
  6737. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6738. abstract="false" native="false" synchronized="false"
  6739. static="true" final="false" visibility="public"
  6740. deprecated="not deprecated">
  6741. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6742. <param name="applicationName" type="java.lang.String"/>
  6743. <param name="queue" type="java.lang.String"/>
  6744. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6745. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6746. <param name="isUnmanagedAM" type="boolean"/>
  6747. <param name="cancelTokensWhenComplete" type="boolean"/>
  6748. <param name="maxAppAttempts" type="int"/>
  6749. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6750. <param name="applicationType" type="java.lang.String"/>
  6751. <param name="keepContainers" type="boolean"/>
  6752. </method>
  6753. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6754. abstract="false" native="false" synchronized="false"
  6755. static="true" final="false" visibility="public"
  6756. deprecated="not deprecated">
  6757. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6758. <param name="applicationName" type="java.lang.String"/>
  6759. <param name="queue" type="java.lang.String"/>
  6760. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6761. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6762. <param name="isUnmanagedAM" type="boolean"/>
  6763. <param name="cancelTokensWhenComplete" type="boolean"/>
  6764. <param name="maxAppAttempts" type="int"/>
  6765. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6766. <param name="applicationType" type="java.lang.String"/>
  6767. </method>
  6768. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6769. abstract="false" native="false" synchronized="false"
  6770. static="true" final="false" visibility="public"
  6771. deprecated="not deprecated">
  6772. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6773. <param name="applicationName" type="java.lang.String"/>
  6774. <param name="queue" type="java.lang.String"/>
  6775. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6776. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6777. <param name="isUnmanagedAM" type="boolean"/>
  6778. <param name="cancelTokensWhenComplete" type="boolean"/>
  6779. <param name="maxAppAttempts" type="int"/>
  6780. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6781. </method>
  6782. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6783. abstract="false" native="false" synchronized="false"
  6784. static="true" final="false" visibility="public"
  6785. deprecated="not deprecated">
  6786. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6787. <param name="applicationName" type="java.lang.String"/>
  6788. <param name="queue" type="java.lang.String"/>
  6789. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6790. <param name="isUnmanagedAM" type="boolean"/>
  6791. <param name="cancelTokensWhenComplete" type="boolean"/>
  6792. <param name="maxAppAttempts" type="int"/>
  6793. <param name="applicationType" type="java.lang.String"/>
  6794. <param name="keepContainers" type="boolean"/>
  6795. <param name="appLabelExpression" type="java.lang.String"/>
  6796. <param name="resourceRequest" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  6797. </method>
  6798. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6799. abstract="false" native="false" synchronized="false"
  6800. static="true" final="false" visibility="public"
  6801. deprecated="not deprecated">
  6802. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6803. <param name="applicationName" type="java.lang.String"/>
  6804. <param name="queue" type="java.lang.String"/>
  6805. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6806. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6807. <param name="isUnmanagedAM" type="boolean"/>
  6808. <param name="cancelTokensWhenComplete" type="boolean"/>
  6809. <param name="maxAppAttempts" type="int"/>
  6810. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6811. <param name="applicationType" type="java.lang.String"/>
  6812. <param name="keepContainers" type="boolean"/>
  6813. <param name="attemptFailuresValidityInterval" type="long"/>
  6814. </method>
  6815. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6816. abstract="false" native="false" synchronized="false"
  6817. static="true" final="false" visibility="public"
  6818. deprecated="not deprecated">
  6819. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6820. <param name="applicationName" type="java.lang.String"/>
  6821. <param name="queue" type="java.lang.String"/>
  6822. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6823. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6824. <param name="isUnmanagedAM" type="boolean"/>
  6825. <param name="cancelTokensWhenComplete" type="boolean"/>
  6826. <param name="maxAppAttempts" type="int"/>
  6827. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6828. <param name="applicationType" type="java.lang.String"/>
  6829. <param name="keepContainers" type="boolean"/>
  6830. <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
  6831. </method>
  6832. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  6833. abstract="true" native="false" synchronized="false"
  6834. static="false" final="false" visibility="public"
  6835. deprecated="not deprecated">
  6836. <doc>
  6837. <![CDATA[Get the <code>ApplicationId</code> of the submitted application.
  6838. @return <code>ApplicationId</code> of the submitted application]]>
  6839. </doc>
  6840. </method>
  6841. <method name="setApplicationId"
  6842. abstract="true" native="false" synchronized="false"
  6843. static="false" final="false" visibility="public"
  6844. deprecated="not deprecated">
  6845. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6846. <doc>
  6847. <![CDATA[Set the <code>ApplicationId</code> of the submitted application.
  6848. @param applicationId <code>ApplicationId</code> of the submitted
  6849. application]]>
  6850. </doc>
  6851. </method>
  6852. <method name="getApplicationName" return="java.lang.String"
  6853. abstract="true" native="false" synchronized="false"
  6854. static="false" final="false" visibility="public"
  6855. deprecated="not deprecated">
  6856. <doc>
  6857. <![CDATA[Get the application <em>name</em>.
  6858. @return application name]]>
  6859. </doc>
  6860. </method>
  6861. <method name="setApplicationName"
  6862. abstract="true" native="false" synchronized="false"
  6863. static="false" final="false" visibility="public"
  6864. deprecated="not deprecated">
  6865. <param name="applicationName" type="java.lang.String"/>
  6866. <doc>
  6867. <![CDATA[Set the application <em>name</em>.
  6868. @param applicationName application name]]>
  6869. </doc>
  6870. </method>
  6871. <method name="getQueue" return="java.lang.String"
  6872. abstract="true" native="false" synchronized="false"
  6873. static="false" final="false" visibility="public"
  6874. deprecated="not deprecated">
  6875. <doc>
  6876. <![CDATA[Get the <em>queue</em> to which the application is being submitted.
  6877. @return <em>queue</em> to which the application is being submitted]]>
  6878. </doc>
  6879. </method>
  6880. <method name="setQueue"
  6881. abstract="true" native="false" synchronized="false"
  6882. static="false" final="false" visibility="public"
  6883. deprecated="not deprecated">
  6884. <param name="queue" type="java.lang.String"/>
  6885. <doc>
  6886. <![CDATA[Set the <em>queue</em> to which the application is being submitted
  6887. @param queue <em>queue</em> to which the application is being submitted]]>
  6888. </doc>
  6889. </method>
  6890. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  6891. abstract="true" native="false" synchronized="false"
  6892. static="false" final="false" visibility="public"
  6893. deprecated="not deprecated">
  6894. <doc>
  6895. <![CDATA[Get the <code>Priority</code> of the application.
  6896. @return <code>Priority</code> of the application]]>
  6897. </doc>
  6898. </method>
  6899. <method name="getAMContainerSpec" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  6900. abstract="true" native="false" synchronized="false"
  6901. static="false" final="false" visibility="public"
  6902. deprecated="not deprecated">
  6903. <doc>
  6904. <![CDATA[Get the <code>ContainerLaunchContext</code> to describe the
  6905. <code>Container</code> with which the <code>ApplicationMaster</code> is
  6906. launched.
  6907. @return <code>ContainerLaunchContext</code> for the
  6908. <code>ApplicationMaster</code> container]]>
  6909. </doc>
  6910. </method>
  6911. <method name="setAMContainerSpec"
  6912. abstract="true" native="false" synchronized="false"
  6913. static="false" final="false" visibility="public"
  6914. deprecated="not deprecated">
  6915. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6916. <doc>
  6917. <![CDATA[Set the <code>ContainerLaunchContext</code> to describe the
  6918. <code>Container</code> with which the <code>ApplicationMaster</code> is
  6919. launched.
  6920. @param amContainer <code>ContainerLaunchContext</code> for the
  6921. <code>ApplicationMaster</code> container]]>
  6922. </doc>
  6923. </method>
  6924. <method name="getUnmanagedAM" return="boolean"
  6925. abstract="true" native="false" synchronized="false"
  6926. static="false" final="false" visibility="public"
  6927. deprecated="not deprecated">
  6928. <doc>
  6929. <![CDATA[Get if the RM should manage the execution of the AM.
  6930. If true, then the RM
  6931. will not allocate a container for the AM and start it. It will expect the
  6932. AM to be launched and connect to the RM within the AM liveliness period and
  6933. fail the app otherwise. The client should launch the AM only after the RM
  6934. has ACCEPTED the application and changed the <code>YarnApplicationState</code>.
  6935. Such apps will not be retried by the RM on app attempt failure.
  6936. The default value is false.
  6937. @return true if the AM is not managed by the RM]]>
  6938. </doc>
  6939. </method>
  6940. <method name="setUnmanagedAM"
  6941. abstract="true" native="false" synchronized="false"
  6942. static="false" final="false" visibility="public"
  6943. deprecated="not deprecated">
  6944. <param name="value" type="boolean"/>
  6945. <doc>
  6946. <![CDATA[@param value true if RM should not manage the AM]]>
  6947. </doc>
  6948. </method>
  6949. <method name="getMaxAppAttempts" return="int"
  6950. abstract="true" native="false" synchronized="false"
  6951. static="false" final="false" visibility="public"
  6952. deprecated="not deprecated">
  6953. <doc>
  6954. <![CDATA[@return the number of max attempts of the application to be submitted]]>
  6955. </doc>
  6956. </method>
  6957. <method name="setMaxAppAttempts"
  6958. abstract="true" native="false" synchronized="false"
  6959. static="false" final="false" visibility="public"
  6960. deprecated="not deprecated">
  6961. <param name="maxAppAttempts" type="int"/>
  6962. <doc>
  6963. <![CDATA[Set the number of max attempts of the application to be submitted. WARNING:
  6964. it should be no larger than the global number of max attempts in the Yarn
  6965. configuration.
  6966. @param maxAppAttempts the number of max attempts of the application
  6967. to be submitted.]]>
  6968. </doc>
  6969. </method>
  6970. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  6971. abstract="true" native="false" synchronized="false"
  6972. static="false" final="false" visibility="public"
  6973. deprecated="not deprecated">
  6974. <doc>
  6975. <![CDATA[Get the resource required by the <code>ApplicationMaster</code> for this
  6976. application. Please note this will be DEPRECATED, use <em>getResource</em>
  6977. in <em>getAMContainerResourceRequest</em> instead.
  6978. @return the resource required by the <code>ApplicationMaster</code> for
  6979. this application.]]>
  6980. </doc>
  6981. </method>
  6982. <method name="setResource"
  6983. abstract="true" native="false" synchronized="false"
  6984. static="false" final="false" visibility="public"
  6985. deprecated="not deprecated">
  6986. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6987. <doc>
  6988. <![CDATA[Set the resource required by the <code>ApplicationMaster</code> for this
  6989. application.
  6990. @param resource the resource required by the <code>ApplicationMaster</code>
  6991. for this application.]]>
  6992. </doc>
  6993. </method>
  6994. <method name="getApplicationType" return="java.lang.String"
  6995. abstract="true" native="false" synchronized="false"
  6996. static="false" final="false" visibility="public"
  6997. deprecated="not deprecated">
  6998. <doc>
  6999. <![CDATA[Get the application type
  7000. @return the application type]]>
  7001. </doc>
  7002. </method>
  7003. <method name="setApplicationType"
  7004. abstract="true" native="false" synchronized="false"
  7005. static="false" final="false" visibility="public"
  7006. deprecated="not deprecated">
  7007. <param name="applicationType" type="java.lang.String"/>
  7008. <doc>
  7009. <![CDATA[Set the application type
  7010. @param applicationType the application type]]>
  7011. </doc>
  7012. </method>
  7013. <method name="getKeepContainersAcrossApplicationAttempts" return="boolean"
  7014. abstract="true" native="false" synchronized="false"
  7015. static="false" final="false" visibility="public"
  7016. deprecated="not deprecated">
  7017. <doc>
  7018. <![CDATA[Get the flag which indicates whether to keep containers across application
  7019. attempts or not.
  7020. @return the flag which indicates whether to keep containers across
  7021. application attempts or not.]]>
  7022. </doc>
  7023. </method>
  7024. <method name="setKeepContainersAcrossApplicationAttempts"
  7025. abstract="true" native="false" synchronized="false"
  7026. static="false" final="false" visibility="public"
  7027. deprecated="not deprecated">
  7028. <param name="keepContainers" type="boolean"/>
  7029. <doc>
  7030. <![CDATA[Set the flag which indicates whether to keep containers across application
  7031. attempts.
  7032. <p>
  7033. For managed AM, if the flag is true, running containers will not be killed
  7034. when application attempt fails and these containers will be retrieved by
  7035. the new application attempt on registration via
  7036. {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}.
  7037. </p>
  7038. <p>
  7039. For unmanaged AM, if the flag is true, RM allows re-register and returns
  7040. the running containers in the same attempt back to the UAM for HA.
  7041. </p>
  7042. @param keepContainers the flag which indicates whether to keep containers
  7043. across application attempts.]]>
  7044. </doc>
  7045. </method>
  7046. <method name="getApplicationTags" return="java.util.Set"
  7047. abstract="true" native="false" synchronized="false"
  7048. static="false" final="false" visibility="public"
  7049. deprecated="not deprecated">
  7050. <doc>
  7051. <![CDATA[Get tags for the application
  7052. @return the application tags]]>
  7053. </doc>
  7054. </method>
  7055. <method name="setApplicationTags"
  7056. abstract="true" native="false" synchronized="false"
  7057. static="false" final="false" visibility="public"
  7058. deprecated="not deprecated">
  7059. <param name="tags" type="java.util.Set"/>
  7060. <doc>
  7061. <![CDATA[Set tags for the application. A maximum of
  7062. {@link YarnConfiguration#RM_APPLICATION_MAX_TAGS} are allowed
  7063. per application. Each tag can be at most
  7064. {@link YarnConfiguration#RM_APPLICATION_MAX_TAG_LENGTH}
  7065. characters, and can contain only ASCII characters.
  7066. @param tags tags to set]]>
  7067. </doc>
  7068. </method>
  7069. <method name="getNodeLabelExpression" return="java.lang.String"
  7070. abstract="true" native="false" synchronized="false"
  7071. static="false" final="false" visibility="public"
  7072. deprecated="not deprecated">
  7073. <doc>
  7074. <![CDATA[Get node-label-expression for this app. If this is set, all containers of
  7075. this application without setting node-label-expression in ResurceRequest
  7076. will get allocated resources on only those nodes that satisfy this
  7077. node-label-expression.
  7078. If different node-label-expression of this app and ResourceRequest are set
  7079. at the same time, the one set in ResourceRequest will be used when
  7080. allocating container
  7081. @return node-label-expression for this app]]>
  7082. </doc>
  7083. </method>
  7084. <method name="setNodeLabelExpression"
  7085. abstract="true" native="false" synchronized="false"
  7086. static="false" final="false" visibility="public"
  7087. deprecated="not deprecated">
  7088. <param name="nodeLabelExpression" type="java.lang.String"/>
  7089. <doc>
  7090. <![CDATA[Set node-label-expression for this app
  7091. @param nodeLabelExpression node-label-expression of this app]]>
  7092. </doc>
  7093. </method>
  7094. <method name="getAMContainerResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  7095. abstract="true" native="false" synchronized="false"
  7096. static="false" final="false" visibility="public"
  7097. deprecated="See {@link #getAMContainerResourceRequests()}">
  7098. <doc>
  7099. <![CDATA[Get the ResourceRequest of the AM container.
  7100. If this is not null, scheduler will use this to acquire resource for AM
  7101. container.
  7102. If this is null, scheduler will assemble a ResourceRequest by using
  7103. <em>getResource</em> and <em>getPriority</em> of
  7104. <em>ApplicationSubmissionContext</em>.
  7105. Number of containers and Priority will be ignored.
  7106. @return ResourceRequest of the AM container
  7107. @deprecated See {@link #getAMContainerResourceRequests()}]]>
  7108. </doc>
  7109. </method>
  7110. <method name="setAMContainerResourceRequest"
  7111. abstract="true" native="false" synchronized="false"
  7112. static="false" final="false" visibility="public"
  7113. deprecated="See {@link #setAMContainerResourceRequests(List)}">
  7114. <param name="request" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  7115. <doc>
  7116. <![CDATA[Set ResourceRequest of the AM container
  7117. @param request of the AM container
  7118. @deprecated See {@link #setAMContainerResourceRequests(List)}]]>
  7119. </doc>
  7120. </method>
  7121. <method name="getAMContainerResourceRequests" return="java.util.List"
  7122. abstract="true" native="false" synchronized="false"
  7123. static="false" final="false" visibility="public"
  7124. deprecated="not deprecated">
  7125. <doc>
  7126. <![CDATA[Get the ResourceRequests of the AM container.
  7127. If this is not null, scheduler will use this to acquire resource for AM
  7128. container.
  7129. If this is null, scheduler will use the ResourceRequest as determined by
  7130. <em>getAMContainerResourceRequest</em> and its behavior.
  7131. Number of containers and Priority will be ignored.
  7132. @return List of ResourceRequests of the AM container]]>
  7133. </doc>
  7134. </method>
  7135. <method name="setAMContainerResourceRequests"
  7136. abstract="true" native="false" synchronized="false"
  7137. static="false" final="false" visibility="public"
  7138. deprecated="not deprecated">
  7139. <param name="requests" type="java.util.List"/>
  7140. <doc>
  7141. <![CDATA[Set ResourceRequests of the AM container.
  7142. @param requests of the AM container]]>
  7143. </doc>
  7144. </method>
  7145. <method name="getAttemptFailuresValidityInterval" return="long"
  7146. abstract="true" native="false" synchronized="false"
  7147. static="false" final="false" visibility="public"
  7148. deprecated="not deprecated">
  7149. <doc>
  7150. <![CDATA[Get the attemptFailuresValidityInterval in milliseconds for the application
  7151. @return the attemptFailuresValidityInterval]]>
  7152. </doc>
  7153. </method>
  7154. <method name="setAttemptFailuresValidityInterval"
  7155. abstract="true" native="false" synchronized="false"
  7156. static="false" final="false" visibility="public"
  7157. deprecated="not deprecated">
  7158. <param name="attemptFailuresValidityInterval" type="long"/>
  7159. <doc>
  7160. <![CDATA[Set the attemptFailuresValidityInterval in milliseconds for the application
  7161. @param attemptFailuresValidityInterval]]>
  7162. </doc>
  7163. </method>
  7164. <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  7165. abstract="true" native="false" synchronized="false"
  7166. static="false" final="false" visibility="public"
  7167. deprecated="not deprecated">
  7168. <doc>
  7169. <![CDATA[Get <code>LogAggregationContext</code> of the application
  7170. @return <code>LogAggregationContext</code> of the application]]>
  7171. </doc>
  7172. </method>
  7173. <method name="setLogAggregationContext"
  7174. abstract="true" native="false" synchronized="false"
  7175. static="false" final="false" visibility="public"
  7176. deprecated="not deprecated">
  7177. <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
  7178. <doc>
  7179. <![CDATA[Set <code>LogAggregationContext</code> for the application
  7180. @param logAggregationContext
  7181. for the application]]>
  7182. </doc>
  7183. </method>
  7184. <method name="getReservationID" return="org.apache.hadoop.yarn.api.records.ReservationId"
  7185. abstract="true" native="false" synchronized="false"
  7186. static="false" final="false" visibility="public"
  7187. deprecated="not deprecated">
  7188. <doc>
  7189. <![CDATA[Get the reservation id, that corresponds to a valid resource allocation in
  7190. the scheduler (between start and end time of the corresponding reservation)
  7191. @return the reservation id representing the unique id of the corresponding
  7192. reserved resource allocation in the scheduler]]>
  7193. </doc>
  7194. </method>
  7195. <method name="setReservationID"
  7196. abstract="true" native="false" synchronized="false"
  7197. static="false" final="false" visibility="public"
  7198. deprecated="not deprecated">
  7199. <param name="reservationID" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  7200. <doc>
  7201. <![CDATA[Set the reservation id, that correspond to a valid resource allocation in
  7202. the scheduler (between start and end time of the corresponding reservation)
  7203. @param reservationID representing the unique id of the
  7204. corresponding reserved resource allocation in the scheduler]]>
  7205. </doc>
  7206. </method>
  7207. <method name="getApplicationTimeouts" return="java.util.Map"
  7208. abstract="true" native="false" synchronized="false"
  7209. static="false" final="false" visibility="public"
  7210. deprecated="not deprecated">
  7211. <doc>
  7212. <![CDATA[Get <code>ApplicationTimeouts</code> of the application. Timeout value is
  7213. in seconds.
  7214. @return all <code>ApplicationTimeouts</code> of the application.]]>
  7215. </doc>
  7216. </method>
  7217. <method name="setApplicationTimeouts"
  7218. abstract="true" native="false" synchronized="false"
  7219. static="false" final="false" visibility="public"
  7220. deprecated="not deprecated">
  7221. <param name="applicationTimeouts" type="java.util.Map"/>
  7222. <doc>
  7223. <![CDATA[Set the <code>ApplicationTimeouts</code> for the application in seconds.
  7224. All pre-existing Map entries are cleared before adding the new Map.
  7225. <p>
  7226. <b>Note:</b> If application timeout value is less than or equal to zero
  7227. then application submission will throw an exception.
  7228. </p>
  7229. @param applicationTimeouts <code>ApplicationTimeouts</code>s for the
  7230. application]]>
  7231. </doc>
  7232. </method>
  7233. <method name="getApplicationSchedulingPropertiesMap" return="java.util.Map"
  7234. abstract="true" native="false" synchronized="false"
  7235. static="false" final="false" visibility="public"
  7236. deprecated="not deprecated">
  7237. <doc>
  7238. <![CDATA[Get application scheduling environment variables stored as a key value
  7239. pair map for application.
  7240. @return placement envs for application.]]>
  7241. </doc>
  7242. </method>
  7243. <method name="setApplicationSchedulingPropertiesMap"
  7244. abstract="true" native="false" synchronized="false"
  7245. static="false" final="false" visibility="public"
  7246. deprecated="not deprecated">
  7247. <param name="schedulingEnvMap" type="java.util.Map"/>
  7248. <doc>
  7249. <![CDATA[Set the scheduling envs for the application.
  7250. @param schedulingEnvMap
  7251. A map of env's for the application scheduling preferences.]]>
  7252. </doc>
  7253. </method>
  7254. <doc>
  7255. <![CDATA[{@code ApplicationSubmissionContext} represents all of the
  7256. information needed by the {@code ResourceManager} to launch
  7257. the {@code ApplicationMaster} for an application.
  7258. <p>
  7259. It includes details such as:
  7260. <ul>
  7261. <li>{@link ApplicationId} of the application.</li>
  7262. <li>Application user.</li>
  7263. <li>Application name.</li>
  7264. <li>{@link Priority} of the application.</li>
  7265. <li>
  7266. {@link ContainerLaunchContext} of the container in which the
  7267. <code>ApplicationMaster</code> is executed.
  7268. </li>
  7269. <li>
  7270. maxAppAttempts. The maximum number of application attempts.
  7271. It should be no larger than the global number of max attempts in the
  7272. YARN configuration.
  7273. </li>
  7274. <li>
  7275. attemptFailuresValidityInterval. The default value is -1.
  7276. when attemptFailuresValidityInterval in milliseconds is set to
  7277. {@literal >} 0, the failure number will no take failures which happen
  7278. out of the validityInterval into failure count. If failure count
  7279. reaches to maxAppAttempts, the application will be failed.
  7280. </li>
  7281. <li>Optional, application-specific {@link LogAggregationContext}</li>
  7282. </ul>
  7283. @see ContainerLaunchContext
  7284. @see ApplicationClientProtocol#submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest)]]>
  7285. </doc>
  7286. </class>
  7287. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
  7288. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationTimeout -->
  7289. <class name="ApplicationTimeout" extends="java.lang.Object"
  7290. abstract="true"
  7291. static="false" final="false" visibility="public"
  7292. deprecated="not deprecated">
  7293. <constructor name="ApplicationTimeout"
  7294. static="false" final="false" visibility="public"
  7295. deprecated="not deprecated">
  7296. </constructor>
  7297. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationTimeout"
  7298. abstract="false" native="false" synchronized="false"
  7299. static="true" final="false" visibility="public"
  7300. deprecated="not deprecated">
  7301. <param name="type" type="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"/>
  7302. <param name="expiryTime" type="java.lang.String"/>
  7303. <param name="remainingTime" type="long"/>
  7304. </method>
  7305. <method name="getTimeoutType" return="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"
  7306. abstract="true" native="false" synchronized="false"
  7307. static="false" final="false" visibility="public"
  7308. deprecated="not deprecated">
  7309. <doc>
  7310. <![CDATA[Get the application timeout type.
  7311. @return timeoutType of an application timeout.]]>
  7312. </doc>
  7313. </method>
  7314. <method name="setTimeoutType"
  7315. abstract="true" native="false" synchronized="false"
  7316. static="false" final="false" visibility="public"
  7317. deprecated="not deprecated">
  7318. <param name="timeoutType" type="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"/>
  7319. <doc>
  7320. <![CDATA[Set the application timeout type.
  7321. @param timeoutType of an application timeout.]]>
  7322. </doc>
  7323. </method>
  7324. <method name="getExpiryTime" return="java.lang.String"
  7325. abstract="true" native="false" synchronized="false"
  7326. static="false" final="false" visibility="public"
  7327. deprecated="not deprecated">
  7328. <doc>
  7329. <![CDATA[Get <code>expiryTime</code> for given timeout type.
  7330. @return expiryTime in ISO8601 standard with format
  7331. <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.]]>
  7332. </doc>
  7333. </method>
  7334. <method name="setExpiryTime"
  7335. abstract="true" native="false" synchronized="false"
  7336. static="false" final="false" visibility="public"
  7337. deprecated="not deprecated">
  7338. <param name="expiryTime" type="java.lang.String"/>
  7339. <doc>
  7340. <![CDATA[Set <code>expiryTime</code> for given timeout type.
  7341. @param expiryTime in ISO8601 standard with format
  7342. <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.]]>
  7343. </doc>
  7344. </method>
  7345. <method name="getRemainingTime" return="long"
  7346. abstract="true" native="false" synchronized="false"
  7347. static="false" final="false" visibility="public"
  7348. deprecated="not deprecated">
  7349. <doc>
  7350. <![CDATA[Get <code>Remaining Time</code> of an application for given timeout type.
  7351. @return Remaining Time in seconds.]]>
  7352. </doc>
  7353. </method>
  7354. <method name="setRemainingTime"
  7355. abstract="true" native="false" synchronized="false"
  7356. static="false" final="false" visibility="public"
  7357. deprecated="not deprecated">
  7358. <param name="remainingTime" type="long"/>
  7359. <doc>
  7360. <![CDATA[Set <code>Remaining Time</code> of an application for given timeout type.
  7361. @param remainingTime in seconds.]]>
  7362. </doc>
  7363. </method>
  7364. <doc>
  7365. <![CDATA[{@code ApplicationTimeout} is a report for configured application timeouts.
  7366. It includes details such as:
  7367. <ul>
  7368. <li>{@link ApplicationTimeoutType} of the timeout type.</li>
  7369. <li>Expiry time in ISO8601 standard with format
  7370. <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b> or "UNLIMITED".</li>
  7371. <li>Remaining time in seconds.</li>
  7372. </ul>
  7373. The possible values for {ExpiryTime, RemainingTimeInSeconds} are
  7374. <ul>
  7375. <li>{UNLIMITED,-1} : Timeout is not configured for given timeout type
  7376. (LIFETIME).</li>
  7377. <li>{ISO8601 date string, 0} : Timeout is configured and application has
  7378. completed.</li>
  7379. <li>{ISO8601 date string, greater than zero} : Timeout is configured and
  7380. application is RUNNING. Application will be timed out after configured
  7381. value.</li>
  7382. </ul>]]>
  7383. </doc>
  7384. </class>
  7385. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationTimeout -->
  7386. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationTimeoutType -->
  7387. <class name="ApplicationTimeoutType" extends="java.lang.Enum"
  7388. abstract="false"
  7389. static="false" final="true" visibility="public"
  7390. deprecated="not deprecated">
  7391. <method name="values" return="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType[]"
  7392. abstract="false" native="false" synchronized="false"
  7393. static="true" final="false" visibility="public"
  7394. deprecated="not deprecated">
  7395. </method>
  7396. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"
  7397. abstract="false" native="false" synchronized="false"
  7398. static="true" final="false" visibility="public"
  7399. deprecated="not deprecated">
  7400. <param name="name" type="java.lang.String"/>
  7401. </method>
  7402. <doc>
  7403. <![CDATA[Application timeout type.]]>
  7404. </doc>
  7405. </class>
  7406. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationTimeoutType -->
  7407. <!-- start class org.apache.hadoop.yarn.api.records.CollectorInfo -->
  7408. <class name="CollectorInfo" extends="java.lang.Object"
  7409. abstract="true"
  7410. static="false" final="false" visibility="public"
  7411. deprecated="not deprecated">
  7412. <constructor name="CollectorInfo"
  7413. static="false" final="false" visibility="public"
  7414. deprecated="not deprecated">
  7415. </constructor>
  7416. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.CollectorInfo"
  7417. abstract="false" native="false" synchronized="false"
  7418. static="true" final="false" visibility="public"
  7419. deprecated="not deprecated">
  7420. <param name="collectorAddr" type="java.lang.String"/>
  7421. </method>
  7422. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.CollectorInfo"
  7423. abstract="false" native="false" synchronized="false"
  7424. static="true" final="false" visibility="public"
  7425. deprecated="not deprecated">
  7426. <param name="collectorAddr" type="java.lang.String"/>
  7427. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  7428. </method>
  7429. <method name="getCollectorAddr" return="java.lang.String"
  7430. abstract="true" native="false" synchronized="false"
  7431. static="false" final="false" visibility="public"
  7432. deprecated="not deprecated">
  7433. </method>
  7434. <method name="setCollectorAddr"
  7435. abstract="true" native="false" synchronized="false"
  7436. static="false" final="false" visibility="public"
  7437. deprecated="not deprecated">
  7438. <param name="addr" type="java.lang.String"/>
  7439. </method>
  7440. <method name="getCollectorToken" return="org.apache.hadoop.yarn.api.records.Token"
  7441. abstract="true" native="false" synchronized="false"
  7442. static="false" final="false" visibility="public"
  7443. deprecated="not deprecated">
  7444. <doc>
  7445. <![CDATA[Get delegation token for app collector which AM will use to publish
  7446. entities.
  7447. @return the delegation token for app collector.]]>
  7448. </doc>
  7449. </method>
  7450. <method name="setCollectorToken"
  7451. abstract="true" native="false" synchronized="false"
  7452. static="false" final="false" visibility="public"
  7453. deprecated="not deprecated">
  7454. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  7455. </method>
  7456. <field name="DEFAULT_TIMESTAMP_VALUE" type="long"
  7457. transient="false" volatile="false"
  7458. static="true" final="true" visibility="protected"
  7459. deprecated="not deprecated">
  7460. </field>
  7461. <doc>
  7462. <![CDATA[Collector info containing collector address and collector token passed from
  7463. RM to AM in Allocate Response.]]>
  7464. </doc>
  7465. </class>
  7466. <!-- end class org.apache.hadoop.yarn.api.records.CollectorInfo -->
  7467. <!-- start class org.apache.hadoop.yarn.api.records.Container -->
  7468. <class name="Container" extends="java.lang.Object"
  7469. abstract="true"
  7470. static="false" final="false" visibility="public"
  7471. deprecated="not deprecated">
  7472. <implements name="java.lang.Comparable"/>
  7473. <constructor name="Container"
  7474. static="false" final="false" visibility="public"
  7475. deprecated="not deprecated">
  7476. </constructor>
  7477. <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  7478. abstract="true" native="false" synchronized="false"
  7479. static="false" final="false" visibility="public"
  7480. deprecated="not deprecated">
  7481. <doc>
  7482. <![CDATA[Get the globally unique identifier for the container.
  7483. @return globally unique identifier for the container]]>
  7484. </doc>
  7485. </method>
  7486. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  7487. abstract="true" native="false" synchronized="false"
  7488. static="false" final="false" visibility="public"
  7489. deprecated="not deprecated">
  7490. <doc>
  7491. <![CDATA[Get the identifier of the node on which the container is allocated.
  7492. @return identifier of the node on which the container is allocated]]>
  7493. </doc>
  7494. </method>
  7495. <method name="getNodeHttpAddress" return="java.lang.String"
  7496. abstract="true" native="false" synchronized="false"
  7497. static="false" final="false" visibility="public"
  7498. deprecated="not deprecated">
  7499. <doc>
  7500. <![CDATA[Get the http uri of the node on which the container is allocated.
  7501. @return http uri of the node on which the container is allocated]]>
  7502. </doc>
  7503. </method>
  7504. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  7505. abstract="true" native="false" synchronized="false"
  7506. static="false" final="false" visibility="public"
  7507. deprecated="not deprecated">
  7508. <doc>
  7509. <![CDATA[Get the <code>Resource</code> allocated to the container.
  7510. @return <code>Resource</code> allocated to the container]]>
  7511. </doc>
  7512. </method>
  7513. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  7514. abstract="true" native="false" synchronized="false"
  7515. static="false" final="false" visibility="public"
  7516. deprecated="not deprecated">
  7517. <doc>
  7518. <![CDATA[Get the <code>Priority</code> at which the <code>Container</code> was
  7519. allocated.
  7520. @return <code>Priority</code> at which the <code>Container</code> was
  7521. allocated]]>
  7522. </doc>
  7523. </method>
  7524. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  7525. abstract="true" native="false" synchronized="false"
  7526. static="false" final="false" visibility="public"
  7527. deprecated="not deprecated">
  7528. <doc>
  7529. <![CDATA[Get the <code>ContainerToken</code> for the container.
  7530. <p><code>ContainerToken</code> is the security token used by the framework
  7531. to verify authenticity of any <code>Container</code>.</p>
  7532. <p>The <code>ResourceManager</code>, on container allocation provides a
  7533. secure token which is verified by the <code>NodeManager</code> on
  7534. container launch.</p>
  7535. <p>Applications do not need to care about <code>ContainerToken</code>, they
  7536. are transparently handled by the framework - the allocated
  7537. <code>Container</code> includes the <code>ContainerToken</code>.</p>
  7538. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
  7539. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
  7540. @return <code>ContainerToken</code> for the container]]>
  7541. </doc>
  7542. </method>
  7543. <method name="getAllocationRequestId" return="long"
  7544. abstract="false" native="false" synchronized="false"
  7545. static="false" final="false" visibility="public"
  7546. deprecated="not deprecated">
  7547. <doc>
  7548. <![CDATA[Get the optional <em>ID</em> corresponding to the original {@code
  7549. ResourceRequest{@link #getAllocationRequestId()}}s which is satisfied by
  7550. this allocated {@code Container}.
  7551. <p>
  7552. The scheduler may return multiple {@code AllocateResponse}s corresponding
  7553. to the same ID as and when scheduler allocates {@code Container}s.
  7554. <b>Applications</b> can continue to completely ignore the returned ID in
  7555. the response and use the allocation for any of their outstanding requests.
  7556. <p>
  7557. @return the <em>ID</em> corresponding to the original allocation request
  7558. which is satisfied by this allocation.]]>
  7559. </doc>
  7560. </method>
  7561. <doc>
  7562. <![CDATA[{@code Container} represents an allocated resource in the cluster.
  7563. <p>
  7564. The {@code ResourceManager} is the sole authority to allocate any
  7565. {@code Container} to applications. The allocated {@code Container}
  7566. is always on a single node and has a unique {@link ContainerId}. It has
  7567. a specific amount of {@link Resource} allocated.
  7568. <p>
  7569. It includes details such as:
  7570. <ul>
  7571. <li>{@link ContainerId} for the container, which is globally unique.</li>
  7572. <li>
  7573. {@link NodeId} of the node on which it is allocated.
  7574. </li>
  7575. <li>HTTP uri of the node.</li>
  7576. <li>{@link Resource} allocated to the container.</li>
  7577. <li>{@link Priority} at which the container was allocated.</li>
  7578. <li>
  7579. Container {@link Token} of the container, used to securely verify
  7580. authenticity of the allocation.
  7581. </li>
  7582. </ul>
  7583. Typically, an {@code ApplicationMaster} receives the {@code Container}
  7584. from the {@code ResourceManager} during resource-negotiation and then
  7585. talks to the {@code NodeManager} to start/stop containers.
  7586. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
  7587. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
  7588. @see ContainerManagementProtocol#stopContainers(org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest)]]>
  7589. </doc>
  7590. </class>
  7591. <!-- end class org.apache.hadoop.yarn.api.records.Container -->
  7592. <!-- start class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
  7593. <class name="ContainerExitStatus" extends="java.lang.Object"
  7594. abstract="false"
  7595. static="false" final="false" visibility="public"
  7596. deprecated="not deprecated">
  7597. <constructor name="ContainerExitStatus"
  7598. static="false" final="false" visibility="public"
  7599. deprecated="not deprecated">
  7600. </constructor>
  7601. <field name="SUCCESS" type="int"
  7602. transient="false" volatile="false"
  7603. static="true" final="true" visibility="public"
  7604. deprecated="not deprecated">
  7605. </field>
  7606. <field name="INVALID" type="int"
  7607. transient="false" volatile="false"
  7608. static="true" final="true" visibility="public"
  7609. deprecated="not deprecated">
  7610. </field>
  7611. <field name="ABORTED" type="int"
  7612. transient="false" volatile="false"
  7613. static="true" final="true" visibility="public"
  7614. deprecated="not deprecated">
  7615. <doc>
  7616. <![CDATA[Containers killed by the framework, either due to being released by
  7617. the application or being 'lost' due to node failures etc.]]>
  7618. </doc>
  7619. </field>
  7620. <field name="DISKS_FAILED" type="int"
  7621. transient="false" volatile="false"
  7622. static="true" final="true" visibility="public"
  7623. deprecated="not deprecated">
  7624. <doc>
  7625. <![CDATA[When threshold number of the nodemanager-local-directories or
  7626. threshold number of the nodemanager-log-directories become bad.]]>
  7627. </doc>
  7628. </field>
  7629. <field name="PREEMPTED" type="int"
  7630. transient="false" volatile="false"
  7631. static="true" final="true" visibility="public"
  7632. deprecated="not deprecated">
  7633. <doc>
  7634. <![CDATA[Containers preempted by the framework.]]>
  7635. </doc>
  7636. </field>
  7637. <field name="KILLED_EXCEEDED_VMEM" type="int"
  7638. transient="false" volatile="false"
  7639. static="true" final="true" visibility="public"
  7640. deprecated="not deprecated">
  7641. <doc>
  7642. <![CDATA[Container terminated because of exceeding allocated virtual memory.]]>
  7643. </doc>
  7644. </field>
  7645. <field name="KILLED_EXCEEDED_PMEM" type="int"
  7646. transient="false" volatile="false"
  7647. static="true" final="true" visibility="public"
  7648. deprecated="not deprecated">
  7649. <doc>
  7650. <![CDATA[Container terminated because of exceeding allocated physical memory.]]>
  7651. </doc>
  7652. </field>
  7653. <field name="KILLED_BY_APPMASTER" type="int"
  7654. transient="false" volatile="false"
  7655. static="true" final="true" visibility="public"
  7656. deprecated="not deprecated">
  7657. <doc>
  7658. <![CDATA[Container was terminated by stop request by the app master.]]>
  7659. </doc>
  7660. </field>
  7661. <field name="KILLED_BY_RESOURCEMANAGER" type="int"
  7662. transient="false" volatile="false"
  7663. static="true" final="true" visibility="public"
  7664. deprecated="not deprecated">
  7665. <doc>
  7666. <![CDATA[Container was terminated by the resource manager.]]>
  7667. </doc>
  7668. </field>
  7669. <field name="KILLED_AFTER_APP_COMPLETION" type="int"
  7670. transient="false" volatile="false"
  7671. static="true" final="true" visibility="public"
  7672. deprecated="not deprecated">
  7673. <doc>
  7674. <![CDATA[Container was terminated after the application finished.]]>
  7675. </doc>
  7676. </field>
  7677. <field name="KILLED_BY_CONTAINER_SCHEDULER" type="int"
  7678. transient="false" volatile="false"
  7679. static="true" final="true" visibility="public"
  7680. deprecated="not deprecated">
  7681. <doc>
  7682. <![CDATA[Container was terminated by the ContainerScheduler to make room
  7683. for another container...]]>
  7684. </doc>
  7685. </field>
  7686. <field name="KILLED_FOR_EXCESS_LOGS" type="int"
  7687. transient="false" volatile="false"
  7688. static="true" final="true" visibility="public"
  7689. deprecated="not deprecated">
  7690. <doc>
  7691. <![CDATA[Container was terminated for generating excess log data.]]>
  7692. </doc>
  7693. </field>
  7694. <doc>
  7695. <![CDATA[Container exit statuses indicating special exit circumstances.]]>
  7696. </doc>
  7697. </class>
  7698. <!-- end class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
  7699. <!-- start class org.apache.hadoop.yarn.api.records.ContainerId -->
  7700. <class name="ContainerId" extends="java.lang.Object"
  7701. abstract="true"
  7702. static="false" final="false" visibility="public"
  7703. deprecated="not deprecated">
  7704. <implements name="java.lang.Comparable"/>
  7705. <constructor name="ContainerId"
  7706. static="false" final="false" visibility="public"
  7707. deprecated="not deprecated">
  7708. </constructor>
  7709. <method name="newContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  7710. abstract="false" native="false" synchronized="false"
  7711. static="true" final="false" visibility="public"
  7712. deprecated="not deprecated">
  7713. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  7714. <param name="containerId" type="long"/>
  7715. </method>
  7716. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  7717. abstract="true" native="false" synchronized="false"
  7718. static="false" final="false" visibility="public"
  7719. deprecated="not deprecated">
  7720. <doc>
  7721. <![CDATA[Get the <code>ApplicationAttemptId</code> of the application to which the
  7722. <code>Container</code> was assigned.
  7723. <p>
  7724. Note: If containers are kept alive across application attempts via
  7725. {@link ApplicationSubmissionContext#setKeepContainersAcrossApplicationAttempts(boolean)}
  7726. the <code>ContainerId</code> does not necessarily contain the current
  7727. running application attempt's <code>ApplicationAttemptId</code> This
  7728. container can be allocated by previously exited application attempt and
  7729. managed by the current running attempt thus have the previous application
  7730. attempt's <code>ApplicationAttemptId</code>.
  7731. </p>
  7732. @return <code>ApplicationAttemptId</code> of the application to which the
  7733. <code>Container</code> was assigned]]>
  7734. </doc>
  7735. </method>
  7736. <method name="getId" return="int"
  7737. abstract="true" native="false" synchronized="false"
  7738. static="false" final="false" visibility="public"
  7739. deprecated="not deprecated">
  7740. <doc>
  7741. <![CDATA[Get the lower 32 bits of identifier of the <code>ContainerId</code>,
  7742. which doesn't include epoch. Note that this method will be marked as
  7743. deprecated, so please use <code>getContainerId</code> instead.
  7744. @return lower 32 bits of identifier of the <code>ContainerId</code>]]>
  7745. </doc>
  7746. </method>
  7747. <method name="getContainerId" return="long"
  7748. abstract="true" native="false" synchronized="false"
  7749. static="false" final="false" visibility="public"
  7750. deprecated="not deprecated">
  7751. <doc>
  7752. <![CDATA[Get the identifier of the <code>ContainerId</code>. Upper 24 bits are
  7753. reserved as epoch of cluster, and lower 40 bits are reserved as
  7754. sequential number of containers.
  7755. @return identifier of the <code>ContainerId</code>]]>
  7756. </doc>
  7757. </method>
  7758. <method name="hashCode" return="int"
  7759. abstract="false" native="false" synchronized="false"
  7760. static="false" final="false" visibility="public"
  7761. deprecated="not deprecated">
  7762. </method>
  7763. <method name="equals" return="boolean"
  7764. abstract="false" native="false" synchronized="false"
  7765. static="false" final="false" visibility="public"
  7766. deprecated="not deprecated">
  7767. <param name="obj" type="java.lang.Object"/>
  7768. </method>
  7769. <method name="compareTo" return="int"
  7770. abstract="false" native="false" synchronized="false"
  7771. static="false" final="false" visibility="public"
  7772. deprecated="not deprecated">
  7773. <param name="other" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  7774. </method>
  7775. <method name="toString" return="java.lang.String"
  7776. abstract="false" native="false" synchronized="false"
  7777. static="false" final="false" visibility="public"
  7778. deprecated="not deprecated">
  7779. <doc>
  7780. <![CDATA[@return A string representation of containerId. The format is
  7781. container_e*epoch*_*clusterTimestamp*_*appId*_*attemptId*_*containerId*
  7782. when epoch is larger than 0
  7783. (e.g. container_e17_1410901177871_0001_01_000005).
  7784. *epoch* is increased when RM restarts or fails over.
  7785. When epoch is 0, epoch is omitted
  7786. (e.g. container_1410901177871_0001_01_000005).]]>
  7787. </doc>
  7788. </method>
  7789. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ContainerId"
  7790. abstract="false" native="false" synchronized="false"
  7791. static="true" final="false" visibility="public"
  7792. deprecated="not deprecated">
  7793. <param name="containerIdStr" type="java.lang.String"/>
  7794. </method>
  7795. <method name="build"
  7796. abstract="true" native="false" synchronized="false"
  7797. static="false" final="false" visibility="protected"
  7798. deprecated="not deprecated">
  7799. </method>
  7800. <field name="CONTAINER_ID_BITMASK" type="long"
  7801. transient="false" volatile="false"
  7802. static="true" final="true" visibility="public"
  7803. deprecated="not deprecated">
  7804. </field>
  7805. <doc>
  7806. <![CDATA[<p><code>ContainerId</code> represents a globally unique identifier
  7807. for a {@link Container} in the cluster.</p>]]>
  7808. </doc>
  7809. </class>
  7810. <!-- end class org.apache.hadoop.yarn.api.records.ContainerId -->
  7811. <!-- start class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
  7812. <class name="ContainerLaunchContext" extends="java.lang.Object"
  7813. abstract="true"
  7814. static="false" final="false" visibility="public"
  7815. deprecated="not deprecated">
  7816. <constructor name="ContainerLaunchContext"
  7817. static="false" final="false" visibility="public"
  7818. deprecated="not deprecated">
  7819. </constructor>
  7820. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  7821. abstract="false" native="false" synchronized="false"
  7822. static="true" final="false" visibility="public"
  7823. deprecated="not deprecated">
  7824. <param name="localResources" type="java.util.Map"/>
  7825. <param name="environment" type="java.util.Map"/>
  7826. <param name="commands" type="java.util.List"/>
  7827. <param name="serviceData" type="java.util.Map"/>
  7828. <param name="tokens" type="java.nio.ByteBuffer"/>
  7829. <param name="acls" type="java.util.Map"/>
  7830. </method>
  7831. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  7832. abstract="false" native="false" synchronized="false"
  7833. static="true" final="false" visibility="public"
  7834. deprecated="not deprecated">
  7835. <param name="localResources" type="java.util.Map"/>
  7836. <param name="environment" type="java.util.Map"/>
  7837. <param name="commands" type="java.util.List"/>
  7838. <param name="serviceData" type="java.util.Map"/>
  7839. <param name="tokens" type="java.nio.ByteBuffer"/>
  7840. <param name="acls" type="java.util.Map"/>
  7841. <param name="containerRetryContext" type="org.apache.hadoop.yarn.api.records.ContainerRetryContext"/>
  7842. </method>
  7843. <method name="getTokens" return="java.nio.ByteBuffer"
  7844. abstract="true" native="false" synchronized="false"
  7845. static="false" final="false" visibility="public"
  7846. deprecated="not deprecated">
  7847. <doc>
  7848. <![CDATA[Get all the tokens needed by this container. It may include file-system
  7849. tokens, ApplicationMaster related tokens if this container is an
  7850. ApplicationMaster or framework level tokens needed by this container to
  7851. communicate to various services in a secure manner.
  7852. @return tokens needed by this container.]]>
  7853. </doc>
  7854. </method>
  7855. <method name="setTokens"
  7856. abstract="true" native="false" synchronized="false"
  7857. static="false" final="false" visibility="public"
  7858. deprecated="not deprecated">
  7859. <param name="tokens" type="java.nio.ByteBuffer"/>
  7860. <doc>
  7861. <![CDATA[Set security tokens needed by this container.
  7862. @param tokens security tokens]]>
  7863. </doc>
  7864. </method>
  7865. <method name="getTokensConf" return="java.nio.ByteBuffer"
  7866. abstract="true" native="false" synchronized="false"
  7867. static="false" final="false" visibility="public"
  7868. deprecated="not deprecated">
  7869. <doc>
  7870. <![CDATA[Get the configuration used by RM to renew tokens.
  7871. @return The configuration used by RM to renew the tokens.]]>
  7872. </doc>
  7873. </method>
  7874. <method name="setTokensConf"
  7875. abstract="true" native="false" synchronized="false"
  7876. static="false" final="false" visibility="public"
  7877. deprecated="not deprecated">
  7878. <param name="tokensConf" type="java.nio.ByteBuffer"/>
  7879. <doc>
  7880. <![CDATA[Set the configuration used by RM to renew the tokens.
  7881. @param tokensConf The configuration used by RM to renew the tokens]]>
  7882. </doc>
  7883. </method>
  7884. <method name="getLocalResources" return="java.util.Map"
  7885. abstract="true" native="false" synchronized="false"
  7886. static="false" final="false" visibility="public"
  7887. deprecated="not deprecated">
  7888. <doc>
  7889. <![CDATA[Get <code>LocalResource</code> required by the container.
  7890. @return all <code>LocalResource</code> required by the container]]>
  7891. </doc>
  7892. </method>
  7893. <method name="setLocalResources"
  7894. abstract="true" native="false" synchronized="false"
  7895. static="false" final="false" visibility="public"
  7896. deprecated="not deprecated">
  7897. <param name="localResources" type="java.util.Map"/>
  7898. <doc>
  7899. <![CDATA[Set <code>LocalResource</code> required by the container. All pre-existing
  7900. Map entries are cleared before adding the new Map
  7901. @param localResources <code>LocalResource</code> required by the container]]>
  7902. </doc>
  7903. </method>
  7904. <method name="getServiceData" return="java.util.Map"
  7905. abstract="true" native="false" synchronized="false"
  7906. static="false" final="false" visibility="public"
  7907. deprecated="not deprecated">
  7908. <doc>
  7909. <![CDATA[<p>
  7910. Get application-specific binary <em>service data</em>. This is a map keyed
  7911. by the name of each {@link AuxiliaryService} that is configured on a
  7912. NodeManager and value correspond to the application specific data targeted
  7913. for the keyed {@link AuxiliaryService}.
  7914. </p>
  7915. <p>
  7916. This will be used to initialize this application on the specific
  7917. {@link AuxiliaryService} running on the NodeManager by calling
  7918. {@link AuxiliaryService#initializeApplication(ApplicationInitializationContext)}
  7919. </p>
  7920. @return application-specific binary <em>service data</em>]]>
  7921. </doc>
  7922. </method>
  7923. <method name="setServiceData"
  7924. abstract="true" native="false" synchronized="false"
  7925. static="false" final="false" visibility="public"
  7926. deprecated="not deprecated">
  7927. <param name="serviceData" type="java.util.Map"/>
  7928. <doc>
  7929. <![CDATA[<p>
  7930. Set application-specific binary <em>service data</em>. This is a map keyed
  7931. by the name of each {@link AuxiliaryService} that is configured on a
  7932. NodeManager and value correspond to the application specific data targeted
  7933. for the keyed {@link AuxiliaryService}. All pre-existing Map entries are
  7934. preserved.
  7935. </p>
  7936. @param serviceData
  7937. application-specific binary <em>service data</em>]]>
  7938. </doc>
  7939. </method>
  7940. <method name="getEnvironment" return="java.util.Map"
  7941. abstract="true" native="false" synchronized="false"
  7942. static="false" final="false" visibility="public"
  7943. deprecated="not deprecated">
  7944. <doc>
  7945. <![CDATA[Get <em>environment variables</em> for the container.
  7946. @return <em>environment variables</em> for the container]]>
  7947. </doc>
  7948. </method>
  7949. <method name="setEnvironment"
  7950. abstract="true" native="false" synchronized="false"
  7951. static="false" final="false" visibility="public"
  7952. deprecated="not deprecated">
  7953. <param name="environment" type="java.util.Map"/>
  7954. <doc>
  7955. <![CDATA[Add <em>environment variables</em> for the container. All pre-existing Map
  7956. entries are cleared before adding the new Map
  7957. @param environment <em>environment variables</em> for the container]]>
  7958. </doc>
  7959. </method>
  7960. <method name="getCommands" return="java.util.List"
  7961. abstract="true" native="false" synchronized="false"
  7962. static="false" final="false" visibility="public"
  7963. deprecated="not deprecated">
  7964. <doc>
  7965. <![CDATA[Get the list of <em>commands</em> for launching the container.
  7966. @return the list of <em>commands</em> for launching the container]]>
  7967. </doc>
  7968. </method>
  7969. <method name="setCommands"
  7970. abstract="true" native="false" synchronized="false"
  7971. static="false" final="false" visibility="public"
  7972. deprecated="not deprecated">
  7973. <param name="commands" type="java.util.List"/>
  7974. <doc>
  7975. <![CDATA[Add the list of <em>commands</em> for launching the container. All
  7976. pre-existing List entries are cleared before adding the new List
  7977. @param commands the list of <em>commands</em> for launching the container]]>
  7978. </doc>
  7979. </method>
  7980. <method name="getApplicationACLs" return="java.util.Map"
  7981. abstract="true" native="false" synchronized="false"
  7982. static="false" final="false" visibility="public"
  7983. deprecated="not deprecated">
  7984. <doc>
  7985. <![CDATA[Get the <code>ApplicationACL</code>s for the application.
  7986. @return all the <code>ApplicationACL</code>s]]>
  7987. </doc>
  7988. </method>
  7989. <method name="setApplicationACLs"
  7990. abstract="true" native="false" synchronized="false"
  7991. static="false" final="false" visibility="public"
  7992. deprecated="not deprecated">
  7993. <param name="acls" type="java.util.Map"/>
  7994. <doc>
  7995. <![CDATA[Set the <code>ApplicationACL</code>s for the application. All pre-existing
  7996. Map entries are cleared before adding the new Map
  7997. @param acls <code>ApplicationACL</code>s for the application]]>
  7998. </doc>
  7999. </method>
  8000. <method name="getContainerRetryContext" return="org.apache.hadoop.yarn.api.records.ContainerRetryContext"
  8001. abstract="true" native="false" synchronized="false"
  8002. static="false" final="false" visibility="public"
  8003. deprecated="not deprecated">
  8004. <doc>
  8005. <![CDATA[Get the <code>ContainerRetryContext</code> to relaunch container.
  8006. @return <code>ContainerRetryContext</code> to relaunch container.]]>
  8007. </doc>
  8008. </method>
  8009. <method name="setContainerRetryContext"
  8010. abstract="true" native="false" synchronized="false"
  8011. static="false" final="false" visibility="public"
  8012. deprecated="not deprecated">
  8013. <param name="containerRetryContext" type="org.apache.hadoop.yarn.api.records.ContainerRetryContext"/>
  8014. <doc>
  8015. <![CDATA[Set the <code>ContainerRetryContext</code> to relaunch container.
  8016. @param containerRetryContext <code>ContainerRetryContext</code> to
  8017. relaunch container.]]>
  8018. </doc>
  8019. </method>
  8020. <doc>
  8021. <![CDATA[{@code ContainerLaunchContext} represents all of the information
  8022. needed by the {@code NodeManager} to launch a container.
  8023. <p>
  8024. It includes details such as:
  8025. <ul>
  8026. <li>{@link ContainerId} of the container.</li>
  8027. <li>{@link Resource} allocated to the container.</li>
  8028. <li>User to whom the container is allocated.</li>
  8029. <li>Security tokens (if security is enabled).</li>
  8030. <li>
  8031. {@link LocalResource} necessary for running the container such
  8032. as binaries, jar, shared-objects, side-files etc.
  8033. </li>
  8034. <li>Optional, application-specific binary service data.</li>
  8035. <li>Environment variables for the launched process.</li>
  8036. <li>Command to launch the container.</li>
  8037. <li>Retry strategy when container exits with failure.</li>
  8038. </ul>
  8039. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  8040. </doc>
  8041. </class>
  8042. <!-- end class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
  8043. <!-- start class org.apache.hadoop.yarn.api.records.ContainerReport -->
  8044. <class name="ContainerReport" extends="java.lang.Object"
  8045. abstract="true"
  8046. static="false" final="false" visibility="public"
  8047. deprecated="not deprecated">
  8048. <constructor name="ContainerReport"
  8049. static="false" final="false" visibility="public"
  8050. deprecated="not deprecated">
  8051. </constructor>
  8052. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  8053. abstract="true" native="false" synchronized="false"
  8054. static="false" final="false" visibility="public"
  8055. deprecated="not deprecated">
  8056. <doc>
  8057. <![CDATA[Get the <code>ContainerId</code> of the container.
  8058. @return <code>ContainerId</code> of the container.]]>
  8059. </doc>
  8060. </method>
  8061. <method name="setContainerId"
  8062. abstract="true" native="false" synchronized="false"
  8063. static="false" final="false" visibility="public"
  8064. deprecated="not deprecated">
  8065. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  8066. </method>
  8067. <method name="getAllocatedResource" return="org.apache.hadoop.yarn.api.records.Resource"
  8068. abstract="true" native="false" synchronized="false"
  8069. static="false" final="false" visibility="public"
  8070. deprecated="not deprecated">
  8071. <doc>
  8072. <![CDATA[Get the allocated <code>Resource</code> of the container.
  8073. @return allocated <code>Resource</code> of the container.]]>
  8074. </doc>
  8075. </method>
  8076. <method name="setAllocatedResource"
  8077. abstract="true" native="false" synchronized="false"
  8078. static="false" final="false" visibility="public"
  8079. deprecated="not deprecated">
  8080. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  8081. </method>
  8082. <method name="getAssignedNode" return="org.apache.hadoop.yarn.api.records.NodeId"
  8083. abstract="true" native="false" synchronized="false"
  8084. static="false" final="false" visibility="public"
  8085. deprecated="not deprecated">
  8086. <doc>
  8087. <![CDATA[Get the allocated <code>NodeId</code> where container is running.
  8088. @return allocated <code>NodeId</code> where container is running.]]>
  8089. </doc>
  8090. </method>
  8091. <method name="setAssignedNode"
  8092. abstract="true" native="false" synchronized="false"
  8093. static="false" final="false" visibility="public"
  8094. deprecated="not deprecated">
  8095. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  8096. </method>
  8097. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  8098. abstract="true" native="false" synchronized="false"
  8099. static="false" final="false" visibility="public"
  8100. deprecated="not deprecated">
  8101. <doc>
  8102. <![CDATA[Get the allocated <code>Priority</code> of the container.
  8103. @return allocated <code>Priority</code> of the container.]]>
  8104. </doc>
  8105. </method>
  8106. <method name="setPriority"
  8107. abstract="true" native="false" synchronized="false"
  8108. static="false" final="false" visibility="public"
  8109. deprecated="not deprecated">
  8110. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  8111. </method>
  8112. <method name="getCreationTime" return="long"
  8113. abstract="true" native="false" synchronized="false"
  8114. static="false" final="false" visibility="public"
  8115. deprecated="not deprecated">
  8116. <doc>
  8117. <![CDATA[Get the creation time of the container.
  8118. @return creation time of the container]]>
  8119. </doc>
  8120. </method>
  8121. <method name="setCreationTime"
  8122. abstract="true" native="false" synchronized="false"
  8123. static="false" final="false" visibility="public"
  8124. deprecated="not deprecated">
  8125. <param name="creationTime" type="long"/>
  8126. </method>
  8127. <method name="getFinishTime" return="long"
  8128. abstract="true" native="false" synchronized="false"
  8129. static="false" final="false" visibility="public"
  8130. deprecated="not deprecated">
  8131. <doc>
  8132. <![CDATA[Get the Finish time of the container.
  8133. @return Finish time of the container]]>
  8134. </doc>
  8135. </method>
  8136. <method name="setFinishTime"
  8137. abstract="true" native="false" synchronized="false"
  8138. static="false" final="false" visibility="public"
  8139. deprecated="not deprecated">
  8140. <param name="finishTime" type="long"/>
  8141. </method>
  8142. <method name="getDiagnosticsInfo" return="java.lang.String"
  8143. abstract="true" native="false" synchronized="false"
  8144. static="false" final="false" visibility="public"
  8145. deprecated="not deprecated">
  8146. <doc>
  8147. <![CDATA[Get the DiagnosticsInfo of the container.
  8148. @return DiagnosticsInfo of the container]]>
  8149. </doc>
  8150. </method>
  8151. <method name="setDiagnosticsInfo"
  8152. abstract="true" native="false" synchronized="false"
  8153. static="false" final="false" visibility="public"
  8154. deprecated="not deprecated">
  8155. <param name="diagnosticsInfo" type="java.lang.String"/>
  8156. </method>
  8157. <method name="getLogUrl" return="java.lang.String"
  8158. abstract="true" native="false" synchronized="false"
  8159. static="false" final="false" visibility="public"
  8160. deprecated="not deprecated">
  8161. <doc>
  8162. <![CDATA[Get the LogURL of the container.
  8163. @return LogURL of the container]]>
  8164. </doc>
  8165. </method>
  8166. <method name="setLogUrl"
  8167. abstract="true" native="false" synchronized="false"
  8168. static="false" final="false" visibility="public"
  8169. deprecated="not deprecated">
  8170. <param name="logUrl" type="java.lang.String"/>
  8171. </method>
  8172. <method name="getContainerState" return="org.apache.hadoop.yarn.api.records.ContainerState"
  8173. abstract="true" native="false" synchronized="false"
  8174. static="false" final="false" visibility="public"
  8175. deprecated="not deprecated">
  8176. <doc>
  8177. <![CDATA[Get the final <code>ContainerState</code> of the container.
  8178. @return final <code>ContainerState</code> of the container.]]>
  8179. </doc>
  8180. </method>
  8181. <method name="setContainerState"
  8182. abstract="true" native="false" synchronized="false"
  8183. static="false" final="false" visibility="public"
  8184. deprecated="not deprecated">
  8185. <param name="containerState" type="org.apache.hadoop.yarn.api.records.ContainerState"/>
  8186. </method>
  8187. <method name="getContainerExitStatus" return="int"
  8188. abstract="true" native="false" synchronized="false"
  8189. static="false" final="false" visibility="public"
  8190. deprecated="not deprecated">
  8191. <doc>
  8192. <![CDATA[Get the final <code>exit status</code> of the container.
  8193. @return final <code>exit status</code> of the container.]]>
  8194. </doc>
  8195. </method>
  8196. <method name="setContainerExitStatus"
  8197. abstract="true" native="false" synchronized="false"
  8198. static="false" final="false" visibility="public"
  8199. deprecated="not deprecated">
  8200. <param name="containerExitStatus" type="int"/>
  8201. </method>
  8202. <method name="getNodeHttpAddress" return="java.lang.String"
  8203. abstract="true" native="false" synchronized="false"
  8204. static="false" final="false" visibility="public"
  8205. deprecated="not deprecated">
  8206. <doc>
  8207. <![CDATA[Get the Node Http address of the container
  8208. @return the node http address of the container]]>
  8209. </doc>
  8210. </method>
  8211. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  8212. abstract="true" native="false" synchronized="false"
  8213. static="false" final="false" visibility="public"
  8214. deprecated="not deprecated">
  8215. <doc>
  8216. <![CDATA[Get the execution type of the container.
  8217. @return the execution type of the container]]>
  8218. </doc>
  8219. </method>
  8220. <doc>
  8221. <![CDATA[{@code ContainerReport} is a report of an container.
  8222. <p>
  8223. It includes details such as:
  8224. <ul>
  8225. <li>{@link ContainerId} of the container.</li>
  8226. <li>Allocated Resources to the container.</li>
  8227. <li>Assigned Node id.</li>
  8228. <li>Assigned Priority.</li>
  8229. <li>Creation Time.</li>
  8230. <li>Finish Time.</li>
  8231. <li>Container Exit Status.</li>
  8232. <li>{@link ContainerState} of the container.</li>
  8233. <li>Diagnostic information in case of errors.</li>
  8234. <li>Log URL.</li>
  8235. <li>nodeHttpAddress</li>
  8236. </ul>]]>
  8237. </doc>
  8238. </class>
  8239. <!-- end class org.apache.hadoop.yarn.api.records.ContainerReport -->
  8240. <!-- start class org.apache.hadoop.yarn.api.records.ContainerRetryContext -->
  8241. <class name="ContainerRetryContext" extends="java.lang.Object"
  8242. abstract="true"
  8243. static="false" final="false" visibility="public"
  8244. deprecated="not deprecated">
  8245. <constructor name="ContainerRetryContext"
  8246. static="false" final="false" visibility="public"
  8247. deprecated="not deprecated">
  8248. </constructor>
  8249. <method name="getRetryPolicy" return="org.apache.hadoop.yarn.api.records.ContainerRetryPolicy"
  8250. abstract="true" native="false" synchronized="false"
  8251. static="false" final="false" visibility="public"
  8252. deprecated="not deprecated">
  8253. </method>
  8254. <method name="setRetryPolicy"
  8255. abstract="true" native="false" synchronized="false"
  8256. static="false" final="false" visibility="public"
  8257. deprecated="not deprecated">
  8258. <param name="retryPolicy" type="org.apache.hadoop.yarn.api.records.ContainerRetryPolicy"/>
  8259. </method>
  8260. <method name="getErrorCodes" return="java.util.Set"
  8261. abstract="true" native="false" synchronized="false"
  8262. static="false" final="false" visibility="public"
  8263. deprecated="not deprecated">
  8264. </method>
  8265. <method name="setErrorCodes"
  8266. abstract="true" native="false" synchronized="false"
  8267. static="false" final="false" visibility="public"
  8268. deprecated="not deprecated">
  8269. <param name="errorCodes" type="java.util.Set"/>
  8270. </method>
  8271. <method name="getMaxRetries" return="int"
  8272. abstract="true" native="false" synchronized="false"
  8273. static="false" final="false" visibility="public"
  8274. deprecated="not deprecated">
  8275. </method>
  8276. <method name="setMaxRetries"
  8277. abstract="true" native="false" synchronized="false"
  8278. static="false" final="false" visibility="public"
  8279. deprecated="not deprecated">
  8280. <param name="maxRetries" type="int"/>
  8281. </method>
  8282. <method name="getRetryInterval" return="int"
  8283. abstract="true" native="false" synchronized="false"
  8284. static="false" final="false" visibility="public"
  8285. deprecated="not deprecated">
  8286. </method>
  8287. <method name="setRetryInterval"
  8288. abstract="true" native="false" synchronized="false"
  8289. static="false" final="false" visibility="public"
  8290. deprecated="not deprecated">
  8291. <param name="retryInterval" type="int"/>
  8292. </method>
  8293. <method name="getFailuresValidityInterval" return="long"
  8294. abstract="true" native="false" synchronized="false"
  8295. static="false" final="false" visibility="public"
  8296. deprecated="not deprecated">
  8297. </method>
  8298. <method name="setFailuresValidityInterval"
  8299. abstract="true" native="false" synchronized="false"
  8300. static="false" final="false" visibility="public"
  8301. deprecated="not deprecated">
  8302. <param name="failuresValidityInterval" type="long"/>
  8303. </method>
  8304. <field name="RETRY_FOREVER" type="int"
  8305. transient="false" volatile="false"
  8306. static="true" final="true" visibility="public"
  8307. deprecated="not deprecated">
  8308. </field>
  8309. <field name="RETRY_INVALID" type="int"
  8310. transient="false" volatile="false"
  8311. static="true" final="true" visibility="public"
  8312. deprecated="not deprecated">
  8313. </field>
  8314. <field name="NEVER_RETRY_CONTEXT" type="org.apache.hadoop.yarn.api.records.ContainerRetryContext"
  8315. transient="false" volatile="false"
  8316. static="true" final="true" visibility="public"
  8317. deprecated="not deprecated">
  8318. </field>
  8319. <doc>
  8320. <![CDATA[{@code ContainerRetryContext} indicates how container retry after it fails
  8321. to run.
  8322. <p>
  8323. It provides details such as:
  8324. <ul>
  8325. <li>
  8326. {@link ContainerRetryPolicy} :
  8327. - NEVER_RETRY(DEFAULT value): no matter what error code is when container
  8328. fails to run, just do not retry.
  8329. - RETRY_ON_ALL_ERRORS: no matter what error code is, when container fails
  8330. to run, just retry.
  8331. - RETRY_ON_SPECIFIC_ERROR_CODES: when container fails to run, do retry if
  8332. the error code is one of <em>errorCodes</em>, otherwise do not retry.
  8333. Note: if error code is 137(SIGKILL) or 143(SIGTERM), it will not retry
  8334. because it is usually killed on purpose.
  8335. </li>
  8336. <li>
  8337. <em>maxRetries</em> specifies how many times to retry if need to retry.
  8338. If the value is -1, it means retry forever.
  8339. </li>
  8340. <li><em>retryInterval</em> specifies delaying some time before relaunch
  8341. container, the unit is millisecond.</li>
  8342. <li>
  8343. <em>failuresValidityInterval</em>: default value is -1.
  8344. When failuresValidityInterval in milliseconds is set to {@literal >} 0,
  8345. the failure number will not take failures which happen out of the
  8346. failuresValidityInterval into failure count. If failure count
  8347. reaches to <em>maxRetries</em>, the container will be failed.
  8348. </li>
  8349. </ul>]]>
  8350. </doc>
  8351. </class>
  8352. <!-- end class org.apache.hadoop.yarn.api.records.ContainerRetryContext -->
  8353. <!-- start class org.apache.hadoop.yarn.api.records.ContainerRetryPolicy -->
  8354. <class name="ContainerRetryPolicy" extends="java.lang.Enum"
  8355. abstract="false"
  8356. static="false" final="true" visibility="public"
  8357. deprecated="not deprecated">
  8358. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerRetryPolicy[]"
  8359. abstract="false" native="false" synchronized="false"
  8360. static="true" final="false" visibility="public"
  8361. deprecated="not deprecated">
  8362. </method>
  8363. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerRetryPolicy"
  8364. abstract="false" native="false" synchronized="false"
  8365. static="true" final="false" visibility="public"
  8366. deprecated="not deprecated">
  8367. <param name="name" type="java.lang.String"/>
  8368. </method>
  8369. <doc>
  8370. <![CDATA[<p>Retry policy for relaunching a <code>Container</code>.</p>]]>
  8371. </doc>
  8372. </class>
  8373. <!-- end class org.apache.hadoop.yarn.api.records.ContainerRetryPolicy -->
  8374. <!-- start class org.apache.hadoop.yarn.api.records.ContainerState -->
  8375. <class name="ContainerState" extends="java.lang.Enum"
  8376. abstract="false"
  8377. static="false" final="true" visibility="public"
  8378. deprecated="not deprecated">
  8379. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerState[]"
  8380. abstract="false" native="false" synchronized="false"
  8381. static="true" final="false" visibility="public"
  8382. deprecated="not deprecated">
  8383. </method>
  8384. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerState"
  8385. abstract="false" native="false" synchronized="false"
  8386. static="true" final="false" visibility="public"
  8387. deprecated="not deprecated">
  8388. <param name="name" type="java.lang.String"/>
  8389. </method>
  8390. <doc>
  8391. <![CDATA[<p>State of a <code>Container</code>.</p>]]>
  8392. </doc>
  8393. </class>
  8394. <!-- end class org.apache.hadoop.yarn.api.records.ContainerState -->
  8395. <!-- start class org.apache.hadoop.yarn.api.records.ContainerStatus -->
  8396. <class name="ContainerStatus" extends="java.lang.Object"
  8397. abstract="true"
  8398. static="false" final="false" visibility="public"
  8399. deprecated="not deprecated">
  8400. <constructor name="ContainerStatus"
  8401. static="false" final="false" visibility="public"
  8402. deprecated="not deprecated">
  8403. </constructor>
  8404. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  8405. abstract="true" native="false" synchronized="false"
  8406. static="false" final="false" visibility="public"
  8407. deprecated="not deprecated">
  8408. <doc>
  8409. <![CDATA[Get the <code>ContainerId</code> of the container.
  8410. @return <code>ContainerId</code> of the container]]>
  8411. </doc>
  8412. </method>
  8413. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  8414. abstract="false" native="false" synchronized="false"
  8415. static="false" final="false" visibility="public"
  8416. deprecated="not deprecated">
  8417. <doc>
  8418. <![CDATA[Get the <code>ExecutionType</code> of the container.
  8419. @return <code>ExecutionType</code> of the container]]>
  8420. </doc>
  8421. </method>
  8422. <method name="getState" return="org.apache.hadoop.yarn.api.records.ContainerState"
  8423. abstract="true" native="false" synchronized="false"
  8424. static="false" final="false" visibility="public"
  8425. deprecated="not deprecated">
  8426. <doc>
  8427. <![CDATA[Get the <code>ContainerState</code> of the container.
  8428. @return <code>ContainerState</code> of the container]]>
  8429. </doc>
  8430. </method>
  8431. <method name="getExitStatus" return="int"
  8432. abstract="true" native="false" synchronized="false"
  8433. static="false" final="false" visibility="public"
  8434. deprecated="not deprecated">
  8435. <doc>
  8436. <![CDATA[<p>Get the <em>exit status</em> for the container.</p>
  8437. <p>Note: This is valid only for completed containers i.e. containers
  8438. with state {@link ContainerState#COMPLETE}.
  8439. Otherwise, it returns an ContainerExitStatus.INVALID.
  8440. </p>
  8441. <p>Containers killed by the framework, either due to being released by
  8442. the application or being 'lost' due to node failures etc. have a special
  8443. exit code of ContainerExitStatus.ABORTED.</p>
  8444. <p>When threshold number of the nodemanager-local-directories or
  8445. threshold number of the nodemanager-log-directories become bad, then
  8446. container is not launched and is exited with ContainersExitStatus.DISKS_FAILED.
  8447. </p>
  8448. @return <em>exit status</em> for the container]]>
  8449. </doc>
  8450. </method>
  8451. <method name="getDiagnostics" return="java.lang.String"
  8452. abstract="true" native="false" synchronized="false"
  8453. static="false" final="false" visibility="public"
  8454. deprecated="not deprecated">
  8455. <doc>
  8456. <![CDATA[Get <em>diagnostic messages</em> for failed containers.
  8457. @return <em>diagnostic messages</em> for failed containers]]>
  8458. </doc>
  8459. </method>
  8460. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  8461. abstract="false" native="false" synchronized="false"
  8462. static="false" final="false" visibility="public"
  8463. deprecated="not deprecated">
  8464. <doc>
  8465. <![CDATA[Get the <code>Resource</code> allocated to the container.
  8466. @return <code>Resource</code> allocated to the container]]>
  8467. </doc>
  8468. </method>
  8469. <method name="getIPs" return="java.util.List"
  8470. abstract="false" native="false" synchronized="false"
  8471. static="false" final="false" visibility="public"
  8472. deprecated="not deprecated">
  8473. <doc>
  8474. <![CDATA[Get all the IP addresses with which the container run.
  8475. @return The IP address where the container runs.]]>
  8476. </doc>
  8477. </method>
  8478. <method name="getHost" return="java.lang.String"
  8479. abstract="false" native="false" synchronized="false"
  8480. static="false" final="false" visibility="public"
  8481. deprecated="not deprecated">
  8482. <doc>
  8483. <![CDATA[Get the hostname where the container runs.
  8484. @return The hostname where the container runs.]]>
  8485. </doc>
  8486. </method>
  8487. <doc>
  8488. <![CDATA[{@code ContainerStatus} represents the current status of a
  8489. {@code Container}.
  8490. <p>
  8491. It provides details such as:
  8492. <ul>
  8493. <li>{@code ContainerId} of the container.</li>
  8494. <li>{@code ExecutionType} of the container.</li>
  8495. <li>{@code ContainerState} of the container.</li>
  8496. <li><em>Exit status</em> of a completed container.</li>
  8497. <li><em>Diagnostic</em> message for a failed container.</li>
  8498. <li>{@link Resource} allocated to the container.</li>
  8499. </ul>]]>
  8500. </doc>
  8501. </class>
  8502. <!-- end class org.apache.hadoop.yarn.api.records.ContainerStatus -->
  8503. <!-- start class org.apache.hadoop.yarn.api.records.ContainerSubState -->
  8504. <class name="ContainerSubState" extends="java.lang.Enum"
  8505. abstract="false"
  8506. static="false" final="true" visibility="public"
  8507. deprecated="not deprecated">
  8508. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerSubState[]"
  8509. abstract="false" native="false" synchronized="false"
  8510. static="true" final="false" visibility="public"
  8511. deprecated="not deprecated">
  8512. </method>
  8513. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerSubState"
  8514. abstract="false" native="false" synchronized="false"
  8515. static="true" final="false" visibility="public"
  8516. deprecated="not deprecated">
  8517. <param name="name" type="java.lang.String"/>
  8518. </method>
  8519. <doc>
  8520. <![CDATA[Container Sub-State.]]>
  8521. </doc>
  8522. </class>
  8523. <!-- end class org.apache.hadoop.yarn.api.records.ContainerSubState -->
  8524. <!-- start class org.apache.hadoop.yarn.api.records.ContainerUpdateType -->
  8525. <class name="ContainerUpdateType" extends="java.lang.Enum"
  8526. abstract="false"
  8527. static="false" final="true" visibility="public"
  8528. deprecated="not deprecated">
  8529. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType[]"
  8530. abstract="false" native="false" synchronized="false"
  8531. static="true" final="false" visibility="public"
  8532. deprecated="not deprecated">
  8533. </method>
  8534. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType"
  8535. abstract="false" native="false" synchronized="false"
  8536. static="true" final="false" visibility="public"
  8537. deprecated="not deprecated">
  8538. <param name="name" type="java.lang.String"/>
  8539. </method>
  8540. <doc>
  8541. <![CDATA[Encodes the type of Container Update.]]>
  8542. </doc>
  8543. </class>
  8544. <!-- end class org.apache.hadoop.yarn.api.records.ContainerUpdateType -->
  8545. <!-- start class org.apache.hadoop.yarn.api.records.ExecutionType -->
  8546. <class name="ExecutionType" extends="java.lang.Enum"
  8547. abstract="false"
  8548. static="false" final="true" visibility="public"
  8549. deprecated="not deprecated">
  8550. <method name="values" return="org.apache.hadoop.yarn.api.records.ExecutionType[]"
  8551. abstract="false" native="false" synchronized="false"
  8552. static="true" final="false" visibility="public"
  8553. deprecated="not deprecated">
  8554. </method>
  8555. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  8556. abstract="false" native="false" synchronized="false"
  8557. static="true" final="false" visibility="public"
  8558. deprecated="not deprecated">
  8559. <param name="name" type="java.lang.String"/>
  8560. </method>
  8561. <doc>
  8562. <![CDATA[Container property encoding execution semantics.
  8563. <p>
  8564. The execution types are the following:
  8565. <ul>
  8566. <li>{@link #GUARANTEED} - this container is guaranteed to start its
  8567. execution, once the corresponding start container request is received by
  8568. an NM.
  8569. <li>{@link #OPPORTUNISTIC} - the execution of this container may not start
  8570. immediately at the NM that receives the corresponding start container
  8571. request (depending on the NM's available resources). Moreover, it may be
  8572. preempted if it blocks a GUARANTEED container from being executed.
  8573. </ul>]]>
  8574. </doc>
  8575. </class>
  8576. <!-- end class org.apache.hadoop.yarn.api.records.ExecutionType -->
  8577. <!-- start class org.apache.hadoop.yarn.api.records.ExecutionTypeRequest -->
  8578. <class name="ExecutionTypeRequest" extends="java.lang.Object"
  8579. abstract="true"
  8580. static="false" final="false" visibility="public"
  8581. deprecated="not deprecated">
  8582. <implements name="java.lang.Comparable"/>
  8583. <constructor name="ExecutionTypeRequest"
  8584. static="false" final="false" visibility="public"
  8585. deprecated="not deprecated">
  8586. </constructor>
  8587. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
  8588. abstract="false" native="false" synchronized="false"
  8589. static="true" final="false" visibility="public"
  8590. deprecated="not deprecated">
  8591. </method>
  8592. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
  8593. abstract="false" native="false" synchronized="false"
  8594. static="true" final="false" visibility="public"
  8595. deprecated="not deprecated">
  8596. <param name="execType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  8597. </method>
  8598. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
  8599. abstract="false" native="false" synchronized="false"
  8600. static="true" final="false" visibility="public"
  8601. deprecated="not deprecated">
  8602. <param name="execType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  8603. <param name="ensureExecutionType" type="boolean"/>
  8604. </method>
  8605. <method name="setExecutionType"
  8606. abstract="true" native="false" synchronized="false"
  8607. static="false" final="false" visibility="public"
  8608. deprecated="not deprecated">
  8609. <param name="execType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  8610. <doc>
  8611. <![CDATA[Set the <code>ExecutionType</code> of the requested container.
  8612. @param execType
  8613. ExecutionType of the requested container]]>
  8614. </doc>
  8615. </method>
  8616. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  8617. abstract="true" native="false" synchronized="false"
  8618. static="false" final="false" visibility="public"
  8619. deprecated="not deprecated">
  8620. <doc>
  8621. <![CDATA[Get <code>ExecutionType</code>.
  8622. @return <code>ExecutionType</code>.]]>
  8623. </doc>
  8624. </method>
  8625. <method name="setEnforceExecutionType"
  8626. abstract="true" native="false" synchronized="false"
  8627. static="false" final="false" visibility="public"
  8628. deprecated="not deprecated">
  8629. <param name="enforceExecutionType" type="boolean"/>
  8630. <doc>
  8631. <![CDATA[Set to true to explicitly ask that the Scheduling Authority return
  8632. Containers of exactly the Execution Type requested.
  8633. @param enforceExecutionType whether ExecutionType request should be
  8634. strictly honored.]]>
  8635. </doc>
  8636. </method>
  8637. <method name="getEnforceExecutionType" return="boolean"
  8638. abstract="true" native="false" synchronized="false"
  8639. static="false" final="false" visibility="public"
  8640. deprecated="not deprecated">
  8641. <doc>
  8642. <![CDATA[Get whether Scheduling Authority should return Containers of exactly the
  8643. Execution Type requested for this <code>ResourceRequest</code>.
  8644. Defaults to false.
  8645. @return whether ExecutionType request should be strictly honored]]>
  8646. </doc>
  8647. </method>
  8648. <method name="hashCode" return="int"
  8649. abstract="false" native="false" synchronized="false"
  8650. static="false" final="false" visibility="public"
  8651. deprecated="not deprecated">
  8652. </method>
  8653. <method name="equals" return="boolean"
  8654. abstract="false" native="false" synchronized="false"
  8655. static="false" final="false" visibility="public"
  8656. deprecated="not deprecated">
  8657. <param name="obj" type="java.lang.Object"/>
  8658. </method>
  8659. <doc>
  8660. <![CDATA[An object of this class represents a specification of the execution
  8661. guarantee of the Containers associated with a ResourceRequest. It consists
  8662. of an <code>ExecutionType</code> as well as flag that explicitly asks the
  8663. configuredScheduler to return Containers of exactly the Execution Type
  8664. requested.]]>
  8665. </doc>
  8666. </class>
  8667. <!-- end class org.apache.hadoop.yarn.api.records.ExecutionTypeRequest -->
  8668. <!-- start class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
  8669. <class name="FinalApplicationStatus" extends="java.lang.Enum"
  8670. abstract="false"
  8671. static="false" final="true" visibility="public"
  8672. deprecated="not deprecated">
  8673. <method name="values" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus[]"
  8674. abstract="false" native="false" synchronized="false"
  8675. static="true" final="false" visibility="public"
  8676. deprecated="not deprecated">
  8677. </method>
  8678. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  8679. abstract="false" native="false" synchronized="false"
  8680. static="true" final="false" visibility="public"
  8681. deprecated="not deprecated">
  8682. <param name="name" type="java.lang.String"/>
  8683. </method>
  8684. <doc>
  8685. <![CDATA[Enumeration of various final states of an <code>Application</code>.]]>
  8686. </doc>
  8687. </class>
  8688. <!-- end class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
  8689. <!-- start class org.apache.hadoop.yarn.api.records.LocalResource -->
  8690. <class name="LocalResource" extends="java.lang.Object"
  8691. abstract="true"
  8692. static="false" final="false" visibility="public"
  8693. deprecated="not deprecated">
  8694. <constructor name="LocalResource"
  8695. static="false" final="false" visibility="public"
  8696. deprecated="not deprecated">
  8697. </constructor>
  8698. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  8699. abstract="false" native="false" synchronized="false"
  8700. static="true" final="false" visibility="public"
  8701. deprecated="not deprecated">
  8702. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  8703. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  8704. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  8705. <param name="size" type="long"/>
  8706. <param name="timestamp" type="long"/>
  8707. <param name="pattern" type="java.lang.String"/>
  8708. </method>
  8709. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  8710. abstract="false" native="false" synchronized="false"
  8711. static="true" final="false" visibility="public"
  8712. deprecated="not deprecated">
  8713. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  8714. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  8715. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  8716. <param name="size" type="long"/>
  8717. <param name="timestamp" type="long"/>
  8718. <param name="pattern" type="java.lang.String"/>
  8719. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  8720. </method>
  8721. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  8722. abstract="false" native="false" synchronized="false"
  8723. static="true" final="false" visibility="public"
  8724. deprecated="not deprecated">
  8725. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  8726. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  8727. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  8728. <param name="size" type="long"/>
  8729. <param name="timestamp" type="long"/>
  8730. </method>
  8731. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  8732. abstract="false" native="false" synchronized="false"
  8733. static="true" final="false" visibility="public"
  8734. deprecated="not deprecated">
  8735. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  8736. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  8737. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  8738. <param name="size" type="long"/>
  8739. <param name="timestamp" type="long"/>
  8740. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  8741. </method>
  8742. <method name="getResource" return="org.apache.hadoop.yarn.api.records.URL"
  8743. abstract="true" native="false" synchronized="false"
  8744. static="false" final="false" visibility="public"
  8745. deprecated="not deprecated">
  8746. <doc>
  8747. <![CDATA[Get the <em>location</em> of the resource to be localized.
  8748. @return <em>location</em> of the resource to be localized]]>
  8749. </doc>
  8750. </method>
  8751. <method name="setResource"
  8752. abstract="true" native="false" synchronized="false"
  8753. static="false" final="false" visibility="public"
  8754. deprecated="not deprecated">
  8755. <param name="resource" type="org.apache.hadoop.yarn.api.records.URL"/>
  8756. <doc>
  8757. <![CDATA[Set <em>location</em> of the resource to be localized.
  8758. @param resource <em>location</em> of the resource to be localized]]>
  8759. </doc>
  8760. </method>
  8761. <method name="getSize" return="long"
  8762. abstract="true" native="false" synchronized="false"
  8763. static="false" final="false" visibility="public"
  8764. deprecated="not deprecated">
  8765. <doc>
  8766. <![CDATA[Get the <em>size</em> of the resource to be localized.
  8767. @return <em>size</em> of the resource to be localized]]>
  8768. </doc>
  8769. </method>
  8770. <method name="setSize"
  8771. abstract="true" native="false" synchronized="false"
  8772. static="false" final="false" visibility="public"
  8773. deprecated="not deprecated">
  8774. <param name="size" type="long"/>
  8775. <doc>
  8776. <![CDATA[Set the <em>size</em> of the resource to be localized.
  8777. @param size <em>size</em> of the resource to be localized]]>
  8778. </doc>
  8779. </method>
  8780. <method name="getTimestamp" return="long"
  8781. abstract="true" native="false" synchronized="false"
  8782. static="false" final="false" visibility="public"
  8783. deprecated="not deprecated">
  8784. <doc>
  8785. <![CDATA[Get the original <em>timestamp</em> of the resource to be localized, used
  8786. for verification.
  8787. @return <em>timestamp</em> of the resource to be localized]]>
  8788. </doc>
  8789. </method>
  8790. <method name="setTimestamp"
  8791. abstract="true" native="false" synchronized="false"
  8792. static="false" final="false" visibility="public"
  8793. deprecated="not deprecated">
  8794. <param name="timestamp" type="long"/>
  8795. <doc>
  8796. <![CDATA[Set the <em>timestamp</em> of the resource to be localized, used
  8797. for verification.
  8798. @param timestamp <em>timestamp</em> of the resource to be localized]]>
  8799. </doc>
  8800. </method>
  8801. <method name="getType" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
  8802. abstract="true" native="false" synchronized="false"
  8803. static="false" final="false" visibility="public"
  8804. deprecated="not deprecated">
  8805. <doc>
  8806. <![CDATA[Get the <code>LocalResourceType</code> of the resource to be localized.
  8807. @return <code>LocalResourceType</code> of the resource to be localized]]>
  8808. </doc>
  8809. </method>
  8810. <method name="setType"
  8811. abstract="true" native="false" synchronized="false"
  8812. static="false" final="false" visibility="public"
  8813. deprecated="not deprecated">
  8814. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  8815. <doc>
  8816. <![CDATA[Set the <code>LocalResourceType</code> of the resource to be localized.
  8817. @param type <code>LocalResourceType</code> of the resource to be localized]]>
  8818. </doc>
  8819. </method>
  8820. <method name="getVisibility" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
  8821. abstract="true" native="false" synchronized="false"
  8822. static="false" final="false" visibility="public"
  8823. deprecated="not deprecated">
  8824. <doc>
  8825. <![CDATA[Get the <code>LocalResourceVisibility</code> of the resource to be
  8826. localized.
  8827. @return <code>LocalResourceVisibility</code> of the resource to be
  8828. localized]]>
  8829. </doc>
  8830. </method>
  8831. <method name="setVisibility"
  8832. abstract="true" native="false" synchronized="false"
  8833. static="false" final="false" visibility="public"
  8834. deprecated="not deprecated">
  8835. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  8836. <doc>
  8837. <![CDATA[Set the <code>LocalResourceVisibility</code> of the resource to be
  8838. localized.
  8839. @param visibility <code>LocalResourceVisibility</code> of the resource to be
  8840. localized]]>
  8841. </doc>
  8842. </method>
  8843. <method name="getPattern" return="java.lang.String"
  8844. abstract="true" native="false" synchronized="false"
  8845. static="false" final="false" visibility="public"
  8846. deprecated="not deprecated">
  8847. <doc>
  8848. <![CDATA[Get the <em>pattern</em> that should be used to extract entries from the
  8849. archive (only used when type is <code>PATTERN</code>).
  8850. @return <em>pattern</em> that should be used to extract entries from the
  8851. archive.]]>
  8852. </doc>
  8853. </method>
  8854. <method name="setPattern"
  8855. abstract="true" native="false" synchronized="false"
  8856. static="false" final="false" visibility="public"
  8857. deprecated="not deprecated">
  8858. <param name="pattern" type="java.lang.String"/>
  8859. <doc>
  8860. <![CDATA[Set the <em>pattern</em> that should be used to extract entries from the
  8861. archive (only used when type is <code>PATTERN</code>).
  8862. @param pattern <em>pattern</em> that should be used to extract entries
  8863. from the archive.]]>
  8864. </doc>
  8865. </method>
  8866. <method name="getShouldBeUploadedToSharedCache" return="boolean"
  8867. abstract="true" native="false" synchronized="false"
  8868. static="false" final="false" visibility="public"
  8869. deprecated="not deprecated">
  8870. <doc>
  8871. <![CDATA[NM uses it to decide whether if it is necessary to upload the resource to
  8872. the shared cache
  8873. @return true if it is necessary to upload the resource
  8874. to the shared cache,
  8875. false otherwise]]>
  8876. </doc>
  8877. </method>
  8878. <method name="setShouldBeUploadedToSharedCache"
  8879. abstract="true" native="false" synchronized="false"
  8880. static="false" final="false" visibility="public"
  8881. deprecated="not deprecated">
  8882. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  8883. <doc>
  8884. <![CDATA[Inform NM whether upload to SCM is needed.
  8885. @param shouldBeUploadedToSharedCache <em>shouldBeUploadedToSharedCache</em>
  8886. of this request]]>
  8887. </doc>
  8888. </method>
  8889. <doc>
  8890. <![CDATA[<p><code>LocalResource</code> represents a local resource required to
  8891. run a container.</p>
  8892. <p>The <code>NodeManager</code> is responsible for localizing the resource
  8893. prior to launching the container.</p>
  8894. <p>Applications can specify {@link LocalResourceType} and
  8895. {@link LocalResourceVisibility}.</p>
  8896. @see LocalResourceType
  8897. @see LocalResourceVisibility
  8898. @see ContainerLaunchContext
  8899. @see ApplicationSubmissionContext
  8900. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  8901. </doc>
  8902. </class>
  8903. <!-- end class org.apache.hadoop.yarn.api.records.LocalResource -->
  8904. <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceType -->
  8905. <class name="LocalResourceType" extends="java.lang.Enum"
  8906. abstract="false"
  8907. static="false" final="true" visibility="public"
  8908. deprecated="not deprecated">
  8909. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceType[]"
  8910. abstract="false" native="false" synchronized="false"
  8911. static="true" final="false" visibility="public"
  8912. deprecated="not deprecated">
  8913. </method>
  8914. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
  8915. abstract="false" native="false" synchronized="false"
  8916. static="true" final="false" visibility="public"
  8917. deprecated="not deprecated">
  8918. <param name="name" type="java.lang.String"/>
  8919. </method>
  8920. <doc>
  8921. <![CDATA[{@code LocalResourceType} specifies the <em>type</em>
  8922. of a resource localized by the {@code NodeManager}.
  8923. <p>
  8924. The <em>type</em> can be one of:
  8925. <ul>
  8926. <li>
  8927. {@link #FILE} - Regular file i.e. uninterpreted bytes.
  8928. </li>
  8929. <li>
  8930. {@link #ARCHIVE} - Archive, which is automatically unarchived by the
  8931. <code>NodeManager</code>.
  8932. </li>
  8933. <li>
  8934. {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}.
  8935. </li>
  8936. </ul>
  8937. @see LocalResource
  8938. @see ContainerLaunchContext
  8939. @see ApplicationSubmissionContext
  8940. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  8941. </doc>
  8942. </class>
  8943. <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceType -->
  8944. <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
  8945. <class name="LocalResourceVisibility" extends="java.lang.Enum"
  8946. abstract="false"
  8947. static="false" final="true" visibility="public"
  8948. deprecated="not deprecated">
  8949. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility[]"
  8950. abstract="false" native="false" synchronized="false"
  8951. static="true" final="false" visibility="public"
  8952. deprecated="not deprecated">
  8953. </method>
  8954. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
  8955. abstract="false" native="false" synchronized="false"
  8956. static="true" final="false" visibility="public"
  8957. deprecated="not deprecated">
  8958. <param name="name" type="java.lang.String"/>
  8959. </method>
  8960. <doc>
  8961. <![CDATA[{@code LocalResourceVisibility} specifies the <em>visibility</em>
  8962. of a resource localized by the {@code NodeManager}.
  8963. <p>
  8964. The <em>visibility</em> can be one of:
  8965. <ul>
  8966. <li>{@link #PUBLIC} - Shared by all users on the node.</li>
  8967. <li>
  8968. {@link #PRIVATE} - Shared among all applications of the
  8969. <em>same user</em> on the node.
  8970. </li>
  8971. <li>
  8972. {@link #APPLICATION} - Shared only among containers of the
  8973. <em>same application</em> on the node.
  8974. </li>
  8975. </ul>
  8976. @see LocalResource
  8977. @see ContainerLaunchContext
  8978. @see ApplicationSubmissionContext
  8979. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  8980. </doc>
  8981. </class>
  8982. <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
  8983. <!-- start class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
  8984. <class name="LogAggregationContext" extends="java.lang.Object"
  8985. abstract="true"
  8986. static="false" final="false" visibility="public"
  8987. deprecated="not deprecated">
  8988. <constructor name="LogAggregationContext"
  8989. static="false" final="false" visibility="public"
  8990. deprecated="not deprecated">
  8991. </constructor>
  8992. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  8993. abstract="false" native="false" synchronized="false"
  8994. static="true" final="false" visibility="public"
  8995. deprecated="not deprecated">
  8996. <param name="includePattern" type="java.lang.String"/>
  8997. <param name="excludePattern" type="java.lang.String"/>
  8998. </method>
  8999. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  9000. abstract="false" native="false" synchronized="false"
  9001. static="true" final="false" visibility="public"
  9002. deprecated="not deprecated">
  9003. <param name="includePattern" type="java.lang.String"/>
  9004. <param name="excludePattern" type="java.lang.String"/>
  9005. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  9006. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  9007. </method>
  9008. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  9009. abstract="false" native="false" synchronized="false"
  9010. static="true" final="false" visibility="public"
  9011. deprecated="not deprecated">
  9012. <param name="includePattern" type="java.lang.String"/>
  9013. <param name="excludePattern" type="java.lang.String"/>
  9014. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  9015. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  9016. <param name="policyClassName" type="java.lang.String"/>
  9017. <param name="policyParameters" type="java.lang.String"/>
  9018. </method>
  9019. <method name="getIncludePattern" return="java.lang.String"
  9020. abstract="true" native="false" synchronized="false"
  9021. static="false" final="false" visibility="public"
  9022. deprecated="not deprecated">
  9023. <doc>
  9024. <![CDATA[Get include pattern. This includePattern only takes affect
  9025. on logs that exist at the time of application finish.
  9026. @return include pattern]]>
  9027. </doc>
  9028. </method>
  9029. <method name="setIncludePattern"
  9030. abstract="true" native="false" synchronized="false"
  9031. static="false" final="false" visibility="public"
  9032. deprecated="not deprecated">
  9033. <param name="includePattern" type="java.lang.String"/>
  9034. <doc>
  9035. <![CDATA[Set include pattern. This includePattern only takes affect
  9036. on logs that exist at the time of application finish.
  9037. @param includePattern]]>
  9038. </doc>
  9039. </method>
  9040. <method name="getExcludePattern" return="java.lang.String"
  9041. abstract="true" native="false" synchronized="false"
  9042. static="false" final="false" visibility="public"
  9043. deprecated="not deprecated">
  9044. <doc>
  9045. <![CDATA[Get exclude pattern. This excludePattern only takes affect
  9046. on logs that exist at the time of application finish.
  9047. @return exclude pattern]]>
  9048. </doc>
  9049. </method>
  9050. <method name="setExcludePattern"
  9051. abstract="true" native="false" synchronized="false"
  9052. static="false" final="false" visibility="public"
  9053. deprecated="not deprecated">
  9054. <param name="excludePattern" type="java.lang.String"/>
  9055. <doc>
  9056. <![CDATA[Set exclude pattern. This excludePattern only takes affect
  9057. on logs that exist at the time of application finish.
  9058. @param excludePattern]]>
  9059. </doc>
  9060. </method>
  9061. <method name="getRolledLogsIncludePattern" return="java.lang.String"
  9062. abstract="true" native="false" synchronized="false"
  9063. static="false" final="false" visibility="public"
  9064. deprecated="not deprecated">
  9065. <doc>
  9066. <![CDATA[Get include pattern in a rolling fashion.
  9067. @return include pattern]]>
  9068. </doc>
  9069. </method>
  9070. <method name="setRolledLogsIncludePattern"
  9071. abstract="true" native="false" synchronized="false"
  9072. static="false" final="false" visibility="public"
  9073. deprecated="not deprecated">
  9074. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  9075. <doc>
  9076. <![CDATA[Set include pattern in a rolling fashion.
  9077. @param rolledLogsIncludePattern]]>
  9078. </doc>
  9079. </method>
  9080. <method name="getRolledLogsExcludePattern" return="java.lang.String"
  9081. abstract="true" native="false" synchronized="false"
  9082. static="false" final="false" visibility="public"
  9083. deprecated="not deprecated">
  9084. <doc>
  9085. <![CDATA[Get exclude pattern for aggregation in a rolling fashion.
  9086. @return exclude pattern]]>
  9087. </doc>
  9088. </method>
  9089. <method name="setRolledLogsExcludePattern"
  9090. abstract="true" native="false" synchronized="false"
  9091. static="false" final="false" visibility="public"
  9092. deprecated="not deprecated">
  9093. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  9094. <doc>
  9095. <![CDATA[Set exclude pattern for in a rolling fashion.
  9096. @param rolledLogsExcludePattern]]>
  9097. </doc>
  9098. </method>
  9099. <method name="getLogAggregationPolicyClassName" return="java.lang.String"
  9100. abstract="true" native="false" synchronized="false"
  9101. static="false" final="false" visibility="public"
  9102. deprecated="not deprecated">
  9103. <doc>
  9104. <![CDATA[Get the log aggregation policy class.
  9105. @return log aggregation policy class]]>
  9106. </doc>
  9107. </method>
  9108. <method name="setLogAggregationPolicyClassName"
  9109. abstract="true" native="false" synchronized="false"
  9110. static="false" final="false" visibility="public"
  9111. deprecated="not deprecated">
  9112. <param name="className" type="java.lang.String"/>
  9113. <doc>
  9114. <![CDATA[Set the log aggregation policy class.
  9115. @param className]]>
  9116. </doc>
  9117. </method>
  9118. <method name="getLogAggregationPolicyParameters" return="java.lang.String"
  9119. abstract="true" native="false" synchronized="false"
  9120. static="false" final="false" visibility="public"
  9121. deprecated="not deprecated">
  9122. <doc>
  9123. <![CDATA[Get the log aggregation policy parameters.
  9124. @return log aggregation policy parameters]]>
  9125. </doc>
  9126. </method>
  9127. <method name="setLogAggregationPolicyParameters"
  9128. abstract="true" native="false" synchronized="false"
  9129. static="false" final="false" visibility="public"
  9130. deprecated="not deprecated">
  9131. <param name="parameters" type="java.lang.String"/>
  9132. <doc>
  9133. <![CDATA[Set the log aggregation policy parameters.
  9134. There is no schema defined for the parameters string.
  9135. It is up to the log aggregation policy class to decide how to parse
  9136. the parameters string.
  9137. @param parameters]]>
  9138. </doc>
  9139. </method>
  9140. <doc>
  9141. <![CDATA[{@code LogAggregationContext} represents all of the
  9142. information needed by the {@code NodeManager} to handle
  9143. the logs for an application.
  9144. <p>
  9145. It includes details such as:
  9146. <ul>
  9147. <li>
  9148. includePattern. It uses Java Regex to filter the log files
  9149. which match the defined include pattern and those log files
  9150. will be uploaded when the application finishes.
  9151. </li>
  9152. <li>
  9153. excludePattern. It uses Java Regex to filter the log files
  9154. which match the defined exclude pattern and those log files
  9155. will not be uploaded when application finishes. If the log file
  9156. name matches both the include and the exclude pattern, this file
  9157. will be excluded eventually.
  9158. </li>
  9159. <li>
  9160. rolledLogsIncludePattern. It uses Java Regex to filter the log files
  9161. which match the defined include pattern and those log files
  9162. will be aggregated in a rolling fashion.
  9163. </li>
  9164. <li>
  9165. rolledLogsExcludePattern. It uses Java Regex to filter the log files
  9166. which match the defined exclude pattern and those log files
  9167. will not be aggregated in a rolling fashion. If the log file
  9168. name matches both the include and the exclude pattern, this file
  9169. will be excluded eventually.
  9170. </li>
  9171. <li>
  9172. policyClassName. The policy class name that implements
  9173. ContainerLogAggregationPolicy. At runtime, nodemanager will the policy
  9174. if a given container's log should be aggregated based on the
  9175. ContainerType and other runtime state such as exit code by calling
  9176. ContainerLogAggregationPolicy#shouldDoLogAggregation.
  9177. This is useful when the app only wants to aggregate logs of a subset of
  9178. containers. Here are the available policies. Please make sure to specify
  9179. the canonical name by prefixing org.apache.hadoop.yarn.server.
  9180. nodemanager.containermanager.logaggregation.
  9181. to the class simple name below.
  9182. NoneContainerLogAggregationPolicy: skip aggregation for all containers.
  9183. AllContainerLogAggregationPolicy: aggregate all containers.
  9184. AMOrFailedContainerLogAggregationPolicy: aggregate application master
  9185. or failed containers.
  9186. FailedOrKilledContainerLogAggregationPolicy: aggregate failed or killed
  9187. containers
  9188. FailedContainerLogAggregationPolicy: aggregate failed containers
  9189. AMOnlyLogAggregationPolicy: aggregate application master containers
  9190. SampleContainerLogAggregationPolicy: sample logs of successful worker
  9191. containers, in addition to application master and failed/killed
  9192. containers.
  9193. If it isn't specified, it will use the cluster-wide default policy
  9194. defined by configuration yarn.nodemanager.log-aggregation.policy.class.
  9195. The default value of yarn.nodemanager.log-aggregation.policy.class is
  9196. AllContainerLogAggregationPolicy.
  9197. </li>
  9198. <li>
  9199. policyParameters. The parameters passed to the policy class via
  9200. ContainerLogAggregationPolicy#parseParameters during the policy object
  9201. initialization. This is optional. Some policy class might use parameters
  9202. to adjust its settings. It is up to policy class to define the scheme of
  9203. parameters.
  9204. For example, SampleContainerLogAggregationPolicy supports the format of
  9205. "SR:0.5,MIN:50", which means sample rate of 50% beyond the first 50
  9206. successful worker containers.
  9207. </li>
  9208. </ul>
  9209. @see ApplicationSubmissionContext]]>
  9210. </doc>
  9211. </class>
  9212. <!-- end class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
  9213. <!-- start class org.apache.hadoop.yarn.api.records.NMToken -->
  9214. <class name="NMToken" extends="java.lang.Object"
  9215. abstract="true"
  9216. static="false" final="false" visibility="public"
  9217. deprecated="not deprecated">
  9218. <constructor name="NMToken"
  9219. static="false" final="false" visibility="public"
  9220. deprecated="not deprecated">
  9221. </constructor>
  9222. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  9223. abstract="true" native="false" synchronized="false"
  9224. static="false" final="false" visibility="public"
  9225. deprecated="not deprecated">
  9226. <doc>
  9227. <![CDATA[Get the {@link NodeId} of the <code>NodeManager</code> for which the NMToken
  9228. is used to authenticate.
  9229. @return the {@link NodeId} of the <code>NodeManager</code> for which the
  9230. NMToken is used to authenticate.]]>
  9231. </doc>
  9232. </method>
  9233. <method name="setNodeId"
  9234. abstract="true" native="false" synchronized="false"
  9235. static="false" final="false" visibility="public"
  9236. deprecated="not deprecated">
  9237. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  9238. </method>
  9239. <method name="getToken" return="org.apache.hadoop.yarn.api.records.Token"
  9240. abstract="true" native="false" synchronized="false"
  9241. static="false" final="false" visibility="public"
  9242. deprecated="not deprecated">
  9243. <doc>
  9244. <![CDATA[Get the {@link Token} used for authenticating with <code>NodeManager</code>
  9245. @return the {@link Token} used for authenticating with <code>NodeManager</code>]]>
  9246. </doc>
  9247. </method>
  9248. <method name="setToken"
  9249. abstract="true" native="false" synchronized="false"
  9250. static="false" final="false" visibility="public"
  9251. deprecated="not deprecated">
  9252. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  9253. </method>
  9254. <method name="hashCode" return="int"
  9255. abstract="false" native="false" synchronized="false"
  9256. static="false" final="false" visibility="public"
  9257. deprecated="not deprecated">
  9258. </method>
  9259. <method name="equals" return="boolean"
  9260. abstract="false" native="false" synchronized="false"
  9261. static="false" final="false" visibility="public"
  9262. deprecated="not deprecated">
  9263. <param name="obj" type="java.lang.Object"/>
  9264. </method>
  9265. <doc>
  9266. <![CDATA[<p>The NMToken is used for authenticating communication with
  9267. <code>NodeManager</code></p>
  9268. <p>It is issued by <code>ResourceMananger</code> when <code>ApplicationMaster</code>
  9269. negotiates resource with <code>ResourceManager</code> and
  9270. validated on <code>NodeManager</code> side.</p>
  9271. @see AllocateResponse#getNMTokens()]]>
  9272. </doc>
  9273. </class>
  9274. <!-- end class org.apache.hadoop.yarn.api.records.NMToken -->
  9275. <!-- start class org.apache.hadoop.yarn.api.records.NodeAttribute -->
  9276. <class name="NodeAttribute" extends="java.lang.Object"
  9277. abstract="true"
  9278. static="false" final="false" visibility="public"
  9279. deprecated="not deprecated">
  9280. <constructor name="NodeAttribute"
  9281. static="false" final="false" visibility="public"
  9282. deprecated="not deprecated">
  9283. </constructor>
  9284. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttribute"
  9285. abstract="false" native="false" synchronized="false"
  9286. static="true" final="false" visibility="public"
  9287. deprecated="not deprecated">
  9288. <param name="attributeName" type="java.lang.String"/>
  9289. <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
  9290. <param name="attributeValue" type="java.lang.String"/>
  9291. </method>
  9292. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttribute"
  9293. abstract="false" native="false" synchronized="false"
  9294. static="true" final="false" visibility="public"
  9295. deprecated="not deprecated">
  9296. <param name="attributePrefix" type="java.lang.String"/>
  9297. <param name="attributeName" type="java.lang.String"/>
  9298. <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
  9299. <param name="attributeValue" type="java.lang.String"/>
  9300. </method>
  9301. <method name="getAttributeKey" return="org.apache.hadoop.yarn.api.records.NodeAttributeKey"
  9302. abstract="true" native="false" synchronized="false"
  9303. static="false" final="false" visibility="public"
  9304. deprecated="not deprecated">
  9305. </method>
  9306. <method name="setAttributeKey"
  9307. abstract="true" native="false" synchronized="false"
  9308. static="false" final="false" visibility="public"
  9309. deprecated="not deprecated">
  9310. <param name="attributeKey" type="org.apache.hadoop.yarn.api.records.NodeAttributeKey"/>
  9311. </method>
  9312. <method name="getAttributeValue" return="java.lang.String"
  9313. abstract="true" native="false" synchronized="false"
  9314. static="false" final="false" visibility="public"
  9315. deprecated="not deprecated">
  9316. </method>
  9317. <method name="setAttributeValue"
  9318. abstract="true" native="false" synchronized="false"
  9319. static="false" final="false" visibility="public"
  9320. deprecated="not deprecated">
  9321. <param name="attributeValue" type="java.lang.String"/>
  9322. </method>
  9323. <method name="getAttributeType" return="org.apache.hadoop.yarn.api.records.NodeAttributeType"
  9324. abstract="true" native="false" synchronized="false"
  9325. static="false" final="false" visibility="public"
  9326. deprecated="not deprecated">
  9327. </method>
  9328. <method name="setAttributeType"
  9329. abstract="true" native="false" synchronized="false"
  9330. static="false" final="false" visibility="public"
  9331. deprecated="not deprecated">
  9332. <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
  9333. </method>
  9334. <field name="PREFIX_DISTRIBUTED" type="java.lang.String"
  9335. transient="false" volatile="false"
  9336. static="true" final="true" visibility="public"
  9337. deprecated="not deprecated">
  9338. </field>
  9339. <field name="PREFIX_CENTRALIZED" type="java.lang.String"
  9340. transient="false" volatile="false"
  9341. static="true" final="true" visibility="public"
  9342. deprecated="not deprecated">
  9343. </field>
  9344. <doc>
  9345. <![CDATA[<p>
  9346. Node Attribute is a kind of a label which represents one of the
  9347. attribute/feature of a Node. Its different from node partition label as
  9348. resource guarantees across the queues will not be maintained for these type
  9349. of labels.
  9350. </p>
  9351. <p>
  9352. A given Node can be mapped with any kind of attribute, few examples are
  9353. HAS_SSD=true, JAVA_VERSION=JDK1.8, OS_TYPE=WINDOWS.
  9354. </p>
  9355. <p>
  9356. Its not compulsory for all the attributes to have value, empty string is the
  9357. default value of the <code>NodeAttributeType.STRING</code>
  9358. </p>
  9359. <p>
  9360. Node Attribute Prefix is used as namespace to segregate the attributes.
  9361. </p>]]>
  9362. </doc>
  9363. </class>
  9364. <!-- end class org.apache.hadoop.yarn.api.records.NodeAttribute -->
  9365. <!-- start class org.apache.hadoop.yarn.api.records.NodeAttributeInfo -->
  9366. <class name="NodeAttributeInfo" extends="java.lang.Object"
  9367. abstract="true"
  9368. static="false" final="false" visibility="public"
  9369. deprecated="not deprecated">
  9370. <constructor name="NodeAttributeInfo"
  9371. static="false" final="false" visibility="public"
  9372. deprecated="not deprecated">
  9373. </constructor>
  9374. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttributeInfo"
  9375. abstract="false" native="false" synchronized="false"
  9376. static="true" final="false" visibility="public"
  9377. deprecated="not deprecated">
  9378. <param name="nodeAttribute" type="org.apache.hadoop.yarn.api.records.NodeAttribute"/>
  9379. </method>
  9380. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttributeInfo"
  9381. abstract="false" native="false" synchronized="false"
  9382. static="true" final="false" visibility="public"
  9383. deprecated="not deprecated">
  9384. <param name="nodeAttributeKey" type="org.apache.hadoop.yarn.api.records.NodeAttributeKey"/>
  9385. <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
  9386. </method>
  9387. <method name="getAttributeKey" return="org.apache.hadoop.yarn.api.records.NodeAttributeKey"
  9388. abstract="true" native="false" synchronized="false"
  9389. static="false" final="false" visibility="public"
  9390. deprecated="not deprecated">
  9391. </method>
  9392. <method name="setAttributeKey"
  9393. abstract="true" native="false" synchronized="false"
  9394. static="false" final="false" visibility="public"
  9395. deprecated="not deprecated">
  9396. <param name="attributeKey" type="org.apache.hadoop.yarn.api.records.NodeAttributeKey"/>
  9397. </method>
  9398. <method name="getAttributeType" return="org.apache.hadoop.yarn.api.records.NodeAttributeType"
  9399. abstract="true" native="false" synchronized="false"
  9400. static="false" final="false" visibility="public"
  9401. deprecated="not deprecated">
  9402. </method>
  9403. <method name="setAttributeType"
  9404. abstract="true" native="false" synchronized="false"
  9405. static="false" final="false" visibility="public"
  9406. deprecated="not deprecated">
  9407. <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
  9408. </method>
  9409. <doc>
  9410. <![CDATA[<p>
  9411. Node Attribute Info describes a NodeAttribute.
  9412. </p>]]>
  9413. </doc>
  9414. </class>
  9415. <!-- end class org.apache.hadoop.yarn.api.records.NodeAttributeInfo -->
  9416. <!-- start class org.apache.hadoop.yarn.api.records.NodeAttributeKey -->
  9417. <class name="NodeAttributeKey" extends="java.lang.Object"
  9418. abstract="true"
  9419. static="false" final="false" visibility="public"
  9420. deprecated="not deprecated">
  9421. <constructor name="NodeAttributeKey"
  9422. static="false" final="false" visibility="public"
  9423. deprecated="not deprecated">
  9424. </constructor>
  9425. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttributeKey"
  9426. abstract="false" native="false" synchronized="false"
  9427. static="true" final="false" visibility="public"
  9428. deprecated="not deprecated">
  9429. <param name="attributeName" type="java.lang.String"/>
  9430. </method>
  9431. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttributeKey"
  9432. abstract="false" native="false" synchronized="false"
  9433. static="true" final="false" visibility="public"
  9434. deprecated="not deprecated">
  9435. <param name="attributePrefix" type="java.lang.String"/>
  9436. <param name="attributeName" type="java.lang.String"/>
  9437. </method>
  9438. <method name="getAttributePrefix" return="java.lang.String"
  9439. abstract="true" native="false" synchronized="false"
  9440. static="false" final="false" visibility="public"
  9441. deprecated="not deprecated">
  9442. </method>
  9443. <method name="setAttributePrefix"
  9444. abstract="true" native="false" synchronized="false"
  9445. static="false" final="false" visibility="public"
  9446. deprecated="not deprecated">
  9447. <param name="attributePrefix" type="java.lang.String"/>
  9448. </method>
  9449. <method name="getAttributeName" return="java.lang.String"
  9450. abstract="true" native="false" synchronized="false"
  9451. static="false" final="false" visibility="public"
  9452. deprecated="not deprecated">
  9453. </method>
  9454. <method name="setAttributeName"
  9455. abstract="true" native="false" synchronized="false"
  9456. static="false" final="false" visibility="public"
  9457. deprecated="not deprecated">
  9458. <param name="attributeName" type="java.lang.String"/>
  9459. </method>
  9460. <doc>
  9461. <![CDATA[<p>
  9462. Node AttributeKey uniquely identifies a given Node Attribute. Node Attribute
  9463. is identified based on attribute prefix and name.
  9464. </p>
  9465. <p>
  9466. Node Attribute Prefix is used as namespace to segregate the attributes.
  9467. </p>]]>
  9468. </doc>
  9469. </class>
  9470. <!-- end class org.apache.hadoop.yarn.api.records.NodeAttributeKey -->
  9471. <!-- start class org.apache.hadoop.yarn.api.records.NodeAttributeOpCode -->
  9472. <class name="NodeAttributeOpCode" extends="java.lang.Enum"
  9473. abstract="false"
  9474. static="false" final="true" visibility="public"
  9475. deprecated="not deprecated">
  9476. <method name="values" return="org.apache.hadoop.yarn.api.records.NodeAttributeOpCode[]"
  9477. abstract="false" native="false" synchronized="false"
  9478. static="true" final="false" visibility="public"
  9479. deprecated="not deprecated">
  9480. </method>
  9481. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.NodeAttributeOpCode"
  9482. abstract="false" native="false" synchronized="false"
  9483. static="true" final="false" visibility="public"
  9484. deprecated="not deprecated">
  9485. <param name="name" type="java.lang.String"/>
  9486. </method>
  9487. <doc>
  9488. <![CDATA[Enumeration of various node attribute op codes.]]>
  9489. </doc>
  9490. </class>
  9491. <!-- end class org.apache.hadoop.yarn.api.records.NodeAttributeOpCode -->
  9492. <!-- start class org.apache.hadoop.yarn.api.records.NodeAttributeType -->
  9493. <class name="NodeAttributeType" extends="java.lang.Enum"
  9494. abstract="false"
  9495. static="false" final="true" visibility="public"
  9496. deprecated="not deprecated">
  9497. <method name="values" return="org.apache.hadoop.yarn.api.records.NodeAttributeType[]"
  9498. abstract="false" native="false" synchronized="false"
  9499. static="true" final="false" visibility="public"
  9500. deprecated="not deprecated">
  9501. </method>
  9502. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.NodeAttributeType"
  9503. abstract="false" native="false" synchronized="false"
  9504. static="true" final="false" visibility="public"
  9505. deprecated="not deprecated">
  9506. <param name="name" type="java.lang.String"/>
  9507. </method>
  9508. <doc>
  9509. <![CDATA[<p>
  9510. Type of a <code>node Attribute</code>.
  9511. </p>
  9512. Based on this attribute expressions and values will be evaluated.]]>
  9513. </doc>
  9514. </class>
  9515. <!-- end class org.apache.hadoop.yarn.api.records.NodeAttributeType -->
  9516. <!-- start class org.apache.hadoop.yarn.api.records.NodeId -->
  9517. <class name="NodeId" extends="java.lang.Object"
  9518. abstract="true"
  9519. static="false" final="false" visibility="public"
  9520. deprecated="not deprecated">
  9521. <implements name="java.lang.Comparable"/>
  9522. <constructor name="NodeId"
  9523. static="false" final="false" visibility="public"
  9524. deprecated="not deprecated">
  9525. </constructor>
  9526. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeId"
  9527. abstract="false" native="false" synchronized="false"
  9528. static="true" final="false" visibility="public"
  9529. deprecated="not deprecated">
  9530. <param name="host" type="java.lang.String"/>
  9531. <param name="port" type="int"/>
  9532. </method>
  9533. <method name="getHost" return="java.lang.String"
  9534. abstract="true" native="false" synchronized="false"
  9535. static="false" final="false" visibility="public"
  9536. deprecated="not deprecated">
  9537. <doc>
  9538. <![CDATA[Get the <em>hostname</em> of the node.
  9539. @return <em>hostname</em> of the node]]>
  9540. </doc>
  9541. </method>
  9542. <method name="getPort" return="int"
  9543. abstract="true" native="false" synchronized="false"
  9544. static="false" final="false" visibility="public"
  9545. deprecated="not deprecated">
  9546. <doc>
  9547. <![CDATA[Get the <em>port</em> for communicating with the node.
  9548. @return <em>port</em> for communicating with the node]]>
  9549. </doc>
  9550. </method>
  9551. <method name="toString" return="java.lang.String"
  9552. abstract="false" native="false" synchronized="false"
  9553. static="false" final="false" visibility="public"
  9554. deprecated="not deprecated">
  9555. </method>
  9556. <method name="hashCode" return="int"
  9557. abstract="false" native="false" synchronized="false"
  9558. static="false" final="false" visibility="public"
  9559. deprecated="not deprecated">
  9560. </method>
  9561. <method name="equals" return="boolean"
  9562. abstract="false" native="false" synchronized="false"
  9563. static="false" final="false" visibility="public"
  9564. deprecated="not deprecated">
  9565. <param name="obj" type="java.lang.Object"/>
  9566. </method>
  9567. <method name="compareTo" return="int"
  9568. abstract="false" native="false" synchronized="false"
  9569. static="false" final="false" visibility="public"
  9570. deprecated="not deprecated">
  9571. <param name="other" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  9572. </method>
  9573. <method name="fromString" return="org.apache.hadoop.yarn.api.records.NodeId"
  9574. abstract="false" native="false" synchronized="false"
  9575. static="true" final="false" visibility="public"
  9576. deprecated="not deprecated">
  9577. <param name="nodeIdStr" type="java.lang.String"/>
  9578. </method>
  9579. <method name="build"
  9580. abstract="true" native="false" synchronized="false"
  9581. static="false" final="false" visibility="protected"
  9582. deprecated="not deprecated">
  9583. </method>
  9584. <doc>
  9585. <![CDATA[<p><code>NodeId</code> is the unique identifier for a node.</p>
  9586. <p>It includes the <em>hostname</em> and <em>port</em> to uniquely
  9587. identify the node. Thus, it is unique across restarts of any
  9588. <code>NodeManager</code>.</p>]]>
  9589. </doc>
  9590. </class>
  9591. <!-- end class org.apache.hadoop.yarn.api.records.NodeId -->
  9592. <!-- start class org.apache.hadoop.yarn.api.records.NodeLabel -->
  9593. <class name="NodeLabel" extends="java.lang.Object"
  9594. abstract="true"
  9595. static="false" final="false" visibility="public"
  9596. deprecated="not deprecated">
  9597. <implements name="java.lang.Comparable"/>
  9598. <constructor name="NodeLabel"
  9599. static="false" final="false" visibility="public"
  9600. deprecated="not deprecated">
  9601. </constructor>
  9602. <method name="getName" return="java.lang.String"
  9603. abstract="true" native="false" synchronized="false"
  9604. static="false" final="false" visibility="public"
  9605. deprecated="not deprecated">
  9606. </method>
  9607. <method name="isExclusive" return="boolean"
  9608. abstract="true" native="false" synchronized="false"
  9609. static="false" final="false" visibility="public"
  9610. deprecated="not deprecated">
  9611. </method>
  9612. <method name="compareTo" return="int"
  9613. abstract="false" native="false" synchronized="false"
  9614. static="false" final="false" visibility="public"
  9615. deprecated="not deprecated">
  9616. <param name="other" type="org.apache.hadoop.yarn.api.records.NodeLabel"/>
  9617. </method>
  9618. <method name="equals" return="boolean"
  9619. abstract="false" native="false" synchronized="false"
  9620. static="false" final="false" visibility="public"
  9621. deprecated="not deprecated">
  9622. <param name="obj" type="java.lang.Object"/>
  9623. </method>
  9624. <method name="toString" return="java.lang.String"
  9625. abstract="false" native="false" synchronized="false"
  9626. static="false" final="false" visibility="public"
  9627. deprecated="not deprecated">
  9628. </method>
  9629. <method name="hashCode" return="int"
  9630. abstract="false" native="false" synchronized="false"
  9631. static="false" final="false" visibility="public"
  9632. deprecated="not deprecated">
  9633. </method>
  9634. <field name="DEFAULT_NODE_LABEL_PARTITION" type="java.lang.String"
  9635. transient="false" volatile="false"
  9636. static="true" final="true" visibility="public"
  9637. deprecated="not deprecated">
  9638. <doc>
  9639. <![CDATA[Default node label partition used for displaying.]]>
  9640. </doc>
  9641. </field>
  9642. <field name="NODE_LABEL_EXPRESSION_NOT_SET" type="java.lang.String"
  9643. transient="false" volatile="false"
  9644. static="true" final="true" visibility="public"
  9645. deprecated="not deprecated">
  9646. <doc>
  9647. <![CDATA[Node Label expression not set .]]>
  9648. </doc>
  9649. </field>
  9650. <field name="DEFAULT_NODE_LABEL_EXCLUSIVITY" type="boolean"
  9651. transient="false" volatile="false"
  9652. static="true" final="true" visibility="public"
  9653. deprecated="not deprecated">
  9654. <doc>
  9655. <![CDATA[By default, node label is exclusive or not]]>
  9656. </doc>
  9657. </field>
  9658. </class>
  9659. <!-- end class org.apache.hadoop.yarn.api.records.NodeLabel -->
  9660. <!-- start class org.apache.hadoop.yarn.api.records.NodeReport -->
  9661. <class name="NodeReport" extends="java.lang.Object"
  9662. abstract="true"
  9663. static="false" final="false" visibility="public"
  9664. deprecated="not deprecated">
  9665. <constructor name="NodeReport"
  9666. static="false" final="false" visibility="public"
  9667. deprecated="not deprecated">
  9668. </constructor>
  9669. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  9670. abstract="true" native="false" synchronized="false"
  9671. static="false" final="false" visibility="public"
  9672. deprecated="not deprecated">
  9673. <doc>
  9674. <![CDATA[Get the <code>NodeId</code> of the node.
  9675. @return <code>NodeId</code> of the node]]>
  9676. </doc>
  9677. </method>
  9678. <method name="getNodeState" return="org.apache.hadoop.yarn.api.records.NodeState"
  9679. abstract="true" native="false" synchronized="false"
  9680. static="false" final="false" visibility="public"
  9681. deprecated="not deprecated">
  9682. <doc>
  9683. <![CDATA[Get the <code>NodeState</code> of the node.
  9684. @return <code>NodeState</code> of the node]]>
  9685. </doc>
  9686. </method>
  9687. <method name="getHttpAddress" return="java.lang.String"
  9688. abstract="true" native="false" synchronized="false"
  9689. static="false" final="false" visibility="public"
  9690. deprecated="not deprecated">
  9691. <doc>
  9692. <![CDATA[Get the <em>http address</em> of the node.
  9693. @return <em>http address</em> of the node]]>
  9694. </doc>
  9695. </method>
  9696. <method name="getRackName" return="java.lang.String"
  9697. abstract="true" native="false" synchronized="false"
  9698. static="false" final="false" visibility="public"
  9699. deprecated="not deprecated">
  9700. <doc>
  9701. <![CDATA[Get the <em>rack name</em> for the node.
  9702. @return <em>rack name</em> for the node]]>
  9703. </doc>
  9704. </method>
  9705. <method name="getUsed" return="org.apache.hadoop.yarn.api.records.Resource"
  9706. abstract="true" native="false" synchronized="false"
  9707. static="false" final="false" visibility="public"
  9708. deprecated="not deprecated">
  9709. <doc>
  9710. <![CDATA[Get <em>used</em> <code>Resource</code> on the node.
  9711. @return <em>used</em> <code>Resource</code> on the node]]>
  9712. </doc>
  9713. </method>
  9714. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  9715. abstract="true" native="false" synchronized="false"
  9716. static="false" final="false" visibility="public"
  9717. deprecated="not deprecated">
  9718. <doc>
  9719. <![CDATA[Get the <em>total</em> <code>Resource</code> on the node.
  9720. @return <em>total</em> <code>Resource</code> on the node]]>
  9721. </doc>
  9722. </method>
  9723. <method name="getHealthReport" return="java.lang.String"
  9724. abstract="true" native="false" synchronized="false"
  9725. static="false" final="false" visibility="public"
  9726. deprecated="not deprecated">
  9727. <doc>
  9728. <![CDATA[Get the <em>diagnostic health report</em> of the node.
  9729. @return <em>diagnostic health report</em> of the node]]>
  9730. </doc>
  9731. </method>
  9732. <method name="getLastHealthReportTime" return="long"
  9733. abstract="true" native="false" synchronized="false"
  9734. static="false" final="false" visibility="public"
  9735. deprecated="not deprecated">
  9736. <doc>
  9737. <![CDATA[Get the <em>last timestamp</em> at which the health report was received.
  9738. @return <em>last timestamp</em> at which the health report was received]]>
  9739. </doc>
  9740. </method>
  9741. <method name="getNodeLabels" return="java.util.Set"
  9742. abstract="true" native="false" synchronized="false"
  9743. static="false" final="false" visibility="public"
  9744. deprecated="not deprecated">
  9745. <doc>
  9746. <![CDATA[Get labels of this node.
  9747. @return labels of this node.]]>
  9748. </doc>
  9749. </method>
  9750. <method name="getAggregatedContainersUtilization" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  9751. abstract="false" native="false" synchronized="false"
  9752. static="false" final="false" visibility="public"
  9753. deprecated="not deprecated">
  9754. <doc>
  9755. <![CDATA[Get containers aggregated resource utilization in a node.
  9756. @return containers resource utilization.]]>
  9757. </doc>
  9758. </method>
  9759. <method name="getNodeUtilization" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  9760. abstract="true" native="false" synchronized="false"
  9761. static="false" final="false" visibility="public"
  9762. deprecated="not deprecated">
  9763. <doc>
  9764. <![CDATA[Get node resource utilization.
  9765. @return node resource utilization.]]>
  9766. </doc>
  9767. </method>
  9768. <method name="getDecommissioningTimeout" return="java.lang.Integer"
  9769. abstract="false" native="false" synchronized="false"
  9770. static="false" final="false" visibility="public"
  9771. deprecated="not deprecated">
  9772. <doc>
  9773. <![CDATA[Optional decommissioning timeout in seconds (null indicates absent
  9774. timeout).
  9775. @return the decommissioning timeout in second.]]>
  9776. </doc>
  9777. </method>
  9778. <method name="setDecommissioningTimeout"
  9779. abstract="false" native="false" synchronized="false"
  9780. static="false" final="false" visibility="public"
  9781. deprecated="not deprecated">
  9782. <param name="decommissioningTimeout" type="java.lang.Integer"/>
  9783. <doc>
  9784. <![CDATA[Set the decommissioning timeout in seconds (null indicates absent timeout).]]>
  9785. </doc>
  9786. </method>
  9787. <method name="getNodeUpdateType" return="org.apache.hadoop.yarn.api.records.NodeUpdateType"
  9788. abstract="false" native="false" synchronized="false"
  9789. static="false" final="false" visibility="public"
  9790. deprecated="not deprecated">
  9791. <doc>
  9792. <![CDATA[Optional node update type (null indicates absent update type).
  9793. @return the node update.]]>
  9794. </doc>
  9795. </method>
  9796. <method name="setNodeUpdateType"
  9797. abstract="false" native="false" synchronized="false"
  9798. static="false" final="false" visibility="public"
  9799. deprecated="not deprecated">
  9800. <param name="nodeUpdateType" type="org.apache.hadoop.yarn.api.records.NodeUpdateType"/>
  9801. <doc>
  9802. <![CDATA[Set the node update type (null indicates absent node update type).]]>
  9803. </doc>
  9804. </method>
  9805. <method name="setNodeAttributes"
  9806. abstract="true" native="false" synchronized="false"
  9807. static="false" final="false" visibility="public"
  9808. deprecated="not deprecated">
  9809. <param name="nodeAttributes" type="java.util.Set"/>
  9810. <doc>
  9811. <![CDATA[Set the node attributes of node.
  9812. @param nodeAttributes set of node attributes.]]>
  9813. </doc>
  9814. </method>
  9815. <method name="getNodeAttributes" return="java.util.Set"
  9816. abstract="true" native="false" synchronized="false"
  9817. static="false" final="false" visibility="public"
  9818. deprecated="not deprecated">
  9819. <doc>
  9820. <![CDATA[Get node attributes of node.
  9821. @return the set of node attributes.]]>
  9822. </doc>
  9823. </method>
  9824. <doc>
  9825. <![CDATA[{@code NodeReport} is a summary of runtime information of a node
  9826. in the cluster.
  9827. <p>
  9828. It includes details such as:
  9829. <ul>
  9830. <li>{@link NodeId} of the node.</li>
  9831. <li>HTTP Tracking URL of the node.</li>
  9832. <li>Rack name for the node.</li>
  9833. <li>Used {@link Resource} on the node.</li>
  9834. <li>Total available {@link Resource} of the node.</li>
  9835. <li>Number of running containers on the node.</li>
  9836. </ul>
  9837. @see ApplicationClientProtocol#getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)]]>
  9838. </doc>
  9839. </class>
  9840. <!-- end class org.apache.hadoop.yarn.api.records.NodeReport -->
  9841. <!-- start class org.apache.hadoop.yarn.api.records.NodeState -->
  9842. <class name="NodeState" extends="java.lang.Enum"
  9843. abstract="false"
  9844. static="false" final="true" visibility="public"
  9845. deprecated="not deprecated">
  9846. <method name="values" return="org.apache.hadoop.yarn.api.records.NodeState[]"
  9847. abstract="false" native="false" synchronized="false"
  9848. static="true" final="false" visibility="public"
  9849. deprecated="not deprecated">
  9850. </method>
  9851. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.NodeState"
  9852. abstract="false" native="false" synchronized="false"
  9853. static="true" final="false" visibility="public"
  9854. deprecated="not deprecated">
  9855. <param name="name" type="java.lang.String"/>
  9856. </method>
  9857. <method name="isUnusable" return="boolean"
  9858. abstract="false" native="false" synchronized="false"
  9859. static="false" final="false" visibility="public"
  9860. deprecated="not deprecated">
  9861. </method>
  9862. <method name="isInactiveState" return="boolean"
  9863. abstract="false" native="false" synchronized="false"
  9864. static="false" final="false" visibility="public"
  9865. deprecated="not deprecated">
  9866. </method>
  9867. <method name="isActiveState" return="boolean"
  9868. abstract="false" native="false" synchronized="false"
  9869. static="false" final="false" visibility="public"
  9870. deprecated="not deprecated">
  9871. </method>
  9872. <doc>
  9873. <![CDATA[<p>State of a <code>Node</code>.</p>]]>
  9874. </doc>
  9875. </class>
  9876. <!-- end class org.apache.hadoop.yarn.api.records.NodeState -->
  9877. <!-- start class org.apache.hadoop.yarn.api.records.NodeToAttributeValue -->
  9878. <class name="NodeToAttributeValue" extends="java.lang.Object"
  9879. abstract="true"
  9880. static="false" final="false" visibility="public"
  9881. deprecated="not deprecated">
  9882. <constructor name="NodeToAttributeValue"
  9883. static="false" final="false" visibility="public"
  9884. deprecated="not deprecated">
  9885. </constructor>
  9886. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeToAttributeValue"
  9887. abstract="false" native="false" synchronized="false"
  9888. static="true" final="false" visibility="public"
  9889. deprecated="not deprecated">
  9890. <param name="hostname" type="java.lang.String"/>
  9891. <param name="attributeValue" type="java.lang.String"/>
  9892. </method>
  9893. <method name="getAttributeValue" return="java.lang.String"
  9894. abstract="true" native="false" synchronized="false"
  9895. static="false" final="false" visibility="public"
  9896. deprecated="not deprecated">
  9897. </method>
  9898. <method name="setAttributeValue"
  9899. abstract="true" native="false" synchronized="false"
  9900. static="false" final="false" visibility="public"
  9901. deprecated="not deprecated">
  9902. <param name="attributeValue" type="java.lang.String"/>
  9903. </method>
  9904. <method name="getHostname" return="java.lang.String"
  9905. abstract="true" native="false" synchronized="false"
  9906. static="false" final="false" visibility="public"
  9907. deprecated="not deprecated">
  9908. </method>
  9909. <method name="setHostname"
  9910. abstract="true" native="false" synchronized="false"
  9911. static="false" final="false" visibility="public"
  9912. deprecated="not deprecated">
  9913. <param name="hostname" type="java.lang.String"/>
  9914. </method>
  9915. <doc>
  9916. <![CDATA[<p>
  9917. Mapping of Attribute Value to a Node.
  9918. </p>]]>
  9919. </doc>
  9920. </class>
  9921. <!-- end class org.apache.hadoop.yarn.api.records.NodeToAttributeValue -->
  9922. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
  9923. <class name="PreemptionContainer" extends="java.lang.Object"
  9924. abstract="true"
  9925. static="false" final="false" visibility="public"
  9926. deprecated="not deprecated">
  9927. <constructor name="PreemptionContainer"
  9928. static="false" final="false" visibility="public"
  9929. deprecated="not deprecated">
  9930. </constructor>
  9931. <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  9932. abstract="true" native="false" synchronized="false"
  9933. static="false" final="false" visibility="public"
  9934. deprecated="not deprecated">
  9935. <doc>
  9936. <![CDATA[@return Container referenced by this handle.]]>
  9937. </doc>
  9938. </method>
  9939. <doc>
  9940. <![CDATA[Specific container requested back by the <code>ResourceManager</code>.
  9941. @see PreemptionContract
  9942. @see StrictPreemptionContract]]>
  9943. </doc>
  9944. </class>
  9945. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
  9946. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContract -->
  9947. <class name="PreemptionContract" extends="java.lang.Object"
  9948. abstract="true"
  9949. static="false" final="false" visibility="public"
  9950. deprecated="not deprecated">
  9951. <constructor name="PreemptionContract"
  9952. static="false" final="false" visibility="public"
  9953. deprecated="not deprecated">
  9954. </constructor>
  9955. <method name="getResourceRequest" return="java.util.List"
  9956. abstract="true" native="false" synchronized="false"
  9957. static="false" final="false" visibility="public"
  9958. deprecated="not deprecated">
  9959. <doc>
  9960. <![CDATA[If the AM releases resources matching these requests, then the {@link
  9961. PreemptionContainer}s enumerated in {@link #getContainers()} should not be
  9962. evicted from the cluster. Due to delays in propagating cluster state and
  9963. sending these messages, there are conditions where satisfied contracts may
  9964. not prevent the platform from killing containers.
  9965. @return List of {@link PreemptionResourceRequest} to update the
  9966. <code>ApplicationMaster</code> about resources requested back by the
  9967. <code>ResourceManager</code>.
  9968. @see AllocateRequest#setAskList(List)]]>
  9969. </doc>
  9970. </method>
  9971. <method name="getContainers" return="java.util.Set"
  9972. abstract="true" native="false" synchronized="false"
  9973. static="false" final="false" visibility="public"
  9974. deprecated="not deprecated">
  9975. <doc>
  9976. <![CDATA[Assign the set of {@link PreemptionContainer} specifying which containers
  9977. owned by the <code>ApplicationMaster</code> that may be reclaimed by the
  9978. <code>ResourceManager</code>. If the AM prefers a different set of
  9979. containers, then it may checkpoint or kill containers matching the
  9980. description in {@link #getResourceRequest}.
  9981. @return Set of containers at risk if the contract is not met.]]>
  9982. </doc>
  9983. </method>
  9984. <doc>
  9985. <![CDATA[Description of resources requested back by the <code>ResourceManager</code>.
  9986. The <code>ApplicationMaster</code> (AM) can satisfy this request according
  9987. to its own priorities to prevent containers from being forcibly killed by
  9988. the platform.
  9989. @see PreemptionMessage]]>
  9990. </doc>
  9991. </class>
  9992. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContract -->
  9993. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
  9994. <class name="PreemptionMessage" extends="java.lang.Object"
  9995. abstract="true"
  9996. static="false" final="false" visibility="public"
  9997. deprecated="not deprecated">
  9998. <constructor name="PreemptionMessage"
  9999. static="false" final="false" visibility="public"
  10000. deprecated="not deprecated">
  10001. </constructor>
  10002. <method name="getStrictContract" return="org.apache.hadoop.yarn.api.records.StrictPreemptionContract"
  10003. abstract="true" native="false" synchronized="false"
  10004. static="false" final="false" visibility="public"
  10005. deprecated="not deprecated">
  10006. <doc>
  10007. <![CDATA[@return Specific resources that may be killed by the
  10008. <code>ResourceManager</code>]]>
  10009. </doc>
  10010. </method>
  10011. <method name="getContract" return="org.apache.hadoop.yarn.api.records.PreemptionContract"
  10012. abstract="true" native="false" synchronized="false"
  10013. static="false" final="false" visibility="public"
  10014. deprecated="not deprecated">
  10015. <doc>
  10016. <![CDATA[@return Contract describing resources to return to the cluster.]]>
  10017. </doc>
  10018. </method>
  10019. <doc>
  10020. <![CDATA[A {@link PreemptionMessage} is part of the RM-AM protocol, and it is used by
  10021. the RM to specify resources that the RM wants to reclaim from this
  10022. {@code ApplicationMaster} (AM). The AM receives a {@link
  10023. StrictPreemptionContract} message encoding which containers the platform may
  10024. forcibly kill, granting it an opportunity to checkpoint state or adjust its
  10025. execution plan. The message may also include a {@link PreemptionContract}
  10026. granting the AM more latitude in selecting which resources to return to the
  10027. cluster.
  10028. <p>
  10029. The AM should decode both parts of the message. The {@link
  10030. StrictPreemptionContract} specifies particular allocations that the RM
  10031. requires back. The AM can checkpoint containers' state, adjust its execution
  10032. plan to move the computation, or take no action and hope that conditions that
  10033. caused the RM to ask for the container will change.
  10034. <p>
  10035. In contrast, the {@link PreemptionContract} also includes a description of
  10036. resources with a set of containers. If the AM releases containers matching
  10037. that profile, then the containers enumerated in {@link
  10038. PreemptionContract#getContainers()} may not be killed.
  10039. <p>
  10040. Each preemption message reflects the RM's current understanding of the
  10041. cluster state, so a request to return <em>N</em> containers may not
  10042. reflect containers the AM is releasing, recently exited containers the RM has
  10043. yet to learn about, or new containers allocated before the message was
  10044. generated. Conversely, an RM may request a different profile of containers in
  10045. subsequent requests.
  10046. <p>
  10047. The policy enforced by the RM is part of the scheduler. Generally, only
  10048. containers that have been requested consistently should be killed, but the
  10049. details are not specified.]]>
  10050. </doc>
  10051. </class>
  10052. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
  10053. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
  10054. <class name="PreemptionResourceRequest" extends="java.lang.Object"
  10055. abstract="true"
  10056. static="false" final="false" visibility="public"
  10057. deprecated="not deprecated">
  10058. <constructor name="PreemptionResourceRequest"
  10059. static="false" final="false" visibility="public"
  10060. deprecated="not deprecated">
  10061. </constructor>
  10062. <method name="getResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  10063. abstract="true" native="false" synchronized="false"
  10064. static="false" final="false" visibility="public"
  10065. deprecated="not deprecated">
  10066. <doc>
  10067. <![CDATA[@return Resource described in this request, to be matched against running
  10068. containers.]]>
  10069. </doc>
  10070. </method>
  10071. <doc>
  10072. <![CDATA[Description of resources requested back by the cluster.
  10073. @see PreemptionContract
  10074. @see AllocateRequest#setAskList(java.util.List)]]>
  10075. </doc>
  10076. </class>
  10077. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
  10078. <!-- start class org.apache.hadoop.yarn.api.records.Priority -->
  10079. <class name="Priority" extends="java.lang.Object"
  10080. abstract="true"
  10081. static="false" final="false" visibility="public"
  10082. deprecated="not deprecated">
  10083. <implements name="java.lang.Comparable"/>
  10084. <constructor name="Priority"
  10085. static="false" final="false" visibility="public"
  10086. deprecated="not deprecated">
  10087. </constructor>
  10088. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Priority"
  10089. abstract="false" native="false" synchronized="false"
  10090. static="true" final="false" visibility="public"
  10091. deprecated="not deprecated">
  10092. <param name="p" type="int"/>
  10093. </method>
  10094. <method name="getPriority" return="int"
  10095. abstract="true" native="false" synchronized="false"
  10096. static="false" final="false" visibility="public"
  10097. deprecated="not deprecated">
  10098. <doc>
  10099. <![CDATA[Get the assigned priority
  10100. @return the assigned priority]]>
  10101. </doc>
  10102. </method>
  10103. <method name="setPriority"
  10104. abstract="true" native="false" synchronized="false"
  10105. static="false" final="false" visibility="public"
  10106. deprecated="not deprecated">
  10107. <param name="priority" type="int"/>
  10108. <doc>
  10109. <![CDATA[Set the assigned priority
  10110. @param priority the assigned priority]]>
  10111. </doc>
  10112. </method>
  10113. <method name="hashCode" return="int"
  10114. abstract="false" native="false" synchronized="false"
  10115. static="false" final="false" visibility="public"
  10116. deprecated="not deprecated">
  10117. </method>
  10118. <method name="equals" return="boolean"
  10119. abstract="false" native="false" synchronized="false"
  10120. static="false" final="false" visibility="public"
  10121. deprecated="not deprecated">
  10122. <param name="obj" type="java.lang.Object"/>
  10123. </method>
  10124. <method name="compareTo" return="int"
  10125. abstract="false" native="false" synchronized="false"
  10126. static="false" final="false" visibility="public"
  10127. deprecated="not deprecated">
  10128. <param name="other" type="org.apache.hadoop.yarn.api.records.Priority"/>
  10129. </method>
  10130. <method name="toString" return="java.lang.String"
  10131. abstract="false" native="false" synchronized="false"
  10132. static="false" final="false" visibility="public"
  10133. deprecated="not deprecated">
  10134. </method>
  10135. <field name="UNDEFINED" type="org.apache.hadoop.yarn.api.records.Priority"
  10136. transient="false" volatile="false"
  10137. static="true" final="true" visibility="public"
  10138. deprecated="not deprecated">
  10139. </field>
  10140. <doc>
  10141. <![CDATA[The priority assigned to a ResourceRequest or Application or Container
  10142. allocation]]>
  10143. </doc>
  10144. </class>
  10145. <!-- end class org.apache.hadoop.yarn.api.records.Priority -->
  10146. <!-- start class org.apache.hadoop.yarn.api.records.QueueACL -->
  10147. <class name="QueueACL" extends="java.lang.Enum"
  10148. abstract="false"
  10149. static="false" final="true" visibility="public"
  10150. deprecated="not deprecated">
  10151. <method name="values" return="org.apache.hadoop.yarn.api.records.QueueACL[]"
  10152. abstract="false" native="false" synchronized="false"
  10153. static="true" final="false" visibility="public"
  10154. deprecated="not deprecated">
  10155. </method>
  10156. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueACL"
  10157. abstract="false" native="false" synchronized="false"
  10158. static="true" final="false" visibility="public"
  10159. deprecated="not deprecated">
  10160. <param name="name" type="java.lang.String"/>
  10161. </method>
  10162. <doc>
  10163. <![CDATA[{@code QueueACL} enumerates the various ACLs for queues.
  10164. <p>
  10165. The ACL is one of:
  10166. <ul>
  10167. <li>
  10168. {@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the queue.
  10169. </li>
  10170. <li>{@link #ADMINISTER_QUEUE} - ACL to administer the queue.</li>
  10171. </ul>
  10172. @see QueueInfo
  10173. @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
  10174. </doc>
  10175. </class>
  10176. <!-- end class org.apache.hadoop.yarn.api.records.QueueACL -->
  10177. <!-- start class org.apache.hadoop.yarn.api.records.QueueInfo -->
  10178. <class name="QueueInfo" extends="java.lang.Object"
  10179. abstract="true"
  10180. static="false" final="false" visibility="public"
  10181. deprecated="not deprecated">
  10182. <constructor name="QueueInfo"
  10183. static="false" final="false" visibility="public"
  10184. deprecated="not deprecated">
  10185. </constructor>
  10186. <method name="getQueueName" return="java.lang.String"
  10187. abstract="true" native="false" synchronized="false"
  10188. static="false" final="false" visibility="public"
  10189. deprecated="not deprecated">
  10190. <doc>
  10191. <![CDATA[Get the <em>name</em> of the queue.
  10192. @return <em>name</em> of the queue]]>
  10193. </doc>
  10194. </method>
  10195. <method name="getCapacity" return="float"
  10196. abstract="true" native="false" synchronized="false"
  10197. static="false" final="false" visibility="public"
  10198. deprecated="not deprecated">
  10199. <doc>
  10200. <![CDATA[Get the <em>configured capacity</em> of the queue.
  10201. @return <em>configured capacity</em> of the queue]]>
  10202. </doc>
  10203. </method>
  10204. <method name="getMaximumCapacity" return="float"
  10205. abstract="true" native="false" synchronized="false"
  10206. static="false" final="false" visibility="public"
  10207. deprecated="not deprecated">
  10208. <doc>
  10209. <![CDATA[Get the <em>maximum capacity</em> of the queue.
  10210. @return <em>maximum capacity</em> of the queue]]>
  10211. </doc>
  10212. </method>
  10213. <method name="getCurrentCapacity" return="float"
  10214. abstract="true" native="false" synchronized="false"
  10215. static="false" final="false" visibility="public"
  10216. deprecated="not deprecated">
  10217. <doc>
  10218. <![CDATA[Get the <em>current capacity</em> of the queue.
  10219. @return <em>current capacity</em> of the queue]]>
  10220. </doc>
  10221. </method>
  10222. <method name="getChildQueues" return="java.util.List"
  10223. abstract="true" native="false" synchronized="false"
  10224. static="false" final="false" visibility="public"
  10225. deprecated="not deprecated">
  10226. <doc>
  10227. <![CDATA[Get the <em>child queues</em> of the queue.
  10228. @return <em>child queues</em> of the queue]]>
  10229. </doc>
  10230. </method>
  10231. <method name="getApplications" return="java.util.List"
  10232. abstract="true" native="false" synchronized="false"
  10233. static="false" final="false" visibility="public"
  10234. deprecated="not deprecated">
  10235. <doc>
  10236. <![CDATA[Get the <em>running applications</em> of the queue.
  10237. @return <em>running applications</em> of the queue]]>
  10238. </doc>
  10239. </method>
  10240. <method name="getQueueState" return="org.apache.hadoop.yarn.api.records.QueueState"
  10241. abstract="true" native="false" synchronized="false"
  10242. static="false" final="false" visibility="public"
  10243. deprecated="not deprecated">
  10244. <doc>
  10245. <![CDATA[Get the <code>QueueState</code> of the queue.
  10246. @return <code>QueueState</code> of the queue]]>
  10247. </doc>
  10248. </method>
  10249. <method name="getAccessibleNodeLabels" return="java.util.Set"
  10250. abstract="true" native="false" synchronized="false"
  10251. static="false" final="false" visibility="public"
  10252. deprecated="not deprecated">
  10253. <doc>
  10254. <![CDATA[Get the <code>accessible node labels</code> of the queue.
  10255. @return <code>accessible node labels</code> of the queue]]>
  10256. </doc>
  10257. </method>
  10258. <method name="getDefaultNodeLabelExpression" return="java.lang.String"
  10259. abstract="true" native="false" synchronized="false"
  10260. static="false" final="false" visibility="public"
  10261. deprecated="not deprecated">
  10262. <doc>
  10263. <![CDATA[Get the <code>default node label expression</code> of the queue, this takes
  10264. affect only when the <code>ApplicationSubmissionContext</code> and
  10265. <code>ResourceRequest</code> don't specify their
  10266. <code>NodeLabelExpression</code>.
  10267. @return <code>default node label expression</code> of the queue]]>
  10268. </doc>
  10269. </method>
  10270. <method name="setDefaultNodeLabelExpression"
  10271. abstract="true" native="false" synchronized="false"
  10272. static="false" final="false" visibility="public"
  10273. deprecated="not deprecated">
  10274. <param name="defaultLabelExpression" type="java.lang.String"/>
  10275. </method>
  10276. <method name="getQueueStatistics" return="org.apache.hadoop.yarn.api.records.QueueStatistics"
  10277. abstract="true" native="false" synchronized="false"
  10278. static="false" final="false" visibility="public"
  10279. deprecated="not deprecated">
  10280. <doc>
  10281. <![CDATA[Get the <code>queue stats</code> for the queue
  10282. @return <code>queue stats</code> of the queue]]>
  10283. </doc>
  10284. </method>
  10285. <method name="setQueueStatistics"
  10286. abstract="true" native="false" synchronized="false"
  10287. static="false" final="false" visibility="public"
  10288. deprecated="not deprecated">
  10289. <param name="queueStatistics" type="org.apache.hadoop.yarn.api.records.QueueStatistics"/>
  10290. <doc>
  10291. <![CDATA[Set the queue statistics for the queue
  10292. @param queueStatistics
  10293. the queue statistics]]>
  10294. </doc>
  10295. </method>
  10296. <method name="getPreemptionDisabled" return="java.lang.Boolean"
  10297. abstract="true" native="false" synchronized="false"
  10298. static="false" final="false" visibility="public"
  10299. deprecated="not deprecated">
  10300. <doc>
  10301. <![CDATA[Get the <em>preemption status</em> of the queue.
  10302. @return if property is not in proto, return null;
  10303. otherwise, return <em>preemption status</em> of the queue]]>
  10304. </doc>
  10305. </method>
  10306. <method name="getQueueConfigurations" return="java.util.Map"
  10307. abstract="true" native="false" synchronized="false"
  10308. static="false" final="false" visibility="public"
  10309. deprecated="not deprecated">
  10310. <doc>
  10311. <![CDATA[Get the per-node-label queue configurations of the queue.
  10312. @return the per-node-label queue configurations of the queue.]]>
  10313. </doc>
  10314. </method>
  10315. <method name="getIntraQueuePreemptionDisabled" return="java.lang.Boolean"
  10316. abstract="true" native="false" synchronized="false"
  10317. static="false" final="false" visibility="public"
  10318. deprecated="not deprecated">
  10319. <doc>
  10320. <![CDATA[Get the intra-queue preemption status of the queue.
  10321. @return if property is not in proto, return null;
  10322. otherwise, return intra-queue preemption status of the queue]]>
  10323. </doc>
  10324. </method>
  10325. <doc>
  10326. <![CDATA[QueueInfo is a report of the runtime information of the queue.
  10327. <p>
  10328. It includes information such as:
  10329. <ul>
  10330. <li>Queue name.</li>
  10331. <li>Capacity of the queue.</li>
  10332. <li>Maximum capacity of the queue.</li>
  10333. <li>Current capacity of the queue.</li>
  10334. <li>Child queues.</li>
  10335. <li>Running applications.</li>
  10336. <li>{@link QueueState} of the queue.</li>
  10337. <li>{@link QueueConfigurations} of the queue.</li>
  10338. </ul>
  10339. @see QueueState
  10340. @see QueueConfigurations
  10341. @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
  10342. </doc>
  10343. </class>
  10344. <!-- end class org.apache.hadoop.yarn.api.records.QueueInfo -->
  10345. <!-- start class org.apache.hadoop.yarn.api.records.QueueState -->
  10346. <class name="QueueState" extends="java.lang.Enum"
  10347. abstract="false"
  10348. static="false" final="true" visibility="public"
  10349. deprecated="not deprecated">
  10350. <method name="values" return="org.apache.hadoop.yarn.api.records.QueueState[]"
  10351. abstract="false" native="false" synchronized="false"
  10352. static="true" final="false" visibility="public"
  10353. deprecated="not deprecated">
  10354. </method>
  10355. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueState"
  10356. abstract="false" native="false" synchronized="false"
  10357. static="true" final="false" visibility="public"
  10358. deprecated="not deprecated">
  10359. <param name="name" type="java.lang.String"/>
  10360. </method>
  10361. <doc>
  10362. <![CDATA[State of a Queue.
  10363. <p>
  10364. A queue is in one of:
  10365. <ul>
  10366. <li>{@link #RUNNING} - normal state.</li>
  10367. <li>{@link #STOPPED} - not accepting new application submissions.</li>
  10368. <li>
  10369. {@link #DRAINING} - not accepting new application submissions
  10370. and waiting for applications finish.
  10371. </li>
  10372. </ul>
  10373. @see QueueInfo
  10374. @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
  10375. </doc>
  10376. </class>
  10377. <!-- end class org.apache.hadoop.yarn.api.records.QueueState -->
  10378. <!-- start class org.apache.hadoop.yarn.api.records.QueueStatistics -->
  10379. <class name="QueueStatistics" extends="java.lang.Object"
  10380. abstract="true"
  10381. static="false" final="false" visibility="public"
  10382. deprecated="not deprecated">
  10383. <constructor name="QueueStatistics"
  10384. static="false" final="false" visibility="public"
  10385. deprecated="not deprecated">
  10386. </constructor>
  10387. <method name="getNumAppsSubmitted" return="long"
  10388. abstract="true" native="false" synchronized="false"
  10389. static="false" final="false" visibility="public"
  10390. deprecated="not deprecated">
  10391. <doc>
  10392. <![CDATA[Get the number of apps submitted
  10393. @return the number of apps submitted]]>
  10394. </doc>
  10395. </method>
  10396. <method name="setNumAppsSubmitted"
  10397. abstract="true" native="false" synchronized="false"
  10398. static="false" final="false" visibility="public"
  10399. deprecated="not deprecated">
  10400. <param name="numAppsSubmitted" type="long"/>
  10401. <doc>
  10402. <![CDATA[Set the number of apps submitted
  10403. @param numAppsSubmitted
  10404. the number of apps submitted]]>
  10405. </doc>
  10406. </method>
  10407. <method name="getNumAppsRunning" return="long"
  10408. abstract="true" native="false" synchronized="false"
  10409. static="false" final="false" visibility="public"
  10410. deprecated="not deprecated">
  10411. <doc>
  10412. <![CDATA[Get the number of running apps
  10413. @return the number of running apps]]>
  10414. </doc>
  10415. </method>
  10416. <method name="setNumAppsRunning"
  10417. abstract="true" native="false" synchronized="false"
  10418. static="false" final="false" visibility="public"
  10419. deprecated="not deprecated">
  10420. <param name="numAppsRunning" type="long"/>
  10421. <doc>
  10422. <![CDATA[Set the number of running apps
  10423. @param numAppsRunning
  10424. the number of running apps]]>
  10425. </doc>
  10426. </method>
  10427. <method name="getNumAppsPending" return="long"
  10428. abstract="true" native="false" synchronized="false"
  10429. static="false" final="false" visibility="public"
  10430. deprecated="not deprecated">
  10431. <doc>
  10432. <![CDATA[Get the number of pending apps
  10433. @return the number of pending apps]]>
  10434. </doc>
  10435. </method>
  10436. <method name="setNumAppsPending"
  10437. abstract="true" native="false" synchronized="false"
  10438. static="false" final="false" visibility="public"
  10439. deprecated="not deprecated">
  10440. <param name="numAppsPending" type="long"/>
  10441. <doc>
  10442. <![CDATA[Set the number of pending apps
  10443. @param numAppsPending
  10444. the number of pending apps]]>
  10445. </doc>
  10446. </method>
  10447. <method name="getNumAppsCompleted" return="long"
  10448. abstract="true" native="false" synchronized="false"
  10449. static="false" final="false" visibility="public"
  10450. deprecated="not deprecated">
  10451. <doc>
  10452. <![CDATA[Get the number of completed apps
  10453. @return the number of completed apps]]>
  10454. </doc>
  10455. </method>
  10456. <method name="setNumAppsCompleted"
  10457. abstract="true" native="false" synchronized="false"
  10458. static="false" final="false" visibility="public"
  10459. deprecated="not deprecated">
  10460. <param name="numAppsCompleted" type="long"/>
  10461. <doc>
  10462. <![CDATA[Set the number of completed apps
  10463. @param numAppsCompleted
  10464. the number of completed apps]]>
  10465. </doc>
  10466. </method>
  10467. <method name="getNumAppsKilled" return="long"
  10468. abstract="true" native="false" synchronized="false"
  10469. static="false" final="false" visibility="public"
  10470. deprecated="not deprecated">
  10471. <doc>
  10472. <![CDATA[Get the number of killed apps
  10473. @return the number of killed apps]]>
  10474. </doc>
  10475. </method>
  10476. <method name="setNumAppsKilled"
  10477. abstract="true" native="false" synchronized="false"
  10478. static="false" final="false" visibility="public"
  10479. deprecated="not deprecated">
  10480. <param name="numAppsKilled" type="long"/>
  10481. <doc>
  10482. <![CDATA[Set the number of killed apps
  10483. @param numAppsKilled
  10484. the number of killed apps]]>
  10485. </doc>
  10486. </method>
  10487. <method name="getNumAppsFailed" return="long"
  10488. abstract="true" native="false" synchronized="false"
  10489. static="false" final="false" visibility="public"
  10490. deprecated="not deprecated">
  10491. <doc>
  10492. <![CDATA[Get the number of failed apps
  10493. @return the number of failed apps]]>
  10494. </doc>
  10495. </method>
  10496. <method name="setNumAppsFailed"
  10497. abstract="true" native="false" synchronized="false"
  10498. static="false" final="false" visibility="public"
  10499. deprecated="not deprecated">
  10500. <param name="numAppsFailed" type="long"/>
  10501. <doc>
  10502. <![CDATA[Set the number of failed apps
  10503. @param numAppsFailed
  10504. the number of failed apps]]>
  10505. </doc>
  10506. </method>
  10507. <method name="getNumActiveUsers" return="long"
  10508. abstract="true" native="false" synchronized="false"
  10509. static="false" final="false" visibility="public"
  10510. deprecated="not deprecated">
  10511. <doc>
  10512. <![CDATA[Get the number of active users
  10513. @return the number of active users]]>
  10514. </doc>
  10515. </method>
  10516. <method name="setNumActiveUsers"
  10517. abstract="true" native="false" synchronized="false"
  10518. static="false" final="false" visibility="public"
  10519. deprecated="not deprecated">
  10520. <param name="numActiveUsers" type="long"/>
  10521. <doc>
  10522. <![CDATA[Set the number of active users
  10523. @param numActiveUsers
  10524. the number of active users]]>
  10525. </doc>
  10526. </method>
  10527. <method name="getAvailableMemoryMB" return="long"
  10528. abstract="true" native="false" synchronized="false"
  10529. static="false" final="false" visibility="public"
  10530. deprecated="not deprecated">
  10531. <doc>
  10532. <![CDATA[Get the available memory in MB
  10533. @return the available memory]]>
  10534. </doc>
  10535. </method>
  10536. <method name="setAvailableMemoryMB"
  10537. abstract="true" native="false" synchronized="false"
  10538. static="false" final="false" visibility="public"
  10539. deprecated="not deprecated">
  10540. <param name="availableMemoryMB" type="long"/>
  10541. <doc>
  10542. <![CDATA[Set the available memory in MB
  10543. @param availableMemoryMB
  10544. the available memory]]>
  10545. </doc>
  10546. </method>
  10547. <method name="getAllocatedMemoryMB" return="long"
  10548. abstract="true" native="false" synchronized="false"
  10549. static="false" final="false" visibility="public"
  10550. deprecated="not deprecated">
  10551. <doc>
  10552. <![CDATA[Get the allocated memory in MB
  10553. @return the allocated memory]]>
  10554. </doc>
  10555. </method>
  10556. <method name="setAllocatedMemoryMB"
  10557. abstract="true" native="false" synchronized="false"
  10558. static="false" final="false" visibility="public"
  10559. deprecated="not deprecated">
  10560. <param name="allocatedMemoryMB" type="long"/>
  10561. <doc>
  10562. <![CDATA[Set the allocated memory in MB
  10563. @param allocatedMemoryMB
  10564. the allocate memory]]>
  10565. </doc>
  10566. </method>
  10567. <method name="getPendingMemoryMB" return="long"
  10568. abstract="true" native="false" synchronized="false"
  10569. static="false" final="false" visibility="public"
  10570. deprecated="not deprecated">
  10571. <doc>
  10572. <![CDATA[Get the pending memory in MB
  10573. @return the pending memory]]>
  10574. </doc>
  10575. </method>
  10576. <method name="setPendingMemoryMB"
  10577. abstract="true" native="false" synchronized="false"
  10578. static="false" final="false" visibility="public"
  10579. deprecated="not deprecated">
  10580. <param name="pendingMemoryMB" type="long"/>
  10581. <doc>
  10582. <![CDATA[Set the pending memory in MB
  10583. @param pendingMemoryMB
  10584. the pending memory]]>
  10585. </doc>
  10586. </method>
  10587. <method name="getReservedMemoryMB" return="long"
  10588. abstract="true" native="false" synchronized="false"
  10589. static="false" final="false" visibility="public"
  10590. deprecated="not deprecated">
  10591. <doc>
  10592. <![CDATA[Get the reserved memory in MB
  10593. @return the reserved memory]]>
  10594. </doc>
  10595. </method>
  10596. <method name="setReservedMemoryMB"
  10597. abstract="true" native="false" synchronized="false"
  10598. static="false" final="false" visibility="public"
  10599. deprecated="not deprecated">
  10600. <param name="reservedMemoryMB" type="long"/>
  10601. <doc>
  10602. <![CDATA[Set the reserved memory in MB
  10603. @param reservedMemoryMB
  10604. the reserved memory]]>
  10605. </doc>
  10606. </method>
  10607. <method name="getAvailableVCores" return="long"
  10608. abstract="true" native="false" synchronized="false"
  10609. static="false" final="false" visibility="public"
  10610. deprecated="not deprecated">
  10611. <doc>
  10612. <![CDATA[Get the available vcores
  10613. @return the available vcores]]>
  10614. </doc>
  10615. </method>
  10616. <method name="setAvailableVCores"
  10617. abstract="true" native="false" synchronized="false"
  10618. static="false" final="false" visibility="public"
  10619. deprecated="not deprecated">
  10620. <param name="availableVCores" type="long"/>
  10621. <doc>
  10622. <![CDATA[Set the available vcores
  10623. @param availableVCores
  10624. the available vcores]]>
  10625. </doc>
  10626. </method>
  10627. <method name="getAllocatedVCores" return="long"
  10628. abstract="true" native="false" synchronized="false"
  10629. static="false" final="false" visibility="public"
  10630. deprecated="not deprecated">
  10631. <doc>
  10632. <![CDATA[Get the allocated vcores
  10633. @return the allocated vcores]]>
  10634. </doc>
  10635. </method>
  10636. <method name="setAllocatedVCores"
  10637. abstract="true" native="false" synchronized="false"
  10638. static="false" final="false" visibility="public"
  10639. deprecated="not deprecated">
  10640. <param name="allocatedVCores" type="long"/>
  10641. <doc>
  10642. <![CDATA[Set the allocated vcores
  10643. @param allocatedVCores
  10644. the allocated vcores]]>
  10645. </doc>
  10646. </method>
  10647. <method name="getPendingVCores" return="long"
  10648. abstract="true" native="false" synchronized="false"
  10649. static="false" final="false" visibility="public"
  10650. deprecated="not deprecated">
  10651. <doc>
  10652. <![CDATA[Get the pending vcores
  10653. @return the pending vcores]]>
  10654. </doc>
  10655. </method>
  10656. <method name="setPendingVCores"
  10657. abstract="true" native="false" synchronized="false"
  10658. static="false" final="false" visibility="public"
  10659. deprecated="not deprecated">
  10660. <param name="pendingVCores" type="long"/>
  10661. <doc>
  10662. <![CDATA[Set the pending vcores
  10663. @param pendingVCores
  10664. the pending vcores]]>
  10665. </doc>
  10666. </method>
  10667. <method name="getPendingContainers" return="long"
  10668. abstract="true" native="false" synchronized="false"
  10669. static="false" final="false" visibility="public"
  10670. deprecated="not deprecated">
  10671. <doc>
  10672. <![CDATA[Get the number of pending containers.
  10673. @return the number of pending containers.]]>
  10674. </doc>
  10675. </method>
  10676. <method name="setPendingContainers"
  10677. abstract="true" native="false" synchronized="false"
  10678. static="false" final="false" visibility="public"
  10679. deprecated="not deprecated">
  10680. <param name="pendingContainers" type="long"/>
  10681. <doc>
  10682. <![CDATA[Set the number of pending containers.
  10683. @param pendingContainers the pending containers.]]>
  10684. </doc>
  10685. </method>
  10686. <method name="getAllocatedContainers" return="long"
  10687. abstract="true" native="false" synchronized="false"
  10688. static="false" final="false" visibility="public"
  10689. deprecated="not deprecated">
  10690. <doc>
  10691. <![CDATA[Get the number of allocated containers.
  10692. @return the number of allocated containers.]]>
  10693. </doc>
  10694. </method>
  10695. <method name="setAllocatedContainers"
  10696. abstract="true" native="false" synchronized="false"
  10697. static="false" final="false" visibility="public"
  10698. deprecated="not deprecated">
  10699. <param name="allocatedContainers" type="long"/>
  10700. <doc>
  10701. <![CDATA[Set the number of allocated containers.
  10702. @param allocatedContainers the allocated containers.]]>
  10703. </doc>
  10704. </method>
  10705. <method name="getReservedContainers" return="long"
  10706. abstract="true" native="false" synchronized="false"
  10707. static="false" final="false" visibility="public"
  10708. deprecated="not deprecated">
  10709. <doc>
  10710. <![CDATA[Get the number of reserved containers.
  10711. @return the number of reserved containers.]]>
  10712. </doc>
  10713. </method>
  10714. <method name="setReservedContainers"
  10715. abstract="true" native="false" synchronized="false"
  10716. static="false" final="false" visibility="public"
  10717. deprecated="not deprecated">
  10718. <param name="reservedContainers" type="long"/>
  10719. <doc>
  10720. <![CDATA[Set the number of reserved containers.
  10721. @param reservedContainers the reserved containers.]]>
  10722. </doc>
  10723. </method>
  10724. <method name="getReservedVCores" return="long"
  10725. abstract="true" native="false" synchronized="false"
  10726. static="false" final="false" visibility="public"
  10727. deprecated="not deprecated">
  10728. <doc>
  10729. <![CDATA[Get the reserved vcores
  10730. @return the reserved vcores]]>
  10731. </doc>
  10732. </method>
  10733. <method name="setReservedVCores"
  10734. abstract="true" native="false" synchronized="false"
  10735. static="false" final="false" visibility="public"
  10736. deprecated="not deprecated">
  10737. <param name="reservedVCores" type="long"/>
  10738. <doc>
  10739. <![CDATA[Set the reserved vcores
  10740. @param reservedVCores
  10741. the reserved vcores]]>
  10742. </doc>
  10743. </method>
  10744. </class>
  10745. <!-- end class org.apache.hadoop.yarn.api.records.QueueStatistics -->
  10746. <!-- start class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
  10747. <class name="QueueUserACLInfo" extends="java.lang.Object"
  10748. abstract="true"
  10749. static="false" final="false" visibility="public"
  10750. deprecated="not deprecated">
  10751. <constructor name="QueueUserACLInfo"
  10752. static="false" final="false" visibility="public"
  10753. deprecated="not deprecated">
  10754. </constructor>
  10755. <method name="getQueueName" return="java.lang.String"
  10756. abstract="true" native="false" synchronized="false"
  10757. static="false" final="false" visibility="public"
  10758. deprecated="not deprecated">
  10759. <doc>
  10760. <![CDATA[Get the <em>queue name</em> of the queue.
  10761. @return <em>queue name</em> of the queue]]>
  10762. </doc>
  10763. </method>
  10764. <method name="getUserAcls" return="java.util.List"
  10765. abstract="true" native="false" synchronized="false"
  10766. static="false" final="false" visibility="public"
  10767. deprecated="not deprecated">
  10768. <doc>
  10769. <![CDATA[Get the list of <code>QueueACL</code> for the given user.
  10770. @return list of <code>QueueACL</code> for the given user]]>
  10771. </doc>
  10772. </method>
  10773. <doc>
  10774. <![CDATA[<p><code>QueueUserACLInfo</code> provides information {@link QueueACL} for
  10775. the given user.</p>
  10776. @see QueueACL
  10777. @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
  10778. </doc>
  10779. </class>
  10780. <!-- end class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
  10781. <!-- start class org.apache.hadoop.yarn.api.records.RejectedSchedulingRequest -->
  10782. <class name="RejectedSchedulingRequest" extends="java.lang.Object"
  10783. abstract="true"
  10784. static="false" final="false" visibility="public"
  10785. deprecated="not deprecated">
  10786. <constructor name="RejectedSchedulingRequest"
  10787. static="false" final="false" visibility="public"
  10788. deprecated="not deprecated">
  10789. </constructor>
  10790. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.RejectedSchedulingRequest"
  10791. abstract="false" native="false" synchronized="false"
  10792. static="true" final="false" visibility="public"
  10793. deprecated="not deprecated">
  10794. <param name="reason" type="org.apache.hadoop.yarn.api.records.RejectionReason"/>
  10795. <param name="request" type="org.apache.hadoop.yarn.api.records.SchedulingRequest"/>
  10796. <doc>
  10797. <![CDATA[Create new RejectedSchedulingRequest.
  10798. @param reason Rejection Reason.
  10799. @param request Rejected Scheduling Request.
  10800. @return RejectedSchedulingRequest.]]>
  10801. </doc>
  10802. </method>
  10803. <method name="getReason" return="org.apache.hadoop.yarn.api.records.RejectionReason"
  10804. abstract="true" native="false" synchronized="false"
  10805. static="false" final="false" visibility="public"
  10806. deprecated="not deprecated">
  10807. <doc>
  10808. <![CDATA[Get Rejection Reason.
  10809. @return Rejection reason.]]>
  10810. </doc>
  10811. </method>
  10812. <method name="setReason"
  10813. abstract="true" native="false" synchronized="false"
  10814. static="false" final="false" visibility="public"
  10815. deprecated="not deprecated">
  10816. <param name="reason" type="org.apache.hadoop.yarn.api.records.RejectionReason"/>
  10817. <doc>
  10818. <![CDATA[Set Rejection Reason.
  10819. @param reason Rejection Reason.]]>
  10820. </doc>
  10821. </method>
  10822. <method name="getRequest" return="org.apache.hadoop.yarn.api.records.SchedulingRequest"
  10823. abstract="true" native="false" synchronized="false"
  10824. static="false" final="false" visibility="public"
  10825. deprecated="not deprecated">
  10826. <doc>
  10827. <![CDATA[Get the Rejected Scheduling Request.
  10828. @return SchedulingRequest.]]>
  10829. </doc>
  10830. </method>
  10831. <method name="setRequest"
  10832. abstract="true" native="false" synchronized="false"
  10833. static="false" final="false" visibility="public"
  10834. deprecated="not deprecated">
  10835. <param name="request" type="org.apache.hadoop.yarn.api.records.SchedulingRequest"/>
  10836. <doc>
  10837. <![CDATA[Set the SchedulingRequest.
  10838. @param request SchedulingRequest.]]>
  10839. </doc>
  10840. </method>
  10841. <doc>
  10842. <![CDATA[This encapsulates a Rejected SchedulingRequest. It contains the offending
  10843. Scheduling Request along with the reason for rejection.]]>
  10844. </doc>
  10845. </class>
  10846. <!-- end class org.apache.hadoop.yarn.api.records.RejectedSchedulingRequest -->
  10847. <!-- start class org.apache.hadoop.yarn.api.records.RejectionReason -->
  10848. <class name="RejectionReason" extends="java.lang.Enum"
  10849. abstract="false"
  10850. static="false" final="true" visibility="public"
  10851. deprecated="not deprecated">
  10852. <method name="values" return="org.apache.hadoop.yarn.api.records.RejectionReason[]"
  10853. abstract="false" native="false" synchronized="false"
  10854. static="true" final="false" visibility="public"
  10855. deprecated="not deprecated">
  10856. </method>
  10857. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.RejectionReason"
  10858. abstract="false" native="false" synchronized="false"
  10859. static="true" final="false" visibility="public"
  10860. deprecated="not deprecated">
  10861. <param name="name" type="java.lang.String"/>
  10862. </method>
  10863. <doc>
  10864. <![CDATA[Reason for rejecting a Scheduling Request.]]>
  10865. </doc>
  10866. </class>
  10867. <!-- end class org.apache.hadoop.yarn.api.records.RejectionReason -->
  10868. <!-- start class org.apache.hadoop.yarn.api.records.ReservationACL -->
  10869. <class name="ReservationACL" extends="java.lang.Enum"
  10870. abstract="false"
  10871. static="false" final="true" visibility="public"
  10872. deprecated="not deprecated">
  10873. <method name="values" return="org.apache.hadoop.yarn.api.records.ReservationACL[]"
  10874. abstract="false" native="false" synchronized="false"
  10875. static="true" final="false" visibility="public"
  10876. deprecated="not deprecated">
  10877. </method>
  10878. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ReservationACL"
  10879. abstract="false" native="false" synchronized="false"
  10880. static="true" final="false" visibility="public"
  10881. deprecated="not deprecated">
  10882. <param name="name" type="java.lang.String"/>
  10883. </method>
  10884. <doc>
  10885. <![CDATA[{@code ReservationACL} enumerates the various ACLs for reservations.
  10886. <p>
  10887. The ACL is one of:
  10888. <ul>
  10889. <li>
  10890. {@link #ADMINISTER_RESERVATIONS} - ACL to create, list, update and
  10891. delete reservations.
  10892. </li>
  10893. <li> {@link #LIST_RESERVATIONS} - ACL to list reservations. </li>
  10894. <li> {@link #SUBMIT_RESERVATIONS} - ACL to create reservations. </li>
  10895. </ul>
  10896. Users can always list, update and delete their own reservations.]]>
  10897. </doc>
  10898. </class>
  10899. <!-- end class org.apache.hadoop.yarn.api.records.ReservationACL -->
  10900. <!-- start class org.apache.hadoop.yarn.api.records.ReservationAllocationState -->
  10901. <class name="ReservationAllocationState" extends="java.lang.Object"
  10902. abstract="true"
  10903. static="false" final="false" visibility="public"
  10904. deprecated="not deprecated">
  10905. <constructor name="ReservationAllocationState"
  10906. static="false" final="false" visibility="public"
  10907. deprecated="not deprecated">
  10908. </constructor>
  10909. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationAllocationState"
  10910. abstract="false" native="false" synchronized="false"
  10911. static="true" final="false" visibility="public"
  10912. deprecated="not deprecated">
  10913. <param name="acceptanceTime" type="long"/>
  10914. <param name="user" type="java.lang.String"/>
  10915. <param name="resourceAllocations" type="java.util.List"/>
  10916. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  10917. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  10918. <doc>
  10919. <![CDATA[@param acceptanceTime The acceptance time of the reservation.
  10920. @param user The username of the user who made the reservation.
  10921. @param resourceAllocations List of {@link ResourceAllocationRequest}
  10922. representing the current state of the
  10923. reservation resource allocations. This is
  10924. subject to change in the event of re-planning.
  10925. @param reservationId {@link ReservationId } of the reservation being
  10926. listed.
  10927. @param reservationDefinition {@link ReservationDefinition} used to make
  10928. the reservation.
  10929. @return {@code ReservationAllocationState} that represents the state of
  10930. the reservation.]]>
  10931. </doc>
  10932. </method>
  10933. <method name="getAcceptanceTime" return="long"
  10934. abstract="true" native="false" synchronized="false"
  10935. static="false" final="false" visibility="public"
  10936. deprecated="not deprecated">
  10937. <doc>
  10938. <![CDATA[Get the acceptance time of the reservation.
  10939. @return the time that the reservation was accepted.]]>
  10940. </doc>
  10941. </method>
  10942. <method name="getUser" return="java.lang.String"
  10943. abstract="true" native="false" synchronized="false"
  10944. static="false" final="false" visibility="public"
  10945. deprecated="not deprecated">
  10946. <doc>
  10947. <![CDATA[Get the user who made the reservation.
  10948. @return the name of the user who made the reservation.]]>
  10949. </doc>
  10950. </method>
  10951. <method name="getResourceAllocationRequests" return="java.util.List"
  10952. abstract="true" native="false" synchronized="false"
  10953. static="false" final="false" visibility="public"
  10954. deprecated="not deprecated">
  10955. <doc>
  10956. <![CDATA[Get the Resource allocations of the reservation based on the current state
  10957. of the plan. This is subject to change in the event of re-planning.
  10958. The allocations will be constraint to the user contract as described by
  10959. the {@link ReservationDefinition}
  10960. @return a list of resource allocations for the reservation.]]>
  10961. </doc>
  10962. </method>
  10963. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  10964. abstract="true" native="false" synchronized="false"
  10965. static="false" final="false" visibility="public"
  10966. deprecated="not deprecated">
  10967. <doc>
  10968. <![CDATA[Get the id of the reservation.
  10969. @return the reservation id corresponding to the reservation.]]>
  10970. </doc>
  10971. </method>
  10972. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  10973. abstract="true" native="false" synchronized="false"
  10974. static="false" final="false" visibility="public"
  10975. deprecated="not deprecated">
  10976. <doc>
  10977. <![CDATA[Get the reservation definition used to make the reservation.
  10978. @return the reservation definition used to make the reservation.]]>
  10979. </doc>
  10980. </method>
  10981. <doc>
  10982. <![CDATA[{@code ReservationAllocationState} represents the reservation that is
  10983. made by a user.
  10984. <p>
  10985. It includes:
  10986. <ul>
  10987. <li>Duration of the reservation.</li>
  10988. <li>Acceptance time of the duration.</li>
  10989. <li>
  10990. List of {@link ResourceAllocationRequest}, which includes the time
  10991. interval, and capability of the allocation.
  10992. {@code ResourceAllocationRequest} represents an allocation
  10993. made for a reservation for the current state of the queue. This can be
  10994. changed for reasons such as re-planning, but will always be subject to
  10995. the constraints of the user contract as described by
  10996. {@link ReservationDefinition}
  10997. </li>
  10998. <li>{@link ReservationId} of the reservation.</li>
  10999. <li>{@link ReservationDefinition} used to make the reservation.</li>
  11000. </ul>
  11001. @see ResourceAllocationRequest
  11002. @see ReservationId
  11003. @see ReservationDefinition]]>
  11004. </doc>
  11005. </class>
  11006. <!-- end class org.apache.hadoop.yarn.api.records.ReservationAllocationState -->
  11007. <!-- start class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
  11008. <class name="ReservationDefinition" extends="java.lang.Object"
  11009. abstract="true"
  11010. static="false" final="false" visibility="public"
  11011. deprecated="not deprecated">
  11012. <constructor name="ReservationDefinition"
  11013. static="false" final="false" visibility="public"
  11014. deprecated="not deprecated">
  11015. </constructor>
  11016. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  11017. abstract="false" native="false" synchronized="false"
  11018. static="true" final="false" visibility="public"
  11019. deprecated="not deprecated">
  11020. <param name="arrival" type="long"/>
  11021. <param name="deadline" type="long"/>
  11022. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  11023. <param name="name" type="java.lang.String"/>
  11024. <param name="recurrenceExpression" type="java.lang.String"/>
  11025. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  11026. </method>
  11027. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  11028. abstract="false" native="false" synchronized="false"
  11029. static="true" final="false" visibility="public"
  11030. deprecated="not deprecated">
  11031. <param name="arrival" type="long"/>
  11032. <param name="deadline" type="long"/>
  11033. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  11034. <param name="name" type="java.lang.String"/>
  11035. </method>
  11036. <method name="getArrival" return="long"
  11037. abstract="true" native="false" synchronized="false"
  11038. static="false" final="false" visibility="public"
  11039. deprecated="not deprecated">
  11040. <doc>
  11041. <![CDATA[Get the arrival time or the earliest time from which the resource(s) can be
  11042. allocated. Time expressed as UTC.
  11043. @return the earliest valid time for this reservation]]>
  11044. </doc>
  11045. </method>
  11046. <method name="setArrival"
  11047. abstract="true" native="false" synchronized="false"
  11048. static="false" final="false" visibility="public"
  11049. deprecated="not deprecated">
  11050. <param name="earliestStartTime" type="long"/>
  11051. <doc>
  11052. <![CDATA[Set the arrival time or the earliest time from which the resource(s) can be
  11053. allocated. Time expressed as UTC.
  11054. @param earliestStartTime the earliest valid time for this reservation]]>
  11055. </doc>
  11056. </method>
  11057. <method name="getDeadline" return="long"
  11058. abstract="true" native="false" synchronized="false"
  11059. static="false" final="false" visibility="public"
  11060. deprecated="not deprecated">
  11061. <doc>
  11062. <![CDATA[Get the deadline or the latest time by when the resource(s) must be
  11063. allocated. Time expressed as UTC.
  11064. @return the deadline or the latest time by when the resource(s) must be
  11065. allocated]]>
  11066. </doc>
  11067. </method>
  11068. <method name="setDeadline"
  11069. abstract="true" native="false" synchronized="false"
  11070. static="false" final="false" visibility="public"
  11071. deprecated="not deprecated">
  11072. <param name="latestEndTime" type="long"/>
  11073. <doc>
  11074. <![CDATA[Set the deadline or the latest time by when the resource(s) must be
  11075. allocated. Time expressed as UTC.
  11076. @param latestEndTime the deadline or the latest time by when the
  11077. resource(s) should be allocated]]>
  11078. </doc>
  11079. </method>
  11080. <method name="getReservationRequests" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
  11081. abstract="true" native="false" synchronized="false"
  11082. static="false" final="false" visibility="public"
  11083. deprecated="not deprecated">
  11084. <doc>
  11085. <![CDATA[Get the list of {@link ReservationRequests} representing the resources
  11086. required by the application
  11087. @return the list of {@link ReservationRequests}]]>
  11088. </doc>
  11089. </method>
  11090. <method name="setReservationRequests"
  11091. abstract="true" native="false" synchronized="false"
  11092. static="false" final="false" visibility="public"
  11093. deprecated="not deprecated">
  11094. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  11095. <doc>
  11096. <![CDATA[Set the list of {@link ReservationRequests} representing the resources
  11097. required by the application
  11098. @param reservationRequests the list of {@link ReservationRequests}]]>
  11099. </doc>
  11100. </method>
  11101. <method name="getReservationName" return="java.lang.String"
  11102. abstract="true" native="false" synchronized="false"
  11103. static="false" final="false" visibility="public"
  11104. deprecated="not deprecated">
  11105. <doc>
  11106. <![CDATA[Get the name for this reservation. The name need-not be unique, and it is
  11107. just a mnemonic for the user (akin to job names). Accepted reservations are
  11108. uniquely identified by a system-generated ReservationId.
  11109. @return string representing the name of the corresponding reserved resource
  11110. allocation in the scheduler]]>
  11111. </doc>
  11112. </method>
  11113. <method name="setReservationName"
  11114. abstract="true" native="false" synchronized="false"
  11115. static="false" final="false" visibility="public"
  11116. deprecated="not deprecated">
  11117. <param name="name" type="java.lang.String"/>
  11118. <doc>
  11119. <![CDATA[Set the name for this reservation. The name need-not be unique, and it is
  11120. just a mnemonic for the user (akin to job names). Accepted reservations are
  11121. uniquely identified by a system-generated ReservationId.
  11122. @param name representing the name of the corresponding reserved resource
  11123. allocation in the scheduler]]>
  11124. </doc>
  11125. </method>
  11126. <method name="getRecurrenceExpression" return="java.lang.String"
  11127. abstract="true" native="false" synchronized="false"
  11128. static="false" final="false" visibility="public"
  11129. deprecated="not deprecated">
  11130. <doc>
  11131. <![CDATA[Get the recurrence of this reservation representing the time period of
  11132. the periodic job. Currently, only long values are supported. Later,
  11133. support for regular expressions denoting arbitrary recurrence patterns
  11134. (e.g., every Tuesday and Thursday) will be added.
  11135. Recurrence is represented in milliseconds for periodic jobs.
  11136. Recurrence is 0 for non-periodic jobs. Periodic jobs are valid until they
  11137. are explicitly cancelled and have higher priority than non-periodic jobs
  11138. (during initial placement and replanning). Periodic job allocations are
  11139. consistent across runs (flexibility in allocation is leveraged only during
  11140. initial placement, allocations remain consistent thereafter). Note that
  11141. as a long, the recurrence expression must be greater than the duration of
  11142. the reservation (deadline - arrival). Also note that the configured max
  11143. period must be divisible by the recurrence expression if expressed as a
  11144. long.
  11145. @return recurrence of this reservation]]>
  11146. </doc>
  11147. </method>
  11148. <method name="setRecurrenceExpression"
  11149. abstract="true" native="false" synchronized="false"
  11150. static="false" final="false" visibility="public"
  11151. deprecated="not deprecated">
  11152. <param name="recurrenceExpression" type="java.lang.String"/>
  11153. <doc>
  11154. <![CDATA[Set the recurrence of this reservation representing the time period of
  11155. the periodic job. Currently, only long values are supported. Later,
  11156. support for regular expressions denoting arbitrary recurrence patterns
  11157. (e.g., every Tuesday and Thursday) will be added.
  11158. Recurrence is represented in milliseconds for periodic jobs.
  11159. Recurrence is 0 for non-periodic jobs. Periodic jobs are valid until they
  11160. are explicitly cancelled and have higher priority than non-periodic jobs
  11161. (during initial placement and replanning). Periodic job allocations are
  11162. consistent across runs (flexibility in allocation is leveraged only during
  11163. initial placement, allocations remain consistent thereafter). Note that
  11164. as a long, the recurrence expression must be greater than the duration of
  11165. the reservation (deadline - arrival). Also note that the configured max
  11166. period must be divisible by the recurrence expression if expressed as a
  11167. long.
  11168. @param recurrenceExpression recurrence interval of this reservation]]>
  11169. </doc>
  11170. </method>
  11171. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  11172. abstract="true" native="false" synchronized="false"
  11173. static="false" final="false" visibility="public"
  11174. deprecated="not deprecated">
  11175. <doc>
  11176. <![CDATA[Get the priority for this reservation. A lower number for priority
  11177. indicates a higher priority reservation. Recurring reservations are
  11178. always higher priority than non-recurring reservations. Priority for
  11179. non-recurring reservations are only compared with non-recurring
  11180. reservations. Likewise for recurring reservations.
  11181. @return int representing the priority of the reserved resource
  11182. allocation in the scheduler]]>
  11183. </doc>
  11184. </method>
  11185. <method name="setPriority"
  11186. abstract="true" native="false" synchronized="false"
  11187. static="false" final="false" visibility="public"
  11188. deprecated="not deprecated">
  11189. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  11190. <doc>
  11191. <![CDATA[Set the priority for this reservation. A lower number for priority
  11192. indicates a higher priority reservation. Recurring reservations are
  11193. always higher priority than non-recurring reservations. Priority for
  11194. non-recurring reservations are only compared with non-recurring
  11195. reservations. Likewise for recurring reservations.
  11196. @param priority representing the priority of the reserved resource
  11197. allocation in the scheduler]]>
  11198. </doc>
  11199. </method>
  11200. <doc>
  11201. <![CDATA[{@link ReservationDefinition} captures the set of resource and time
  11202. constraints the user cares about regarding a reservation.
  11203. @see ResourceRequest]]>
  11204. </doc>
  11205. </class>
  11206. <!-- end class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
  11207. <!-- start class org.apache.hadoop.yarn.api.records.ReservationId -->
  11208. <class name="ReservationId" extends="java.lang.Object"
  11209. abstract="true"
  11210. static="false" final="false" visibility="public"
  11211. deprecated="not deprecated">
  11212. <implements name="java.lang.Comparable"/>
  11213. <constructor name="ReservationId"
  11214. static="false" final="false" visibility="public"
  11215. deprecated="not deprecated">
  11216. </constructor>
  11217. <method name="getId" return="long"
  11218. abstract="true" native="false" synchronized="false"
  11219. static="false" final="false" visibility="public"
  11220. deprecated="not deprecated">
  11221. <doc>
  11222. <![CDATA[Get the long identifier of the {@link ReservationId} which is unique for
  11223. all Reservations started by a particular instance of the
  11224. {@code ResourceManager}.
  11225. @return long identifier of the {@link ReservationId}]]>
  11226. </doc>
  11227. </method>
  11228. <method name="getClusterTimestamp" return="long"
  11229. abstract="true" native="false" synchronized="false"
  11230. static="false" final="false" visibility="public"
  11231. deprecated="not deprecated">
  11232. <doc>
  11233. <![CDATA[Get the <em>start time</em> of the {@code ResourceManager} which is used to
  11234. generate globally unique {@link ReservationId}.
  11235. @return <em>start time</em> of the {@code ResourceManager}]]>
  11236. </doc>
  11237. </method>
  11238. <method name="build"
  11239. abstract="true" native="false" synchronized="false"
  11240. static="false" final="false" visibility="protected"
  11241. deprecated="not deprecated">
  11242. </method>
  11243. <method name="compareTo" return="int"
  11244. abstract="false" native="false" synchronized="false"
  11245. static="false" final="false" visibility="public"
  11246. deprecated="not deprecated">
  11247. <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  11248. </method>
  11249. <method name="toString" return="java.lang.String"
  11250. abstract="false" native="false" synchronized="false"
  11251. static="false" final="false" visibility="public"
  11252. deprecated="not deprecated">
  11253. </method>
  11254. <method name="parseReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  11255. abstract="false" native="false" synchronized="false"
  11256. static="true" final="false" visibility="public"
  11257. deprecated="not deprecated">
  11258. <param name="reservationId" type="java.lang.String"/>
  11259. <exception name="IOException" type="java.io.IOException"/>
  11260. <doc>
  11261. <![CDATA[Parse the string argument as a {@link ReservationId}
  11262. @param reservationId the string representation of the {@link ReservationId}
  11263. @return the {@link ReservationId} corresponding to the input string if
  11264. valid, null if input is null
  11265. @throws IOException if unable to parse the input string]]>
  11266. </doc>
  11267. </method>
  11268. <method name="hashCode" return="int"
  11269. abstract="false" native="false" synchronized="false"
  11270. static="false" final="false" visibility="public"
  11271. deprecated="not deprecated">
  11272. </method>
  11273. <method name="equals" return="boolean"
  11274. abstract="false" native="false" synchronized="false"
  11275. static="false" final="false" visibility="public"
  11276. deprecated="not deprecated">
  11277. <param name="obj" type="java.lang.Object"/>
  11278. </method>
  11279. <field name="reserveIdStrPrefix" type="java.lang.String"
  11280. transient="false" volatile="false"
  11281. static="true" final="true" visibility="public"
  11282. deprecated="not deprecated">
  11283. </field>
  11284. <field name="clusterTimestamp" type="long"
  11285. transient="false" volatile="false"
  11286. static="false" final="false" visibility="protected"
  11287. deprecated="not deprecated">
  11288. </field>
  11289. <field name="id" type="long"
  11290. transient="false" volatile="false"
  11291. static="false" final="false" visibility="protected"
  11292. deprecated="not deprecated">
  11293. </field>
  11294. <doc>
  11295. <![CDATA[<p>
  11296. {@link ReservationId} represents the <em>globally unique</em> identifier for
  11297. a reservation.
  11298. </p>
  11299. <p>
  11300. The globally unique nature of the identifier is achieved by using the
  11301. <em>cluster timestamp</em> i.e. start-time of the {@code ResourceManager}
  11302. along with a monotonically increasing counter for the reservation.
  11303. </p>]]>
  11304. </doc>
  11305. </class>
  11306. <!-- end class org.apache.hadoop.yarn.api.records.ReservationId -->
  11307. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest -->
  11308. <class name="ReservationRequest" extends="java.lang.Object"
  11309. abstract="true"
  11310. static="false" final="false" visibility="public"
  11311. deprecated="not deprecated">
  11312. <implements name="java.lang.Comparable"/>
  11313. <constructor name="ReservationRequest"
  11314. static="false" final="false" visibility="public"
  11315. deprecated="not deprecated">
  11316. </constructor>
  11317. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
  11318. abstract="false" native="false" synchronized="false"
  11319. static="true" final="false" visibility="public"
  11320. deprecated="not deprecated">
  11321. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11322. <param name="numContainers" type="int"/>
  11323. </method>
  11324. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
  11325. abstract="false" native="false" synchronized="false"
  11326. static="true" final="false" visibility="public"
  11327. deprecated="not deprecated">
  11328. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11329. <param name="numContainers" type="int"/>
  11330. <param name="concurrency" type="int"/>
  11331. <param name="duration" type="long"/>
  11332. </method>
  11333. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  11334. abstract="true" native="false" synchronized="false"
  11335. static="false" final="false" visibility="public"
  11336. deprecated="not deprecated">
  11337. <doc>
  11338. <![CDATA[Get the {@link Resource} capability of the request.
  11339. @return {@link Resource} capability of the request]]>
  11340. </doc>
  11341. </method>
  11342. <method name="setCapability"
  11343. abstract="true" native="false" synchronized="false"
  11344. static="false" final="false" visibility="public"
  11345. deprecated="not deprecated">
  11346. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11347. <doc>
  11348. <![CDATA[Set the {@link Resource} capability of the request
  11349. @param capability {@link Resource} capability of the request]]>
  11350. </doc>
  11351. </method>
  11352. <method name="getNumContainers" return="int"
  11353. abstract="true" native="false" synchronized="false"
  11354. static="false" final="false" visibility="public"
  11355. deprecated="not deprecated">
  11356. <doc>
  11357. <![CDATA[Get the number of containers required with the given specifications.
  11358. @return number of containers required with the given specifications]]>
  11359. </doc>
  11360. </method>
  11361. <method name="setNumContainers"
  11362. abstract="true" native="false" synchronized="false"
  11363. static="false" final="false" visibility="public"
  11364. deprecated="not deprecated">
  11365. <param name="numContainers" type="int"/>
  11366. <doc>
  11367. <![CDATA[Set the number of containers required with the given specifications
  11368. @param numContainers number of containers required with the given
  11369. specifications]]>
  11370. </doc>
  11371. </method>
  11372. <method name="getConcurrency" return="int"
  11373. abstract="true" native="false" synchronized="false"
  11374. static="false" final="false" visibility="public"
  11375. deprecated="not deprecated">
  11376. <doc>
  11377. <![CDATA[Get the number of containers that need to be scheduled concurrently. The
  11378. default value of 1 would fall back to the current non concurrency
  11379. constraints on the scheduling behavior.
  11380. @return the number of containers to be concurrently scheduled]]>
  11381. </doc>
  11382. </method>
  11383. <method name="setConcurrency"
  11384. abstract="true" native="false" synchronized="false"
  11385. static="false" final="false" visibility="public"
  11386. deprecated="not deprecated">
  11387. <param name="numContainers" type="int"/>
  11388. <doc>
  11389. <![CDATA[Set the number of containers that need to be scheduled concurrently. The
  11390. default value of 1 would fall back to the current non concurrency
  11391. constraints on the scheduling behavior.
  11392. @param numContainers the number of containers to be concurrently scheduled]]>
  11393. </doc>
  11394. </method>
  11395. <method name="getDuration" return="long"
  11396. abstract="true" native="false" synchronized="false"
  11397. static="false" final="false" visibility="public"
  11398. deprecated="not deprecated">
  11399. <doc>
  11400. <![CDATA[Get the duration in milliseconds for which the resource is required. A
  11401. default value of -1, indicates an unspecified lease duration, and fallback
  11402. to current behavior.
  11403. @return the duration in milliseconds for which the resource is required]]>
  11404. </doc>
  11405. </method>
  11406. <method name="setDuration"
  11407. abstract="true" native="false" synchronized="false"
  11408. static="false" final="false" visibility="public"
  11409. deprecated="not deprecated">
  11410. <param name="duration" type="long"/>
  11411. <doc>
  11412. <![CDATA[Set the duration in milliseconds for which the resource is required.
  11413. @param duration the duration in milliseconds for which the resource is
  11414. required]]>
  11415. </doc>
  11416. </method>
  11417. <method name="hashCode" return="int"
  11418. abstract="false" native="false" synchronized="false"
  11419. static="false" final="false" visibility="public"
  11420. deprecated="not deprecated">
  11421. </method>
  11422. <method name="equals" return="boolean"
  11423. abstract="false" native="false" synchronized="false"
  11424. static="false" final="false" visibility="public"
  11425. deprecated="not deprecated">
  11426. <param name="obj" type="java.lang.Object"/>
  11427. </method>
  11428. <method name="compareTo" return="int"
  11429. abstract="false" native="false" synchronized="false"
  11430. static="false" final="false" visibility="public"
  11431. deprecated="not deprecated">
  11432. <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  11433. </method>
  11434. <doc>
  11435. <![CDATA[{@link ReservationRequest} represents the request made by an application to
  11436. the {@code ResourceManager} to reserve {@link Resource}s.
  11437. <p>
  11438. It includes:
  11439. <ul>
  11440. <li>{@link Resource} required for each request.</li>
  11441. <li>
  11442. Number of containers, of above specifications, which are required by the
  11443. application.
  11444. </li>
  11445. <li>Concurrency that indicates the gang size of the request.</li>
  11446. </ul>]]>
  11447. </doc>
  11448. </class>
  11449. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest -->
  11450. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
  11451. <class name="ReservationRequest.ReservationRequestComparator" extends="java.lang.Object"
  11452. abstract="false"
  11453. static="true" final="false" visibility="public"
  11454. deprecated="not deprecated">
  11455. <implements name="java.util.Comparator"/>
  11456. <implements name="java.io.Serializable"/>
  11457. <constructor name="ReservationRequestComparator"
  11458. static="false" final="false" visibility="public"
  11459. deprecated="not deprecated">
  11460. </constructor>
  11461. <method name="compare" return="int"
  11462. abstract="false" native="false" synchronized="false"
  11463. static="false" final="false" visibility="public"
  11464. deprecated="not deprecated">
  11465. <param name="r1" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  11466. <param name="r2" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  11467. </method>
  11468. </class>
  11469. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
  11470. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
  11471. <class name="ReservationRequestInterpreter" extends="java.lang.Enum"
  11472. abstract="false"
  11473. static="false" final="true" visibility="public"
  11474. deprecated="not deprecated">
  11475. <method name="values" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter[]"
  11476. abstract="false" native="false" synchronized="false"
  11477. static="true" final="false" visibility="public"
  11478. deprecated="not deprecated">
  11479. </method>
  11480. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
  11481. abstract="false" native="false" synchronized="false"
  11482. static="true" final="false" visibility="public"
  11483. deprecated="not deprecated">
  11484. <param name="name" type="java.lang.String"/>
  11485. </method>
  11486. <doc>
  11487. <![CDATA[Enumeration of various types of dependencies among multiple
  11488. {@link ReservationRequests} within one {@link ReservationDefinition} (from
  11489. least constraining to most constraining).]]>
  11490. </doc>
  11491. </class>
  11492. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
  11493. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequests -->
  11494. <class name="ReservationRequests" extends="java.lang.Object"
  11495. abstract="true"
  11496. static="false" final="false" visibility="public"
  11497. deprecated="not deprecated">
  11498. <constructor name="ReservationRequests"
  11499. static="false" final="false" visibility="public"
  11500. deprecated="not deprecated">
  11501. </constructor>
  11502. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
  11503. abstract="false" native="false" synchronized="false"
  11504. static="true" final="false" visibility="public"
  11505. deprecated="not deprecated">
  11506. <param name="reservationResources" type="java.util.List"/>
  11507. <param name="type" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
  11508. </method>
  11509. <method name="getReservationResources" return="java.util.List"
  11510. abstract="true" native="false" synchronized="false"
  11511. static="false" final="false" visibility="public"
  11512. deprecated="not deprecated">
  11513. <doc>
  11514. <![CDATA[Get the list of {@link ReservationRequest} representing the resources
  11515. required by the application
  11516. @return the list of {@link ReservationRequest}]]>
  11517. </doc>
  11518. </method>
  11519. <method name="setReservationResources"
  11520. abstract="true" native="false" synchronized="false"
  11521. static="false" final="false" visibility="public"
  11522. deprecated="not deprecated">
  11523. <param name="reservationResources" type="java.util.List"/>
  11524. <doc>
  11525. <![CDATA[Set the list of {@link ReservationRequest} representing the resources
  11526. required by the application
  11527. @param reservationResources the list of {@link ReservationRequest}]]>
  11528. </doc>
  11529. </method>
  11530. <method name="getInterpreter" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
  11531. abstract="true" native="false" synchronized="false"
  11532. static="false" final="false" visibility="public"
  11533. deprecated="not deprecated">
  11534. <doc>
  11535. <![CDATA[Get the {@link ReservationRequestInterpreter}, representing how the list of
  11536. resources should be allocated, this captures temporal ordering and other
  11537. constraints.
  11538. @return the list of {@link ReservationRequestInterpreter}]]>
  11539. </doc>
  11540. </method>
  11541. <method name="setInterpreter"
  11542. abstract="true" native="false" synchronized="false"
  11543. static="false" final="false" visibility="public"
  11544. deprecated="not deprecated">
  11545. <param name="interpreter" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
  11546. <doc>
  11547. <![CDATA[Set the {@link ReservationRequestInterpreter}, representing how the list of
  11548. resources should be allocated, this captures temporal ordering and other
  11549. constraints.
  11550. @param interpreter the {@link ReservationRequestInterpreter} for this
  11551. reservation]]>
  11552. </doc>
  11553. </method>
  11554. <doc>
  11555. <![CDATA[{@link ReservationRequests} captures the set of resource and constraints the
  11556. user cares about regarding a reservation.
  11557. @see ReservationRequest]]>
  11558. </doc>
  11559. </class>
  11560. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequests -->
  11561. <!-- start class org.apache.hadoop.yarn.api.records.Resource -->
  11562. <class name="Resource" extends="java.lang.Object"
  11563. abstract="true"
  11564. static="false" final="false" visibility="public"
  11565. deprecated="not deprecated">
  11566. <implements name="java.lang.Comparable"/>
  11567. <constructor name="Resource"
  11568. static="false" final="false" visibility="public"
  11569. deprecated="not deprecated">
  11570. </constructor>
  11571. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
  11572. abstract="false" native="false" synchronized="false"
  11573. static="true" final="false" visibility="public"
  11574. deprecated="not deprecated">
  11575. <param name="memory" type="int"/>
  11576. <param name="vCores" type="int"/>
  11577. </method>
  11578. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
  11579. abstract="false" native="false" synchronized="false"
  11580. static="true" final="false" visibility="public"
  11581. deprecated="not deprecated">
  11582. <param name="memory" type="long"/>
  11583. <param name="vCores" type="int"/>
  11584. </method>
  11585. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
  11586. abstract="false" native="false" synchronized="false"
  11587. static="true" final="false" visibility="public"
  11588. deprecated="not deprecated">
  11589. <param name="memory" type="long"/>
  11590. <param name="vCores" type="int"/>
  11591. <param name="others" type="java.util.Map"/>
  11592. <doc>
  11593. <![CDATA[Create a new {@link Resource} instance with the given CPU and memory
  11594. values and additional resource values as set in the {@code others}
  11595. parameter. Note that the CPU and memory settings in the {@code others}
  11596. parameter will be ignored.
  11597. @param memory the memory value
  11598. @param vCores the CPU value
  11599. @param others a map of other resource values indexed by resource name
  11600. @return a {@link Resource} instance with the given resource values]]>
  11601. </doc>
  11602. </method>
  11603. <method name="getMemory" return="int"
  11604. abstract="true" native="false" synchronized="false"
  11605. static="false" final="false" visibility="public"
  11606. deprecated="not deprecated">
  11607. <doc>
  11608. <![CDATA[This method is DEPRECATED:
  11609. Use {@link Resource#getMemorySize()} instead
  11610. Get <em>memory</em> of the resource. Note - while memory has
  11611. never had a unit specified, all YARN configurations have specified memory
  11612. in MB. The assumption has been that the daemons and applications are always
  11613. using the same units. With the introduction of the ResourceInformation
  11614. class we have support for units - so this function will continue to return
  11615. memory but in the units of MB
  11616. @return <em>memory</em>(in MB) of the resource]]>
  11617. </doc>
  11618. </method>
  11619. <method name="getMemorySize" return="long"
  11620. abstract="false" native="false" synchronized="false"
  11621. static="false" final="false" visibility="public"
  11622. deprecated="not deprecated">
  11623. <doc>
  11624. <![CDATA[Get <em>memory</em> of the resource. Note - while memory has
  11625. never had a unit specified, all YARN configurations have specified memory
  11626. in MB. The assumption has been that the daemons and applications are always
  11627. using the same units. With the introduction of the ResourceInformation
  11628. class we have support for units - so this function will continue to return
  11629. memory but in the units of MB
  11630. @return <em>memory</em> of the resource]]>
  11631. </doc>
  11632. </method>
  11633. <method name="setMemory"
  11634. abstract="true" native="false" synchronized="false"
  11635. static="false" final="false" visibility="public"
  11636. deprecated="not deprecated">
  11637. <param name="memory" type="int"/>
  11638. <doc>
  11639. <![CDATA[Set <em>memory</em> of the resource. Note - while memory has
  11640. never had a unit specified, all YARN configurations have specified memory
  11641. in MB. The assumption has been that the daemons and applications are always
  11642. using the same units. With the introduction of the ResourceInformation
  11643. class we have support for units - so this function will continue to set
  11644. memory but the assumption is that the value passed is in units of MB.
  11645. @param memory <em>memory</em>(in MB) of the resource]]>
  11646. </doc>
  11647. </method>
  11648. <method name="setMemorySize"
  11649. abstract="false" native="false" synchronized="false"
  11650. static="false" final="false" visibility="public"
  11651. deprecated="not deprecated">
  11652. <param name="memory" type="long"/>
  11653. <doc>
  11654. <![CDATA[Set <em>memory</em> of the resource.
  11655. @param memory <em>memory</em> of the resource]]>
  11656. </doc>
  11657. </method>
  11658. <method name="getVirtualCores" return="int"
  11659. abstract="true" native="false" synchronized="false"
  11660. static="false" final="false" visibility="public"
  11661. deprecated="not deprecated">
  11662. <doc>
  11663. <![CDATA[Get <em>number of virtual cpu cores</em> of the resource.
  11664. Virtual cores are a unit for expressing CPU parallelism. A node's capacity
  11665. should be configured with virtual cores equal to its number of physical
  11666. cores. A container should be requested with the number of cores it can
  11667. saturate, i.e. the average number of threads it expects to have runnable
  11668. at a time.
  11669. @return <em>num of virtual cpu cores</em> of the resource]]>
  11670. </doc>
  11671. </method>
  11672. <method name="setVirtualCores"
  11673. abstract="true" native="false" synchronized="false"
  11674. static="false" final="false" visibility="public"
  11675. deprecated="not deprecated">
  11676. <param name="vCores" type="int"/>
  11677. <doc>
  11678. <![CDATA[Set <em>number of virtual cpu cores</em> of the resource.
  11679. Virtual cores are a unit for expressing CPU parallelism. A node's capacity
  11680. should be configured with virtual cores equal to its number of physical
  11681. cores. A container should be requested with the number of cores it can
  11682. saturate, i.e. the average number of threads it expects to have runnable
  11683. at a time.
  11684. @param vCores <em>number of virtual cpu cores</em> of the resource]]>
  11685. </doc>
  11686. </method>
  11687. <method name="getResourceInformation" return="org.apache.hadoop.yarn.api.records.ResourceInformation"
  11688. abstract="false" native="false" synchronized="false"
  11689. static="false" final="false" visibility="public"
  11690. deprecated="not deprecated">
  11691. <param name="resource" type="java.lang.String"/>
  11692. <doc>
  11693. <![CDATA[Get ResourceInformation for a specified resource.
  11694. @param resource name of the resource
  11695. @return the ResourceInformation object for the resource]]>
  11696. </doc>
  11697. </method>
  11698. <method name="getResourceValue" return="long"
  11699. abstract="false" native="false" synchronized="false"
  11700. static="false" final="false" visibility="public"
  11701. deprecated="not deprecated">
  11702. <param name="resource" type="java.lang.String"/>
  11703. <doc>
  11704. <![CDATA[Get the value for a specified resource. No information about the units is
  11705. returned.
  11706. @param resource name of the resource
  11707. @return the value for the resource]]>
  11708. </doc>
  11709. </method>
  11710. <method name="setResourceInformation"
  11711. abstract="false" native="false" synchronized="false"
  11712. static="false" final="false" visibility="public"
  11713. deprecated="not deprecated">
  11714. <param name="resource" type="java.lang.String"/>
  11715. <param name="resourceInformation" type="org.apache.hadoop.yarn.api.records.ResourceInformation"/>
  11716. <doc>
  11717. <![CDATA[Set the ResourceInformation object for a particular resource.
  11718. @param resource the resource for which the ResourceInformation is provided
  11719. @param resourceInformation ResourceInformation object]]>
  11720. </doc>
  11721. </method>
  11722. <method name="setResourceValue"
  11723. abstract="false" native="false" synchronized="false"
  11724. static="false" final="false" visibility="public"
  11725. deprecated="not deprecated">
  11726. <param name="resource" type="java.lang.String"/>
  11727. <param name="value" type="long"/>
  11728. <doc>
  11729. <![CDATA[Set the value of a resource in the ResourceInformation object. The unit of
  11730. the value is assumed to be the one in the ResourceInformation object.
  11731. @param resource the resource for which the value is provided.
  11732. @param value the value to set]]>
  11733. </doc>
  11734. </method>
  11735. <method name="throwExceptionWhenArrayOutOfBound"
  11736. abstract="false" native="false" synchronized="false"
  11737. static="false" final="false" visibility="protected"
  11738. deprecated="not deprecated">
  11739. <param name="index" type="int"/>
  11740. </method>
  11741. <method name="equals" return="boolean"
  11742. abstract="false" native="false" synchronized="false"
  11743. static="false" final="false" visibility="public"
  11744. deprecated="not deprecated">
  11745. <param name="obj" type="java.lang.Object"/>
  11746. </method>
  11747. <method name="compareTo" return="int"
  11748. abstract="false" native="false" synchronized="false"
  11749. static="false" final="false" visibility="public"
  11750. deprecated="not deprecated">
  11751. <param name="other" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11752. </method>
  11753. <method name="toString" return="java.lang.String"
  11754. abstract="false" native="false" synchronized="false"
  11755. static="false" final="false" visibility="public"
  11756. deprecated="not deprecated">
  11757. </method>
  11758. <method name="getFormattedString" return="java.lang.String"
  11759. abstract="false" native="false" synchronized="false"
  11760. static="false" final="false" visibility="public"
  11761. deprecated="not deprecated">
  11762. <doc>
  11763. <![CDATA[This method is to get memory in terms of KB|MB|GB.
  11764. @return string containing all resources]]>
  11765. </doc>
  11766. </method>
  11767. <method name="hashCode" return="int"
  11768. abstract="false" native="false" synchronized="false"
  11769. static="false" final="false" visibility="public"
  11770. deprecated="not deprecated">
  11771. </method>
  11772. <method name="castToIntSafely" return="int"
  11773. abstract="false" native="false" synchronized="false"
  11774. static="true" final="false" visibility="protected"
  11775. deprecated="not deprecated">
  11776. <param name="value" type="long"/>
  11777. <doc>
  11778. <![CDATA[Convert long to int for a resource value safely. This method assumes
  11779. resource value is positive.
  11780. @param value long resource value
  11781. @return int resource value]]>
  11782. </doc>
  11783. </method>
  11784. <method name="newDefaultInformation" return="org.apache.hadoop.yarn.api.records.ResourceInformation"
  11785. abstract="false" native="false" synchronized="false"
  11786. static="true" final="false" visibility="protected"
  11787. deprecated="not deprecated">
  11788. <param name="name" type="java.lang.String"/>
  11789. <param name="unit" type="java.lang.String"/>
  11790. <param name="value" type="long"/>
  11791. <doc>
  11792. <![CDATA[Create ResourceInformation with basic fields.
  11793. @param name Resource Type Name
  11794. @param unit Default unit of provided resource type
  11795. @param value Value associated with giveb resource
  11796. @return ResourceInformation object]]>
  11797. </doc>
  11798. </method>
  11799. <field name="resources" type="org.apache.hadoop.yarn.api.records.ResourceInformation[]"
  11800. transient="false" volatile="false"
  11801. static="false" final="false" visibility="protected"
  11802. deprecated="not deprecated">
  11803. </field>
  11804. <field name="NUM_MANDATORY_RESOURCES" type="int"
  11805. transient="false" volatile="false"
  11806. static="true" final="true" visibility="protected"
  11807. deprecated="not deprecated">
  11808. </field>
  11809. <field name="MEMORY_INDEX" type="int"
  11810. transient="false" volatile="false"
  11811. static="true" final="true" visibility="public"
  11812. deprecated="not deprecated">
  11813. </field>
  11814. <field name="VCORES_INDEX" type="int"
  11815. transient="false" volatile="false"
  11816. static="true" final="true" visibility="public"
  11817. deprecated="not deprecated">
  11818. </field>
  11819. <doc>
  11820. <![CDATA[<p><code>Resource</code> models a set of computer resources in the
  11821. cluster.</p>
  11822. <p>Currently it models both <em>memory</em> and <em>CPU</em>.</p>
  11823. <p>The unit for memory is megabytes. CPU is modeled with virtual cores
  11824. (vcores), a unit for expressing parallelism. A node's capacity should
  11825. be configured with virtual cores equal to its number of physical cores. A
  11826. container should be requested with the number of cores it can saturate, i.e.
  11827. the average number of threads it expects to have runnable at a time.</p>
  11828. <p>Virtual cores take integer values and thus currently CPU-scheduling is
  11829. very coarse. A complementary axis for CPU requests that represents
  11830. processing power will likely be added in the future to enable finer-grained
  11831. resource configuration.</p>
  11832. <p>Typically, applications request <code>Resource</code> of suitable
  11833. capability to run their component tasks.</p>
  11834. @see ResourceRequest
  11835. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  11836. </doc>
  11837. </class>
  11838. <!-- end class org.apache.hadoop.yarn.api.records.Resource -->
  11839. <!-- start class org.apache.hadoop.yarn.api.records.ResourceAllocationRequest -->
  11840. <class name="ResourceAllocationRequest" extends="java.lang.Object"
  11841. abstract="true"
  11842. static="false" final="false" visibility="public"
  11843. deprecated="not deprecated">
  11844. <constructor name="ResourceAllocationRequest"
  11845. static="false" final="false" visibility="public"
  11846. deprecated="not deprecated">
  11847. </constructor>
  11848. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceAllocationRequest"
  11849. abstract="false" native="false" synchronized="false"
  11850. static="true" final="false" visibility="public"
  11851. deprecated="not deprecated">
  11852. <param name="startTime" type="long"/>
  11853. <param name="endTime" type="long"/>
  11854. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11855. <doc>
  11856. <![CDATA[@param startTime The start time that the capability is reserved for.
  11857. @param endTime The end time that the capability is reserved for.
  11858. @param capability {@link Resource} representing the capability of the
  11859. resource allocation.
  11860. @return {ResourceAllocationRequest} which represents the capability of
  11861. the resource allocation for a time interval.]]>
  11862. </doc>
  11863. </method>
  11864. <method name="getStartTime" return="long"
  11865. abstract="true" native="false" synchronized="false"
  11866. static="false" final="false" visibility="public"
  11867. deprecated="not deprecated">
  11868. <doc>
  11869. <![CDATA[Get the start time that the resource is allocated.
  11870. @return the start time that the resource is allocated.]]>
  11871. </doc>
  11872. </method>
  11873. <method name="getEndTime" return="long"
  11874. abstract="true" native="false" synchronized="false"
  11875. static="false" final="false" visibility="public"
  11876. deprecated="not deprecated">
  11877. <doc>
  11878. <![CDATA[Get the end time that the resource is allocated.
  11879. @return the end time that the resource is allocated.]]>
  11880. </doc>
  11881. </method>
  11882. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  11883. abstract="true" native="false" synchronized="false"
  11884. static="false" final="false" visibility="public"
  11885. deprecated="not deprecated">
  11886. <doc>
  11887. <![CDATA[Get the allocated resource.
  11888. @return the allocated resource.]]>
  11889. </doc>
  11890. </method>
  11891. <doc>
  11892. <![CDATA[{@code ResourceAllocationRequest} represents an allocation
  11893. made for a reservation for the current state of the plan. This can be
  11894. changed for reasons such as re-planning, but will always be subject to the
  11895. constraints of the user contract as described by
  11896. {@link ReservationDefinition}
  11897. {@link Resource}
  11898. <p>
  11899. It includes:
  11900. <ul>
  11901. <li>StartTime of the allocation.</li>
  11902. <li>EndTime of the allocation.</li>
  11903. <li>{@link Resource} reserved for the allocation.</li>
  11904. </ul>
  11905. @see Resource]]>
  11906. </doc>
  11907. </class>
  11908. <!-- end class org.apache.hadoop.yarn.api.records.ResourceAllocationRequest -->
  11909. <!-- start class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
  11910. <class name="ResourceBlacklistRequest" extends="java.lang.Object"
  11911. abstract="true"
  11912. static="false" final="false" visibility="public"
  11913. deprecated="not deprecated">
  11914. <constructor name="ResourceBlacklistRequest"
  11915. static="false" final="false" visibility="public"
  11916. deprecated="not deprecated">
  11917. </constructor>
  11918. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
  11919. abstract="false" native="false" synchronized="false"
  11920. static="true" final="false" visibility="public"
  11921. deprecated="not deprecated">
  11922. <param name="additions" type="java.util.List"/>
  11923. <param name="removals" type="java.util.List"/>
  11924. </method>
  11925. <method name="getBlacklistAdditions" return="java.util.List"
  11926. abstract="true" native="false" synchronized="false"
  11927. static="false" final="false" visibility="public"
  11928. deprecated="not deprecated">
  11929. <doc>
  11930. <![CDATA[Get the list of resource-names which should be added to the
  11931. application blacklist.
  11932. @return list of resource-names which should be added to the
  11933. application blacklist]]>
  11934. </doc>
  11935. </method>
  11936. <method name="setBlacklistAdditions"
  11937. abstract="true" native="false" synchronized="false"
  11938. static="false" final="false" visibility="public"
  11939. deprecated="not deprecated">
  11940. <param name="resourceNames" type="java.util.List"/>
  11941. <doc>
  11942. <![CDATA[Set list of resource-names which should be added to the application blacklist.
  11943. @param resourceNames list of resource-names which should be added to the
  11944. application blacklist]]>
  11945. </doc>
  11946. </method>
  11947. <method name="getBlacklistRemovals" return="java.util.List"
  11948. abstract="true" native="false" synchronized="false"
  11949. static="false" final="false" visibility="public"
  11950. deprecated="not deprecated">
  11951. <doc>
  11952. <![CDATA[Get the list of resource-names which should be removed from the
  11953. application blacklist.
  11954. @return list of resource-names which should be removed from the
  11955. application blacklist]]>
  11956. </doc>
  11957. </method>
  11958. <method name="setBlacklistRemovals"
  11959. abstract="true" native="false" synchronized="false"
  11960. static="false" final="false" visibility="public"
  11961. deprecated="not deprecated">
  11962. <param name="resourceNames" type="java.util.List"/>
  11963. <doc>
  11964. <![CDATA[Set list of resource-names which should be removed from the
  11965. application blacklist.
  11966. @param resourceNames list of resource-names which should be removed from the
  11967. application blacklist]]>
  11968. </doc>
  11969. </method>
  11970. <doc>
  11971. <![CDATA[{@link ResourceBlacklistRequest} encapsulates the list of resource-names
  11972. which should be added or removed from the <em>blacklist</em> of resources
  11973. for the application.
  11974. @see ResourceRequest
  11975. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  11976. </doc>
  11977. </class>
  11978. <!-- end class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
  11979. <!-- start class org.apache.hadoop.yarn.api.records.ResourceOption -->
  11980. <class name="ResourceOption" extends="java.lang.Object"
  11981. abstract="true"
  11982. static="false" final="false" visibility="public"
  11983. deprecated="not deprecated">
  11984. <constructor name="ResourceOption"
  11985. static="false" final="false" visibility="public"
  11986. deprecated="not deprecated">
  11987. </constructor>
  11988. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceOption"
  11989. abstract="false" native="false" synchronized="false"
  11990. static="true" final="false" visibility="public"
  11991. deprecated="not deprecated">
  11992. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11993. <param name="overCommitTimeout" type="int"/>
  11994. </method>
  11995. <method name="toString" return="java.lang.String"
  11996. abstract="false" native="false" synchronized="false"
  11997. static="false" final="false" visibility="public"
  11998. deprecated="not deprecated">
  11999. </method>
  12000. <field name="OVER_COMMIT_TIMEOUT_MILLIS_DEFAULT" type="int"
  12001. transient="false" volatile="false"
  12002. static="true" final="true" visibility="public"
  12003. deprecated="not deprecated">
  12004. <doc>
  12005. <![CDATA[Negative value means no timeout.]]>
  12006. </doc>
  12007. </field>
  12008. </class>
  12009. <!-- end class org.apache.hadoop.yarn.api.records.ResourceOption -->
  12010. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest -->
  12011. <class name="ResourceRequest" extends="java.lang.Object"
  12012. abstract="true"
  12013. static="false" final="false" visibility="public"
  12014. deprecated="not deprecated">
  12015. <implements name="java.lang.Comparable"/>
  12016. <constructor name="ResourceRequest"
  12017. static="false" final="false" visibility="public"
  12018. deprecated="not deprecated">
  12019. </constructor>
  12020. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  12021. abstract="false" native="false" synchronized="false"
  12022. static="true" final="false" visibility="public"
  12023. deprecated="not deprecated">
  12024. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12025. <param name="hostName" type="java.lang.String"/>
  12026. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12027. <param name="numContainers" type="int"/>
  12028. </method>
  12029. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  12030. abstract="false" native="false" synchronized="false"
  12031. static="true" final="false" visibility="public"
  12032. deprecated="not deprecated">
  12033. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12034. <param name="hostName" type="java.lang.String"/>
  12035. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12036. <param name="numContainers" type="int"/>
  12037. <param name="relaxLocality" type="boolean"/>
  12038. </method>
  12039. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  12040. abstract="false" native="false" synchronized="false"
  12041. static="true" final="false" visibility="public"
  12042. deprecated="not deprecated">
  12043. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12044. <param name="hostName" type="java.lang.String"/>
  12045. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12046. <param name="numContainers" type="int"/>
  12047. <param name="relaxLocality" type="boolean"/>
  12048. <param name="labelExpression" type="java.lang.String"/>
  12049. </method>
  12050. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  12051. abstract="false" native="false" synchronized="false"
  12052. static="true" final="false" visibility="public"
  12053. deprecated="not deprecated">
  12054. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12055. <param name="hostName" type="java.lang.String"/>
  12056. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12057. <param name="numContainers" type="int"/>
  12058. <param name="relaxLocality" type="boolean"/>
  12059. <param name="labelExpression" type="java.lang.String"/>
  12060. <param name="executionTypeRequest" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  12061. </method>
  12062. <method name="clone" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  12063. abstract="false" native="false" synchronized="false"
  12064. static="true" final="false" visibility="public"
  12065. deprecated="not deprecated">
  12066. <param name="rr" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  12067. <doc>
  12068. <![CDATA[Clone a ResourceRequest object (shallow copy). Please keep it loaded with
  12069. all (new) fields
  12070. @param rr the object to copy from
  12071. @return the copied object]]>
  12072. </doc>
  12073. </method>
  12074. <method name="newBuilder" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12075. abstract="false" native="false" synchronized="false"
  12076. static="true" final="false" visibility="public"
  12077. deprecated="not deprecated">
  12078. </method>
  12079. <method name="isAnyLocation" return="boolean"
  12080. abstract="false" native="false" synchronized="false"
  12081. static="true" final="false" visibility="public"
  12082. deprecated="not deprecated">
  12083. <param name="hostName" type="java.lang.String"/>
  12084. <doc>
  12085. <![CDATA[Check whether the given <em>host/rack</em> string represents an arbitrary
  12086. host name.
  12087. @param hostName <em>host/rack</em> on which the allocation is desired
  12088. @return whether the given <em>host/rack</em> string represents an arbitrary
  12089. host name]]>
  12090. </doc>
  12091. </method>
  12092. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  12093. abstract="true" native="false" synchronized="false"
  12094. static="false" final="false" visibility="public"
  12095. deprecated="not deprecated">
  12096. <doc>
  12097. <![CDATA[Get the <code>Priority</code> of the request.
  12098. @return <code>Priority</code> of the request]]>
  12099. </doc>
  12100. </method>
  12101. <method name="setPriority"
  12102. abstract="true" native="false" synchronized="false"
  12103. static="false" final="false" visibility="public"
  12104. deprecated="not deprecated">
  12105. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12106. <doc>
  12107. <![CDATA[Set the <code>Priority</code> of the request
  12108. @param priority <code>Priority</code> of the request]]>
  12109. </doc>
  12110. </method>
  12111. <method name="getResourceName" return="java.lang.String"
  12112. abstract="true" native="false" synchronized="false"
  12113. static="false" final="false" visibility="public"
  12114. deprecated="not deprecated">
  12115. <doc>
  12116. <![CDATA[Get the resource (e.g. <em>host/rack</em>) on which the allocation
  12117. is desired.
  12118. A special value of <em>*</em> signifies that <em>any</em> resource
  12119. (host/rack) is acceptable.
  12120. @return resource (e.g. <em>host/rack</em>) on which the allocation
  12121. is desired]]>
  12122. </doc>
  12123. </method>
  12124. <method name="setResourceName"
  12125. abstract="true" native="false" synchronized="false"
  12126. static="false" final="false" visibility="public"
  12127. deprecated="not deprecated">
  12128. <param name="resourceName" type="java.lang.String"/>
  12129. <doc>
  12130. <![CDATA[Set the resource name (e.g. <em>host/rack</em>) on which the allocation
  12131. is desired.
  12132. A special value of <em>*</em> signifies that <em>any</em> resource name
  12133. (e.g. host/rack) is acceptable.
  12134. @param resourceName (e.g. <em>host/rack</em>) on which the
  12135. allocation is desired]]>
  12136. </doc>
  12137. </method>
  12138. <method name="getNumContainers" return="int"
  12139. abstract="true" native="false" synchronized="false"
  12140. static="false" final="false" visibility="public"
  12141. deprecated="not deprecated">
  12142. <doc>
  12143. <![CDATA[Get the number of containers required with the given specifications.
  12144. @return number of containers required with the given specifications]]>
  12145. </doc>
  12146. </method>
  12147. <method name="setNumContainers"
  12148. abstract="true" native="false" synchronized="false"
  12149. static="false" final="false" visibility="public"
  12150. deprecated="not deprecated">
  12151. <param name="numContainers" type="int"/>
  12152. <doc>
  12153. <![CDATA[Set the number of containers required with the given specifications
  12154. @param numContainers number of containers required with the given
  12155. specifications]]>
  12156. </doc>
  12157. </method>
  12158. <method name="getRelaxLocality" return="boolean"
  12159. abstract="true" native="false" synchronized="false"
  12160. static="false" final="false" visibility="public"
  12161. deprecated="not deprecated">
  12162. <doc>
  12163. <![CDATA[Get whether locality relaxation is enabled with this
  12164. <code>ResourceRequest</code>. Defaults to true.
  12165. @return whether locality relaxation is enabled with this
  12166. <code>ResourceRequest</code>.]]>
  12167. </doc>
  12168. </method>
  12169. <method name="setExecutionTypeRequest"
  12170. abstract="false" native="false" synchronized="false"
  12171. static="false" final="false" visibility="public"
  12172. deprecated="not deprecated">
  12173. <param name="execSpec" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  12174. <doc>
  12175. <![CDATA[Set the <code>ExecutionTypeRequest</code> of the requested container.
  12176. @param execSpec
  12177. ExecutionTypeRequest of the requested container]]>
  12178. </doc>
  12179. </method>
  12180. <method name="getExecutionTypeRequest" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
  12181. abstract="false" native="false" synchronized="false"
  12182. static="false" final="false" visibility="public"
  12183. deprecated="not deprecated">
  12184. <doc>
  12185. <![CDATA[Get whether locality relaxation is enabled with this
  12186. <code>ResourceRequest</code>. Defaults to true.
  12187. @return whether locality relaxation is enabled with this
  12188. <code>ResourceRequest</code>.]]>
  12189. </doc>
  12190. </method>
  12191. <method name="setRelaxLocality"
  12192. abstract="true" native="false" synchronized="false"
  12193. static="false" final="false" visibility="public"
  12194. deprecated="not deprecated">
  12195. <param name="relaxLocality" type="boolean"/>
  12196. <doc>
  12197. <![CDATA[<p>For a request at a network hierarchy level, set whether locality can be relaxed
  12198. to that level and beyond.<p>
  12199. <p>If the flag is off on a rack-level <code>ResourceRequest</code>,
  12200. containers at that request's priority will not be assigned to nodes on that
  12201. request's rack unless requests specifically for those nodes have also been
  12202. submitted.<p>
  12203. <p>If the flag is off on an {@link ResourceRequest#ANY}-level
  12204. <code>ResourceRequest</code>, containers at that request's priority will
  12205. only be assigned on racks for which specific requests have also been
  12206. submitted.<p>
  12207. <p>For example, to request a container strictly on a specific node, the
  12208. corresponding rack-level and any-level requests should have locality
  12209. relaxation set to false. Similarly, to request a container strictly on a
  12210. specific rack, the corresponding any-level request should have locality
  12211. relaxation set to false.<p>
  12212. @param relaxLocality whether locality relaxation is enabled with this
  12213. <code>ResourceRequest</code>.]]>
  12214. </doc>
  12215. </method>
  12216. <method name="getNodeLabelExpression" return="java.lang.String"
  12217. abstract="true" native="false" synchronized="false"
  12218. static="false" final="false" visibility="public"
  12219. deprecated="not deprecated">
  12220. <doc>
  12221. <![CDATA[Get node-label-expression for this Resource Request. If this is set, all
  12222. containers allocated to satisfy this resource-request will be only on those
  12223. nodes that satisfy this node-label-expression.
  12224. Please note that node label expression now can only take effect when the
  12225. resource request has resourceName = ANY
  12226. @return node-label-expression]]>
  12227. </doc>
  12228. </method>
  12229. <method name="setNodeLabelExpression"
  12230. abstract="true" native="false" synchronized="false"
  12231. static="false" final="false" visibility="public"
  12232. deprecated="not deprecated">
  12233. <param name="nodelabelExpression" type="java.lang.String"/>
  12234. <doc>
  12235. <![CDATA[Set node label expression of this resource request. Now only support
  12236. specifying a single node label. In the future we will support more complex
  12237. node label expression specification like {@code AND(&&), OR(||)}, etc.
  12238. Any please note that node label expression now can only take effect when
  12239. the resource request has resourceName = ANY
  12240. @param nodelabelExpression
  12241. node-label-expression of this ResourceRequest]]>
  12242. </doc>
  12243. </method>
  12244. <method name="getAllocationRequestId" return="long"
  12245. abstract="false" native="false" synchronized="false"
  12246. static="false" final="false" visibility="public"
  12247. deprecated="not deprecated">
  12248. <doc>
  12249. <![CDATA[Get the optional <em>ID</em> corresponding to this allocation request. This
  12250. ID is an identifier for different {@code ResourceRequest}s from the <b>same
  12251. application</b>. The allocated {@code Container}(s) received as part of the
  12252. {@code AllocateResponse} response will have the ID corresponding to the
  12253. original {@code ResourceRequest} for which the RM made the allocation.
  12254. <p>
  12255. The scheduler may return multiple {@code AllocateResponse}s corresponding
  12256. to the same ID as and when scheduler allocates {@code Container}(s).
  12257. <b>Applications</b> can continue to completely ignore the returned ID in
  12258. the response and use the allocation for any of their outstanding requests.
  12259. <p>
  12260. If one wishes to replace an entire {@code ResourceRequest} corresponding to
  12261. a specific ID, they can simply cancel the corresponding {@code
  12262. ResourceRequest} and submit a new one afresh.
  12263. @return the <em>ID</em> corresponding to this allocation request.]]>
  12264. </doc>
  12265. </method>
  12266. <method name="setAllocationRequestId"
  12267. abstract="false" native="false" synchronized="false"
  12268. static="false" final="false" visibility="public"
  12269. deprecated="not deprecated">
  12270. <param name="allocationRequestID" type="long"/>
  12271. <doc>
  12272. <![CDATA[Set the optional <em>ID</em> corresponding to this allocation request. This
  12273. ID is an identifier for different {@code ResourceRequest}s from the <b>same
  12274. application</b>. The allocated {@code Container}(s) received as part of the
  12275. {@code AllocateResponse} response will have the ID corresponding to the
  12276. original {@code ResourceRequest} for which the RM made the allocation.
  12277. <p>
  12278. The scheduler may return multiple {@code AllocateResponse}s corresponding
  12279. to the same ID as and when scheduler allocates {@code Container}(s).
  12280. <b>Applications</b> can continue to completely ignore the returned ID in
  12281. the response and use the allocation for any of their outstanding requests.
  12282. <p>
  12283. If one wishes to replace an entire {@code ResourceRequest} corresponding to
  12284. a specific ID, they can simply cancel the corresponding {@code
  12285. ResourceRequest} and submit a new one afresh.
  12286. <p>
  12287. If the ID is not set, scheduler will continue to work as previously and all
  12288. allocated {@code Container}(s) will have the default ID, -1.
  12289. @param allocationRequestID the <em>ID</em> corresponding to this allocation
  12290. request.]]>
  12291. </doc>
  12292. </method>
  12293. <method name="setCapability"
  12294. abstract="true" native="false" synchronized="false"
  12295. static="false" final="false" visibility="public"
  12296. deprecated="not deprecated">
  12297. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12298. <doc>
  12299. <![CDATA[Set the <code>Resource</code> capability of the request.
  12300. @param capability <code>Resource</code> capability of the request]]>
  12301. </doc>
  12302. </method>
  12303. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  12304. abstract="true" native="false" synchronized="false"
  12305. static="false" final="false" visibility="public"
  12306. deprecated="not deprecated">
  12307. <doc>
  12308. <![CDATA[Get the <code>Resource</code> capability of the request.
  12309. @return <code>Resource</code> capability of the request]]>
  12310. </doc>
  12311. </method>
  12312. <method name="hashCode" return="int"
  12313. abstract="false" native="false" synchronized="false"
  12314. static="false" final="false" visibility="public"
  12315. deprecated="not deprecated">
  12316. </method>
  12317. <method name="equals" return="boolean"
  12318. abstract="false" native="false" synchronized="false"
  12319. static="false" final="false" visibility="public"
  12320. deprecated="not deprecated">
  12321. <param name="obj" type="java.lang.Object"/>
  12322. </method>
  12323. <method name="compareTo" return="int"
  12324. abstract="false" native="false" synchronized="false"
  12325. static="false" final="false" visibility="public"
  12326. deprecated="not deprecated">
  12327. <param name="other" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  12328. </method>
  12329. <field name="ANY" type="java.lang.String"
  12330. transient="false" volatile="false"
  12331. static="true" final="true" visibility="public"
  12332. deprecated="not deprecated">
  12333. <doc>
  12334. <![CDATA[The constant string representing no locality.
  12335. It should be used by all references that want to pass an arbitrary host
  12336. name in.]]>
  12337. </doc>
  12338. </field>
  12339. <doc>
  12340. <![CDATA[{@code ResourceRequest} represents the request made
  12341. by an application to the {@code ResourceManager}
  12342. to obtain various {@code Container} allocations.
  12343. <p>
  12344. It includes:
  12345. <ul>
  12346. <li>{@link Priority} of the request.</li>
  12347. <li>
  12348. The <em>name</em> of the host or rack on which the allocation is
  12349. desired. A special value of <em>*</em> signifies that
  12350. <em>any</em> host/rack is acceptable to the application.
  12351. </li>
  12352. <li>{@link Resource} required for each request.</li>
  12353. <li>
  12354. Number of containers, of above specifications, which are required
  12355. by the application.
  12356. </li>
  12357. <li>
  12358. A boolean <em>relaxLocality</em> flag, defaulting to {@code true},
  12359. which tells the {@code ResourceManager} if the application wants
  12360. locality to be loose (i.e. allows fall-through to rack or <em>any</em>)
  12361. or strict (i.e. specify hard constraint on resource allocation).
  12362. </li>
  12363. </ul>
  12364. @see Resource
  12365. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  12366. </doc>
  12367. </class>
  12368. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest -->
  12369. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder -->
  12370. <class name="ResourceRequest.ResourceRequestBuilder" extends="java.lang.Object"
  12371. abstract="false"
  12372. static="true" final="true" visibility="public"
  12373. deprecated="not deprecated">
  12374. <method name="priority" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12375. abstract="false" native="false" synchronized="false"
  12376. static="false" final="false" visibility="public"
  12377. deprecated="not deprecated">
  12378. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12379. <doc>
  12380. <![CDATA[Set the <code>priority</code> of the request.
  12381. @see ResourceRequest#setPriority(Priority)
  12382. @param priority <code>priority</code> of the request
  12383. @return {@link ResourceRequestBuilder}]]>
  12384. </doc>
  12385. </method>
  12386. <method name="resourceName" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12387. abstract="false" native="false" synchronized="false"
  12388. static="false" final="false" visibility="public"
  12389. deprecated="not deprecated">
  12390. <param name="resourceName" type="java.lang.String"/>
  12391. <doc>
  12392. <![CDATA[Set the <code>resourceName</code> of the request.
  12393. @see ResourceRequest#setResourceName(String)
  12394. @param resourceName <code>resourceName</code> of the request
  12395. @return {@link ResourceRequestBuilder}]]>
  12396. </doc>
  12397. </method>
  12398. <method name="capability" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12399. abstract="false" native="false" synchronized="false"
  12400. static="false" final="false" visibility="public"
  12401. deprecated="not deprecated">
  12402. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12403. <doc>
  12404. <![CDATA[Set the <code>capability</code> of the request.
  12405. @see ResourceRequest#setCapability(Resource)
  12406. @param capability <code>capability</code> of the request
  12407. @return {@link ResourceRequestBuilder}]]>
  12408. </doc>
  12409. </method>
  12410. <method name="numContainers" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12411. abstract="false" native="false" synchronized="false"
  12412. static="false" final="false" visibility="public"
  12413. deprecated="not deprecated">
  12414. <param name="numContainers" type="int"/>
  12415. <doc>
  12416. <![CDATA[Set the <code>numContainers</code> of the request.
  12417. @see ResourceRequest#setNumContainers(int)
  12418. @param numContainers <code>numContainers</code> of the request
  12419. @return {@link ResourceRequestBuilder}]]>
  12420. </doc>
  12421. </method>
  12422. <method name="relaxLocality" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12423. abstract="false" native="false" synchronized="false"
  12424. static="false" final="false" visibility="public"
  12425. deprecated="not deprecated">
  12426. <param name="relaxLocality" type="boolean"/>
  12427. <doc>
  12428. <![CDATA[Set the <code>relaxLocality</code> of the request.
  12429. @see ResourceRequest#setRelaxLocality(boolean)
  12430. @param relaxLocality <code>relaxLocality</code> of the request
  12431. @return {@link ResourceRequestBuilder}]]>
  12432. </doc>
  12433. </method>
  12434. <method name="nodeLabelExpression" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12435. abstract="false" native="false" synchronized="false"
  12436. static="false" final="false" visibility="public"
  12437. deprecated="not deprecated">
  12438. <param name="nodeLabelExpression" type="java.lang.String"/>
  12439. <doc>
  12440. <![CDATA[Set the <code>nodeLabelExpression</code> of the request.
  12441. @see ResourceRequest#setNodeLabelExpression(String)
  12442. @param nodeLabelExpression
  12443. <code>nodeLabelExpression</code> of the request
  12444. @return {@link ResourceRequestBuilder}]]>
  12445. </doc>
  12446. </method>
  12447. <method name="executionTypeRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12448. abstract="false" native="false" synchronized="false"
  12449. static="false" final="false" visibility="public"
  12450. deprecated="not deprecated">
  12451. <param name="executionTypeRequest" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  12452. <doc>
  12453. <![CDATA[Set the <code>executionTypeRequest</code> of the request.
  12454. @see ResourceRequest#setExecutionTypeRequest(
  12455. ExecutionTypeRequest)
  12456. @param executionTypeRequest
  12457. <code>executionTypeRequest</code> of the request
  12458. @return {@link ResourceRequestBuilder}]]>
  12459. </doc>
  12460. </method>
  12461. <method name="executionType" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12462. abstract="false" native="false" synchronized="false"
  12463. static="false" final="false" visibility="public"
  12464. deprecated="not deprecated">
  12465. <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  12466. <doc>
  12467. <![CDATA[Set the <code>executionTypeRequest</code> of the request with 'ensure
  12468. execution type' flag set to true.
  12469. @see ResourceRequest#setExecutionTypeRequest(
  12470. ExecutionTypeRequest)
  12471. @param executionType <code>executionType</code> of the request.
  12472. @return {@link ResourceRequestBuilder}]]>
  12473. </doc>
  12474. </method>
  12475. <method name="allocationRequestId" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12476. abstract="false" native="false" synchronized="false"
  12477. static="false" final="false" visibility="public"
  12478. deprecated="not deprecated">
  12479. <param name="allocationRequestId" type="long"/>
  12480. <doc>
  12481. <![CDATA[Set the <code>allocationRequestId</code> of the request.
  12482. @see ResourceRequest#setAllocationRequestId(long)
  12483. @param allocationRequestId
  12484. <code>allocationRequestId</code> of the request
  12485. @return {@link ResourceRequestBuilder}]]>
  12486. </doc>
  12487. </method>
  12488. <method name="build" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  12489. abstract="false" native="false" synchronized="false"
  12490. static="false" final="false" visibility="public"
  12491. deprecated="not deprecated">
  12492. <doc>
  12493. <![CDATA[Return generated {@link ResourceRequest} object.
  12494. @return {@link ResourceRequest}]]>
  12495. </doc>
  12496. </method>
  12497. <doc>
  12498. <![CDATA[Class to construct instances of {@link ResourceRequest} with specific
  12499. options.]]>
  12500. </doc>
  12501. </class>
  12502. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder -->
  12503. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
  12504. <class name="ResourceRequest.ResourceRequestComparator" extends="java.lang.Object"
  12505. abstract="false"
  12506. static="true" final="false" visibility="public"
  12507. deprecated="not deprecated">
  12508. <implements name="java.util.Comparator"/>
  12509. <implements name="java.io.Serializable"/>
  12510. <constructor name="ResourceRequestComparator"
  12511. static="false" final="false" visibility="public"
  12512. deprecated="not deprecated">
  12513. </constructor>
  12514. <method name="compare" return="int"
  12515. abstract="false" native="false" synchronized="false"
  12516. static="false" final="false" visibility="public"
  12517. deprecated="not deprecated">
  12518. <param name="r1" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  12519. <param name="r2" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  12520. </method>
  12521. </class>
  12522. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
  12523. <!-- start class org.apache.hadoop.yarn.api.records.ResourceSizing -->
  12524. <class name="ResourceSizing" extends="java.lang.Object"
  12525. abstract="true"
  12526. static="false" final="false" visibility="public"
  12527. deprecated="not deprecated">
  12528. <constructor name="ResourceSizing"
  12529. static="false" final="false" visibility="public"
  12530. deprecated="not deprecated">
  12531. </constructor>
  12532. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceSizing"
  12533. abstract="false" native="false" synchronized="false"
  12534. static="true" final="false" visibility="public"
  12535. deprecated="not deprecated">
  12536. <param name="resources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12537. </method>
  12538. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceSizing"
  12539. abstract="false" native="false" synchronized="false"
  12540. static="true" final="false" visibility="public"
  12541. deprecated="not deprecated">
  12542. <param name="numAllocations" type="int"/>
  12543. <param name="resources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12544. </method>
  12545. <method name="getNumAllocations" return="int"
  12546. abstract="true" native="false" synchronized="false"
  12547. static="false" final="false" visibility="public"
  12548. deprecated="not deprecated">
  12549. </method>
  12550. <method name="setNumAllocations"
  12551. abstract="true" native="false" synchronized="false"
  12552. static="false" final="false" visibility="public"
  12553. deprecated="not deprecated">
  12554. <param name="numAllocations" type="int"/>
  12555. </method>
  12556. <method name="getResources" return="org.apache.hadoop.yarn.api.records.Resource"
  12557. abstract="true" native="false" synchronized="false"
  12558. static="false" final="false" visibility="public"
  12559. deprecated="not deprecated">
  12560. </method>
  12561. <method name="setResources"
  12562. abstract="true" native="false" synchronized="false"
  12563. static="false" final="false" visibility="public"
  12564. deprecated="not deprecated">
  12565. <param name="resources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12566. </method>
  12567. <method name="hashCode" return="int"
  12568. abstract="false" native="false" synchronized="false"
  12569. static="false" final="false" visibility="public"
  12570. deprecated="not deprecated">
  12571. </method>
  12572. <method name="equals" return="boolean"
  12573. abstract="false" native="false" synchronized="false"
  12574. static="false" final="false" visibility="public"
  12575. deprecated="not deprecated">
  12576. <param name="obj" type="java.lang.Object"/>
  12577. </method>
  12578. <doc>
  12579. <![CDATA[{@code ResourceSizing} contains information for the size of a
  12580. {@link SchedulingRequest}, such as the number of requested allocations and
  12581. the resources for each allocation.]]>
  12582. </doc>
  12583. </class>
  12584. <!-- end class org.apache.hadoop.yarn.api.records.ResourceSizing -->
  12585. <!-- start class org.apache.hadoop.yarn.api.records.ResourceUtilization -->
  12586. <class name="ResourceUtilization" extends="java.lang.Object"
  12587. abstract="true"
  12588. static="false" final="false" visibility="public"
  12589. deprecated="not deprecated">
  12590. <implements name="java.lang.Comparable"/>
  12591. <constructor name="ResourceUtilization"
  12592. static="false" final="false" visibility="public"
  12593. deprecated="not deprecated">
  12594. </constructor>
  12595. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  12596. abstract="false" native="false" synchronized="false"
  12597. static="true" final="false" visibility="public"
  12598. deprecated="not deprecated">
  12599. <param name="pmem" type="int"/>
  12600. <param name="vmem" type="int"/>
  12601. <param name="cpu" type="float"/>
  12602. </method>
  12603. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  12604. abstract="false" native="false" synchronized="false"
  12605. static="true" final="false" visibility="public"
  12606. deprecated="not deprecated">
  12607. <param name="resourceUtil" type="org.apache.hadoop.yarn.api.records.ResourceUtilization"/>
  12608. </method>
  12609. <method name="getVirtualMemory" return="int"
  12610. abstract="true" native="false" synchronized="false"
  12611. static="false" final="false" visibility="public"
  12612. deprecated="not deprecated">
  12613. <doc>
  12614. <![CDATA[Get used <em>virtual memory</em>.
  12615. @return <em>virtual memory</em> in MB]]>
  12616. </doc>
  12617. </method>
  12618. <method name="setVirtualMemory"
  12619. abstract="true" native="false" synchronized="false"
  12620. static="false" final="false" visibility="public"
  12621. deprecated="not deprecated">
  12622. <param name="vmem" type="int"/>
  12623. <doc>
  12624. <![CDATA[Set used <em>virtual memory</em>.
  12625. @param vmem <em>virtual memory</em> in MB]]>
  12626. </doc>
  12627. </method>
  12628. <method name="getPhysicalMemory" return="int"
  12629. abstract="true" native="false" synchronized="false"
  12630. static="false" final="false" visibility="public"
  12631. deprecated="not deprecated">
  12632. <doc>
  12633. <![CDATA[Get <em>physical memory</em>.
  12634. @return <em>physical memory</em> in MB]]>
  12635. </doc>
  12636. </method>
  12637. <method name="setPhysicalMemory"
  12638. abstract="true" native="false" synchronized="false"
  12639. static="false" final="false" visibility="public"
  12640. deprecated="not deprecated">
  12641. <param name="pmem" type="int"/>
  12642. <doc>
  12643. <![CDATA[Set <em>physical memory</em>.
  12644. @param pmem <em>physical memory</em> in MB]]>
  12645. </doc>
  12646. </method>
  12647. <method name="getCPU" return="float"
  12648. abstract="true" native="false" synchronized="false"
  12649. static="false" final="false" visibility="public"
  12650. deprecated="not deprecated">
  12651. <doc>
  12652. <![CDATA[Get <em>CPU</em> utilization.
  12653. @return <em>CPU utilization</em> normalized to 1 CPU]]>
  12654. </doc>
  12655. </method>
  12656. <method name="setCPU"
  12657. abstract="true" native="false" synchronized="false"
  12658. static="false" final="false" visibility="public"
  12659. deprecated="not deprecated">
  12660. <param name="cpu" type="float"/>
  12661. <doc>
  12662. <![CDATA[Set <em>CPU</em> utilization.
  12663. @param cpu <em>CPU utilization</em> normalized to 1 CPU]]>
  12664. </doc>
  12665. </method>
  12666. <method name="hashCode" return="int"
  12667. abstract="false" native="false" synchronized="false"
  12668. static="false" final="false" visibility="public"
  12669. deprecated="not deprecated">
  12670. </method>
  12671. <method name="equals" return="boolean"
  12672. abstract="false" native="false" synchronized="false"
  12673. static="false" final="false" visibility="public"
  12674. deprecated="not deprecated">
  12675. <param name="obj" type="java.lang.Object"/>
  12676. </method>
  12677. <method name="toString" return="java.lang.String"
  12678. abstract="false" native="false" synchronized="false"
  12679. static="false" final="false" visibility="public"
  12680. deprecated="not deprecated">
  12681. </method>
  12682. <method name="addTo"
  12683. abstract="false" native="false" synchronized="false"
  12684. static="false" final="false" visibility="public"
  12685. deprecated="not deprecated">
  12686. <param name="pmem" type="int"/>
  12687. <param name="vmem" type="int"/>
  12688. <param name="cpu" type="float"/>
  12689. <doc>
  12690. <![CDATA[Add utilization to the current one.
  12691. @param pmem Physical memory used to add.
  12692. @param vmem Virtual memory used to add.
  12693. @param cpu CPU utilization to add.]]>
  12694. </doc>
  12695. </method>
  12696. <method name="subtractFrom"
  12697. abstract="false" native="false" synchronized="false"
  12698. static="false" final="false" visibility="public"
  12699. deprecated="not deprecated">
  12700. <param name="pmem" type="int"/>
  12701. <param name="vmem" type="int"/>
  12702. <param name="cpu" type="float"/>
  12703. <doc>
  12704. <![CDATA[Subtract utilization from the current one.
  12705. @param pmem Physical memory to be subtracted.
  12706. @param vmem Virtual memory to be subtracted.
  12707. @param cpu CPU utilization to be subtracted.]]>
  12708. </doc>
  12709. </method>
  12710. <doc>
  12711. <![CDATA[<p>
  12712. <code>ResourceUtilization</code> models the utilization of a set of computer
  12713. resources in the cluster.
  12714. </p>]]>
  12715. </doc>
  12716. </class>
  12717. <!-- end class org.apache.hadoop.yarn.api.records.ResourceUtilization -->
  12718. <!-- start class org.apache.hadoop.yarn.api.records.SchedulingRequest -->
  12719. <class name="SchedulingRequest" extends="java.lang.Object"
  12720. abstract="true"
  12721. static="false" final="false" visibility="public"
  12722. deprecated="not deprecated">
  12723. <constructor name="SchedulingRequest"
  12724. static="false" final="false" visibility="public"
  12725. deprecated="not deprecated">
  12726. </constructor>
  12727. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.SchedulingRequest"
  12728. abstract="false" native="false" synchronized="false"
  12729. static="true" final="false" visibility="public"
  12730. deprecated="not deprecated">
  12731. <param name="allocationRequestId" type="long"/>
  12732. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12733. <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  12734. <param name="allocationTags" type="java.util.Set"/>
  12735. <param name="resourceSizing" type="org.apache.hadoop.yarn.api.records.ResourceSizing"/>
  12736. <param name="placementConstraintExpression" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint"/>
  12737. </method>
  12738. <method name="newBuilder" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
  12739. abstract="false" native="false" synchronized="false"
  12740. static="true" final="false" visibility="public"
  12741. deprecated="not deprecated">
  12742. </method>
  12743. <method name="getAllocationRequestId" return="long"
  12744. abstract="true" native="false" synchronized="false"
  12745. static="false" final="false" visibility="public"
  12746. deprecated="not deprecated">
  12747. </method>
  12748. <method name="setAllocationRequestId"
  12749. abstract="true" native="false" synchronized="false"
  12750. static="false" final="false" visibility="public"
  12751. deprecated="not deprecated">
  12752. <param name="allocationRequestId" type="long"/>
  12753. </method>
  12754. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  12755. abstract="true" native="false" synchronized="false"
  12756. static="false" final="false" visibility="public"
  12757. deprecated="not deprecated">
  12758. </method>
  12759. <method name="setPriority"
  12760. abstract="true" native="false" synchronized="false"
  12761. static="false" final="false" visibility="public"
  12762. deprecated="not deprecated">
  12763. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12764. </method>
  12765. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
  12766. abstract="true" native="false" synchronized="false"
  12767. static="false" final="false" visibility="public"
  12768. deprecated="not deprecated">
  12769. </method>
  12770. <method name="setExecutionType"
  12771. abstract="true" native="false" synchronized="false"
  12772. static="false" final="false" visibility="public"
  12773. deprecated="not deprecated">
  12774. <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  12775. </method>
  12776. <method name="getAllocationTags" return="java.util.Set"
  12777. abstract="true" native="false" synchronized="false"
  12778. static="false" final="false" visibility="public"
  12779. deprecated="not deprecated">
  12780. </method>
  12781. <method name="setAllocationTags"
  12782. abstract="true" native="false" synchronized="false"
  12783. static="false" final="false" visibility="public"
  12784. deprecated="not deprecated">
  12785. <param name="allocationTags" type="java.util.Set"/>
  12786. </method>
  12787. <method name="getResourceSizing" return="org.apache.hadoop.yarn.api.records.ResourceSizing"
  12788. abstract="true" native="false" synchronized="false"
  12789. static="false" final="false" visibility="public"
  12790. deprecated="not deprecated">
  12791. </method>
  12792. <method name="setResourceSizing"
  12793. abstract="true" native="false" synchronized="false"
  12794. static="false" final="false" visibility="public"
  12795. deprecated="not deprecated">
  12796. <param name="resourceSizing" type="org.apache.hadoop.yarn.api.records.ResourceSizing"/>
  12797. </method>
  12798. <method name="getPlacementConstraint" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint"
  12799. abstract="true" native="false" synchronized="false"
  12800. static="false" final="false" visibility="public"
  12801. deprecated="not deprecated">
  12802. </method>
  12803. <method name="setPlacementConstraint"
  12804. abstract="true" native="false" synchronized="false"
  12805. static="false" final="false" visibility="public"
  12806. deprecated="not deprecated">
  12807. <param name="placementConstraint" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint"/>
  12808. </method>
  12809. <doc>
  12810. <![CDATA[{@code SchedulingRequest} represents a request made by an application to the
  12811. {@code ResourceManager} to obtain an allocation. It is similar to the
  12812. {@link ResourceRequest}. However, it is more complete than the latter, as it
  12813. allows applications to specify allocation tags (e.g., to express that an
  12814. allocation belongs to {@code Spark} or is an {@code HBase-master}), as well
  12815. as involved {@link PlacementConstraint}s (e.g., anti-affinity between Spark
  12816. and HBase allocations).
  12817. The size specification of the allocation is in {@code ResourceSizing}.]]>
  12818. </doc>
  12819. </class>
  12820. <!-- end class org.apache.hadoop.yarn.api.records.SchedulingRequest -->
  12821. <!-- start class org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder -->
  12822. <class name="SchedulingRequest.SchedulingRequestBuilder" extends="java.lang.Object"
  12823. abstract="false"
  12824. static="true" final="true" visibility="public"
  12825. deprecated="not deprecated">
  12826. <method name="allocationRequestId" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
  12827. abstract="false" native="false" synchronized="false"
  12828. static="false" final="false" visibility="public"
  12829. deprecated="not deprecated">
  12830. <param name="allocationRequestId" type="long"/>
  12831. <doc>
  12832. <![CDATA[Set the <code>allocationRequestId</code> of the request.
  12833. @see SchedulingRequest#setAllocationRequestId(long)
  12834. @param allocationRequestId <code>allocationRequestId</code> of the
  12835. request
  12836. @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
  12837. </doc>
  12838. </method>
  12839. <method name="priority" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
  12840. abstract="false" native="false" synchronized="false"
  12841. static="false" final="false" visibility="public"
  12842. deprecated="not deprecated">
  12843. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12844. <doc>
  12845. <![CDATA[Set the <code>priority</code> of the request.
  12846. @param priority <code>priority</code> of the request
  12847. @return {@link SchedulingRequest.SchedulingRequestBuilder}
  12848. @see SchedulingRequest#setPriority(Priority)]]>
  12849. </doc>
  12850. </method>
  12851. <method name="executionType" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
  12852. abstract="false" native="false" synchronized="false"
  12853. static="false" final="false" visibility="public"
  12854. deprecated="not deprecated">
  12855. <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  12856. <doc>
  12857. <![CDATA[Set the <code>executionType</code> of the request.
  12858. @see SchedulingRequest#setExecutionType(ExecutionTypeRequest)
  12859. @param executionType <code>executionType</code> of the request
  12860. @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
  12861. </doc>
  12862. </method>
  12863. <method name="allocationTags" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
  12864. abstract="false" native="false" synchronized="false"
  12865. static="false" final="false" visibility="public"
  12866. deprecated="not deprecated">
  12867. <param name="allocationTags" type="java.util.Set"/>
  12868. <doc>
  12869. <![CDATA[Set the <code>allocationTags</code> of the request.
  12870. @see SchedulingRequest#setAllocationTags(Set)
  12871. @param allocationTags <code>allocationsTags</code> of the request
  12872. @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
  12873. </doc>
  12874. </method>
  12875. <method name="resourceSizing" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
  12876. abstract="false" native="false" synchronized="false"
  12877. static="false" final="false" visibility="public"
  12878. deprecated="not deprecated">
  12879. <param name="resourceSizing" type="org.apache.hadoop.yarn.api.records.ResourceSizing"/>
  12880. <doc>
  12881. <![CDATA[Set the <code>executionType</code> of the request.
  12882. @see SchedulingRequest#setResourceSizing(ResourceSizing)
  12883. @param resourceSizing <code>resourceSizing</code> of the request
  12884. @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
  12885. </doc>
  12886. </method>
  12887. <method name="placementConstraintExpression" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
  12888. abstract="false" native="false" synchronized="false"
  12889. static="false" final="false" visibility="public"
  12890. deprecated="not deprecated">
  12891. <param name="placementConstraintExpression" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint"/>
  12892. <doc>
  12893. <![CDATA[Set the <code>placementConstraintExpression</code> of the request.
  12894. @see SchedulingRequest#setPlacementConstraint(
  12895. PlacementConstraint)
  12896. @param placementConstraintExpression <code>placementConstraints</code> of
  12897. the request
  12898. @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
  12899. </doc>
  12900. </method>
  12901. <method name="build" return="org.apache.hadoop.yarn.api.records.SchedulingRequest"
  12902. abstract="false" native="false" synchronized="false"
  12903. static="false" final="false" visibility="public"
  12904. deprecated="not deprecated">
  12905. <doc>
  12906. <![CDATA[Return generated {@link SchedulingRequest} object.
  12907. @return {@link SchedulingRequest}]]>
  12908. </doc>
  12909. </method>
  12910. <doc>
  12911. <![CDATA[Class to construct instances of {@link SchedulingRequest} with specific
  12912. options.]]>
  12913. </doc>
  12914. </class>
  12915. <!-- end class org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder -->
  12916. <!-- start class org.apache.hadoop.yarn.api.records.SignalContainerCommand -->
  12917. <class name="SignalContainerCommand" extends="java.lang.Enum"
  12918. abstract="false"
  12919. static="false" final="true" visibility="public"
  12920. deprecated="not deprecated">
  12921. <method name="values" return="org.apache.hadoop.yarn.api.records.SignalContainerCommand[]"
  12922. abstract="false" native="false" synchronized="false"
  12923. static="true" final="false" visibility="public"
  12924. deprecated="not deprecated">
  12925. </method>
  12926. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.SignalContainerCommand"
  12927. abstract="false" native="false" synchronized="false"
  12928. static="true" final="false" visibility="public"
  12929. deprecated="not deprecated">
  12930. <param name="name" type="java.lang.String"/>
  12931. </method>
  12932. <doc>
  12933. <![CDATA[Enumeration of various signal container commands.]]>
  12934. </doc>
  12935. </class>
  12936. <!-- end class org.apache.hadoop.yarn.api.records.SignalContainerCommand -->
  12937. <!-- start class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
  12938. <class name="StrictPreemptionContract" extends="java.lang.Object"
  12939. abstract="true"
  12940. static="false" final="false" visibility="public"
  12941. deprecated="not deprecated">
  12942. <constructor name="StrictPreemptionContract"
  12943. static="false" final="false" visibility="public"
  12944. deprecated="not deprecated">
  12945. </constructor>
  12946. <method name="getContainers" return="java.util.Set"
  12947. abstract="true" native="false" synchronized="false"
  12948. static="false" final="false" visibility="public"
  12949. deprecated="not deprecated">
  12950. <doc>
  12951. <![CDATA[Get the set of {@link PreemptionContainer} specifying containers owned by
  12952. the <code>ApplicationMaster</code> that may be reclaimed by the
  12953. <code>ResourceManager</code>.
  12954. @return the set of {@link ContainerId} to be preempted.]]>
  12955. </doc>
  12956. </method>
  12957. <doc>
  12958. <![CDATA[Enumeration of particular allocations to be reclaimed. The platform will
  12959. reclaim exactly these resources, so the <code>ApplicationMaster</code> (AM)
  12960. may attempt to checkpoint work or adjust its execution plan to accommodate
  12961. it. In contrast to {@link PreemptionContract}, the AM has no flexibility in
  12962. selecting which resources to return to the cluster.
  12963. @see PreemptionMessage]]>
  12964. </doc>
  12965. </class>
  12966. <!-- end class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
  12967. <!-- start class org.apache.hadoop.yarn.api.records.Token -->
  12968. <class name="Token" extends="java.lang.Object"
  12969. abstract="true"
  12970. static="false" final="false" visibility="public"
  12971. deprecated="not deprecated">
  12972. <constructor name="Token"
  12973. static="false" final="false" visibility="public"
  12974. deprecated="not deprecated">
  12975. </constructor>
  12976. <method name="getIdentifier" return="java.nio.ByteBuffer"
  12977. abstract="true" native="false" synchronized="false"
  12978. static="false" final="false" visibility="public"
  12979. deprecated="not deprecated">
  12980. <doc>
  12981. <![CDATA[Get the token identifier.
  12982. @return token identifier]]>
  12983. </doc>
  12984. </method>
  12985. <method name="getPassword" return="java.nio.ByteBuffer"
  12986. abstract="true" native="false" synchronized="false"
  12987. static="false" final="false" visibility="public"
  12988. deprecated="not deprecated">
  12989. <doc>
  12990. <![CDATA[Get the token password
  12991. @return token password]]>
  12992. </doc>
  12993. </method>
  12994. <method name="getKind" return="java.lang.String"
  12995. abstract="true" native="false" synchronized="false"
  12996. static="false" final="false" visibility="public"
  12997. deprecated="not deprecated">
  12998. <doc>
  12999. <![CDATA[Get the token kind.
  13000. @return token kind]]>
  13001. </doc>
  13002. </method>
  13003. <method name="getService" return="java.lang.String"
  13004. abstract="true" native="false" synchronized="false"
  13005. static="false" final="false" visibility="public"
  13006. deprecated="not deprecated">
  13007. <doc>
  13008. <![CDATA[Get the service to which the token is allocated.
  13009. @return service to which the token is allocated]]>
  13010. </doc>
  13011. </method>
  13012. <doc>
  13013. <![CDATA[<p><code>Token</code> is the security entity used by the framework
  13014. to verify authenticity of any resource.</p>]]>
  13015. </doc>
  13016. </class>
  13017. <!-- end class org.apache.hadoop.yarn.api.records.Token -->
  13018. <!-- start class org.apache.hadoop.yarn.api.records.UpdateContainerError -->
  13019. <class name="UpdateContainerError" extends="java.lang.Object"
  13020. abstract="true"
  13021. static="false" final="false" visibility="public"
  13022. deprecated="not deprecated">
  13023. <constructor name="UpdateContainerError"
  13024. static="false" final="false" visibility="public"
  13025. deprecated="not deprecated">
  13026. </constructor>
  13027. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdateContainerError"
  13028. abstract="false" native="false" synchronized="false"
  13029. static="true" final="false" visibility="public"
  13030. deprecated="not deprecated">
  13031. <param name="reason" type="java.lang.String"/>
  13032. <param name="updateContainerRequest" type="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"/>
  13033. </method>
  13034. <method name="getReason" return="java.lang.String"
  13035. abstract="true" native="false" synchronized="false"
  13036. static="false" final="false" visibility="public"
  13037. deprecated="not deprecated">
  13038. <doc>
  13039. <![CDATA[Get reason why the update request was not satisfiable.
  13040. @return Reason]]>
  13041. </doc>
  13042. </method>
  13043. <method name="setReason"
  13044. abstract="true" native="false" synchronized="false"
  13045. static="false" final="false" visibility="public"
  13046. deprecated="not deprecated">
  13047. <param name="reason" type="java.lang.String"/>
  13048. <doc>
  13049. <![CDATA[Set reason why the update request was not satisfiable.
  13050. @param reason Reason]]>
  13051. </doc>
  13052. </method>
  13053. <method name="getCurrentContainerVersion" return="int"
  13054. abstract="true" native="false" synchronized="false"
  13055. static="false" final="false" visibility="public"
  13056. deprecated="not deprecated">
  13057. <doc>
  13058. <![CDATA[Get current container version.
  13059. @return Current container Version.]]>
  13060. </doc>
  13061. </method>
  13062. <method name="setCurrentContainerVersion"
  13063. abstract="true" native="false" synchronized="false"
  13064. static="false" final="false" visibility="public"
  13065. deprecated="not deprecated">
  13066. <param name="currentVersion" type="int"/>
  13067. <doc>
  13068. <![CDATA[Set current container version.
  13069. @param currentVersion Current container version.]]>
  13070. </doc>
  13071. </method>
  13072. <method name="getUpdateContainerRequest" return="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"
  13073. abstract="true" native="false" synchronized="false"
  13074. static="false" final="false" visibility="public"
  13075. deprecated="not deprecated">
  13076. <doc>
  13077. <![CDATA[Get the {@code UpdateContainerRequest} that was not satisfiable.
  13078. @return UpdateContainerRequest]]>
  13079. </doc>
  13080. </method>
  13081. <method name="setUpdateContainerRequest"
  13082. abstract="true" native="false" synchronized="false"
  13083. static="false" final="false" visibility="public"
  13084. deprecated="not deprecated">
  13085. <param name="updateContainerRequest" type="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"/>
  13086. <doc>
  13087. <![CDATA[Set the {@code UpdateContainerRequest} that was not satisfiable.
  13088. @param updateContainerRequest Update Container Request]]>
  13089. </doc>
  13090. </method>
  13091. <method name="hashCode" return="int"
  13092. abstract="false" native="false" synchronized="false"
  13093. static="false" final="false" visibility="public"
  13094. deprecated="not deprecated">
  13095. </method>
  13096. <method name="toString" return="java.lang.String"
  13097. abstract="false" native="false" synchronized="false"
  13098. static="false" final="false" visibility="public"
  13099. deprecated="not deprecated">
  13100. </method>
  13101. <method name="equals" return="boolean"
  13102. abstract="false" native="false" synchronized="false"
  13103. static="false" final="false" visibility="public"
  13104. deprecated="not deprecated">
  13105. <param name="obj" type="java.lang.Object"/>
  13106. </method>
  13107. <doc>
  13108. <![CDATA[{@code UpdateContainerError} is used by the Scheduler to notify the
  13109. ApplicationMaster of an UpdateContainerRequest it cannot satisfy due to
  13110. an error in the request. It includes the update request as well as
  13111. a reason for why the request was not satisfiable.]]>
  13112. </doc>
  13113. </class>
  13114. <!-- end class org.apache.hadoop.yarn.api.records.UpdateContainerError -->
  13115. <!-- start class org.apache.hadoop.yarn.api.records.UpdateContainerRequest -->
  13116. <class name="UpdateContainerRequest" extends="java.lang.Object"
  13117. abstract="true"
  13118. static="false" final="false" visibility="public"
  13119. deprecated="not deprecated">
  13120. <constructor name="UpdateContainerRequest"
  13121. static="false" final="false" visibility="public"
  13122. deprecated="not deprecated">
  13123. </constructor>
  13124. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"
  13125. abstract="false" native="false" synchronized="false"
  13126. static="true" final="false" visibility="public"
  13127. deprecated="not deprecated">
  13128. <param name="version" type="int"/>
  13129. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  13130. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  13131. <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  13132. <param name="targetExecutionType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  13133. </method>
  13134. <method name="getContainerVersion" return="int"
  13135. abstract="true" native="false" synchronized="false"
  13136. static="false" final="false" visibility="public"
  13137. deprecated="not deprecated">
  13138. <doc>
  13139. <![CDATA[Get the <code>ContainerId</code> of the container.
  13140. @return <code>ContainerId</code> of the container]]>
  13141. </doc>
  13142. </method>
  13143. <method name="setContainerVersion"
  13144. abstract="true" native="false" synchronized="false"
  13145. static="false" final="false" visibility="public"
  13146. deprecated="not deprecated">
  13147. <param name="containerVersion" type="int"/>
  13148. <doc>
  13149. <![CDATA[Set the current version of the container.
  13150. @param containerVersion of the container]]>
  13151. </doc>
  13152. </method>
  13153. <method name="getContainerUpdateType" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType"
  13154. abstract="true" native="false" synchronized="false"
  13155. static="false" final="false" visibility="public"
  13156. deprecated="not deprecated">
  13157. <doc>
  13158. <![CDATA[Get the <code>ContainerUpdateType</code> of the container.
  13159. @return <code>ContainerUpdateType</code> of the container.]]>
  13160. </doc>
  13161. </method>
  13162. <method name="setContainerUpdateType"
  13163. abstract="true" native="false" synchronized="false"
  13164. static="false" final="false" visibility="public"
  13165. deprecated="not deprecated">
  13166. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  13167. <doc>
  13168. <![CDATA[Set the <code>ContainerUpdateType</code> of the container.
  13169. @param updateType of the Container]]>
  13170. </doc>
  13171. </method>
  13172. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  13173. abstract="true" native="false" synchronized="false"
  13174. static="false" final="false" visibility="public"
  13175. deprecated="not deprecated">
  13176. <doc>
  13177. <![CDATA[Get the <code>ContainerId</code> of the container.
  13178. @return <code>ContainerId</code> of the container]]>
  13179. </doc>
  13180. </method>
  13181. <method name="setContainerId"
  13182. abstract="true" native="false" synchronized="false"
  13183. static="false" final="false" visibility="public"
  13184. deprecated="not deprecated">
  13185. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  13186. <doc>
  13187. <![CDATA[Set the <code>ContainerId</code> of the container.
  13188. @param containerId <code>ContainerId</code> of the container]]>
  13189. </doc>
  13190. </method>
  13191. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  13192. abstract="true" native="false" synchronized="false"
  13193. static="false" final="false" visibility="public"
  13194. deprecated="not deprecated">
  13195. <doc>
  13196. <![CDATA[Get the target <code>ExecutionType</code> of the container.
  13197. @return <code>ExecutionType</code> of the container]]>
  13198. </doc>
  13199. </method>
  13200. <method name="setExecutionType"
  13201. abstract="true" native="false" synchronized="false"
  13202. static="false" final="false" visibility="public"
  13203. deprecated="not deprecated">
  13204. <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  13205. <doc>
  13206. <![CDATA[Set the target <code>ExecutionType</code> of the container.
  13207. @param executionType <code>ExecutionType</code> of the container]]>
  13208. </doc>
  13209. </method>
  13210. <method name="setCapability"
  13211. abstract="true" native="false" synchronized="false"
  13212. static="false" final="false" visibility="public"
  13213. deprecated="not deprecated">
  13214. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  13215. <doc>
  13216. <![CDATA[Set the <code>Resource</code> capability of the request.
  13217. @param capability <code>Resource</code> capability of the request]]>
  13218. </doc>
  13219. </method>
  13220. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  13221. abstract="true" native="false" synchronized="false"
  13222. static="false" final="false" visibility="public"
  13223. deprecated="not deprecated">
  13224. <doc>
  13225. <![CDATA[Get the <code>Resource</code> capability of the request.
  13226. @return <code>Resource</code> capability of the request]]>
  13227. </doc>
  13228. </method>
  13229. <method name="hashCode" return="int"
  13230. abstract="false" native="false" synchronized="false"
  13231. static="false" final="false" visibility="public"
  13232. deprecated="not deprecated">
  13233. </method>
  13234. <method name="toString" return="java.lang.String"
  13235. abstract="false" native="false" synchronized="false"
  13236. static="false" final="false" visibility="public"
  13237. deprecated="not deprecated">
  13238. </method>
  13239. <method name="equals" return="boolean"
  13240. abstract="false" native="false" synchronized="false"
  13241. static="false" final="false" visibility="public"
  13242. deprecated="not deprecated">
  13243. <param name="obj" type="java.lang.Object"/>
  13244. </method>
  13245. <doc>
  13246. <![CDATA[{@code UpdateContainerRequest} represents the request made by an
  13247. application to the {@code ResourceManager} to update an attribute of a
  13248. {@code Container} such as its Resource allocation or (@code ExecutionType}
  13249. <p>
  13250. It includes:
  13251. <ul>
  13252. <li>version for the container.</li>
  13253. <li>{@link ContainerId} for the container.</li>
  13254. <li>
  13255. {@link Resource} capability of the container after the update request
  13256. is completed.
  13257. </li>
  13258. <li>
  13259. {@link ExecutionType} of the container after the update request is
  13260. completed.
  13261. </li>
  13262. </ul>
  13263. Update rules:
  13264. <ul>
  13265. <li>
  13266. Currently only ONE aspect of the container can be updated per request
  13267. (user can either update Capability OR ExecutionType in one request..
  13268. not both).
  13269. </li>
  13270. <li>
  13271. There must be only 1 update request per container in an allocate call.
  13272. </li>
  13273. <li>
  13274. If a new update request is sent for a container (in a subsequent allocate
  13275. call) before the first one is satisfied by the Scheduler, it will
  13276. overwrite the previous request.
  13277. </li>
  13278. </ul>
  13279. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  13280. </doc>
  13281. </class>
  13282. <!-- end class org.apache.hadoop.yarn.api.records.UpdateContainerRequest -->
  13283. <!-- start class org.apache.hadoop.yarn.api.records.UpdatedContainer -->
  13284. <class name="UpdatedContainer" extends="java.lang.Object"
  13285. abstract="true"
  13286. static="false" final="false" visibility="public"
  13287. deprecated="not deprecated">
  13288. <constructor name="UpdatedContainer"
  13289. static="false" final="false" visibility="public"
  13290. deprecated="not deprecated">
  13291. </constructor>
  13292. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdatedContainer"
  13293. abstract="false" native="false" synchronized="false"
  13294. static="true" final="false" visibility="public"
  13295. deprecated="not deprecated">
  13296. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  13297. <param name="container" type="org.apache.hadoop.yarn.api.records.Container"/>
  13298. <doc>
  13299. <![CDATA[Static Factory method.
  13300. @param updateType ContainerUpdateType
  13301. @param container Container
  13302. @return UpdatedContainer]]>
  13303. </doc>
  13304. </method>
  13305. <method name="getUpdateType" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType"
  13306. abstract="true" native="false" synchronized="false"
  13307. static="false" final="false" visibility="public"
  13308. deprecated="not deprecated">
  13309. <doc>
  13310. <![CDATA[Get the <code>ContainerUpdateType</code>.
  13311. @return ContainerUpdateType]]>
  13312. </doc>
  13313. </method>
  13314. <method name="setUpdateType"
  13315. abstract="true" native="false" synchronized="false"
  13316. static="false" final="false" visibility="public"
  13317. deprecated="not deprecated">
  13318. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  13319. <doc>
  13320. <![CDATA[Set the <code>ContainerUpdateType</code>.
  13321. @param updateType ContainerUpdateType]]>
  13322. </doc>
  13323. </method>
  13324. <method name="getContainer" return="org.apache.hadoop.yarn.api.records.Container"
  13325. abstract="true" native="false" synchronized="false"
  13326. static="false" final="false" visibility="public"
  13327. deprecated="not deprecated">
  13328. <doc>
  13329. <![CDATA[Get the <code>Container</code>.
  13330. @return Container]]>
  13331. </doc>
  13332. </method>
  13333. <method name="setContainer"
  13334. abstract="true" native="false" synchronized="false"
  13335. static="false" final="false" visibility="public"
  13336. deprecated="not deprecated">
  13337. <param name="container" type="org.apache.hadoop.yarn.api.records.Container"/>
  13338. <doc>
  13339. <![CDATA[Set the <code>Container</code>.
  13340. @param container Container]]>
  13341. </doc>
  13342. </method>
  13343. <method name="hashCode" return="int"
  13344. abstract="false" native="false" synchronized="false"
  13345. static="false" final="false" visibility="public"
  13346. deprecated="not deprecated">
  13347. </method>
  13348. <method name="equals" return="boolean"
  13349. abstract="false" native="false" synchronized="false"
  13350. static="false" final="false" visibility="public"
  13351. deprecated="not deprecated">
  13352. <param name="obj" type="java.lang.Object"/>
  13353. </method>
  13354. <doc>
  13355. <![CDATA[An object that encapsulates an updated container and the
  13356. type of Update.]]>
  13357. </doc>
  13358. </class>
  13359. <!-- end class org.apache.hadoop.yarn.api.records.UpdatedContainer -->
  13360. <!-- start class org.apache.hadoop.yarn.api.records.URL -->
  13361. <class name="URL" extends="java.lang.Object"
  13362. abstract="true"
  13363. static="false" final="false" visibility="public"
  13364. deprecated="not deprecated">
  13365. <constructor name="URL"
  13366. static="false" final="false" visibility="public"
  13367. deprecated="not deprecated">
  13368. </constructor>
  13369. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.URL"
  13370. abstract="false" native="false" synchronized="false"
  13371. static="true" final="false" visibility="public"
  13372. deprecated="not deprecated">
  13373. <param name="scheme" type="java.lang.String"/>
  13374. <param name="host" type="java.lang.String"/>
  13375. <param name="port" type="int"/>
  13376. <param name="file" type="java.lang.String"/>
  13377. </method>
  13378. <method name="getScheme" return="java.lang.String"
  13379. abstract="true" native="false" synchronized="false"
  13380. static="false" final="false" visibility="public"
  13381. deprecated="not deprecated">
  13382. <doc>
  13383. <![CDATA[Get the scheme of the URL.
  13384. @return scheme of the URL]]>
  13385. </doc>
  13386. </method>
  13387. <method name="setScheme"
  13388. abstract="true" native="false" synchronized="false"
  13389. static="false" final="false" visibility="public"
  13390. deprecated="not deprecated">
  13391. <param name="scheme" type="java.lang.String"/>
  13392. <doc>
  13393. <![CDATA[Set the scheme of the URL
  13394. @param scheme scheme of the URL]]>
  13395. </doc>
  13396. </method>
  13397. <method name="getUserInfo" return="java.lang.String"
  13398. abstract="true" native="false" synchronized="false"
  13399. static="false" final="false" visibility="public"
  13400. deprecated="not deprecated">
  13401. <doc>
  13402. <![CDATA[Get the user info of the URL.
  13403. @return user info of the URL]]>
  13404. </doc>
  13405. </method>
  13406. <method name="setUserInfo"
  13407. abstract="true" native="false" synchronized="false"
  13408. static="false" final="false" visibility="public"
  13409. deprecated="not deprecated">
  13410. <param name="userInfo" type="java.lang.String"/>
  13411. <doc>
  13412. <![CDATA[Set the user info of the URL.
  13413. @param userInfo user info of the URL]]>
  13414. </doc>
  13415. </method>
  13416. <method name="getHost" return="java.lang.String"
  13417. abstract="true" native="false" synchronized="false"
  13418. static="false" final="false" visibility="public"
  13419. deprecated="not deprecated">
  13420. <doc>
  13421. <![CDATA[Get the host of the URL.
  13422. @return host of the URL]]>
  13423. </doc>
  13424. </method>
  13425. <method name="setHost"
  13426. abstract="true" native="false" synchronized="false"
  13427. static="false" final="false" visibility="public"
  13428. deprecated="not deprecated">
  13429. <param name="host" type="java.lang.String"/>
  13430. <doc>
  13431. <![CDATA[Set the host of the URL.
  13432. @param host host of the URL]]>
  13433. </doc>
  13434. </method>
  13435. <method name="getPort" return="int"
  13436. abstract="true" native="false" synchronized="false"
  13437. static="false" final="false" visibility="public"
  13438. deprecated="not deprecated">
  13439. <doc>
  13440. <![CDATA[Get the port of the URL.
  13441. @return port of the URL]]>
  13442. </doc>
  13443. </method>
  13444. <method name="setPort"
  13445. abstract="true" native="false" synchronized="false"
  13446. static="false" final="false" visibility="public"
  13447. deprecated="not deprecated">
  13448. <param name="port" type="int"/>
  13449. <doc>
  13450. <![CDATA[Set the port of the URL
  13451. @param port port of the URL]]>
  13452. </doc>
  13453. </method>
  13454. <method name="getFile" return="java.lang.String"
  13455. abstract="true" native="false" synchronized="false"
  13456. static="false" final="false" visibility="public"
  13457. deprecated="not deprecated">
  13458. <doc>
  13459. <![CDATA[Get the file of the URL.
  13460. @return file of the URL]]>
  13461. </doc>
  13462. </method>
  13463. <method name="setFile"
  13464. abstract="true" native="false" synchronized="false"
  13465. static="false" final="false" visibility="public"
  13466. deprecated="not deprecated">
  13467. <param name="file" type="java.lang.String"/>
  13468. <doc>
  13469. <![CDATA[Set the file of the URL.
  13470. @param file file of the URL]]>
  13471. </doc>
  13472. </method>
  13473. <method name="toPath" return="org.apache.hadoop.fs.Path"
  13474. abstract="false" native="false" synchronized="false"
  13475. static="false" final="false" visibility="public"
  13476. deprecated="not deprecated">
  13477. <exception name="URISyntaxException" type="java.net.URISyntaxException"/>
  13478. </method>
  13479. <method name="fromURI" return="org.apache.hadoop.yarn.api.records.URL"
  13480. abstract="false" native="false" synchronized="false"
  13481. static="true" final="false" visibility="public"
  13482. deprecated="not deprecated">
  13483. <param name="uri" type="java.net.URI"/>
  13484. </method>
  13485. <method name="fromPath" return="org.apache.hadoop.yarn.api.records.URL"
  13486. abstract="false" native="false" synchronized="false"
  13487. static="true" final="false" visibility="public"
  13488. deprecated="not deprecated">
  13489. <param name="path" type="org.apache.hadoop.fs.Path"/>
  13490. </method>
  13491. <doc>
  13492. <![CDATA[<p><code>URL</code> represents a serializable {@link java.net.URL}.</p>]]>
  13493. </doc>
  13494. </class>
  13495. <!-- end class org.apache.hadoop.yarn.api.records.URL -->
  13496. <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
  13497. <class name="YarnApplicationAttemptState" extends="java.lang.Enum"
  13498. abstract="false"
  13499. static="false" final="true" visibility="public"
  13500. deprecated="not deprecated">
  13501. <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState[]"
  13502. abstract="false" native="false" synchronized="false"
  13503. static="true" final="false" visibility="public"
  13504. deprecated="not deprecated">
  13505. </method>
  13506. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
  13507. abstract="false" native="false" synchronized="false"
  13508. static="true" final="false" visibility="public"
  13509. deprecated="not deprecated">
  13510. <param name="name" type="java.lang.String"/>
  13511. </method>
  13512. <doc>
  13513. <![CDATA[Enumeration of various states of a <code>RMAppAttempt</code>.]]>
  13514. </doc>
  13515. </class>
  13516. <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
  13517. <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
  13518. <class name="YarnApplicationState" extends="java.lang.Enum"
  13519. abstract="false"
  13520. static="false" final="true" visibility="public"
  13521. deprecated="not deprecated">
  13522. <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationState[]"
  13523. abstract="false" native="false" synchronized="false"
  13524. static="true" final="false" visibility="public"
  13525. deprecated="not deprecated">
  13526. </method>
  13527. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
  13528. abstract="false" native="false" synchronized="false"
  13529. static="true" final="false" visibility="public"
  13530. deprecated="not deprecated">
  13531. <param name="name" type="java.lang.String"/>
  13532. </method>
  13533. <doc>
  13534. <![CDATA[Enumeration of various states of an <code>ApplicationMaster</code>.]]>
  13535. </doc>
  13536. </class>
  13537. <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
  13538. <!-- start class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
  13539. <class name="YarnClusterMetrics" extends="java.lang.Object"
  13540. abstract="true"
  13541. static="false" final="false" visibility="public"
  13542. deprecated="not deprecated">
  13543. <constructor name="YarnClusterMetrics"
  13544. static="false" final="false" visibility="public"
  13545. deprecated="not deprecated">
  13546. </constructor>
  13547. <method name="getNumNodeManagers" return="int"
  13548. abstract="true" native="false" synchronized="false"
  13549. static="false" final="false" visibility="public"
  13550. deprecated="not deprecated">
  13551. <doc>
  13552. <![CDATA[Get the number of <code>NodeManager</code>s in the cluster.
  13553. @return number of <code>NodeManager</code>s in the cluster]]>
  13554. </doc>
  13555. </method>
  13556. <method name="getNumDecommissionedNodeManagers" return="int"
  13557. abstract="true" native="false" synchronized="false"
  13558. static="false" final="false" visibility="public"
  13559. deprecated="not deprecated">
  13560. <doc>
  13561. <![CDATA[Get the number of <code>DecommissionedNodeManager</code>s in the cluster.
  13562. @return number of <code>DecommissionedNodeManager</code>s in the cluster]]>
  13563. </doc>
  13564. </method>
  13565. <method name="getNumActiveNodeManagers" return="int"
  13566. abstract="true" native="false" synchronized="false"
  13567. static="false" final="false" visibility="public"
  13568. deprecated="not deprecated">
  13569. <doc>
  13570. <![CDATA[Get the number of <code>ActiveNodeManager</code>s in the cluster.
  13571. @return number of <code>ActiveNodeManager</code>s in the cluster]]>
  13572. </doc>
  13573. </method>
  13574. <method name="getNumLostNodeManagers" return="int"
  13575. abstract="true" native="false" synchronized="false"
  13576. static="false" final="false" visibility="public"
  13577. deprecated="not deprecated">
  13578. <doc>
  13579. <![CDATA[Get the number of <code>LostNodeManager</code>s in the cluster.
  13580. @return number of <code>LostNodeManager</code>s in the cluster]]>
  13581. </doc>
  13582. </method>
  13583. <method name="getNumUnhealthyNodeManagers" return="int"
  13584. abstract="true" native="false" synchronized="false"
  13585. static="false" final="false" visibility="public"
  13586. deprecated="not deprecated">
  13587. <doc>
  13588. <![CDATA[Get the number of <code>UnhealthyNodeManager</code>s in the cluster.
  13589. @return number of <code>UnhealthyNodeManager</code>s in the cluster]]>
  13590. </doc>
  13591. </method>
  13592. <method name="getNumRebootedNodeManagers" return="int"
  13593. abstract="true" native="false" synchronized="false"
  13594. static="false" final="false" visibility="public"
  13595. deprecated="not deprecated">
  13596. <doc>
  13597. <![CDATA[Get the number of <code>RebootedNodeManager</code>s in the cluster.
  13598. @return number of <code>RebootedNodeManager</code>s in the cluster]]>
  13599. </doc>
  13600. </method>
  13601. <doc>
  13602. <![CDATA[<p><code>YarnClusterMetrics</code> represents cluster metrics.</p>
  13603. <p>Currently only number of <code>NodeManager</code>s is provided.</p>]]>
  13604. </doc>
  13605. </class>
  13606. <!-- end class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
  13607. </package>
  13608. <package name="org.apache.hadoop.yarn.api.records.impl">
  13609. </package>
  13610. <package name="org.apache.hadoop.yarn.api.records.timeline">
  13611. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineAbout -->
  13612. <class name="TimelineAbout" extends="java.lang.Object"
  13613. abstract="false"
  13614. static="false" final="false" visibility="public"
  13615. deprecated="not deprecated">
  13616. <constructor name="TimelineAbout"
  13617. static="false" final="false" visibility="public"
  13618. deprecated="not deprecated">
  13619. </constructor>
  13620. <constructor name="TimelineAbout" type="java.lang.String"
  13621. static="false" final="false" visibility="public"
  13622. deprecated="not deprecated">
  13623. </constructor>
  13624. <method name="getAbout" return="java.lang.String"
  13625. abstract="false" native="false" synchronized="false"
  13626. static="false" final="false" visibility="public"
  13627. deprecated="not deprecated">
  13628. </method>
  13629. <method name="setAbout"
  13630. abstract="false" native="false" synchronized="false"
  13631. static="false" final="false" visibility="public"
  13632. deprecated="not deprecated">
  13633. <param name="about" type="java.lang.String"/>
  13634. </method>
  13635. <method name="getTimelineServiceVersion" return="java.lang.String"
  13636. abstract="false" native="false" synchronized="false"
  13637. static="false" final="false" visibility="public"
  13638. deprecated="not deprecated">
  13639. </method>
  13640. <method name="setTimelineServiceVersion"
  13641. abstract="false" native="false" synchronized="false"
  13642. static="false" final="false" visibility="public"
  13643. deprecated="not deprecated">
  13644. <param name="timelineServiceVersion" type="java.lang.String"/>
  13645. </method>
  13646. <method name="getTimelineServiceBuildVersion" return="java.lang.String"
  13647. abstract="false" native="false" synchronized="false"
  13648. static="false" final="false" visibility="public"
  13649. deprecated="not deprecated">
  13650. </method>
  13651. <method name="setTimelineServiceBuildVersion"
  13652. abstract="false" native="false" synchronized="false"
  13653. static="false" final="false" visibility="public"
  13654. deprecated="not deprecated">
  13655. <param name="timelineServiceBuildVersion" type="java.lang.String"/>
  13656. </method>
  13657. <method name="getTimelineServiceVersionBuiltOn" return="java.lang.String"
  13658. abstract="false" native="false" synchronized="false"
  13659. static="false" final="false" visibility="public"
  13660. deprecated="not deprecated">
  13661. </method>
  13662. <method name="setTimelineServiceVersionBuiltOn"
  13663. abstract="false" native="false" synchronized="false"
  13664. static="false" final="false" visibility="public"
  13665. deprecated="not deprecated">
  13666. <param name="timelineServiceVersionBuiltOn" type="java.lang.String"/>
  13667. </method>
  13668. <method name="getHadoopVersion" return="java.lang.String"
  13669. abstract="false" native="false" synchronized="false"
  13670. static="false" final="false" visibility="public"
  13671. deprecated="not deprecated">
  13672. </method>
  13673. <method name="setHadoopVersion"
  13674. abstract="false" native="false" synchronized="false"
  13675. static="false" final="false" visibility="public"
  13676. deprecated="not deprecated">
  13677. <param name="hadoopVersion" type="java.lang.String"/>
  13678. </method>
  13679. <method name="getHadoopBuildVersion" return="java.lang.String"
  13680. abstract="false" native="false" synchronized="false"
  13681. static="false" final="false" visibility="public"
  13682. deprecated="not deprecated">
  13683. </method>
  13684. <method name="setHadoopBuildVersion"
  13685. abstract="false" native="false" synchronized="false"
  13686. static="false" final="false" visibility="public"
  13687. deprecated="not deprecated">
  13688. <param name="hadoopBuildVersion" type="java.lang.String"/>
  13689. </method>
  13690. <method name="getHadoopVersionBuiltOn" return="java.lang.String"
  13691. abstract="false" native="false" synchronized="false"
  13692. static="false" final="false" visibility="public"
  13693. deprecated="not deprecated">
  13694. </method>
  13695. <method name="setHadoopVersionBuiltOn"
  13696. abstract="false" native="false" synchronized="false"
  13697. static="false" final="false" visibility="public"
  13698. deprecated="not deprecated">
  13699. <param name="hadoopVersionBuiltOn" type="java.lang.String"/>
  13700. </method>
  13701. </class>
  13702. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineAbout -->
  13703. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
  13704. <class name="TimelineDelegationTokenResponse" extends="java.lang.Object"
  13705. abstract="false"
  13706. static="false" final="false" visibility="public"
  13707. deprecated="not deprecated">
  13708. <constructor name="TimelineDelegationTokenResponse"
  13709. static="false" final="false" visibility="public"
  13710. deprecated="not deprecated">
  13711. </constructor>
  13712. <method name="getType" return="java.lang.String"
  13713. abstract="false" native="false" synchronized="false"
  13714. static="false" final="false" visibility="public"
  13715. deprecated="not deprecated">
  13716. </method>
  13717. <method name="setType"
  13718. abstract="false" native="false" synchronized="false"
  13719. static="false" final="false" visibility="public"
  13720. deprecated="not deprecated">
  13721. <param name="type" type="java.lang.String"/>
  13722. </method>
  13723. <method name="getContent" return="java.lang.Object"
  13724. abstract="false" native="false" synchronized="false"
  13725. static="false" final="false" visibility="public"
  13726. deprecated="not deprecated">
  13727. </method>
  13728. <method name="setContent"
  13729. abstract="false" native="false" synchronized="false"
  13730. static="false" final="false" visibility="public"
  13731. deprecated="not deprecated">
  13732. <param name="content" type="java.lang.Object"/>
  13733. </method>
  13734. <doc>
  13735. <![CDATA[The response of delegation token related request]]>
  13736. </doc>
  13737. </class>
  13738. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
  13739. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
  13740. <class name="TimelineDomain" extends="java.lang.Object"
  13741. abstract="false"
  13742. static="false" final="false" visibility="public"
  13743. deprecated="not deprecated">
  13744. <constructor name="TimelineDomain"
  13745. static="false" final="false" visibility="public"
  13746. deprecated="not deprecated">
  13747. </constructor>
  13748. <method name="getId" return="java.lang.String"
  13749. abstract="false" native="false" synchronized="false"
  13750. static="false" final="false" visibility="public"
  13751. deprecated="not deprecated">
  13752. <doc>
  13753. <![CDATA[Get the domain ID
  13754. @return the domain ID]]>
  13755. </doc>
  13756. </method>
  13757. <method name="setId"
  13758. abstract="false" native="false" synchronized="false"
  13759. static="false" final="false" visibility="public"
  13760. deprecated="not deprecated">
  13761. <param name="id" type="java.lang.String"/>
  13762. <doc>
  13763. <![CDATA[Set the domain ID
  13764. @param id the domain ID]]>
  13765. </doc>
  13766. </method>
  13767. <method name="getDescription" return="java.lang.String"
  13768. abstract="false" native="false" synchronized="false"
  13769. static="false" final="false" visibility="public"
  13770. deprecated="not deprecated">
  13771. <doc>
  13772. <![CDATA[Get the domain description
  13773. @return the domain description]]>
  13774. </doc>
  13775. </method>
  13776. <method name="setDescription"
  13777. abstract="false" native="false" synchronized="false"
  13778. static="false" final="false" visibility="public"
  13779. deprecated="not deprecated">
  13780. <param name="description" type="java.lang.String"/>
  13781. <doc>
  13782. <![CDATA[Set the domain description
  13783. @param description the domain description]]>
  13784. </doc>
  13785. </method>
  13786. <method name="getOwner" return="java.lang.String"
  13787. abstract="false" native="false" synchronized="false"
  13788. static="false" final="false" visibility="public"
  13789. deprecated="not deprecated">
  13790. <doc>
  13791. <![CDATA[Get the domain owner
  13792. @return the domain owner]]>
  13793. </doc>
  13794. </method>
  13795. <method name="setOwner"
  13796. abstract="false" native="false" synchronized="false"
  13797. static="false" final="false" visibility="public"
  13798. deprecated="not deprecated">
  13799. <param name="owner" type="java.lang.String"/>
  13800. <doc>
  13801. <![CDATA[Set the domain owner. The user doesn't need to set it, which will
  13802. automatically set to the user who puts the domain.
  13803. @param owner the domain owner]]>
  13804. </doc>
  13805. </method>
  13806. <method name="getReaders" return="java.lang.String"
  13807. abstract="false" native="false" synchronized="false"
  13808. static="false" final="false" visibility="public"
  13809. deprecated="not deprecated">
  13810. <doc>
  13811. <![CDATA[Get the reader (and/or reader group) list string
  13812. @return the reader (and/or reader group) list string]]>
  13813. </doc>
  13814. </method>
  13815. <method name="setReaders"
  13816. abstract="false" native="false" synchronized="false"
  13817. static="false" final="false" visibility="public"
  13818. deprecated="not deprecated">
  13819. <param name="readers" type="java.lang.String"/>
  13820. <doc>
  13821. <![CDATA[Set the reader (and/or reader group) list string
  13822. @param readers the reader (and/or reader group) list string]]>
  13823. </doc>
  13824. </method>
  13825. <method name="getWriters" return="java.lang.String"
  13826. abstract="false" native="false" synchronized="false"
  13827. static="false" final="false" visibility="public"
  13828. deprecated="not deprecated">
  13829. <doc>
  13830. <![CDATA[Get the writer (and/or writer group) list string
  13831. @return the writer (and/or writer group) list string]]>
  13832. </doc>
  13833. </method>
  13834. <method name="setWriters"
  13835. abstract="false" native="false" synchronized="false"
  13836. static="false" final="false" visibility="public"
  13837. deprecated="not deprecated">
  13838. <param name="writers" type="java.lang.String"/>
  13839. <doc>
  13840. <![CDATA[Set the writer (and/or writer group) list string
  13841. @param writers the writer (and/or writer group) list string]]>
  13842. </doc>
  13843. </method>
  13844. <method name="getCreatedTime" return="java.lang.Long"
  13845. abstract="false" native="false" synchronized="false"
  13846. static="false" final="false" visibility="public"
  13847. deprecated="not deprecated">
  13848. <doc>
  13849. <![CDATA[Get the created time of the domain
  13850. @return the created time of the domain]]>
  13851. </doc>
  13852. </method>
  13853. <method name="setCreatedTime"
  13854. abstract="false" native="false" synchronized="false"
  13855. static="false" final="false" visibility="public"
  13856. deprecated="not deprecated">
  13857. <param name="createdTime" type="java.lang.Long"/>
  13858. <doc>
  13859. <![CDATA[Set the created time of the domain
  13860. @param createdTime the created time of the domain]]>
  13861. </doc>
  13862. </method>
  13863. <method name="getModifiedTime" return="java.lang.Long"
  13864. abstract="false" native="false" synchronized="false"
  13865. static="false" final="false" visibility="public"
  13866. deprecated="not deprecated">
  13867. <doc>
  13868. <![CDATA[Get the modified time of the domain
  13869. @return the modified time of the domain]]>
  13870. </doc>
  13871. </method>
  13872. <method name="setModifiedTime"
  13873. abstract="false" native="false" synchronized="false"
  13874. static="false" final="false" visibility="public"
  13875. deprecated="not deprecated">
  13876. <param name="modifiedTime" type="java.lang.Long"/>
  13877. <doc>
  13878. <![CDATA[Set the modified time of the domain
  13879. @param modifiedTime the modified time of the domain]]>
  13880. </doc>
  13881. </method>
  13882. <doc>
  13883. <![CDATA[<p>
  13884. This class contains the information about a timeline domain, which is used
  13885. to a user to host a number of timeline entities, isolating them from others'.
  13886. The user can also define the reader and writer users/groups for the the
  13887. domain, which is used to control the access to its entities.
  13888. </p>
  13889. <p>
  13890. The reader and writer users/groups pattern that the user can supply is the
  13891. same as what <code>AccessControlList</code> takes.
  13892. </p>]]>
  13893. </doc>
  13894. </class>
  13895. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
  13896. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
  13897. <class name="TimelineDomains" extends="java.lang.Object"
  13898. abstract="false"
  13899. static="false" final="false" visibility="public"
  13900. deprecated="not deprecated">
  13901. <constructor name="TimelineDomains"
  13902. static="false" final="false" visibility="public"
  13903. deprecated="not deprecated">
  13904. </constructor>
  13905. <method name="getDomains" return="java.util.List"
  13906. abstract="false" native="false" synchronized="false"
  13907. static="false" final="false" visibility="public"
  13908. deprecated="not deprecated">
  13909. <doc>
  13910. <![CDATA[Get a list of domains
  13911. @return a list of domains]]>
  13912. </doc>
  13913. </method>
  13914. <method name="addDomain"
  13915. abstract="false" native="false" synchronized="false"
  13916. static="false" final="false" visibility="public"
  13917. deprecated="not deprecated">
  13918. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  13919. <doc>
  13920. <![CDATA[Add a single domain into the existing domain list
  13921. @param domain
  13922. a single domain]]>
  13923. </doc>
  13924. </method>
  13925. <method name="addDomains"
  13926. abstract="false" native="false" synchronized="false"
  13927. static="false" final="false" visibility="public"
  13928. deprecated="not deprecated">
  13929. <param name="domains" type="java.util.List"/>
  13930. <doc>
  13931. <![CDATA[All a list of domains into the existing domain list
  13932. @param domains
  13933. a list of domains]]>
  13934. </doc>
  13935. </method>
  13936. <method name="setDomains"
  13937. abstract="false" native="false" synchronized="false"
  13938. static="false" final="false" visibility="public"
  13939. deprecated="not deprecated">
  13940. <param name="domains" type="java.util.List"/>
  13941. <doc>
  13942. <![CDATA[Set the domain list to the given list of domains
  13943. @param domains
  13944. a list of domains]]>
  13945. </doc>
  13946. </method>
  13947. <doc>
  13948. <![CDATA[The class that hosts a list of timeline domains.]]>
  13949. </doc>
  13950. </class>
  13951. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
  13952. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
  13953. <class name="TimelineEntities" extends="java.lang.Object"
  13954. abstract="false"
  13955. static="false" final="false" visibility="public"
  13956. deprecated="not deprecated">
  13957. <constructor name="TimelineEntities"
  13958. static="false" final="false" visibility="public"
  13959. deprecated="not deprecated">
  13960. </constructor>
  13961. <method name="getEntities" return="java.util.List"
  13962. abstract="false" native="false" synchronized="false"
  13963. static="false" final="false" visibility="public"
  13964. deprecated="not deprecated">
  13965. <doc>
  13966. <![CDATA[Get a list of entities
  13967. @return a list of entities]]>
  13968. </doc>
  13969. </method>
  13970. <method name="addEntity"
  13971. abstract="false" native="false" synchronized="false"
  13972. static="false" final="false" visibility="public"
  13973. deprecated="not deprecated">
  13974. <param name="entity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
  13975. <doc>
  13976. <![CDATA[Add a single entity into the existing entity list
  13977. @param entity
  13978. a single entity]]>
  13979. </doc>
  13980. </method>
  13981. <method name="addEntities"
  13982. abstract="false" native="false" synchronized="false"
  13983. static="false" final="false" visibility="public"
  13984. deprecated="not deprecated">
  13985. <param name="entities" type="java.util.List"/>
  13986. <doc>
  13987. <![CDATA[All a list of entities into the existing entity list
  13988. @param entities
  13989. a list of entities]]>
  13990. </doc>
  13991. </method>
  13992. <method name="setEntities"
  13993. abstract="false" native="false" synchronized="false"
  13994. static="false" final="false" visibility="public"
  13995. deprecated="not deprecated">
  13996. <param name="entities" type="java.util.List"/>
  13997. <doc>
  13998. <![CDATA[Set the entity list to the given list of entities
  13999. @param entities
  14000. a list of entities]]>
  14001. </doc>
  14002. </method>
  14003. <doc>
  14004. <![CDATA[The class that hosts a list of timeline entities.]]>
  14005. </doc>
  14006. </class>
  14007. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
  14008. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
  14009. <class name="TimelineEntity" extends="java.lang.Object"
  14010. abstract="false"
  14011. static="false" final="false" visibility="public"
  14012. deprecated="not deprecated">
  14013. <implements name="java.lang.Comparable"/>
  14014. <constructor name="TimelineEntity"
  14015. static="false" final="false" visibility="public"
  14016. deprecated="not deprecated">
  14017. </constructor>
  14018. <method name="getEntityType" return="java.lang.String"
  14019. abstract="false" native="false" synchronized="false"
  14020. static="false" final="false" visibility="public"
  14021. deprecated="not deprecated">
  14022. <doc>
  14023. <![CDATA[Get the entity type
  14024. @return the entity type]]>
  14025. </doc>
  14026. </method>
  14027. <method name="setEntityType"
  14028. abstract="false" native="false" synchronized="false"
  14029. static="false" final="false" visibility="public"
  14030. deprecated="not deprecated">
  14031. <param name="entityType" type="java.lang.String"/>
  14032. <doc>
  14033. <![CDATA[Set the entity type
  14034. @param entityType
  14035. the entity type]]>
  14036. </doc>
  14037. </method>
  14038. <method name="getEntityId" return="java.lang.String"
  14039. abstract="false" native="false" synchronized="false"
  14040. static="false" final="false" visibility="public"
  14041. deprecated="not deprecated">
  14042. <doc>
  14043. <![CDATA[Get the entity Id
  14044. @return the entity Id]]>
  14045. </doc>
  14046. </method>
  14047. <method name="setEntityId"
  14048. abstract="false" native="false" synchronized="false"
  14049. static="false" final="false" visibility="public"
  14050. deprecated="not deprecated">
  14051. <param name="entityId" type="java.lang.String"/>
  14052. <doc>
  14053. <![CDATA[Set the entity Id
  14054. @param entityId
  14055. the entity Id]]>
  14056. </doc>
  14057. </method>
  14058. <method name="getStartTime" return="java.lang.Long"
  14059. abstract="false" native="false" synchronized="false"
  14060. static="false" final="false" visibility="public"
  14061. deprecated="not deprecated">
  14062. <doc>
  14063. <![CDATA[Get the start time of the entity
  14064. @return the start time of the entity]]>
  14065. </doc>
  14066. </method>
  14067. <method name="setStartTime"
  14068. abstract="false" native="false" synchronized="false"
  14069. static="false" final="false" visibility="public"
  14070. deprecated="not deprecated">
  14071. <param name="startTime" type="java.lang.Long"/>
  14072. <doc>
  14073. <![CDATA[Set the start time of the entity
  14074. @param startTime
  14075. the start time of the entity]]>
  14076. </doc>
  14077. </method>
  14078. <method name="getEvents" return="java.util.List"
  14079. abstract="false" native="false" synchronized="false"
  14080. static="false" final="false" visibility="public"
  14081. deprecated="not deprecated">
  14082. <doc>
  14083. <![CDATA[Get a list of events related to the entity
  14084. @return a list of events related to the entity]]>
  14085. </doc>
  14086. </method>
  14087. <method name="addEvent"
  14088. abstract="false" native="false" synchronized="false"
  14089. static="false" final="false" visibility="public"
  14090. deprecated="not deprecated">
  14091. <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  14092. <doc>
  14093. <![CDATA[Add a single event related to the entity to the existing event list
  14094. @param event
  14095. a single event related to the entity]]>
  14096. </doc>
  14097. </method>
  14098. <method name="addEvents"
  14099. abstract="false" native="false" synchronized="false"
  14100. static="false" final="false" visibility="public"
  14101. deprecated="not deprecated">
  14102. <param name="events" type="java.util.List"/>
  14103. <doc>
  14104. <![CDATA[Add a list of events related to the entity to the existing event list
  14105. @param events
  14106. a list of events related to the entity]]>
  14107. </doc>
  14108. </method>
  14109. <method name="setEvents"
  14110. abstract="false" native="false" synchronized="false"
  14111. static="false" final="false" visibility="public"
  14112. deprecated="not deprecated">
  14113. <param name="events" type="java.util.List"/>
  14114. <doc>
  14115. <![CDATA[Set the event list to the given list of events related to the entity
  14116. @param events
  14117. events a list of events related to the entity]]>
  14118. </doc>
  14119. </method>
  14120. <method name="getRelatedEntities" return="java.util.Map"
  14121. abstract="false" native="false" synchronized="false"
  14122. static="false" final="false" visibility="public"
  14123. deprecated="not deprecated">
  14124. <doc>
  14125. <![CDATA[Get the related entities
  14126. @return the related entities]]>
  14127. </doc>
  14128. </method>
  14129. <method name="addRelatedEntity"
  14130. abstract="false" native="false" synchronized="false"
  14131. static="false" final="false" visibility="public"
  14132. deprecated="not deprecated">
  14133. <param name="entityType" type="java.lang.String"/>
  14134. <param name="entityId" type="java.lang.String"/>
  14135. <doc>
  14136. <![CDATA[Add an entity to the existing related entity map
  14137. @param entityType
  14138. the entity type
  14139. @param entityId
  14140. the entity Id]]>
  14141. </doc>
  14142. </method>
  14143. <method name="addRelatedEntities"
  14144. abstract="false" native="false" synchronized="false"
  14145. static="false" final="false" visibility="public"
  14146. deprecated="not deprecated">
  14147. <param name="relatedEntities" type="java.util.Map"/>
  14148. <doc>
  14149. <![CDATA[Add a map of related entities to the existing related entity map
  14150. @param relatedEntities
  14151. a map of related entities]]>
  14152. </doc>
  14153. </method>
  14154. <method name="setRelatedEntities"
  14155. abstract="false" native="false" synchronized="false"
  14156. static="false" final="false" visibility="public"
  14157. deprecated="not deprecated">
  14158. <param name="relatedEntities" type="java.util.Map"/>
  14159. <doc>
  14160. <![CDATA[Set the related entity map to the given map of related entities
  14161. @param relatedEntities
  14162. a map of related entities]]>
  14163. </doc>
  14164. </method>
  14165. <method name="getPrimaryFilters" return="java.util.Map"
  14166. abstract="false" native="false" synchronized="false"
  14167. static="false" final="false" visibility="public"
  14168. deprecated="not deprecated">
  14169. <doc>
  14170. <![CDATA[Get the primary filters
  14171. @return the primary filters]]>
  14172. </doc>
  14173. </method>
  14174. <method name="addPrimaryFilter"
  14175. abstract="false" native="false" synchronized="false"
  14176. static="false" final="false" visibility="public"
  14177. deprecated="not deprecated">
  14178. <param name="key" type="java.lang.String"/>
  14179. <param name="value" type="java.lang.Object"/>
  14180. <doc>
  14181. <![CDATA[Add a single piece of primary filter to the existing primary filter map
  14182. @param key
  14183. the primary filter key
  14184. @param value
  14185. the primary filter value]]>
  14186. </doc>
  14187. </method>
  14188. <method name="addPrimaryFilters"
  14189. abstract="false" native="false" synchronized="false"
  14190. static="false" final="false" visibility="public"
  14191. deprecated="not deprecated">
  14192. <param name="primaryFilters" type="java.util.Map"/>
  14193. <doc>
  14194. <![CDATA[Add a map of primary filters to the existing primary filter map
  14195. @param primaryFilters
  14196. a map of primary filters]]>
  14197. </doc>
  14198. </method>
  14199. <method name="setPrimaryFilters"
  14200. abstract="false" native="false" synchronized="false"
  14201. static="false" final="false" visibility="public"
  14202. deprecated="not deprecated">
  14203. <param name="primaryFilters" type="java.util.Map"/>
  14204. <doc>
  14205. <![CDATA[Set the primary filter map to the given map of primary filters
  14206. @param primaryFilters
  14207. a map of primary filters]]>
  14208. </doc>
  14209. </method>
  14210. <method name="getOtherInfo" return="java.util.Map"
  14211. abstract="false" native="false" synchronized="false"
  14212. static="false" final="false" visibility="public"
  14213. deprecated="not deprecated">
  14214. <doc>
  14215. <![CDATA[Get the other information of the entity
  14216. @return the other information of the entity]]>
  14217. </doc>
  14218. </method>
  14219. <method name="addOtherInfo"
  14220. abstract="false" native="false" synchronized="false"
  14221. static="false" final="false" visibility="public"
  14222. deprecated="not deprecated">
  14223. <param name="key" type="java.lang.String"/>
  14224. <param name="value" type="java.lang.Object"/>
  14225. <doc>
  14226. <![CDATA[Add one piece of other information of the entity to the existing other info
  14227. map
  14228. @param key
  14229. the other information key
  14230. @param value
  14231. the other information value]]>
  14232. </doc>
  14233. </method>
  14234. <method name="addOtherInfo"
  14235. abstract="false" native="false" synchronized="false"
  14236. static="false" final="false" visibility="public"
  14237. deprecated="not deprecated">
  14238. <param name="otherInfo" type="java.util.Map"/>
  14239. <doc>
  14240. <![CDATA[Add a map of other information of the entity to the existing other info map
  14241. @param otherInfo
  14242. a map of other information]]>
  14243. </doc>
  14244. </method>
  14245. <method name="setOtherInfo"
  14246. abstract="false" native="false" synchronized="false"
  14247. static="false" final="false" visibility="public"
  14248. deprecated="not deprecated">
  14249. <param name="otherInfo" type="java.util.Map"/>
  14250. <doc>
  14251. <![CDATA[Set the other info map to the given map of other information
  14252. @param otherInfo
  14253. a map of other information]]>
  14254. </doc>
  14255. </method>
  14256. <method name="getDomainId" return="java.lang.String"
  14257. abstract="false" native="false" synchronized="false"
  14258. static="false" final="false" visibility="public"
  14259. deprecated="not deprecated">
  14260. <doc>
  14261. <![CDATA[Get the ID of the domain that the entity is to be put
  14262. @return the domain ID]]>
  14263. </doc>
  14264. </method>
  14265. <method name="setDomainId"
  14266. abstract="false" native="false" synchronized="false"
  14267. static="false" final="false" visibility="public"
  14268. deprecated="not deprecated">
  14269. <param name="domainId" type="java.lang.String"/>
  14270. <doc>
  14271. <![CDATA[Set the ID of the domain that the entity is to be put
  14272. @param domainId
  14273. the name space ID]]>
  14274. </doc>
  14275. </method>
  14276. <method name="hashCode" return="int"
  14277. abstract="false" native="false" synchronized="false"
  14278. static="false" final="false" visibility="public"
  14279. deprecated="not deprecated">
  14280. </method>
  14281. <method name="equals" return="boolean"
  14282. abstract="false" native="false" synchronized="false"
  14283. static="false" final="false" visibility="public"
  14284. deprecated="not deprecated">
  14285. <param name="obj" type="java.lang.Object"/>
  14286. </method>
  14287. <method name="compareTo" return="int"
  14288. abstract="false" native="false" synchronized="false"
  14289. static="false" final="false" visibility="public"
  14290. deprecated="not deprecated">
  14291. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
  14292. </method>
  14293. <doc>
  14294. <![CDATA[<p>
  14295. The class that contains the the meta information of some conceptual entity
  14296. and its related events. The entity can be an application, an application
  14297. attempt, a container or whatever the user-defined object.
  14298. </p>
  14299. <p>
  14300. Primary filters will be used to index the entities in
  14301. <code>TimelineStore</code>, such that users should carefully choose the
  14302. information they want to store as the primary filters. The remaining can be
  14303. stored as other information.
  14304. </p>]]>
  14305. </doc>
  14306. </class>
  14307. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
  14308. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId -->
  14309. <class name="TimelineEntityGroupId" extends="java.lang.Object"
  14310. abstract="false"
  14311. static="false" final="false" visibility="public"
  14312. deprecated="not deprecated">
  14313. <implements name="java.lang.Comparable"/>
  14314. <constructor name="TimelineEntityGroupId"
  14315. static="false" final="false" visibility="public"
  14316. deprecated="not deprecated">
  14317. </constructor>
  14318. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"
  14319. abstract="false" native="false" synchronized="false"
  14320. static="true" final="false" visibility="public"
  14321. deprecated="not deprecated">
  14322. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  14323. <param name="id" type="java.lang.String"/>
  14324. </method>
  14325. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  14326. abstract="false" native="false" synchronized="false"
  14327. static="false" final="false" visibility="public"
  14328. deprecated="not deprecated">
  14329. <doc>
  14330. <![CDATA[Get the <code>ApplicationId</code> of the
  14331. <code>TimelineEntityGroupId</code>.
  14332. @return <code>ApplicationId</code> of the
  14333. <code>TimelineEntityGroupId</code>]]>
  14334. </doc>
  14335. </method>
  14336. <method name="setApplicationId"
  14337. abstract="false" native="false" synchronized="false"
  14338. static="false" final="false" visibility="public"
  14339. deprecated="not deprecated">
  14340. <param name="appID" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  14341. </method>
  14342. <method name="getTimelineEntityGroupId" return="java.lang.String"
  14343. abstract="false" native="false" synchronized="false"
  14344. static="false" final="false" visibility="public"
  14345. deprecated="not deprecated">
  14346. <doc>
  14347. <![CDATA[Get the <code>timelineEntityGroupId</code>.
  14348. @return <code>timelineEntityGroupId</code>]]>
  14349. </doc>
  14350. </method>
  14351. <method name="hashCode" return="int"
  14352. abstract="false" native="false" synchronized="false"
  14353. static="false" final="false" visibility="public"
  14354. deprecated="not deprecated">
  14355. </method>
  14356. <method name="equals" return="boolean"
  14357. abstract="false" native="false" synchronized="false"
  14358. static="false" final="false" visibility="public"
  14359. deprecated="not deprecated">
  14360. <param name="obj" type="java.lang.Object"/>
  14361. </method>
  14362. <method name="compareTo" return="int"
  14363. abstract="false" native="false" synchronized="false"
  14364. static="false" final="false" visibility="public"
  14365. deprecated="not deprecated">
  14366. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"/>
  14367. </method>
  14368. <method name="toString" return="java.lang.String"
  14369. abstract="false" native="false" synchronized="false"
  14370. static="false" final="false" visibility="public"
  14371. deprecated="not deprecated">
  14372. </method>
  14373. <method name="fromString" return="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"
  14374. abstract="false" native="false" synchronized="false"
  14375. static="true" final="false" visibility="public"
  14376. deprecated="not deprecated">
  14377. <param name="timelineEntityGroupIdStr" type="java.lang.String"/>
  14378. </method>
  14379. <field name="TIMELINE_ENTITY_GROUPID_STR_PREFIX" type="java.lang.String"
  14380. transient="false" volatile="false"
  14381. static="true" final="true" visibility="public"
  14382. deprecated="not deprecated">
  14383. </field>
  14384. <doc>
  14385. <![CDATA[<p><code>TimelineEntityGroupId</code> is an abstract way for
  14386. timeline service users to represent #a group of related timeline data.
  14387. For example, all entities that represents one data flow DAG execution
  14388. can be grouped into one timeline entity group. </p>]]>
  14389. </doc>
  14390. </class>
  14391. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId -->
  14392. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
  14393. <class name="TimelineEvent" extends="java.lang.Object"
  14394. abstract="false"
  14395. static="false" final="false" visibility="public"
  14396. deprecated="not deprecated">
  14397. <implements name="java.lang.Comparable"/>
  14398. <constructor name="TimelineEvent"
  14399. static="false" final="false" visibility="public"
  14400. deprecated="not deprecated">
  14401. </constructor>
  14402. <method name="getTimestamp" return="long"
  14403. abstract="false" native="false" synchronized="false"
  14404. static="false" final="false" visibility="public"
  14405. deprecated="not deprecated">
  14406. <doc>
  14407. <![CDATA[Get the timestamp of the event
  14408. @return the timestamp of the event]]>
  14409. </doc>
  14410. </method>
  14411. <method name="setTimestamp"
  14412. abstract="false" native="false" synchronized="false"
  14413. static="false" final="false" visibility="public"
  14414. deprecated="not deprecated">
  14415. <param name="timestamp" type="long"/>
  14416. <doc>
  14417. <![CDATA[Set the timestamp of the event
  14418. @param timestamp
  14419. the timestamp of the event]]>
  14420. </doc>
  14421. </method>
  14422. <method name="getEventType" return="java.lang.String"
  14423. abstract="false" native="false" synchronized="false"
  14424. static="false" final="false" visibility="public"
  14425. deprecated="not deprecated">
  14426. <doc>
  14427. <![CDATA[Get the event type
  14428. @return the event type]]>
  14429. </doc>
  14430. </method>
  14431. <method name="setEventType"
  14432. abstract="false" native="false" synchronized="false"
  14433. static="false" final="false" visibility="public"
  14434. deprecated="not deprecated">
  14435. <param name="eventType" type="java.lang.String"/>
  14436. <doc>
  14437. <![CDATA[Set the event type
  14438. @param eventType
  14439. the event type]]>
  14440. </doc>
  14441. </method>
  14442. <method name="getEventInfo" return="java.util.Map"
  14443. abstract="false" native="false" synchronized="false"
  14444. static="false" final="false" visibility="public"
  14445. deprecated="not deprecated">
  14446. <doc>
  14447. <![CDATA[Set the information of the event
  14448. @return the information of the event]]>
  14449. </doc>
  14450. </method>
  14451. <method name="addEventInfo"
  14452. abstract="false" native="false" synchronized="false"
  14453. static="false" final="false" visibility="public"
  14454. deprecated="not deprecated">
  14455. <param name="key" type="java.lang.String"/>
  14456. <param name="value" type="java.lang.Object"/>
  14457. <doc>
  14458. <![CDATA[Add one piece of the information of the event to the existing information
  14459. map
  14460. @param key
  14461. the information key
  14462. @param value
  14463. the information value]]>
  14464. </doc>
  14465. </method>
  14466. <method name="addEventInfo"
  14467. abstract="false" native="false" synchronized="false"
  14468. static="false" final="false" visibility="public"
  14469. deprecated="not deprecated">
  14470. <param name="eventInfo" type="java.util.Map"/>
  14471. <doc>
  14472. <![CDATA[Add a map of the information of the event to the existing information map
  14473. @param eventInfo
  14474. a map of of the information of the event]]>
  14475. </doc>
  14476. </method>
  14477. <method name="setEventInfo"
  14478. abstract="false" native="false" synchronized="false"
  14479. static="false" final="false" visibility="public"
  14480. deprecated="not deprecated">
  14481. <param name="eventInfo" type="java.util.Map"/>
  14482. <doc>
  14483. <![CDATA[Set the information map to the given map of the information of the event
  14484. @param eventInfo
  14485. a map of of the information of the event]]>
  14486. </doc>
  14487. </method>
  14488. <method name="compareTo" return="int"
  14489. abstract="false" native="false" synchronized="false"
  14490. static="false" final="false" visibility="public"
  14491. deprecated="not deprecated">
  14492. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  14493. </method>
  14494. <method name="equals" return="boolean"
  14495. abstract="false" native="false" synchronized="false"
  14496. static="false" final="false" visibility="public"
  14497. deprecated="not deprecated">
  14498. <param name="o" type="java.lang.Object"/>
  14499. </method>
  14500. <method name="hashCode" return="int"
  14501. abstract="false" native="false" synchronized="false"
  14502. static="false" final="false" visibility="public"
  14503. deprecated="not deprecated">
  14504. </method>
  14505. <doc>
  14506. <![CDATA[The class that contains the information of an event that is related to some
  14507. conceptual entity of an application. Users are free to define what the event
  14508. means, such as starting an application, getting allocated a container and
  14509. etc.]]>
  14510. </doc>
  14511. </class>
  14512. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
  14513. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
  14514. <class name="TimelineEvents" extends="java.lang.Object"
  14515. abstract="false"
  14516. static="false" final="false" visibility="public"
  14517. deprecated="not deprecated">
  14518. <constructor name="TimelineEvents"
  14519. static="false" final="false" visibility="public"
  14520. deprecated="not deprecated">
  14521. </constructor>
  14522. <method name="getAllEvents" return="java.util.List"
  14523. abstract="false" native="false" synchronized="false"
  14524. static="false" final="false" visibility="public"
  14525. deprecated="not deprecated">
  14526. <doc>
  14527. <![CDATA[Get a list of {@link EventsOfOneEntity} instances
  14528. @return a list of {@link EventsOfOneEntity} instances]]>
  14529. </doc>
  14530. </method>
  14531. <method name="addEvent"
  14532. abstract="false" native="false" synchronized="false"
  14533. static="false" final="false" visibility="public"
  14534. deprecated="not deprecated">
  14535. <param name="eventsOfOneEntity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity"/>
  14536. <doc>
  14537. <![CDATA[Add a single {@link EventsOfOneEntity} instance into the existing list
  14538. @param eventsOfOneEntity
  14539. a single {@link EventsOfOneEntity} instance]]>
  14540. </doc>
  14541. </method>
  14542. <method name="addEvents"
  14543. abstract="false" native="false" synchronized="false"
  14544. static="false" final="false" visibility="public"
  14545. deprecated="not deprecated">
  14546. <param name="allEvents" type="java.util.List"/>
  14547. <doc>
  14548. <![CDATA[Add a list of {@link EventsOfOneEntity} instances into the existing list
  14549. @param allEvents
  14550. a list of {@link EventsOfOneEntity} instances]]>
  14551. </doc>
  14552. </method>
  14553. <method name="setEvents"
  14554. abstract="false" native="false" synchronized="false"
  14555. static="false" final="false" visibility="public"
  14556. deprecated="not deprecated">
  14557. <param name="allEvents" type="java.util.List"/>
  14558. <doc>
  14559. <![CDATA[Set the list to the given list of {@link EventsOfOneEntity} instances
  14560. @param allEvents
  14561. a list of {@link EventsOfOneEntity} instances]]>
  14562. </doc>
  14563. </method>
  14564. <doc>
  14565. <![CDATA[The class that hosts a list of events, which are categorized according to
  14566. their related entities.]]>
  14567. </doc>
  14568. </class>
  14569. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
  14570. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
  14571. <class name="TimelineEvents.EventsOfOneEntity" extends="java.lang.Object"
  14572. abstract="false"
  14573. static="true" final="false" visibility="public"
  14574. deprecated="not deprecated">
  14575. <constructor name="EventsOfOneEntity"
  14576. static="false" final="false" visibility="public"
  14577. deprecated="not deprecated">
  14578. </constructor>
  14579. <method name="getEntityId" return="java.lang.String"
  14580. abstract="false" native="false" synchronized="false"
  14581. static="false" final="false" visibility="public"
  14582. deprecated="not deprecated">
  14583. <doc>
  14584. <![CDATA[Get the entity Id
  14585. @return the entity Id]]>
  14586. </doc>
  14587. </method>
  14588. <method name="setEntityId"
  14589. abstract="false" native="false" synchronized="false"
  14590. static="false" final="false" visibility="public"
  14591. deprecated="not deprecated">
  14592. <param name="entityId" type="java.lang.String"/>
  14593. <doc>
  14594. <![CDATA[Set the entity Id
  14595. @param entityId
  14596. the entity Id]]>
  14597. </doc>
  14598. </method>
  14599. <method name="getEntityType" return="java.lang.String"
  14600. abstract="false" native="false" synchronized="false"
  14601. static="false" final="false" visibility="public"
  14602. deprecated="not deprecated">
  14603. <doc>
  14604. <![CDATA[Get the entity type
  14605. @return the entity type]]>
  14606. </doc>
  14607. </method>
  14608. <method name="setEntityType"
  14609. abstract="false" native="false" synchronized="false"
  14610. static="false" final="false" visibility="public"
  14611. deprecated="not deprecated">
  14612. <param name="entityType" type="java.lang.String"/>
  14613. <doc>
  14614. <![CDATA[Set the entity type
  14615. @param entityType
  14616. the entity type]]>
  14617. </doc>
  14618. </method>
  14619. <method name="getEvents" return="java.util.List"
  14620. abstract="false" native="false" synchronized="false"
  14621. static="false" final="false" visibility="public"
  14622. deprecated="not deprecated">
  14623. <doc>
  14624. <![CDATA[Get a list of events
  14625. @return a list of events]]>
  14626. </doc>
  14627. </method>
  14628. <method name="addEvent"
  14629. abstract="false" native="false" synchronized="false"
  14630. static="false" final="false" visibility="public"
  14631. deprecated="not deprecated">
  14632. <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  14633. <doc>
  14634. <![CDATA[Add a single event to the existing event list
  14635. @param event
  14636. a single event]]>
  14637. </doc>
  14638. </method>
  14639. <method name="addEvents"
  14640. abstract="false" native="false" synchronized="false"
  14641. static="false" final="false" visibility="public"
  14642. deprecated="not deprecated">
  14643. <param name="events" type="java.util.List"/>
  14644. <doc>
  14645. <![CDATA[Add a list of event to the existing event list
  14646. @param events
  14647. a list of events]]>
  14648. </doc>
  14649. </method>
  14650. <method name="setEvents"
  14651. abstract="false" native="false" synchronized="false"
  14652. static="false" final="false" visibility="public"
  14653. deprecated="not deprecated">
  14654. <param name="events" type="java.util.List"/>
  14655. <doc>
  14656. <![CDATA[Set the event list to the given list of events
  14657. @param events
  14658. a list of events]]>
  14659. </doc>
  14660. </method>
  14661. <doc>
  14662. <![CDATA[The class that hosts a list of events that are only related to one entity.]]>
  14663. </doc>
  14664. </class>
  14665. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
  14666. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineHealth -->
  14667. <class name="TimelineHealth" extends="java.lang.Object"
  14668. abstract="false"
  14669. static="false" final="false" visibility="public"
  14670. deprecated="not deprecated">
  14671. <constructor name="TimelineHealth" type="org.apache.hadoop.yarn.api.records.timeline.TimelineHealth.TimelineHealthStatus, java.lang.String"
  14672. static="false" final="false" visibility="public"
  14673. deprecated="not deprecated">
  14674. </constructor>
  14675. <constructor name="TimelineHealth"
  14676. static="false" final="false" visibility="public"
  14677. deprecated="not deprecated">
  14678. </constructor>
  14679. <method name="getHealthStatus" return="org.apache.hadoop.yarn.api.records.timeline.TimelineHealth.TimelineHealthStatus"
  14680. abstract="false" native="false" synchronized="false"
  14681. static="false" final="false" visibility="public"
  14682. deprecated="not deprecated">
  14683. </method>
  14684. <method name="getDiagnosticsInfo" return="java.lang.String"
  14685. abstract="false" native="false" synchronized="false"
  14686. static="false" final="false" visibility="public"
  14687. deprecated="not deprecated">
  14688. </method>
  14689. <method name="setHealthStatus"
  14690. abstract="false" native="false" synchronized="false"
  14691. static="false" final="false" visibility="public"
  14692. deprecated="not deprecated">
  14693. <param name="healthStatus" type="org.apache.hadoop.yarn.api.records.timeline.TimelineHealth.TimelineHealthStatus"/>
  14694. </method>
  14695. <method name="setDiagnosticsInfo"
  14696. abstract="false" native="false" synchronized="false"
  14697. static="false" final="false" visibility="public"
  14698. deprecated="not deprecated">
  14699. <param name="diagnosticsInfo" type="java.lang.String"/>
  14700. </method>
  14701. <doc>
  14702. <![CDATA[This class holds health information for ATS.]]>
  14703. </doc>
  14704. </class>
  14705. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineHealth -->
  14706. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
  14707. <class name="TimelinePutResponse" extends="java.lang.Object"
  14708. abstract="false"
  14709. static="false" final="false" visibility="public"
  14710. deprecated="not deprecated">
  14711. <constructor name="TimelinePutResponse"
  14712. static="false" final="false" visibility="public"
  14713. deprecated="not deprecated">
  14714. </constructor>
  14715. <method name="getErrors" return="java.util.List"
  14716. abstract="false" native="false" synchronized="false"
  14717. static="false" final="false" visibility="public"
  14718. deprecated="not deprecated">
  14719. <doc>
  14720. <![CDATA[Get a list of {@link TimelinePutError} instances
  14721. @return a list of {@link TimelinePutError} instances]]>
  14722. </doc>
  14723. </method>
  14724. <method name="addError"
  14725. abstract="false" native="false" synchronized="false"
  14726. static="false" final="false" visibility="public"
  14727. deprecated="not deprecated">
  14728. <param name="error" type="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError"/>
  14729. <doc>
  14730. <![CDATA[Add a single {@link TimelinePutError} instance into the existing list
  14731. @param error
  14732. a single {@link TimelinePutError} instance]]>
  14733. </doc>
  14734. </method>
  14735. <method name="addErrors"
  14736. abstract="false" native="false" synchronized="false"
  14737. static="false" final="false" visibility="public"
  14738. deprecated="not deprecated">
  14739. <param name="errors" type="java.util.List"/>
  14740. <doc>
  14741. <![CDATA[Add a list of {@link TimelinePutError} instances into the existing list
  14742. @param errors
  14743. a list of {@link TimelinePutError} instances]]>
  14744. </doc>
  14745. </method>
  14746. <method name="setErrors"
  14747. abstract="false" native="false" synchronized="false"
  14748. static="false" final="false" visibility="public"
  14749. deprecated="not deprecated">
  14750. <param name="errors" type="java.util.List"/>
  14751. <doc>
  14752. <![CDATA[Set the list to the given list of {@link TimelinePutError} instances
  14753. @param errors
  14754. a list of {@link TimelinePutError} instances]]>
  14755. </doc>
  14756. </method>
  14757. <doc>
  14758. <![CDATA[A class that holds a list of put errors. This is the response returned when a
  14759. list of {@link TimelineEntity} objects is added to the timeline. If there are errors
  14760. in storing individual entity objects, they will be indicated in the list of
  14761. errors.]]>
  14762. </doc>
  14763. </class>
  14764. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
  14765. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
  14766. <class name="TimelinePutResponse.TimelinePutError" extends="java.lang.Object"
  14767. abstract="false"
  14768. static="true" final="false" visibility="public"
  14769. deprecated="not deprecated">
  14770. <constructor name="TimelinePutError"
  14771. static="false" final="false" visibility="public"
  14772. deprecated="not deprecated">
  14773. </constructor>
  14774. <method name="getEntityId" return="java.lang.String"
  14775. abstract="false" native="false" synchronized="false"
  14776. static="false" final="false" visibility="public"
  14777. deprecated="not deprecated">
  14778. <doc>
  14779. <![CDATA[Get the entity Id
  14780. @return the entity Id]]>
  14781. </doc>
  14782. </method>
  14783. <method name="setEntityId"
  14784. abstract="false" native="false" synchronized="false"
  14785. static="false" final="false" visibility="public"
  14786. deprecated="not deprecated">
  14787. <param name="entityId" type="java.lang.String"/>
  14788. <doc>
  14789. <![CDATA[Set the entity Id
  14790. @param entityId
  14791. the entity Id]]>
  14792. </doc>
  14793. </method>
  14794. <method name="getEntityType" return="java.lang.String"
  14795. abstract="false" native="false" synchronized="false"
  14796. static="false" final="false" visibility="public"
  14797. deprecated="not deprecated">
  14798. <doc>
  14799. <![CDATA[Get the entity type
  14800. @return the entity type]]>
  14801. </doc>
  14802. </method>
  14803. <method name="setEntityType"
  14804. abstract="false" native="false" synchronized="false"
  14805. static="false" final="false" visibility="public"
  14806. deprecated="not deprecated">
  14807. <param name="entityType" type="java.lang.String"/>
  14808. <doc>
  14809. <![CDATA[Set the entity type
  14810. @param entityType
  14811. the entity type]]>
  14812. </doc>
  14813. </method>
  14814. <method name="getErrorCode" return="int"
  14815. abstract="false" native="false" synchronized="false"
  14816. static="false" final="false" visibility="public"
  14817. deprecated="not deprecated">
  14818. <doc>
  14819. <![CDATA[Get the error code
  14820. @return an error code]]>
  14821. </doc>
  14822. </method>
  14823. <method name="setErrorCode"
  14824. abstract="false" native="false" synchronized="false"
  14825. static="false" final="false" visibility="public"
  14826. deprecated="not deprecated">
  14827. <param name="errorCode" type="int"/>
  14828. <doc>
  14829. <![CDATA[Set the error code to the given error code
  14830. @param errorCode
  14831. an error code]]>
  14832. </doc>
  14833. </method>
  14834. <field name="NO_START_TIME" type="int"
  14835. transient="false" volatile="false"
  14836. static="true" final="true" visibility="public"
  14837. deprecated="not deprecated">
  14838. <doc>
  14839. <![CDATA[Error code returned when no start time can be found when putting an
  14840. entity. This occurs when the entity does not already exist in the store
  14841. and it is put with no start time or events specified.]]>
  14842. </doc>
  14843. </field>
  14844. <field name="IO_EXCEPTION" type="int"
  14845. transient="false" volatile="false"
  14846. static="true" final="true" visibility="public"
  14847. deprecated="not deprecated">
  14848. <doc>
  14849. <![CDATA[Error code returned if an IOException is encountered when putting an
  14850. entity.]]>
  14851. </doc>
  14852. </field>
  14853. <field name="SYSTEM_FILTER_CONFLICT" type="int"
  14854. transient="false" volatile="false"
  14855. static="true" final="true" visibility="public"
  14856. deprecated="not deprecated">
  14857. <doc>
  14858. <![CDATA[Error code returned if the user specifies the timeline system reserved
  14859. filter key]]>
  14860. </doc>
  14861. </field>
  14862. <field name="ACCESS_DENIED" type="int"
  14863. transient="false" volatile="false"
  14864. static="true" final="true" visibility="public"
  14865. deprecated="not deprecated">
  14866. <doc>
  14867. <![CDATA[Error code returned if the user is denied to access the timeline data]]>
  14868. </doc>
  14869. </field>
  14870. <field name="NO_DOMAIN" type="int"
  14871. transient="false" volatile="false"
  14872. static="true" final="true" visibility="public"
  14873. deprecated="not deprecated">
  14874. <doc>
  14875. <![CDATA[Error code returned if the entity doesn't have an valid domain ID]]>
  14876. </doc>
  14877. </field>
  14878. <field name="FORBIDDEN_RELATION" type="int"
  14879. transient="false" volatile="false"
  14880. static="true" final="true" visibility="public"
  14881. deprecated="not deprecated">
  14882. <doc>
  14883. <![CDATA[Error code returned if the user is denied to relate the entity to another
  14884. one in different domain]]>
  14885. </doc>
  14886. </field>
  14887. <field name="EXPIRED_ENTITY" type="int"
  14888. transient="false" volatile="false"
  14889. static="true" final="true" visibility="public"
  14890. deprecated="not deprecated">
  14891. <doc>
  14892. <![CDATA[Error code returned if the entity start time is before the eviction
  14893. period of old data.]]>
  14894. </doc>
  14895. </field>
  14896. <doc>
  14897. <![CDATA[A class that holds the error code for one entity.]]>
  14898. </doc>
  14899. </class>
  14900. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
  14901. </package>
  14902. <package name="org.apache.hadoop.yarn.api.records.timelineservice">
  14903. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationAttemptEntity -->
  14904. <class name="ApplicationAttemptEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  14905. abstract="false"
  14906. static="false" final="false" visibility="public"
  14907. deprecated="not deprecated">
  14908. <constructor name="ApplicationAttemptEntity"
  14909. static="false" final="false" visibility="public"
  14910. deprecated="not deprecated">
  14911. </constructor>
  14912. <constructor name="ApplicationAttemptEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  14913. static="false" final="false" visibility="public"
  14914. deprecated="not deprecated">
  14915. </constructor>
  14916. <doc>
  14917. <![CDATA[This entity represents an application attempt.]]>
  14918. </doc>
  14919. </class>
  14920. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationAttemptEntity -->
  14921. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationEntity -->
  14922. <class name="ApplicationEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  14923. abstract="false"
  14924. static="false" final="false" visibility="public"
  14925. deprecated="not deprecated">
  14926. <constructor name="ApplicationEntity"
  14927. static="false" final="false" visibility="public"
  14928. deprecated="not deprecated">
  14929. </constructor>
  14930. <constructor name="ApplicationEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  14931. static="false" final="false" visibility="public"
  14932. deprecated="not deprecated">
  14933. </constructor>
  14934. <method name="getQueue" return="java.lang.String"
  14935. abstract="false" native="false" synchronized="false"
  14936. static="false" final="false" visibility="public"
  14937. deprecated="not deprecated">
  14938. </method>
  14939. <method name="setQueue"
  14940. abstract="false" native="false" synchronized="false"
  14941. static="false" final="false" visibility="public"
  14942. deprecated="not deprecated">
  14943. <param name="queue" type="java.lang.String"/>
  14944. </method>
  14945. <method name="isApplicationEntity" return="boolean"
  14946. abstract="false" native="false" synchronized="false"
  14947. static="true" final="false" visibility="public"
  14948. deprecated="not deprecated">
  14949. <param name="te" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  14950. <doc>
  14951. <![CDATA[Checks if the input TimelineEntity object is an ApplicationEntity.
  14952. @param te TimelineEntity object.
  14953. @return true if input is an ApplicationEntity, false otherwise]]>
  14954. </doc>
  14955. </method>
  14956. <method name="getApplicationEvent" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent"
  14957. abstract="false" native="false" synchronized="false"
  14958. static="true" final="false" visibility="public"
  14959. deprecated="not deprecated">
  14960. <param name="te" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  14961. <param name="eventId" type="java.lang.String"/>
  14962. <doc>
  14963. <![CDATA[@param te TimelineEntity object.
  14964. @param eventId event with this id needs to be fetched
  14965. @return TimelineEvent if TimelineEntity contains the desired event.]]>
  14966. </doc>
  14967. </method>
  14968. <field name="QUEUE_INFO_KEY" type="java.lang.String"
  14969. transient="false" volatile="false"
  14970. static="true" final="true" visibility="public"
  14971. deprecated="not deprecated">
  14972. </field>
  14973. <doc>
  14974. <![CDATA[This entity represents an application.]]>
  14975. </doc>
  14976. </class>
  14977. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationEntity -->
  14978. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ClusterEntity -->
  14979. <class name="ClusterEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  14980. abstract="false"
  14981. static="false" final="false" visibility="public"
  14982. deprecated="not deprecated">
  14983. <constructor name="ClusterEntity"
  14984. static="false" final="false" visibility="public"
  14985. deprecated="not deprecated">
  14986. </constructor>
  14987. <constructor name="ClusterEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  14988. static="false" final="false" visibility="public"
  14989. deprecated="not deprecated">
  14990. </constructor>
  14991. <doc>
  14992. <![CDATA[This entity represents a YARN cluster.]]>
  14993. </doc>
  14994. </class>
  14995. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ClusterEntity -->
  14996. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ContainerEntity -->
  14997. <class name="ContainerEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  14998. abstract="false"
  14999. static="false" final="false" visibility="public"
  15000. deprecated="not deprecated">
  15001. <constructor name="ContainerEntity"
  15002. static="false" final="false" visibility="public"
  15003. deprecated="not deprecated">
  15004. </constructor>
  15005. <constructor name="ContainerEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15006. static="false" final="false" visibility="public"
  15007. deprecated="not deprecated">
  15008. </constructor>
  15009. <doc>
  15010. <![CDATA[This entity represents a container belonging to an application attempt.]]>
  15011. </doc>
  15012. </class>
  15013. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ContainerEntity -->
  15014. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.FlowActivityEntity -->
  15015. <class name="FlowActivityEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15016. abstract="false"
  15017. static="false" final="false" visibility="public"
  15018. deprecated="not deprecated">
  15019. <constructor name="FlowActivityEntity"
  15020. static="false" final="false" visibility="public"
  15021. deprecated="not deprecated">
  15022. </constructor>
  15023. <constructor name="FlowActivityEntity" type="java.lang.String, long, java.lang.String, java.lang.String"
  15024. static="false" final="false" visibility="public"
  15025. deprecated="not deprecated">
  15026. </constructor>
  15027. <constructor name="FlowActivityEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15028. static="false" final="false" visibility="public"
  15029. deprecated="not deprecated">
  15030. </constructor>
  15031. <method name="getId" return="java.lang.String"
  15032. abstract="false" native="false" synchronized="false"
  15033. static="false" final="false" visibility="public"
  15034. deprecated="not deprecated">
  15035. </method>
  15036. <method name="compareTo" return="int"
  15037. abstract="false" native="false" synchronized="false"
  15038. static="false" final="false" visibility="public"
  15039. deprecated="not deprecated">
  15040. <param name="entity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  15041. </method>
  15042. <method name="equals" return="boolean"
  15043. abstract="false" native="false" synchronized="false"
  15044. static="false" final="false" visibility="public"
  15045. deprecated="not deprecated">
  15046. <param name="obj" type="java.lang.Object"/>
  15047. <doc>
  15048. <![CDATA[Reuse the base class equals method.]]>
  15049. </doc>
  15050. </method>
  15051. <method name="hashCode" return="int"
  15052. abstract="false" native="false" synchronized="false"
  15053. static="false" final="false" visibility="public"
  15054. deprecated="not deprecated">
  15055. <doc>
  15056. <![CDATA[Reuse the base class hashCode method.]]>
  15057. </doc>
  15058. </method>
  15059. <method name="getCluster" return="java.lang.String"
  15060. abstract="false" native="false" synchronized="false"
  15061. static="false" final="false" visibility="public"
  15062. deprecated="not deprecated">
  15063. </method>
  15064. <method name="setCluster"
  15065. abstract="false" native="false" synchronized="false"
  15066. static="false" final="false" visibility="public"
  15067. deprecated="not deprecated">
  15068. <param name="cluster" type="java.lang.String"/>
  15069. </method>
  15070. <method name="getDate" return="java.util.Date"
  15071. abstract="false" native="false" synchronized="false"
  15072. static="false" final="false" visibility="public"
  15073. deprecated="not deprecated">
  15074. </method>
  15075. <method name="setDate"
  15076. abstract="false" native="false" synchronized="false"
  15077. static="false" final="false" visibility="public"
  15078. deprecated="not deprecated">
  15079. <param name="time" type="long"/>
  15080. </method>
  15081. <method name="getUser" return="java.lang.String"
  15082. abstract="false" native="false" synchronized="false"
  15083. static="false" final="false" visibility="public"
  15084. deprecated="not deprecated">
  15085. </method>
  15086. <method name="setUser"
  15087. abstract="false" native="false" synchronized="false"
  15088. static="false" final="false" visibility="public"
  15089. deprecated="not deprecated">
  15090. <param name="user" type="java.lang.String"/>
  15091. </method>
  15092. <method name="getFlowName" return="java.lang.String"
  15093. abstract="false" native="false" synchronized="false"
  15094. static="false" final="false" visibility="public"
  15095. deprecated="not deprecated">
  15096. </method>
  15097. <method name="setFlowName"
  15098. abstract="false" native="false" synchronized="false"
  15099. static="false" final="false" visibility="public"
  15100. deprecated="not deprecated">
  15101. <param name="flowName" type="java.lang.String"/>
  15102. </method>
  15103. <method name="addFlowRun"
  15104. abstract="false" native="false" synchronized="false"
  15105. static="false" final="false" visibility="public"
  15106. deprecated="not deprecated">
  15107. <param name="run" type="org.apache.hadoop.yarn.api.records.timelineservice.FlowRunEntity"/>
  15108. </method>
  15109. <method name="addFlowRuns"
  15110. abstract="false" native="false" synchronized="false"
  15111. static="false" final="false" visibility="public"
  15112. deprecated="not deprecated">
  15113. <param name="runs" type="java.util.Collection"/>
  15114. </method>
  15115. <method name="getFlowRuns" return="java.util.NavigableSet"
  15116. abstract="false" native="false" synchronized="false"
  15117. static="false" final="false" visibility="public"
  15118. deprecated="not deprecated">
  15119. </method>
  15120. <method name="getNumberOfRuns" return="int"
  15121. abstract="false" native="false" synchronized="false"
  15122. static="false" final="false" visibility="public"
  15123. deprecated="not deprecated">
  15124. </method>
  15125. <field name="CLUSTER_INFO_KEY" type="java.lang.String"
  15126. transient="false" volatile="false"
  15127. static="true" final="true" visibility="public"
  15128. deprecated="not deprecated">
  15129. </field>
  15130. <field name="DATE_INFO_KEY" type="java.lang.String"
  15131. transient="false" volatile="false"
  15132. static="true" final="true" visibility="public"
  15133. deprecated="not deprecated">
  15134. </field>
  15135. <field name="USER_INFO_KEY" type="java.lang.String"
  15136. transient="false" volatile="false"
  15137. static="true" final="true" visibility="public"
  15138. deprecated="not deprecated">
  15139. </field>
  15140. <field name="FLOW_NAME_INFO_KEY" type="java.lang.String"
  15141. transient="false" volatile="false"
  15142. static="true" final="true" visibility="public"
  15143. deprecated="not deprecated">
  15144. </field>
  15145. <doc>
  15146. <![CDATA[Entity that represents a record for flow activity. It's essentially a
  15147. container entity for flow runs with limited information.]]>
  15148. </doc>
  15149. </class>
  15150. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.FlowActivityEntity -->
  15151. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.FlowRunEntity -->
  15152. <class name="FlowRunEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  15153. abstract="false"
  15154. static="false" final="false" visibility="public"
  15155. deprecated="not deprecated">
  15156. <constructor name="FlowRunEntity"
  15157. static="false" final="false" visibility="public"
  15158. deprecated="not deprecated">
  15159. </constructor>
  15160. <constructor name="FlowRunEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15161. static="false" final="false" visibility="public"
  15162. deprecated="not deprecated">
  15163. </constructor>
  15164. <method name="getId" return="java.lang.String"
  15165. abstract="false" native="false" synchronized="false"
  15166. static="false" final="false" visibility="public"
  15167. deprecated="not deprecated">
  15168. </method>
  15169. <method name="getUser" return="java.lang.String"
  15170. abstract="false" native="false" synchronized="false"
  15171. static="false" final="false" visibility="public"
  15172. deprecated="not deprecated">
  15173. </method>
  15174. <method name="setUser"
  15175. abstract="false" native="false" synchronized="false"
  15176. static="false" final="false" visibility="public"
  15177. deprecated="not deprecated">
  15178. <param name="user" type="java.lang.String"/>
  15179. </method>
  15180. <method name="getName" return="java.lang.String"
  15181. abstract="false" native="false" synchronized="false"
  15182. static="false" final="false" visibility="public"
  15183. deprecated="not deprecated">
  15184. </method>
  15185. <method name="setName"
  15186. abstract="false" native="false" synchronized="false"
  15187. static="false" final="false" visibility="public"
  15188. deprecated="not deprecated">
  15189. <param name="name" type="java.lang.String"/>
  15190. </method>
  15191. <method name="getVersion" return="java.lang.String"
  15192. abstract="false" native="false" synchronized="false"
  15193. static="false" final="false" visibility="public"
  15194. deprecated="not deprecated">
  15195. </method>
  15196. <method name="setVersion"
  15197. abstract="false" native="false" synchronized="false"
  15198. static="false" final="false" visibility="public"
  15199. deprecated="not deprecated">
  15200. <param name="version" type="java.lang.String"/>
  15201. </method>
  15202. <method name="getRunId" return="long"
  15203. abstract="false" native="false" synchronized="false"
  15204. static="false" final="false" visibility="public"
  15205. deprecated="not deprecated">
  15206. </method>
  15207. <method name="setRunId"
  15208. abstract="false" native="false" synchronized="false"
  15209. static="false" final="false" visibility="public"
  15210. deprecated="not deprecated">
  15211. <param name="runId" type="long"/>
  15212. </method>
  15213. <method name="getStartTime" return="long"
  15214. abstract="false" native="false" synchronized="false"
  15215. static="false" final="false" visibility="public"
  15216. deprecated="not deprecated">
  15217. </method>
  15218. <method name="setStartTime"
  15219. abstract="false" native="false" synchronized="false"
  15220. static="false" final="false" visibility="public"
  15221. deprecated="not deprecated">
  15222. <param name="startTime" type="long"/>
  15223. </method>
  15224. <method name="getMaxEndTime" return="long"
  15225. abstract="false" native="false" synchronized="false"
  15226. static="false" final="false" visibility="public"
  15227. deprecated="not deprecated">
  15228. </method>
  15229. <method name="setMaxEndTime"
  15230. abstract="false" native="false" synchronized="false"
  15231. static="false" final="false" visibility="public"
  15232. deprecated="not deprecated">
  15233. <param name="endTime" type="long"/>
  15234. </method>
  15235. <field name="USER_INFO_KEY" type="java.lang.String"
  15236. transient="false" volatile="false"
  15237. static="true" final="true" visibility="public"
  15238. deprecated="not deprecated">
  15239. </field>
  15240. <field name="FLOW_NAME_INFO_KEY" type="java.lang.String"
  15241. transient="false" volatile="false"
  15242. static="true" final="true" visibility="public"
  15243. deprecated="not deprecated">
  15244. </field>
  15245. <field name="FLOW_VERSION_INFO_KEY" type="java.lang.String"
  15246. transient="false" volatile="false"
  15247. static="true" final="true" visibility="public"
  15248. deprecated="not deprecated">
  15249. </field>
  15250. <field name="FLOW_RUN_ID_INFO_KEY" type="java.lang.String"
  15251. transient="false" volatile="false"
  15252. static="true" final="true" visibility="public"
  15253. deprecated="not deprecated">
  15254. </field>
  15255. <field name="FLOW_RUN_END_TIME" type="java.lang.String"
  15256. transient="false" volatile="false"
  15257. static="true" final="true" visibility="public"
  15258. deprecated="not deprecated">
  15259. </field>
  15260. <doc>
  15261. <![CDATA[This entity represents a flow run.]]>
  15262. </doc>
  15263. </class>
  15264. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.FlowRunEntity -->
  15265. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity -->
  15266. <class name="HierarchicalTimelineEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15267. abstract="true"
  15268. static="false" final="false" visibility="public"
  15269. deprecated="not deprecated">
  15270. <method name="getParent" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"
  15271. abstract="false" native="false" synchronized="false"
  15272. static="false" final="false" visibility="public"
  15273. deprecated="not deprecated">
  15274. </method>
  15275. <method name="setParent"
  15276. abstract="false" native="false" synchronized="false"
  15277. static="false" final="false" visibility="public"
  15278. deprecated="not deprecated">
  15279. <param name="parent" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"/>
  15280. </method>
  15281. <method name="setParent"
  15282. abstract="false" native="false" synchronized="false"
  15283. static="false" final="false" visibility="public"
  15284. deprecated="not deprecated">
  15285. <param name="type" type="java.lang.String"/>
  15286. <param name="id" type="java.lang.String"/>
  15287. </method>
  15288. <method name="getChildren" return="java.util.Set"
  15289. abstract="false" native="false" synchronized="false"
  15290. static="false" final="false" visibility="public"
  15291. deprecated="not deprecated">
  15292. </method>
  15293. <method name="setChildren"
  15294. abstract="false" native="false" synchronized="false"
  15295. static="false" final="false" visibility="public"
  15296. deprecated="not deprecated">
  15297. <param name="children" type="java.util.Set"/>
  15298. </method>
  15299. <method name="addChildren"
  15300. abstract="false" native="false" synchronized="false"
  15301. static="false" final="false" visibility="public"
  15302. deprecated="not deprecated">
  15303. <param name="children" type="java.util.Set"/>
  15304. </method>
  15305. <method name="addChild"
  15306. abstract="false" native="false" synchronized="false"
  15307. static="false" final="false" visibility="public"
  15308. deprecated="not deprecated">
  15309. <param name="child" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"/>
  15310. </method>
  15311. <method name="addChild"
  15312. abstract="false" native="false" synchronized="false"
  15313. static="false" final="false" visibility="public"
  15314. deprecated="not deprecated">
  15315. <param name="type" type="java.lang.String"/>
  15316. <param name="id" type="java.lang.String"/>
  15317. </method>
  15318. <field name="PARENT_INFO_KEY" type="java.lang.String"
  15319. transient="false" volatile="false"
  15320. static="true" final="true" visibility="public"
  15321. deprecated="not deprecated">
  15322. </field>
  15323. <field name="CHILDREN_INFO_KEY" type="java.lang.String"
  15324. transient="false" volatile="false"
  15325. static="true" final="true" visibility="public"
  15326. deprecated="not deprecated">
  15327. </field>
  15328. <doc>
  15329. <![CDATA[This class extends timeline entity and defines parent-child relationships
  15330. with other entities.]]>
  15331. </doc>
  15332. </class>
  15333. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity -->
  15334. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.QueueEntity -->
  15335. <class name="QueueEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  15336. abstract="false"
  15337. static="false" final="false" visibility="public"
  15338. deprecated="not deprecated">
  15339. <constructor name="QueueEntity"
  15340. static="false" final="false" visibility="public"
  15341. deprecated="not deprecated">
  15342. </constructor>
  15343. <constructor name="QueueEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15344. static="false" final="false" visibility="public"
  15345. deprecated="not deprecated">
  15346. </constructor>
  15347. <doc>
  15348. <![CDATA[This entity represents a queue.]]>
  15349. </doc>
  15350. </class>
  15351. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.QueueEntity -->
  15352. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.SubApplicationEntity -->
  15353. <class name="SubApplicationEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  15354. abstract="false"
  15355. static="false" final="false" visibility="public"
  15356. deprecated="not deprecated">
  15357. <constructor name="SubApplicationEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15358. static="false" final="false" visibility="public"
  15359. deprecated="not deprecated">
  15360. </constructor>
  15361. <method name="isSubApplicationEntity" return="boolean"
  15362. abstract="false" native="false" synchronized="false"
  15363. static="true" final="false" visibility="public"
  15364. deprecated="not deprecated">
  15365. <param name="te" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  15366. <doc>
  15367. <![CDATA[Checks if the input TimelineEntity object is an SubApplicationEntity.
  15368. @param te TimelineEntity object.
  15369. @return true if input is an SubApplicationEntity, false otherwise]]>
  15370. </doc>
  15371. </method>
  15372. <method name="setApplicationId"
  15373. abstract="false" native="false" synchronized="false"
  15374. static="false" final="false" visibility="public"
  15375. deprecated="not deprecated">
  15376. <param name="appId" type="java.lang.String"/>
  15377. </method>
  15378. <field name="YARN_APPLICATION_ID" type="java.lang.String"
  15379. transient="false" volatile="false"
  15380. static="true" final="true" visibility="public"
  15381. deprecated="not deprecated">
  15382. </field>
  15383. <doc>
  15384. <![CDATA[This entity represents a user defined entities to be stored under sub
  15385. application table.]]>
  15386. </doc>
  15387. </class>
  15388. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.SubApplicationEntity -->
  15389. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain -->
  15390. <class name="TimelineDomain" extends="java.lang.Object"
  15391. abstract="false"
  15392. static="false" final="false" visibility="public"
  15393. deprecated="not deprecated">
  15394. <constructor name="TimelineDomain"
  15395. static="false" final="false" visibility="public"
  15396. deprecated="not deprecated">
  15397. </constructor>
  15398. <method name="getId" return="java.lang.String"
  15399. abstract="false" native="false" synchronized="false"
  15400. static="false" final="false" visibility="public"
  15401. deprecated="not deprecated">
  15402. <doc>
  15403. <![CDATA[Get the domain ID.
  15404. @return the domain ID]]>
  15405. </doc>
  15406. </method>
  15407. <method name="setId"
  15408. abstract="false" native="false" synchronized="false"
  15409. static="false" final="false" visibility="public"
  15410. deprecated="not deprecated">
  15411. <param name="id" type="java.lang.String"/>
  15412. <doc>
  15413. <![CDATA[Set the domain ID.
  15414. @param id the domain ID]]>
  15415. </doc>
  15416. </method>
  15417. <method name="getDescription" return="java.lang.String"
  15418. abstract="false" native="false" synchronized="false"
  15419. static="false" final="false" visibility="public"
  15420. deprecated="not deprecated">
  15421. <doc>
  15422. <![CDATA[Get the domain description.
  15423. @return the domain description]]>
  15424. </doc>
  15425. </method>
  15426. <method name="setDescription"
  15427. abstract="false" native="false" synchronized="false"
  15428. static="false" final="false" visibility="public"
  15429. deprecated="not deprecated">
  15430. <param name="description" type="java.lang.String"/>
  15431. <doc>
  15432. <![CDATA[Set the domain description.
  15433. @param description the domain description]]>
  15434. </doc>
  15435. </method>
  15436. <method name="getOwner" return="java.lang.String"
  15437. abstract="false" native="false" synchronized="false"
  15438. static="false" final="false" visibility="public"
  15439. deprecated="not deprecated">
  15440. <doc>
  15441. <![CDATA[Get the domain owner.
  15442. @return the domain owner]]>
  15443. </doc>
  15444. </method>
  15445. <method name="setOwner"
  15446. abstract="false" native="false" synchronized="false"
  15447. static="false" final="false" visibility="public"
  15448. deprecated="not deprecated">
  15449. <param name="owner" type="java.lang.String"/>
  15450. <doc>
  15451. <![CDATA[Set the domain owner. The user doesn't need to set it, which will
  15452. automatically set to the user who puts the domain.
  15453. @param owner the domain owner]]>
  15454. </doc>
  15455. </method>
  15456. <method name="getReaders" return="java.lang.String"
  15457. abstract="false" native="false" synchronized="false"
  15458. static="false" final="false" visibility="public"
  15459. deprecated="not deprecated">
  15460. <doc>
  15461. <![CDATA[Get the reader (and/or reader group) list string.
  15462. @return the reader (and/or reader group) list string]]>
  15463. </doc>
  15464. </method>
  15465. <method name="setReaders"
  15466. abstract="false" native="false" synchronized="false"
  15467. static="false" final="false" visibility="public"
  15468. deprecated="not deprecated">
  15469. <param name="readers" type="java.lang.String"/>
  15470. <doc>
  15471. <![CDATA[Set the reader (and/or reader group) list string.
  15472. @param readers the reader (and/or reader group) list string]]>
  15473. </doc>
  15474. </method>
  15475. <method name="getWriters" return="java.lang.String"
  15476. abstract="false" native="false" synchronized="false"
  15477. static="false" final="false" visibility="public"
  15478. deprecated="not deprecated">
  15479. <doc>
  15480. <![CDATA[Get the writer (and/or writer group) list string.
  15481. @return the writer (and/or writer group) list string]]>
  15482. </doc>
  15483. </method>
  15484. <method name="setWriters"
  15485. abstract="false" native="false" synchronized="false"
  15486. static="false" final="false" visibility="public"
  15487. deprecated="not deprecated">
  15488. <param name="writers" type="java.lang.String"/>
  15489. <doc>
  15490. <![CDATA[Set the writer (and/or writer group) list string.
  15491. @param writers the writer (and/or writer group) list string]]>
  15492. </doc>
  15493. </method>
  15494. <method name="getCreatedTime" return="java.lang.Long"
  15495. abstract="false" native="false" synchronized="false"
  15496. static="false" final="false" visibility="public"
  15497. deprecated="not deprecated">
  15498. <doc>
  15499. <![CDATA[Get the created time of the domain.
  15500. @return the created time of the domain]]>
  15501. </doc>
  15502. </method>
  15503. <method name="setCreatedTime"
  15504. abstract="false" native="false" synchronized="false"
  15505. static="false" final="false" visibility="public"
  15506. deprecated="not deprecated">
  15507. <param name="createdTime" type="java.lang.Long"/>
  15508. <doc>
  15509. <![CDATA[Set the created time of the domain.
  15510. @param createdTime the created time of the domain]]>
  15511. </doc>
  15512. </method>
  15513. <method name="getModifiedTime" return="java.lang.Long"
  15514. abstract="false" native="false" synchronized="false"
  15515. static="false" final="false" visibility="public"
  15516. deprecated="not deprecated">
  15517. <doc>
  15518. <![CDATA[Get the modified time of the domain.
  15519. @return the modified time of the domain]]>
  15520. </doc>
  15521. </method>
  15522. <method name="setModifiedTime"
  15523. abstract="false" native="false" synchronized="false"
  15524. static="false" final="false" visibility="public"
  15525. deprecated="not deprecated">
  15526. <param name="modifiedTime" type="java.lang.Long"/>
  15527. <doc>
  15528. <![CDATA[Set the modified time of the domain.
  15529. @param modifiedTime the modified time of the domain]]>
  15530. </doc>
  15531. </method>
  15532. <doc>
  15533. <![CDATA[<p>
  15534. This class contains the information about a timeline service domain, which is
  15535. used to a user to host a number of timeline entities, isolating them from
  15536. others'. The user can also define the reader and writer users/groups for
  15537. the domain, which is used to control the access to its entities.
  15538. </p>
  15539. <p>
  15540. The reader and writer users/groups pattern that the user can supply is the
  15541. same as what <code>AccessControlList</code> takes.
  15542. </p>]]>
  15543. </doc>
  15544. </class>
  15545. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain -->
  15546. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities -->
  15547. <class name="TimelineEntities" extends="java.lang.Object"
  15548. abstract="false"
  15549. static="false" final="false" visibility="public"
  15550. deprecated="not deprecated">
  15551. <constructor name="TimelineEntities"
  15552. static="false" final="false" visibility="public"
  15553. deprecated="not deprecated">
  15554. </constructor>
  15555. <method name="getEntities" return="java.util.List"
  15556. abstract="false" native="false" synchronized="false"
  15557. static="false" final="false" visibility="public"
  15558. deprecated="not deprecated">
  15559. </method>
  15560. <method name="setEntities"
  15561. abstract="false" native="false" synchronized="false"
  15562. static="false" final="false" visibility="public"
  15563. deprecated="not deprecated">
  15564. <param name="timelineEntities" type="java.util.List"/>
  15565. </method>
  15566. <method name="addEntities"
  15567. abstract="false" native="false" synchronized="false"
  15568. static="false" final="false" visibility="public"
  15569. deprecated="not deprecated">
  15570. <param name="timelineEntities" type="java.util.List"/>
  15571. </method>
  15572. <method name="addEntity"
  15573. abstract="false" native="false" synchronized="false"
  15574. static="false" final="false" visibility="public"
  15575. deprecated="not deprecated">
  15576. <param name="entity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  15577. </method>
  15578. <doc>
  15579. <![CDATA[This class hosts a set of timeline entities.]]>
  15580. </doc>
  15581. </class>
  15582. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities -->
  15583. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity -->
  15584. <class name="TimelineEntity" extends="java.lang.Object"
  15585. abstract="false"
  15586. static="false" final="false" visibility="public"
  15587. deprecated="not deprecated">
  15588. <implements name="java.lang.Comparable"/>
  15589. <constructor name="TimelineEntity"
  15590. static="false" final="false" visibility="public"
  15591. deprecated="not deprecated">
  15592. </constructor>
  15593. <constructor name="TimelineEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15594. static="false" final="false" visibility="public"
  15595. deprecated="not deprecated">
  15596. <doc>
  15597. <![CDATA[<p>
  15598. The constuctor is used to construct a proxy {@link TimelineEntity} or its
  15599. subclass object from the real entity object that carries information.
  15600. </p>
  15601. <p>
  15602. It is usually used in the case where we want to recover class polymorphism
  15603. after deserializing the entity from its JSON form.
  15604. </p>
  15605. @param entity the real entity that carries information]]>
  15606. </doc>
  15607. </constructor>
  15608. <constructor name="TimelineEntity" type="java.lang.String"
  15609. static="false" final="false" visibility="protected"
  15610. deprecated="not deprecated">
  15611. </constructor>
  15612. <method name="getType" return="java.lang.String"
  15613. abstract="false" native="false" synchronized="false"
  15614. static="false" final="false" visibility="public"
  15615. deprecated="not deprecated">
  15616. </method>
  15617. <method name="setType"
  15618. abstract="false" native="false" synchronized="false"
  15619. static="false" final="false" visibility="public"
  15620. deprecated="not deprecated">
  15621. <param name="type" type="java.lang.String"/>
  15622. </method>
  15623. <method name="getId" return="java.lang.String"
  15624. abstract="false" native="false" synchronized="false"
  15625. static="false" final="false" visibility="public"
  15626. deprecated="not deprecated">
  15627. </method>
  15628. <method name="setId"
  15629. abstract="false" native="false" synchronized="false"
  15630. static="false" final="false" visibility="public"
  15631. deprecated="not deprecated">
  15632. <param name="id" type="java.lang.String"/>
  15633. </method>
  15634. <method name="getIdentifier" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"
  15635. abstract="false" native="false" synchronized="false"
  15636. static="false" final="false" visibility="public"
  15637. deprecated="not deprecated">
  15638. </method>
  15639. <method name="setIdentifier"
  15640. abstract="false" native="false" synchronized="false"
  15641. static="false" final="false" visibility="public"
  15642. deprecated="not deprecated">
  15643. <param name="entityIdentifier" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"/>
  15644. </method>
  15645. <method name="getInfo" return="java.util.Map"
  15646. abstract="false" native="false" synchronized="false"
  15647. static="false" final="false" visibility="public"
  15648. deprecated="not deprecated">
  15649. </method>
  15650. <method name="setInfo"
  15651. abstract="false" native="false" synchronized="false"
  15652. static="false" final="false" visibility="public"
  15653. deprecated="not deprecated">
  15654. <param name="entityInfos" type="java.util.Map"/>
  15655. </method>
  15656. <method name="addInfo"
  15657. abstract="false" native="false" synchronized="false"
  15658. static="false" final="false" visibility="public"
  15659. deprecated="not deprecated">
  15660. <param name="entityInfos" type="java.util.Map"/>
  15661. </method>
  15662. <method name="addInfo"
  15663. abstract="false" native="false" synchronized="false"
  15664. static="false" final="false" visibility="public"
  15665. deprecated="not deprecated">
  15666. <param name="key" type="java.lang.String"/>
  15667. <param name="value" type="java.lang.Object"/>
  15668. </method>
  15669. <method name="getConfigs" return="java.util.Map"
  15670. abstract="false" native="false" synchronized="false"
  15671. static="false" final="false" visibility="public"
  15672. deprecated="not deprecated">
  15673. </method>
  15674. <method name="setConfigs"
  15675. abstract="false" native="false" synchronized="false"
  15676. static="false" final="false" visibility="public"
  15677. deprecated="not deprecated">
  15678. <param name="entityConfigs" type="java.util.Map"/>
  15679. </method>
  15680. <method name="addConfigs"
  15681. abstract="false" native="false" synchronized="false"
  15682. static="false" final="false" visibility="public"
  15683. deprecated="not deprecated">
  15684. <param name="entityConfigs" type="java.util.Map"/>
  15685. </method>
  15686. <method name="addConfig"
  15687. abstract="false" native="false" synchronized="false"
  15688. static="false" final="false" visibility="public"
  15689. deprecated="not deprecated">
  15690. <param name="key" type="java.lang.String"/>
  15691. <param name="value" type="java.lang.String"/>
  15692. </method>
  15693. <method name="getMetrics" return="java.util.Set"
  15694. abstract="false" native="false" synchronized="false"
  15695. static="false" final="false" visibility="public"
  15696. deprecated="not deprecated">
  15697. </method>
  15698. <method name="setMetrics"
  15699. abstract="false" native="false" synchronized="false"
  15700. static="false" final="false" visibility="public"
  15701. deprecated="not deprecated">
  15702. <param name="entityMetrics" type="java.util.Set"/>
  15703. </method>
  15704. <method name="addMetrics"
  15705. abstract="false" native="false" synchronized="false"
  15706. static="false" final="false" visibility="public"
  15707. deprecated="not deprecated">
  15708. <param name="entityMetrics" type="java.util.Set"/>
  15709. </method>
  15710. <method name="addMetric"
  15711. abstract="false" native="false" synchronized="false"
  15712. static="false" final="false" visibility="public"
  15713. deprecated="not deprecated">
  15714. <param name="metric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  15715. </method>
  15716. <method name="getEvents" return="java.util.NavigableSet"
  15717. abstract="false" native="false" synchronized="false"
  15718. static="false" final="false" visibility="public"
  15719. deprecated="not deprecated">
  15720. </method>
  15721. <method name="setEvents"
  15722. abstract="false" native="false" synchronized="false"
  15723. static="false" final="false" visibility="public"
  15724. deprecated="not deprecated">
  15725. <param name="entityEvents" type="java.util.NavigableSet"/>
  15726. </method>
  15727. <method name="addEvents"
  15728. abstract="false" native="false" synchronized="false"
  15729. static="false" final="false" visibility="public"
  15730. deprecated="not deprecated">
  15731. <param name="entityEvents" type="java.util.Set"/>
  15732. </method>
  15733. <method name="addEvent"
  15734. abstract="false" native="false" synchronized="false"
  15735. static="false" final="false" visibility="public"
  15736. deprecated="not deprecated">
  15737. <param name="event" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent"/>
  15738. </method>
  15739. <method name="getIsRelatedToEntities" return="java.util.Map"
  15740. abstract="false" native="false" synchronized="false"
  15741. static="false" final="false" visibility="public"
  15742. deprecated="not deprecated">
  15743. </method>
  15744. <method name="setIsRelatedToEntities"
  15745. abstract="false" native="false" synchronized="false"
  15746. static="false" final="false" visibility="public"
  15747. deprecated="not deprecated">
  15748. <param name="isRelatedTo" type="java.util.Map"/>
  15749. </method>
  15750. <method name="addIsRelatedToEntities"
  15751. abstract="false" native="false" synchronized="false"
  15752. static="false" final="false" visibility="public"
  15753. deprecated="not deprecated">
  15754. <param name="isRelatedTo" type="java.util.Map"/>
  15755. </method>
  15756. <method name="addIsRelatedToEntity"
  15757. abstract="false" native="false" synchronized="false"
  15758. static="false" final="false" visibility="public"
  15759. deprecated="not deprecated">
  15760. <param name="type" type="java.lang.String"/>
  15761. <param name="id" type="java.lang.String"/>
  15762. </method>
  15763. <method name="getRelatesToEntities" return="java.util.Map"
  15764. abstract="false" native="false" synchronized="false"
  15765. static="false" final="false" visibility="public"
  15766. deprecated="not deprecated">
  15767. </method>
  15768. <method name="addRelatesToEntities"
  15769. abstract="false" native="false" synchronized="false"
  15770. static="false" final="false" visibility="public"
  15771. deprecated="not deprecated">
  15772. <param name="relatesTo" type="java.util.Map"/>
  15773. </method>
  15774. <method name="addRelatesToEntity"
  15775. abstract="false" native="false" synchronized="false"
  15776. static="false" final="false" visibility="public"
  15777. deprecated="not deprecated">
  15778. <param name="type" type="java.lang.String"/>
  15779. <param name="id" type="java.lang.String"/>
  15780. </method>
  15781. <method name="setRelatesToEntities"
  15782. abstract="false" native="false" synchronized="false"
  15783. static="false" final="false" visibility="public"
  15784. deprecated="not deprecated">
  15785. <param name="relatesTo" type="java.util.Map"/>
  15786. </method>
  15787. <method name="getCreatedTime" return="java.lang.Long"
  15788. abstract="false" native="false" synchronized="false"
  15789. static="false" final="false" visibility="public"
  15790. deprecated="not deprecated">
  15791. </method>
  15792. <method name="setCreatedTime"
  15793. abstract="false" native="false" synchronized="false"
  15794. static="false" final="false" visibility="public"
  15795. deprecated="not deprecated">
  15796. <param name="createdTs" type="java.lang.Long"/>
  15797. </method>
  15798. <method name="setUID"
  15799. abstract="false" native="false" synchronized="false"
  15800. static="false" final="false" visibility="public"
  15801. deprecated="not deprecated">
  15802. <param name="uidKey" type="java.lang.String"/>
  15803. <param name="uId" type="java.lang.String"/>
  15804. <doc>
  15805. <![CDATA[Set UID in info which will be then used for query by UI.
  15806. @param uidKey key for UID in info.
  15807. @param uId UID to be set for the key.]]>
  15808. </doc>
  15809. </method>
  15810. <method name="isValid" return="boolean"
  15811. abstract="false" native="false" synchronized="false"
  15812. static="false" final="false" visibility="public"
  15813. deprecated="not deprecated">
  15814. </method>
  15815. <method name="hashCode" return="int"
  15816. abstract="false" native="false" synchronized="false"
  15817. static="false" final="false" visibility="public"
  15818. deprecated="not deprecated">
  15819. </method>
  15820. <method name="equals" return="boolean"
  15821. abstract="false" native="false" synchronized="false"
  15822. static="false" final="false" visibility="public"
  15823. deprecated="not deprecated">
  15824. <param name="obj" type="java.lang.Object"/>
  15825. </method>
  15826. <method name="compareTo" return="int"
  15827. abstract="false" native="false" synchronized="false"
  15828. static="false" final="false" visibility="public"
  15829. deprecated="not deprecated">
  15830. <param name="other" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  15831. </method>
  15832. <method name="getReal" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15833. abstract="false" native="false" synchronized="false"
  15834. static="false" final="false" visibility="protected"
  15835. deprecated="not deprecated">
  15836. </method>
  15837. <method name="toString" return="java.lang.String"
  15838. abstract="false" native="false" synchronized="false"
  15839. static="false" final="false" visibility="public"
  15840. deprecated="not deprecated">
  15841. </method>
  15842. <method name="getIdPrefix" return="long"
  15843. abstract="false" native="false" synchronized="false"
  15844. static="false" final="false" visibility="public"
  15845. deprecated="not deprecated">
  15846. </method>
  15847. <method name="setIdPrefix"
  15848. abstract="false" native="false" synchronized="false"
  15849. static="false" final="false" visibility="public"
  15850. deprecated="not deprecated">
  15851. <param name="entityIdPrefix" type="long"/>
  15852. <doc>
  15853. <![CDATA[Sets idPrefix for an entity.
  15854. <p>
  15855. <b>Note</b>: Entities will be stored in the order of idPrefix specified.
  15856. If users decide to set idPrefix for an entity, they <b>MUST</b> provide
  15857. the same prefix for every update of this entity.
  15858. </p>
  15859. Example: <blockquote><pre>
  15860. TimelineEntity entity = new TimelineEntity();
  15861. entity.setIdPrefix(value);
  15862. </pre></blockquote>
  15863. Users can use {@link TimelineServiceHelper#invertLong(long)} to invert
  15864. the prefix if necessary.
  15865. @param entityIdPrefix prefix for an entity.]]>
  15866. </doc>
  15867. </method>
  15868. <field name="SYSTEM_INFO_KEY_PREFIX" type="java.lang.String"
  15869. transient="false" volatile="false"
  15870. static="true" final="true" visibility="protected"
  15871. deprecated="not deprecated">
  15872. </field>
  15873. <field name="DEFAULT_ENTITY_PREFIX" type="long"
  15874. transient="false" volatile="false"
  15875. static="true" final="true" visibility="public"
  15876. deprecated="not deprecated">
  15877. </field>
  15878. <doc>
  15879. <![CDATA[The basic timeline entity data structure for timeline service v2. Timeline
  15880. entity objects are not thread safe and should not be accessed concurrently.
  15881. All collection members will be initialized into empty collections. Two
  15882. timeline entities are equal iff. their type and id are identical.
  15883. All non-primitive type, non-collection members will be initialized into null.
  15884. User should set the type and id of a timeline entity to make it valid (can be
  15885. checked by using the {@link #isValid()} method). Callers to the getters
  15886. should perform null checks for non-primitive type, non-collection members.
  15887. Callers are recommended not to alter the returned collection objects from the
  15888. getters.]]>
  15889. </doc>
  15890. </class>
  15891. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity -->
  15892. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType -->
  15893. <class name="TimelineEntityType" extends="java.lang.Enum"
  15894. abstract="false"
  15895. static="false" final="true" visibility="public"
  15896. deprecated="not deprecated">
  15897. <method name="values" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType[]"
  15898. abstract="false" native="false" synchronized="false"
  15899. static="true" final="false" visibility="public"
  15900. deprecated="not deprecated">
  15901. </method>
  15902. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType"
  15903. abstract="false" native="false" synchronized="false"
  15904. static="true" final="false" visibility="public"
  15905. deprecated="not deprecated">
  15906. <param name="name" type="java.lang.String"/>
  15907. </method>
  15908. <method name="isParent" return="boolean"
  15909. abstract="false" native="false" synchronized="false"
  15910. static="false" final="false" visibility="public"
  15911. deprecated="not deprecated">
  15912. <param name="type" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType"/>
  15913. <doc>
  15914. <![CDATA[Whether the input type can be a parent of this entity.
  15915. @param type entity type.
  15916. @return true, if this entity type is parent of passed entity type, false
  15917. otherwise.]]>
  15918. </doc>
  15919. </method>
  15920. <method name="isChild" return="boolean"
  15921. abstract="false" native="false" synchronized="false"
  15922. static="false" final="false" visibility="public"
  15923. deprecated="not deprecated">
  15924. <param name="type" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType"/>
  15925. <doc>
  15926. <![CDATA[Whether the input type can be a child of this entity.
  15927. @param type entity type.
  15928. @return true, if this entity type is child of passed entity type, false
  15929. otherwise.]]>
  15930. </doc>
  15931. </method>
  15932. <method name="matches" return="boolean"
  15933. abstract="false" native="false" synchronized="false"
  15934. static="false" final="false" visibility="public"
  15935. deprecated="not deprecated">
  15936. <param name="typeString" type="java.lang.String"/>
  15937. <doc>
  15938. <![CDATA[Whether the type of this entity matches the type indicated by the input
  15939. argument.
  15940. @param typeString entity type represented as a string.
  15941. @return true, if string representation of this entity type matches the
  15942. entity type passed.]]>
  15943. </doc>
  15944. </method>
  15945. <doc>
  15946. <![CDATA[Defines type of entity.]]>
  15947. </doc>
  15948. </class>
  15949. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType -->
  15950. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent -->
  15951. <class name="TimelineEvent" extends="java.lang.Object"
  15952. abstract="false"
  15953. static="false" final="false" visibility="public"
  15954. deprecated="not deprecated">
  15955. <implements name="java.lang.Comparable"/>
  15956. <constructor name="TimelineEvent"
  15957. static="false" final="false" visibility="public"
  15958. deprecated="not deprecated">
  15959. </constructor>
  15960. <method name="getId" return="java.lang.String"
  15961. abstract="false" native="false" synchronized="false"
  15962. static="false" final="false" visibility="public"
  15963. deprecated="not deprecated">
  15964. </method>
  15965. <method name="setId"
  15966. abstract="false" native="false" synchronized="false"
  15967. static="false" final="false" visibility="public"
  15968. deprecated="not deprecated">
  15969. <param name="eventId" type="java.lang.String"/>
  15970. </method>
  15971. <method name="getInfo" return="java.util.Map"
  15972. abstract="false" native="false" synchronized="false"
  15973. static="false" final="false" visibility="public"
  15974. deprecated="not deprecated">
  15975. </method>
  15976. <method name="setInfo"
  15977. abstract="false" native="false" synchronized="false"
  15978. static="false" final="false" visibility="public"
  15979. deprecated="not deprecated">
  15980. <param name="infos" type="java.util.Map"/>
  15981. </method>
  15982. <method name="addInfo"
  15983. abstract="false" native="false" synchronized="false"
  15984. static="false" final="false" visibility="public"
  15985. deprecated="not deprecated">
  15986. <param name="infos" type="java.util.Map"/>
  15987. </method>
  15988. <method name="addInfo"
  15989. abstract="false" native="false" synchronized="false"
  15990. static="false" final="false" visibility="public"
  15991. deprecated="not deprecated">
  15992. <param name="key" type="java.lang.String"/>
  15993. <param name="value" type="java.lang.Object"/>
  15994. </method>
  15995. <method name="getTimestamp" return="long"
  15996. abstract="false" native="false" synchronized="false"
  15997. static="false" final="false" visibility="public"
  15998. deprecated="not deprecated">
  15999. </method>
  16000. <method name="setTimestamp"
  16001. abstract="false" native="false" synchronized="false"
  16002. static="false" final="false" visibility="public"
  16003. deprecated="not deprecated">
  16004. <param name="ts" type="long"/>
  16005. </method>
  16006. <method name="isValid" return="boolean"
  16007. abstract="false" native="false" synchronized="false"
  16008. static="false" final="false" visibility="public"
  16009. deprecated="not deprecated">
  16010. </method>
  16011. <method name="hashCode" return="int"
  16012. abstract="false" native="false" synchronized="false"
  16013. static="false" final="false" visibility="public"
  16014. deprecated="not deprecated">
  16015. </method>
  16016. <method name="equals" return="boolean"
  16017. abstract="false" native="false" synchronized="false"
  16018. static="false" final="false" visibility="public"
  16019. deprecated="not deprecated">
  16020. <param name="o" type="java.lang.Object"/>
  16021. </method>
  16022. <method name="compareTo" return="int"
  16023. abstract="false" native="false" synchronized="false"
  16024. static="false" final="false" visibility="public"
  16025. deprecated="not deprecated">
  16026. <param name="other" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent"/>
  16027. </method>
  16028. <field name="INVALID_TIMESTAMP" type="long"
  16029. transient="false" volatile="false"
  16030. static="true" final="true" visibility="public"
  16031. deprecated="not deprecated">
  16032. </field>
  16033. <doc>
  16034. <![CDATA[This class contains the information of an event that belongs to an entity.
  16035. Users are free to define what the event means, such as starting an
  16036. application, container being allocated, etc.]]>
  16037. </doc>
  16038. </class>
  16039. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent -->
  16040. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric -->
  16041. <class name="TimelineMetric" extends="java.lang.Object"
  16042. abstract="false"
  16043. static="false" final="false" visibility="public"
  16044. deprecated="not deprecated">
  16045. <constructor name="TimelineMetric"
  16046. static="false" final="false" visibility="public"
  16047. deprecated="not deprecated">
  16048. </constructor>
  16049. <constructor name="TimelineMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric.Type"
  16050. static="false" final="false" visibility="public"
  16051. deprecated="not deprecated">
  16052. </constructor>
  16053. <method name="getType" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric.Type"
  16054. abstract="false" native="false" synchronized="false"
  16055. static="false" final="false" visibility="public"
  16056. deprecated="not deprecated">
  16057. </method>
  16058. <method name="setType"
  16059. abstract="false" native="false" synchronized="false"
  16060. static="false" final="false" visibility="public"
  16061. deprecated="not deprecated">
  16062. <param name="metricType" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric.Type"/>
  16063. </method>
  16064. <method name="getId" return="java.lang.String"
  16065. abstract="false" native="false" synchronized="false"
  16066. static="false" final="false" visibility="public"
  16067. deprecated="not deprecated">
  16068. </method>
  16069. <method name="setId"
  16070. abstract="false" native="false" synchronized="false"
  16071. static="false" final="false" visibility="public"
  16072. deprecated="not deprecated">
  16073. <param name="metricId" type="java.lang.String"/>
  16074. </method>
  16075. <method name="getRealtimeAggregationOp" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetricOperation"
  16076. abstract="false" native="false" synchronized="false"
  16077. static="false" final="false" visibility="public"
  16078. deprecated="not deprecated">
  16079. <doc>
  16080. <![CDATA[Get the real time aggregation operation of this metric.
  16081. @return Real time aggregation operation]]>
  16082. </doc>
  16083. </method>
  16084. <method name="setRealtimeAggregationOp"
  16085. abstract="false" native="false" synchronized="false"
  16086. static="false" final="false" visibility="public"
  16087. deprecated="not deprecated">
  16088. <param name="op" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetricOperation"/>
  16089. <doc>
  16090. <![CDATA[Set the real time aggregation operation of this metric.
  16091. @param op A timeline metric operation that the metric should perform on
  16092. real time aggregations]]>
  16093. </doc>
  16094. </method>
  16095. <method name="getValues" return="java.util.Map"
  16096. abstract="false" native="false" synchronized="false"
  16097. static="false" final="false" visibility="public"
  16098. deprecated="not deprecated">
  16099. </method>
  16100. <method name="setValues"
  16101. abstract="false" native="false" synchronized="false"
  16102. static="false" final="false" visibility="public"
  16103. deprecated="not deprecated">
  16104. <param name="vals" type="java.util.Map"/>
  16105. </method>
  16106. <method name="addValues"
  16107. abstract="false" native="false" synchronized="false"
  16108. static="false" final="false" visibility="public"
  16109. deprecated="not deprecated">
  16110. <param name="vals" type="java.util.Map"/>
  16111. </method>
  16112. <method name="addValue"
  16113. abstract="false" native="false" synchronized="false"
  16114. static="false" final="false" visibility="public"
  16115. deprecated="not deprecated">
  16116. <param name="timestamp" type="long"/>
  16117. <param name="value" type="java.lang.Number"/>
  16118. </method>
  16119. <method name="isValid" return="boolean"
  16120. abstract="false" native="false" synchronized="false"
  16121. static="false" final="false" visibility="public"
  16122. deprecated="not deprecated">
  16123. </method>
  16124. <method name="hashCode" return="int"
  16125. abstract="false" native="false" synchronized="false"
  16126. static="false" final="false" visibility="public"
  16127. deprecated="not deprecated">
  16128. </method>
  16129. <method name="equals" return="boolean"
  16130. abstract="false" native="false" synchronized="false"
  16131. static="false" final="false" visibility="public"
  16132. deprecated="not deprecated">
  16133. <param name="o" type="java.lang.Object"/>
  16134. </method>
  16135. <method name="toString" return="java.lang.String"
  16136. abstract="false" native="false" synchronized="false"
  16137. static="false" final="false" visibility="public"
  16138. deprecated="not deprecated">
  16139. </method>
  16140. <method name="getLatestSingleValueMetric" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"
  16141. abstract="false" native="false" synchronized="false"
  16142. static="true" final="false" visibility="public"
  16143. deprecated="not deprecated">
  16144. <param name="metric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  16145. <doc>
  16146. <![CDATA[Get the latest timeline metric as single value type.
  16147. @param metric Incoming timeline metric
  16148. @return The latest metric in the incoming metric]]>
  16149. </doc>
  16150. </method>
  16151. <method name="getSingleDataTimestamp" return="long"
  16152. abstract="false" native="false" synchronized="false"
  16153. static="false" final="false" visibility="public"
  16154. deprecated="not deprecated">
  16155. <doc>
  16156. <![CDATA[Get single data timestamp of the metric.
  16157. @return the single data timestamp]]>
  16158. </doc>
  16159. </method>
  16160. <method name="getSingleDataValue" return="java.lang.Number"
  16161. abstract="false" native="false" synchronized="false"
  16162. static="false" final="false" visibility="public"
  16163. deprecated="not deprecated">
  16164. <doc>
  16165. <![CDATA[Get single data value of the metric.
  16166. @return the single data value]]>
  16167. </doc>
  16168. </method>
  16169. <method name="aggregateTo" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"
  16170. abstract="false" native="false" synchronized="false"
  16171. static="true" final="false" visibility="public"
  16172. deprecated="not deprecated">
  16173. <param name="incomingMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  16174. <param name="baseAggregatedMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  16175. <doc>
  16176. <![CDATA[Aggregate an incoming metric to the base aggregated metric with the given
  16177. operation state in a stateless fashion. The assumption here is
  16178. baseAggregatedMetric and latestMetric should be single value data if not
  16179. null.
  16180. @param incomingMetric Incoming timeline metric to aggregate
  16181. @param baseAggregatedMetric Base timeline metric
  16182. @return Result metric after aggregation]]>
  16183. </doc>
  16184. </method>
  16185. <method name="aggregateTo" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"
  16186. abstract="false" native="false" synchronized="false"
  16187. static="true" final="false" visibility="public"
  16188. deprecated="not deprecated">
  16189. <param name="incomingMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  16190. <param name="baseAggregatedMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  16191. <param name="state" type="java.util.Map"/>
  16192. <doc>
  16193. <![CDATA[Aggregate an incoming metric to the base aggregated metric with the given
  16194. operation state. The assumption here is baseAggregatedMetric and
  16195. latestMetric should be single value data if not null.
  16196. @param incomingMetric Incoming timeline metric to aggregate
  16197. @param baseAggregatedMetric Base timeline metric
  16198. @param state Operation state
  16199. @return Result metric after aggregation]]>
  16200. </doc>
  16201. </method>
  16202. <doc>
  16203. <![CDATA[This class contains the information of a metric that is related to some
  16204. entity. Metric can either be a time series or single value.]]>
  16205. </doc>
  16206. </class>
  16207. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric -->
  16208. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse -->
  16209. <class name="TimelineWriteResponse" extends="java.lang.Object"
  16210. abstract="false"
  16211. static="false" final="false" visibility="public"
  16212. deprecated="not deprecated">
  16213. <constructor name="TimelineWriteResponse"
  16214. static="false" final="false" visibility="public"
  16215. deprecated="not deprecated">
  16216. </constructor>
  16217. <method name="getErrors" return="java.util.List"
  16218. abstract="false" native="false" synchronized="false"
  16219. static="false" final="false" visibility="public"
  16220. deprecated="not deprecated">
  16221. <doc>
  16222. <![CDATA[Get a list of {@link TimelineWriteError} instances.
  16223. @return a list of {@link TimelineWriteError} instances]]>
  16224. </doc>
  16225. </method>
  16226. <method name="addError"
  16227. abstract="false" native="false" synchronized="false"
  16228. static="false" final="false" visibility="public"
  16229. deprecated="not deprecated">
  16230. <param name="error" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse.TimelineWriteError"/>
  16231. <doc>
  16232. <![CDATA[Add a single {@link TimelineWriteError} instance into the existing list.
  16233. @param error
  16234. a single {@link TimelineWriteError} instance]]>
  16235. </doc>
  16236. </method>
  16237. <method name="addErrors"
  16238. abstract="false" native="false" synchronized="false"
  16239. static="false" final="false" visibility="public"
  16240. deprecated="not deprecated">
  16241. <param name="writeErrors" type="java.util.List"/>
  16242. <doc>
  16243. <![CDATA[Add a list of {@link TimelineWriteError} instances into the existing list.
  16244. @param writeErrors
  16245. a list of {@link TimelineWriteError} instances]]>
  16246. </doc>
  16247. </method>
  16248. <method name="setErrors"
  16249. abstract="false" native="false" synchronized="false"
  16250. static="false" final="false" visibility="public"
  16251. deprecated="not deprecated">
  16252. <param name="writeErrors" type="java.util.List"/>
  16253. <doc>
  16254. <![CDATA[Set the list to the given list of {@link TimelineWriteError} instances.
  16255. @param writeErrors
  16256. a list of {@link TimelineWriteError} instances]]>
  16257. </doc>
  16258. </method>
  16259. <doc>
  16260. <![CDATA[A class that holds a list of put errors. This is the response returned when a
  16261. list of {@link TimelineEntity} objects is added to the timeline. If there are
  16262. errors in storing individual entity objects, they will be indicated in the
  16263. list of errors.]]>
  16264. </doc>
  16265. </class>
  16266. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse -->
  16267. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse.TimelineWriteError -->
  16268. <class name="TimelineWriteResponse.TimelineWriteError" extends="java.lang.Object"
  16269. abstract="false"
  16270. static="true" final="false" visibility="public"
  16271. deprecated="not deprecated">
  16272. <constructor name="TimelineWriteError"
  16273. static="false" final="false" visibility="public"
  16274. deprecated="not deprecated">
  16275. </constructor>
  16276. <method name="getEntityId" return="java.lang.String"
  16277. abstract="false" native="false" synchronized="false"
  16278. static="false" final="false" visibility="public"
  16279. deprecated="not deprecated">
  16280. <doc>
  16281. <![CDATA[Get the entity Id.
  16282. @return the entity Id]]>
  16283. </doc>
  16284. </method>
  16285. <method name="setEntityId"
  16286. abstract="false" native="false" synchronized="false"
  16287. static="false" final="false" visibility="public"
  16288. deprecated="not deprecated">
  16289. <param name="id" type="java.lang.String"/>
  16290. <doc>
  16291. <![CDATA[Set the entity Id.
  16292. @param id the entity Id.]]>
  16293. </doc>
  16294. </method>
  16295. <method name="getEntityType" return="java.lang.String"
  16296. abstract="false" native="false" synchronized="false"
  16297. static="false" final="false" visibility="public"
  16298. deprecated="not deprecated">
  16299. <doc>
  16300. <![CDATA[Get the entity type.
  16301. @return the entity type]]>
  16302. </doc>
  16303. </method>
  16304. <method name="setEntityType"
  16305. abstract="false" native="false" synchronized="false"
  16306. static="false" final="false" visibility="public"
  16307. deprecated="not deprecated">
  16308. <param name="type" type="java.lang.String"/>
  16309. <doc>
  16310. <![CDATA[Set the entity type.
  16311. @param type the entity type.]]>
  16312. </doc>
  16313. </method>
  16314. <method name="getErrorCode" return="int"
  16315. abstract="false" native="false" synchronized="false"
  16316. static="false" final="false" visibility="public"
  16317. deprecated="not deprecated">
  16318. <doc>
  16319. <![CDATA[Get the error code.
  16320. @return an error code]]>
  16321. </doc>
  16322. </method>
  16323. <method name="setErrorCode"
  16324. abstract="false" native="false" synchronized="false"
  16325. static="false" final="false" visibility="public"
  16326. deprecated="not deprecated">
  16327. <param name="code" type="int"/>
  16328. <doc>
  16329. <![CDATA[Set the error code to the given error code.
  16330. @param code an error code.]]>
  16331. </doc>
  16332. </method>
  16333. <field name="IO_EXCEPTION" type="int"
  16334. transient="false" volatile="false"
  16335. static="true" final="true" visibility="public"
  16336. deprecated="not deprecated">
  16337. <doc>
  16338. <![CDATA[Error code returned if an IOException is encountered when storing an
  16339. entity.]]>
  16340. </doc>
  16341. </field>
  16342. <doc>
  16343. <![CDATA[A class that holds the error code for one entity.]]>
  16344. </doc>
  16345. </class>
  16346. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse.TimelineWriteError -->
  16347. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.UserEntity -->
  16348. <class name="UserEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  16349. abstract="false"
  16350. static="false" final="false" visibility="public"
  16351. deprecated="not deprecated">
  16352. <constructor name="UserEntity"
  16353. static="false" final="false" visibility="public"
  16354. deprecated="not deprecated">
  16355. </constructor>
  16356. <constructor name="UserEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  16357. static="false" final="false" visibility="public"
  16358. deprecated="not deprecated">
  16359. </constructor>
  16360. <doc>
  16361. <![CDATA[This entity represents a user.]]>
  16362. </doc>
  16363. </class>
  16364. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.UserEntity -->
  16365. </package>
  16366. <package name="org.apache.hadoop.yarn.api.resource">
  16367. <!-- start class org.apache.hadoop.yarn.api.resource.PlacementConstraint -->
  16368. <class name="PlacementConstraint" extends="java.lang.Object"
  16369. abstract="false"
  16370. static="false" final="false" visibility="public"
  16371. deprecated="not deprecated">
  16372. <constructor name="PlacementConstraint" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16373. static="false" final="false" visibility="public"
  16374. deprecated="not deprecated">
  16375. </constructor>
  16376. <method name="toString" return="java.lang.String"
  16377. abstract="false" native="false" synchronized="false"
  16378. static="false" final="false" visibility="public"
  16379. deprecated="not deprecated">
  16380. </method>
  16381. <method name="getConstraintExpr" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16382. abstract="false" native="false" synchronized="false"
  16383. static="false" final="false" visibility="public"
  16384. deprecated="not deprecated">
  16385. <doc>
  16386. <![CDATA[Get the constraint expression of the placement constraint.
  16387. @return the constraint expression]]>
  16388. </doc>
  16389. </method>
  16390. <method name="equals" return="boolean"
  16391. abstract="false" native="false" synchronized="false"
  16392. static="false" final="false" visibility="public"
  16393. deprecated="not deprecated">
  16394. <param name="o" type="java.lang.Object"/>
  16395. </method>
  16396. <method name="hashCode" return="int"
  16397. abstract="false" native="false" synchronized="false"
  16398. static="false" final="false" visibility="public"
  16399. deprecated="not deprecated">
  16400. </method>
  16401. <doc>
  16402. <![CDATA[{@code PlacementConstraint} represents a placement constraint for a resource
  16403. allocation.]]>
  16404. </doc>
  16405. </class>
  16406. <!-- end class org.apache.hadoop.yarn.api.resource.PlacementConstraint -->
  16407. <!-- start class org.apache.hadoop.yarn.api.resource.PlacementConstraints -->
  16408. <class name="PlacementConstraints" extends="java.lang.Object"
  16409. abstract="false"
  16410. static="false" final="true" visibility="public"
  16411. deprecated="not deprecated">
  16412. <method name="targetIn" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16413. abstract="false" native="false" synchronized="false"
  16414. static="true" final="false" visibility="public"
  16415. deprecated="not deprecated">
  16416. <param name="scope" type="java.lang.String"/>
  16417. <param name="targetExpressions" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TargetExpression[]"/>
  16418. <doc>
  16419. <![CDATA[Creates a constraint that requires allocations to be placed on nodes that
  16420. satisfy all target expressions within the given scope (e.g., node or rack).
  16421. For example, {@code targetIn(RACK, allocationTag("hbase-m"))}, allows
  16422. allocations on nodes that belong to a rack that has at least one tag with
  16423. value "hbase-m".
  16424. @param scope the scope within which the target expressions should be
  16425. satisfied
  16426. @param targetExpressions the expressions that need to be satisfied within
  16427. the scope
  16428. @return the resulting placement constraint]]>
  16429. </doc>
  16430. </method>
  16431. <method name="targetNotIn" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16432. abstract="false" native="false" synchronized="false"
  16433. static="true" final="false" visibility="public"
  16434. deprecated="not deprecated">
  16435. <param name="scope" type="java.lang.String"/>
  16436. <param name="targetExpressions" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TargetExpression[]"/>
  16437. <doc>
  16438. <![CDATA[Creates a constraint that requires allocations to be placed on nodes that
  16439. belong to a scope (e.g., node or rack) that does not satisfy any of the
  16440. target expressions.
  16441. @param scope the scope within which the target expressions should not be
  16442. true
  16443. @param targetExpressions the expressions that need to not be true within
  16444. the scope
  16445. @return the resulting placement constraint]]>
  16446. </doc>
  16447. </method>
  16448. <method name="targetNodeAttribute" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16449. abstract="false" native="false" synchronized="false"
  16450. static="true" final="false" visibility="public"
  16451. deprecated="not deprecated">
  16452. <param name="scope" type="java.lang.String"/>
  16453. <param name="opCode" type="org.apache.hadoop.yarn.api.records.NodeAttributeOpCode"/>
  16454. <param name="targetExpressions" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TargetExpression[]"/>
  16455. <doc>
  16456. <![CDATA[Creates a constraint that requires allocations to be placed on nodes that
  16457. belong to a scope (e.g., node or rack) that satisfy any of the
  16458. target expressions based on node attribute op code.
  16459. @param scope the scope within which the target expressions should not be
  16460. true
  16461. @param opCode Node Attribute code which could be equals, not equals.
  16462. @param targetExpressions the expressions that need to not be true within
  16463. the scope
  16464. @return the resulting placement constraint]]>
  16465. </doc>
  16466. </method>
  16467. <method name="cardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16468. abstract="false" native="false" synchronized="false"
  16469. static="true" final="false" visibility="public"
  16470. deprecated="not deprecated">
  16471. <param name="scope" type="java.lang.String"/>
  16472. <param name="minCardinality" type="int"/>
  16473. <param name="maxCardinality" type="int"/>
  16474. <param name="allocationTags" type="java.lang.String[]"/>
  16475. <doc>
  16476. <![CDATA[Creates a constraint that restricts the number of allocations within a
  16477. given scope (e.g., node or rack).
  16478. For example, {@code cardinality(NODE, 3, 10, "zk")} is satisfied on nodes
  16479. where there are no less than 3 allocations with tag "zk" and no more than
  16480. 10.
  16481. @param scope the scope of the constraint
  16482. @param minCardinality determines the minimum number of allocations within
  16483. the scope
  16484. @param maxCardinality determines the maximum number of allocations within
  16485. the scope
  16486. @param allocationTags the constraint targets allocations with these tags
  16487. @return the resulting placement constraint]]>
  16488. </doc>
  16489. </method>
  16490. <method name="cardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16491. abstract="false" native="false" synchronized="false"
  16492. static="true" final="false" visibility="public"
  16493. deprecated="not deprecated">
  16494. <param name="scope" type="java.lang.String"/>
  16495. <param name="namespace" type="java.lang.String"/>
  16496. <param name="minCardinality" type="int"/>
  16497. <param name="maxCardinality" type="int"/>
  16498. <param name="allocationTags" type="java.lang.String[]"/>
  16499. <doc>
  16500. <![CDATA[Similar to {@link #cardinality(String, int, int, String...)}, but let you
  16501. attach a namespace to the given allocation tags.
  16502. @param scope the scope of the constraint
  16503. @param namespace the namespace of the allocation tags
  16504. @param minCardinality determines the minimum number of allocations within
  16505. the scope
  16506. @param maxCardinality determines the maximum number of allocations within
  16507. the scope
  16508. @param allocationTags allocation tags
  16509. @return the resulting placement constraint]]>
  16510. </doc>
  16511. </method>
  16512. <method name="minCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16513. abstract="false" native="false" synchronized="false"
  16514. static="true" final="false" visibility="public"
  16515. deprecated="not deprecated">
  16516. <param name="scope" type="java.lang.String"/>
  16517. <param name="minCardinality" type="int"/>
  16518. <param name="allocationTags" type="java.lang.String[]"/>
  16519. <doc>
  16520. <![CDATA[Similar to {@link #cardinality(String, int, int, String...)}, but
  16521. determines only the minimum cardinality (the maximum cardinality is
  16522. unbound).
  16523. @param scope the scope of the constraint
  16524. @param minCardinality determines the minimum number of allocations within
  16525. the scope
  16526. @param allocationTags the constraint targets allocations with these tags
  16527. @return the resulting placement constraint]]>
  16528. </doc>
  16529. </method>
  16530. <method name="minCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16531. abstract="false" native="false" synchronized="false"
  16532. static="true" final="false" visibility="public"
  16533. deprecated="not deprecated">
  16534. <param name="scope" type="java.lang.String"/>
  16535. <param name="namespace" type="java.lang.String"/>
  16536. <param name="minCardinality" type="int"/>
  16537. <param name="allocationTags" type="java.lang.String[]"/>
  16538. <doc>
  16539. <![CDATA[Similar to {@link #minCardinality(String, int, String...)}, but let you
  16540. attach a namespace to the allocation tags.
  16541. @param scope the scope of the constraint
  16542. @param namespace the namespace of these tags
  16543. @param minCardinality determines the minimum number of allocations within
  16544. the scope
  16545. @param allocationTags the constraint targets allocations with these tags
  16546. @return the resulting placement constraint]]>
  16547. </doc>
  16548. </method>
  16549. <method name="maxCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16550. abstract="false" native="false" synchronized="false"
  16551. static="true" final="false" visibility="public"
  16552. deprecated="not deprecated">
  16553. <param name="scope" type="java.lang.String"/>
  16554. <param name="maxCardinality" type="int"/>
  16555. <param name="allocationTags" type="java.lang.String[]"/>
  16556. <doc>
  16557. <![CDATA[Similar to {@link #cardinality(String, int, int, String...)}, but
  16558. determines only the maximum cardinality (the minimum cardinality is 0).
  16559. @param scope the scope of the constraint
  16560. @param maxCardinality determines the maximum number of allocations within
  16561. the scope
  16562. @param allocationTags the constraint targets allocations with these tags
  16563. @return the resulting placement constraint]]>
  16564. </doc>
  16565. </method>
  16566. <method name="maxCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16567. abstract="false" native="false" synchronized="false"
  16568. static="true" final="false" visibility="public"
  16569. deprecated="not deprecated">
  16570. <param name="scope" type="java.lang.String"/>
  16571. <param name="tagNamespace" type="java.lang.String"/>
  16572. <param name="maxCardinality" type="int"/>
  16573. <param name="allocationTags" type="java.lang.String[]"/>
  16574. <doc>
  16575. <![CDATA[Similar to {@link #maxCardinality(String, int, String...)}, but let you
  16576. specify a namespace for the tags, see supported namespaces in
  16577. {@link AllocationTagNamespaceType}.
  16578. @param scope the scope of the constraint
  16579. @param tagNamespace the namespace of these tags
  16580. @param maxCardinality determines the maximum number of allocations within
  16581. the scope
  16582. @param allocationTags allocation tags
  16583. @return the resulting placement constraint]]>
  16584. </doc>
  16585. </method>
  16586. <method name="targetCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16587. abstract="false" native="false" synchronized="false"
  16588. static="true" final="false" visibility="public"
  16589. deprecated="not deprecated">
  16590. <param name="scope" type="java.lang.String"/>
  16591. <param name="minCardinality" type="int"/>
  16592. <param name="maxCardinality" type="int"/>
  16593. <param name="targetExpressions" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TargetExpression[]"/>
  16594. <doc>
  16595. <![CDATA[This constraint generalizes the cardinality and target constraints.
  16596. Consider a set of nodes N that belongs to the scope specified in the
  16597. constraint. If the target expressions are satisfied at least minCardinality
  16598. times and at most maxCardinality times in the node set N, then the
  16599. constraint is satisfied.
  16600. For example, {@code targetCardinality(RACK, 2, 10, allocationTag("zk"))},
  16601. requires an allocation to be placed within a rack that has at least 2 and
  16602. at most 10 other allocations with tag "zk".
  16603. @param scope the scope of the constraint
  16604. @param minCardinality the minimum number of times the target expressions
  16605. have to be satisfied with the given scope
  16606. @param maxCardinality the maximum number of times the target expressions
  16607. have to be satisfied with the given scope
  16608. @param targetExpressions the target expressions
  16609. @return the resulting placement constraint]]>
  16610. </doc>
  16611. </method>
  16612. <method name="and" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.And"
  16613. abstract="false" native="false" synchronized="false"
  16614. static="true" final="false" visibility="public"
  16615. deprecated="not deprecated">
  16616. <param name="children" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint[]"/>
  16617. <doc>
  16618. <![CDATA[A conjunction of constraints.
  16619. @param children the children constraints that should all be satisfied
  16620. @return the resulting placement constraint]]>
  16621. </doc>
  16622. </method>
  16623. <method name="or" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.Or"
  16624. abstract="false" native="false" synchronized="false"
  16625. static="true" final="false" visibility="public"
  16626. deprecated="not deprecated">
  16627. <param name="children" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint[]"/>
  16628. <doc>
  16629. <![CDATA[A disjunction of constraints.
  16630. @param children the children constraints, one of which should be satisfied
  16631. @return the resulting placement constraint]]>
  16632. </doc>
  16633. </method>
  16634. <method name="delayedOr" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.DelayedOr"
  16635. abstract="false" native="false" synchronized="false"
  16636. static="true" final="false" visibility="public"
  16637. deprecated="not deprecated">
  16638. <param name="children" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TimedPlacementConstraint[]"/>
  16639. <doc>
  16640. <![CDATA[Creates a composite constraint that includes a list of timed placement
  16641. constraints. The scheduler should try to satisfy first the first timed
  16642. child constraint within the specified time window. If this is not possible,
  16643. it should attempt to satisfy the second, and so on.
  16644. @param children the timed children constraints
  16645. @return the resulting composite constraint]]>
  16646. </doc>
  16647. </method>
  16648. <method name="timedClockConstraint" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TimedPlacementConstraint"
  16649. abstract="false" native="false" synchronized="false"
  16650. static="true" final="false" visibility="public"
  16651. deprecated="not deprecated">
  16652. <param name="constraint" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"/>
  16653. <param name="delay" type="long"/>
  16654. <param name="timeUnit" type="java.util.concurrent.TimeUnit"/>
  16655. <doc>
  16656. <![CDATA[Creates a placement constraint that has to be satisfied within a time
  16657. window.
  16658. @param constraint the placement constraint
  16659. @param delay the length of the time window within which the constraint has
  16660. to be satisfied
  16661. @param timeUnit the unit of time of the time window
  16662. @return the resulting timed placement constraint]]>
  16663. </doc>
  16664. </method>
  16665. <method name="timedOpportunitiesConstraint" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TimedPlacementConstraint"
  16666. abstract="false" native="false" synchronized="false"
  16667. static="true" final="false" visibility="public"
  16668. deprecated="not deprecated">
  16669. <param name="constraint" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"/>
  16670. <param name="delay" type="long"/>
  16671. <doc>
  16672. <![CDATA[Creates a placement constraint that has to be satisfied within a number of
  16673. placement opportunities (invocations of the scheduler).
  16674. @param constraint the placement constraint
  16675. @param delay the number of scheduling opportunities within which the
  16676. constraint has to be satisfied
  16677. @return the resulting timed placement constraint]]>
  16678. </doc>
  16679. </method>
  16680. <method name="build" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint"
  16681. abstract="false" native="false" synchronized="false"
  16682. static="true" final="false" visibility="public"
  16683. deprecated="not deprecated">
  16684. <param name="constraintExpr" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"/>
  16685. <doc>
  16686. <![CDATA[Creates a {@link PlacementConstraint} given a constraint expression.
  16687. @param constraintExpr the constraint expression
  16688. @return the placement constraint]]>
  16689. </doc>
  16690. </method>
  16691. <field name="NODE" type="java.lang.String"
  16692. transient="false" volatile="false"
  16693. static="true" final="true" visibility="public"
  16694. deprecated="not deprecated">
  16695. </field>
  16696. <field name="RACK" type="java.lang.String"
  16697. transient="false" volatile="false"
  16698. static="true" final="true" visibility="public"
  16699. deprecated="not deprecated">
  16700. </field>
  16701. <field name="NODE_PARTITION" type="java.lang.String"
  16702. transient="false" volatile="false"
  16703. static="true" final="true" visibility="public"
  16704. deprecated="not deprecated">
  16705. </field>
  16706. <doc>
  16707. <![CDATA[This class contains various static methods for the applications to create
  16708. placement constraints (see also {@link PlacementConstraint}).]]>
  16709. </doc>
  16710. </class>
  16711. <!-- end class org.apache.hadoop.yarn.api.resource.PlacementConstraints -->
  16712. </package>
  16713. <package name="org.apache.hadoop.yarn.conf">
  16714. <!-- start class org.apache.hadoop.yarn.conf.YarnConfiguration -->
  16715. <class name="YarnConfiguration" extends="org.apache.hadoop.conf.Configuration"
  16716. abstract="false"
  16717. static="false" final="false" visibility="public"
  16718. deprecated="not deprecated">
  16719. <constructor name="YarnConfiguration"
  16720. static="false" final="false" visibility="public"
  16721. deprecated="not deprecated">
  16722. </constructor>
  16723. <constructor name="YarnConfiguration" type="org.apache.hadoop.conf.Configuration"
  16724. static="false" final="false" visibility="public"
  16725. deprecated="not deprecated">
  16726. </constructor>
  16727. <method name="isAclEnabled" return="boolean"
  16728. abstract="false" native="false" synchronized="false"
  16729. static="true" final="false" visibility="public"
  16730. deprecated="not deprecated">
  16731. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  16732. </method>
  16733. <method name="getSocketAddr" return="java.net.InetSocketAddress"
  16734. abstract="false" native="false" synchronized="false"
  16735. static="false" final="false" visibility="public"
  16736. deprecated="not deprecated">
  16737. <param name="name" type="java.lang.String"/>
  16738. <param name="defaultAddress" type="java.lang.String"/>
  16739. <param name="defaultPort" type="int"/>
  16740. <doc>
  16741. <![CDATA[Get the socket address for <code>name</code> property as a
  16742. <code>InetSocketAddress</code>. On an HA cluster,
  16743. this fetches the address corresponding to the RM identified by
  16744. {@link #RM_HA_ID}.
  16745. @param name property name.
  16746. @param defaultAddress the default value
  16747. @param defaultPort the default port
  16748. @return InetSocketAddress]]>
  16749. </doc>
  16750. </method>
  16751. <method name="updateConnectAddr" return="java.net.InetSocketAddress"
  16752. abstract="false" native="false" synchronized="false"
  16753. static="false" final="false" visibility="public"
  16754. deprecated="not deprecated">
  16755. <param name="name" type="java.lang.String"/>
  16756. <param name="addr" type="java.net.InetSocketAddress"/>
  16757. </method>
  16758. <method name="useHttps" return="boolean"
  16759. abstract="false" native="false" synchronized="false"
  16760. static="true" final="false" visibility="public"
  16761. deprecated="not deprecated">
  16762. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  16763. </method>
  16764. <method name="shouldRMFailFast" return="boolean"
  16765. abstract="false" native="false" synchronized="false"
  16766. static="true" final="false" visibility="public"
  16767. deprecated="not deprecated">
  16768. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  16769. </method>
  16770. <method name="isDistSchedulingEnabled" return="boolean"
  16771. abstract="false" native="false" synchronized="false"
  16772. static="true" final="false" visibility="public"
  16773. deprecated="not deprecated">
  16774. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  16775. </method>
  16776. <method name="isOpportunisticContainerAllocationEnabled" return="boolean"
  16777. abstract="false" native="false" synchronized="false"
  16778. static="true" final="false" visibility="public"
  16779. deprecated="not deprecated">
  16780. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  16781. </method>
  16782. <method name="timelineServiceEnabled" return="boolean"
  16783. abstract="false" native="false" synchronized="false"
  16784. static="true" final="false" visibility="public"
  16785. deprecated="not deprecated">
  16786. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  16787. <doc>
  16788. <![CDATA[Returns whether the timeline service is enabled via configuration.
  16789. @param conf the configuration
  16790. @return whether the timeline service is enabled.]]>
  16791. </doc>
  16792. </method>
  16793. <method name="getTimelineServiceVersion" return="float"
  16794. abstract="false" native="false" synchronized="false"
  16795. static="true" final="false" visibility="public"
  16796. deprecated="not deprecated">
  16797. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  16798. <doc>
  16799. <![CDATA[Returns the timeline service version. It does not check whether the
  16800. timeline service itself is enabled.
  16801. @param conf the configuration
  16802. @return the timeline service version as a float.]]>
  16803. </doc>
  16804. </method>
  16805. <method name="timelineServiceV2Enabled" return="boolean"
  16806. abstract="false" native="false" synchronized="false"
  16807. static="true" final="false" visibility="public"
  16808. deprecated="not deprecated">
  16809. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  16810. <doc>
  16811. <![CDATA[Returns whether the timeline service v.2 is enabled via configuration.
  16812. @param conf the configuration
  16813. @return whether the timeline service v.2 is enabled. V.2 refers to a
  16814. version greater than equal to 2 but smaller than 3.]]>
  16815. </doc>
  16816. </method>
  16817. <method name="timelineServiceV1Enabled" return="boolean"
  16818. abstract="false" native="false" synchronized="false"
  16819. static="true" final="false" visibility="public"
  16820. deprecated="not deprecated">
  16821. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  16822. <doc>
  16823. <![CDATA[Returns whether the timeline service v.1 is enabled via configuration.
  16824. @param conf the configuration
  16825. @return whether the timeline service v.1 is enabled. V.1 refers to a
  16826. version greater than equal to 1 but smaller than 2.]]>
  16827. </doc>
  16828. </method>
  16829. <method name="timelineServiceV15Enabled" return="boolean"
  16830. abstract="false" native="false" synchronized="false"
  16831. static="true" final="false" visibility="public"
  16832. deprecated="not deprecated">
  16833. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  16834. <doc>
  16835. <![CDATA[Returns whether the timeline service v.1,5 is enabled via configuration.
  16836. @param conf the configuration
  16837. @return whether the timeline service v.1.5 is enabled. V.1.5 refers to a
  16838. version equal to 1.5.]]>
  16839. </doc>
  16840. </method>
  16841. <method name="systemMetricsPublisherEnabled" return="boolean"
  16842. abstract="false" native="false" synchronized="false"
  16843. static="true" final="false" visibility="public"
  16844. deprecated="not deprecated">
  16845. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  16846. <doc>
  16847. <![CDATA[Returns whether the system publisher is enabled.
  16848. @param conf the configuration
  16849. @return whether the system publisher is enabled.]]>
  16850. </doc>
  16851. </method>
  16852. <method name="numaAwarenessEnabled" return="boolean"
  16853. abstract="false" native="false" synchronized="false"
  16854. static="true" final="false" visibility="public"
  16855. deprecated="not deprecated">
  16856. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  16857. <doc>
  16858. <![CDATA[Returns whether the NUMA awareness is enabled.
  16859. @param conf the configuration
  16860. @return whether the NUMA awareness is enabled.]]>
  16861. </doc>
  16862. </method>
  16863. <method name="main"
  16864. abstract="false" native="false" synchronized="false"
  16865. static="true" final="false" visibility="public"
  16866. deprecated="not deprecated">
  16867. <param name="args" type="java.lang.String[]"/>
  16868. <exception name="Exception" type="java.lang.Exception"/>
  16869. </method>
  16870. <field name="DR_CONFIGURATION_FILE" type="java.lang.String"
  16871. transient="false" volatile="false"
  16872. static="true" final="true" visibility="public"
  16873. deprecated="not deprecated">
  16874. </field>
  16875. <field name="CS_CONFIGURATION_FILE" type="java.lang.String"
  16876. transient="false" volatile="false"
  16877. static="true" final="true" visibility="public"
  16878. deprecated="not deprecated">
  16879. </field>
  16880. <field name="HADOOP_POLICY_CONFIGURATION_FILE" type="java.lang.String"
  16881. transient="false" volatile="false"
  16882. static="true" final="true" visibility="public"
  16883. deprecated="not deprecated">
  16884. </field>
  16885. <field name="YARN_SITE_CONFIGURATION_FILE" type="java.lang.String"
  16886. transient="false" volatile="false"
  16887. static="true" final="true" visibility="public"
  16888. deprecated="not deprecated">
  16889. </field>
  16890. <field name="CORE_SITE_CONFIGURATION_FILE" type="java.lang.String"
  16891. transient="false" volatile="false"
  16892. static="true" final="true" visibility="public"
  16893. deprecated="not deprecated">
  16894. </field>
  16895. <field name="RESOURCE_TYPES_CONFIGURATION_FILE" type="java.lang.String"
  16896. transient="false" volatile="false"
  16897. static="true" final="true" visibility="public"
  16898. deprecated="not deprecated">
  16899. </field>
  16900. <field name="NODE_RESOURCES_CONFIGURATION_FILE" type="java.lang.String"
  16901. transient="false" volatile="false"
  16902. static="true" final="true" visibility="public"
  16903. deprecated="not deprecated">
  16904. </field>
  16905. <field name="RM_CONFIGURATION_FILES" type="java.util.List"
  16906. transient="false" volatile="false"
  16907. static="true" final="true" visibility="public"
  16908. deprecated="not deprecated">
  16909. </field>
  16910. <field name="NM_CONFIGURATION_FILES" type="java.util.List"
  16911. transient="false" volatile="false"
  16912. static="true" final="true" visibility="public"
  16913. deprecated="not deprecated">
  16914. </field>
  16915. <field name="APPLICATION_MAX_TAGS" type="int"
  16916. transient="false" volatile="false"
  16917. static="true" final="true" visibility="public"
  16918. deprecated="not deprecated">
  16919. </field>
  16920. <field name="APPLICATION_MAX_TAG_LENGTH" type="int"
  16921. transient="false" volatile="false"
  16922. static="true" final="true" visibility="public"
  16923. deprecated="not deprecated">
  16924. </field>
  16925. <field name="YARN_PREFIX" type="java.lang.String"
  16926. transient="false" volatile="false"
  16927. static="true" final="true" visibility="public"
  16928. deprecated="not deprecated">
  16929. </field>
  16930. <field name="RESOURCE_TYPES" type="java.lang.String"
  16931. transient="false" volatile="false"
  16932. static="true" final="true" visibility="public"
  16933. deprecated="not deprecated">
  16934. </field>
  16935. <field name="NM_RESOURCES_PREFIX" type="java.lang.String"
  16936. transient="false" volatile="false"
  16937. static="true" final="true" visibility="public"
  16938. deprecated="not deprecated">
  16939. </field>
  16940. <field name="DEBUG_NM_DELETE_DELAY_SEC" type="java.lang.String"
  16941. transient="false" volatile="false"
  16942. static="true" final="true" visibility="public"
  16943. deprecated="not deprecated">
  16944. <doc>
  16945. <![CDATA[Delay before deleting resource to ease debugging of NM issues]]>
  16946. </doc>
  16947. </field>
  16948. <field name="NM_LOG_CONTAINER_DEBUG_INFO" type="java.lang.String"
  16949. transient="false" volatile="false"
  16950. static="true" final="true" visibility="public"
  16951. deprecated="not deprecated">
  16952. </field>
  16953. <field name="DEFAULT_NM_LOG_CONTAINER_DEBUG_INFO" type="boolean"
  16954. transient="false" volatile="false"
  16955. static="true" final="true" visibility="public"
  16956. deprecated="not deprecated">
  16957. </field>
  16958. <field name="IPC_PREFIX" type="java.lang.String"
  16959. transient="false" volatile="false"
  16960. static="true" final="true" visibility="public"
  16961. deprecated="not deprecated">
  16962. </field>
  16963. <field name="IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
  16964. transient="false" volatile="false"
  16965. static="true" final="true" visibility="public"
  16966. deprecated="not deprecated">
  16967. <doc>
  16968. <![CDATA[Factory to create client IPC classes.]]>
  16969. </doc>
  16970. </field>
  16971. <field name="DEFAULT_IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
  16972. transient="false" volatile="false"
  16973. static="true" final="true" visibility="public"
  16974. deprecated="not deprecated">
  16975. </field>
  16976. <field name="IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
  16977. transient="false" volatile="false"
  16978. static="true" final="true" visibility="public"
  16979. deprecated="not deprecated">
  16980. <doc>
  16981. <![CDATA[Factory to create server IPC classes.]]>
  16982. </doc>
  16983. </field>
  16984. <field name="DEFAULT_IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
  16985. transient="false" volatile="false"
  16986. static="true" final="true" visibility="public"
  16987. deprecated="not deprecated">
  16988. </field>
  16989. <field name="IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
  16990. transient="false" volatile="false"
  16991. static="true" final="true" visibility="public"
  16992. deprecated="not deprecated">
  16993. <doc>
  16994. <![CDATA[Factory to create serializable records.]]>
  16995. </doc>
  16996. </field>
  16997. <field name="DEFAULT_IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
  16998. transient="false" volatile="false"
  16999. static="true" final="true" visibility="public"
  17000. deprecated="not deprecated">
  17001. </field>
  17002. <field name="IPC_RPC_IMPL" type="java.lang.String"
  17003. transient="false" volatile="false"
  17004. static="true" final="true" visibility="public"
  17005. deprecated="not deprecated">
  17006. <doc>
  17007. <![CDATA[RPC class implementation]]>
  17008. </doc>
  17009. </field>
  17010. <field name="DEFAULT_IPC_RPC_IMPL" type="java.lang.String"
  17011. transient="false" volatile="false"
  17012. static="true" final="true" visibility="public"
  17013. deprecated="not deprecated">
  17014. </field>
  17015. <field name="RM_PREFIX" type="java.lang.String"
  17016. transient="false" volatile="false"
  17017. static="true" final="true" visibility="public"
  17018. deprecated="not deprecated">
  17019. </field>
  17020. <field name="RM_CLUSTER_ID" type="java.lang.String"
  17021. transient="false" volatile="false"
  17022. static="true" final="true" visibility="public"
  17023. deprecated="not deprecated">
  17024. </field>
  17025. <field name="DEFAULT_RM_CLUSTER_ID" type="java.lang.String"
  17026. transient="false" volatile="false"
  17027. static="true" final="true" visibility="public"
  17028. deprecated="not deprecated">
  17029. </field>
  17030. <field name="RM_HOSTNAME" type="java.lang.String"
  17031. transient="false" volatile="false"
  17032. static="true" final="true" visibility="public"
  17033. deprecated="not deprecated">
  17034. </field>
  17035. <field name="RM_EPOCH" type="java.lang.String"
  17036. transient="false" volatile="false"
  17037. static="true" final="true" visibility="public"
  17038. deprecated="not deprecated">
  17039. </field>
  17040. <field name="DEFAULT_RM_EPOCH" type="long"
  17041. transient="false" volatile="false"
  17042. static="true" final="true" visibility="public"
  17043. deprecated="not deprecated">
  17044. </field>
  17045. <field name="RM_EPOCH_RANGE" type="java.lang.String"
  17046. transient="false" volatile="false"
  17047. static="true" final="true" visibility="public"
  17048. deprecated="not deprecated">
  17049. <doc>
  17050. <![CDATA[The epoch range before wrap around. 0 disables wrap around]]>
  17051. </doc>
  17052. </field>
  17053. <field name="DEFAULT_RM_EPOCH_RANGE" type="long"
  17054. transient="false" volatile="false"
  17055. static="true" final="true" visibility="public"
  17056. deprecated="not deprecated">
  17057. </field>
  17058. <field name="RM_ADDRESS" type="java.lang.String"
  17059. transient="false" volatile="false"
  17060. static="true" final="true" visibility="public"
  17061. deprecated="not deprecated">
  17062. <doc>
  17063. <![CDATA[The address of the applications manager interface in the RM.]]>
  17064. </doc>
  17065. </field>
  17066. <field name="DEFAULT_RM_PORT" type="int"
  17067. transient="false" volatile="false"
  17068. static="true" final="true" visibility="public"
  17069. deprecated="not deprecated">
  17070. </field>
  17071. <field name="DEFAULT_RM_ADDRESS" type="java.lang.String"
  17072. transient="false" volatile="false"
  17073. static="true" final="true" visibility="public"
  17074. deprecated="not deprecated">
  17075. </field>
  17076. <field name="RM_APPLICATION_MAX_TAGS" type="java.lang.String"
  17077. transient="false" volatile="false"
  17078. static="true" final="true" visibility="public"
  17079. deprecated="not deprecated">
  17080. <doc>
  17081. <![CDATA[Max number of application tags.]]>
  17082. </doc>
  17083. </field>
  17084. <field name="DEFAULT_RM_APPLICATION_MAX_TAGS" type="int"
  17085. transient="false" volatile="false"
  17086. static="true" final="true" visibility="public"
  17087. deprecated="not deprecated">
  17088. </field>
  17089. <field name="RM_APPLICATION_MAX_TAG_LENGTH" type="java.lang.String"
  17090. transient="false" volatile="false"
  17091. static="true" final="true" visibility="public"
  17092. deprecated="not deprecated">
  17093. <doc>
  17094. <![CDATA[Max length of each application tag.]]>
  17095. </doc>
  17096. </field>
  17097. <field name="DEFAULT_RM_APPLICATION_MAX_TAG_LENGTH" type="int"
  17098. transient="false" volatile="false"
  17099. static="true" final="true" visibility="public"
  17100. deprecated="not deprecated">
  17101. </field>
  17102. <field name="RM_APPLICATION_MASTER_SERVICE_PROCESSORS" type="java.lang.String"
  17103. transient="false" volatile="false"
  17104. static="true" final="true" visibility="public"
  17105. deprecated="not deprecated">
  17106. </field>
  17107. <field name="RM_AUTO_UPDATE_CONTAINERS" type="java.lang.String"
  17108. transient="false" volatile="false"
  17109. static="true" final="true" visibility="public"
  17110. deprecated="not deprecated">
  17111. </field>
  17112. <field name="DEFAULT_RM_AUTO_UPDATE_CONTAINERS" type="boolean"
  17113. transient="false" volatile="false"
  17114. static="true" final="true" visibility="public"
  17115. deprecated="not deprecated">
  17116. </field>
  17117. <field name="RM_BIND_HOST" type="java.lang.String"
  17118. transient="false" volatile="false"
  17119. static="true" final="true" visibility="public"
  17120. deprecated="not deprecated">
  17121. <doc>
  17122. <![CDATA[The actual bind address for the RM.]]>
  17123. </doc>
  17124. </field>
  17125. <field name="RM_CLIENT_THREAD_COUNT" type="java.lang.String"
  17126. transient="false" volatile="false"
  17127. static="true" final="true" visibility="public"
  17128. deprecated="not deprecated">
  17129. <doc>
  17130. <![CDATA[The number of threads used to handle applications manager requests.]]>
  17131. </doc>
  17132. </field>
  17133. <field name="DEFAULT_RM_CLIENT_THREAD_COUNT" type="int"
  17134. transient="false" volatile="false"
  17135. static="true" final="true" visibility="public"
  17136. deprecated="not deprecated">
  17137. </field>
  17138. <field name="RM_AMLAUNCHER_THREAD_COUNT" type="java.lang.String"
  17139. transient="false" volatile="false"
  17140. static="true" final="true" visibility="public"
  17141. deprecated="not deprecated">
  17142. <doc>
  17143. <![CDATA[Number of threads used to launch/cleanup AM.]]>
  17144. </doc>
  17145. </field>
  17146. <field name="DEFAULT_RM_AMLAUNCHER_THREAD_COUNT" type="int"
  17147. transient="false" volatile="false"
  17148. static="true" final="true" visibility="public"
  17149. deprecated="not deprecated">
  17150. </field>
  17151. <field name="RM_NODEMANAGER_CONNECT_RETRIES" type="java.lang.String"
  17152. transient="false" volatile="false"
  17153. static="true" final="true" visibility="public"
  17154. deprecated="not deprecated">
  17155. <doc>
  17156. <![CDATA[Retry times to connect with NM.]]>
  17157. </doc>
  17158. </field>
  17159. <field name="DEFAULT_RM_NODEMANAGER_CONNECT_RETRIES" type="int"
  17160. transient="false" volatile="false"
  17161. static="true" final="true" visibility="public"
  17162. deprecated="not deprecated">
  17163. </field>
  17164. <field name="RM_PRINCIPAL" type="java.lang.String"
  17165. transient="false" volatile="false"
  17166. static="true" final="true" visibility="public"
  17167. deprecated="not deprecated">
  17168. <doc>
  17169. <![CDATA[The Kerberos principal for the resource manager.]]>
  17170. </doc>
  17171. </field>
  17172. <field name="RM_SCHEDULER_ADDRESS" type="java.lang.String"
  17173. transient="false" volatile="false"
  17174. static="true" final="true" visibility="public"
  17175. deprecated="not deprecated">
  17176. <doc>
  17177. <![CDATA[The address of the scheduler interface.]]>
  17178. </doc>
  17179. </field>
  17180. <field name="DEFAULT_RM_SCHEDULER_PORT" type="int"
  17181. transient="false" volatile="false"
  17182. static="true" final="true" visibility="public"
  17183. deprecated="not deprecated">
  17184. </field>
  17185. <field name="DEFAULT_RM_SCHEDULER_ADDRESS" type="java.lang.String"
  17186. transient="false" volatile="false"
  17187. static="true" final="true" visibility="public"
  17188. deprecated="not deprecated">
  17189. </field>
  17190. <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="java.lang.String"
  17191. transient="false" volatile="false"
  17192. static="true" final="true" visibility="public"
  17193. deprecated="not deprecated">
  17194. <doc>
  17195. <![CDATA[Minimum request grant-able by the RM scheduler.]]>
  17196. </doc>
  17197. </field>
  17198. <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="int"
  17199. transient="false" volatile="false"
  17200. static="true" final="true" visibility="public"
  17201. deprecated="not deprecated">
  17202. </field>
  17203. <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="java.lang.String"
  17204. transient="false" volatile="false"
  17205. static="true" final="true" visibility="public"
  17206. deprecated="not deprecated">
  17207. </field>
  17208. <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="int"
  17209. transient="false" volatile="false"
  17210. static="true" final="true" visibility="public"
  17211. deprecated="not deprecated">
  17212. </field>
  17213. <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="java.lang.String"
  17214. transient="false" volatile="false"
  17215. static="true" final="true" visibility="public"
  17216. deprecated="not deprecated">
  17217. <doc>
  17218. <![CDATA[Maximum request grant-able by the RM scheduler.]]>
  17219. </doc>
  17220. </field>
  17221. <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="int"
  17222. transient="false" volatile="false"
  17223. static="true" final="true" visibility="public"
  17224. deprecated="not deprecated">
  17225. </field>
  17226. <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="java.lang.String"
  17227. transient="false" volatile="false"
  17228. static="true" final="true" visibility="public"
  17229. deprecated="not deprecated">
  17230. </field>
  17231. <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="int"
  17232. transient="false" volatile="false"
  17233. static="true" final="true" visibility="public"
  17234. deprecated="not deprecated">
  17235. </field>
  17236. <field name="RM_SCHEDULER_CLIENT_THREAD_COUNT" type="java.lang.String"
  17237. transient="false" volatile="false"
  17238. static="true" final="true" visibility="public"
  17239. deprecated="not deprecated">
  17240. <doc>
  17241. <![CDATA[Number of threads to handle scheduler interface.]]>
  17242. </doc>
  17243. </field>
  17244. <field name="DEFAULT_RM_SCHEDULER_CLIENT_THREAD_COUNT" type="int"
  17245. transient="false" volatile="false"
  17246. static="true" final="true" visibility="public"
  17247. deprecated="not deprecated">
  17248. </field>
  17249. <field name="RM_SCHEDULER_INCLUDE_PORT_IN_NODE_NAME" type="java.lang.String"
  17250. transient="false" volatile="false"
  17251. static="true" final="true" visibility="public"
  17252. deprecated="not deprecated">
  17253. <doc>
  17254. <![CDATA[If the port should be included or not in the node name. The node name
  17255. is used by the scheduler for resource requests allocation location
  17256. matching. Typically this is just the hostname, using the port is needed
  17257. when using minicluster and specific NM are required.]]>
  17258. </doc>
  17259. </field>
  17260. <field name="DEFAULT_RM_SCHEDULER_USE_PORT_FOR_NODE_NAME" type="boolean"
  17261. transient="false" volatile="false"
  17262. static="true" final="true" visibility="public"
  17263. deprecated="not deprecated">
  17264. </field>
  17265. <field name="QUEUE_PLACEMENT_RULES" type="java.lang.String"
  17266. transient="false" volatile="false"
  17267. static="true" final="true" visibility="public"
  17268. deprecated="not deprecated">
  17269. <doc>
  17270. <![CDATA[Configured scheduler queue placement rules.]]>
  17271. </doc>
  17272. </field>
  17273. <field name="USER_GROUP_PLACEMENT_RULE" type="java.lang.String"
  17274. transient="false" volatile="false"
  17275. static="true" final="true" visibility="public"
  17276. deprecated="not deprecated">
  17277. <doc>
  17278. <![CDATA[UserGroupMappingPlacementRule configuration string.]]>
  17279. </doc>
  17280. </field>
  17281. <field name="APP_NAME_PLACEMENT_RULE" type="java.lang.String"
  17282. transient="false" volatile="false"
  17283. static="true" final="true" visibility="public"
  17284. deprecated="not deprecated">
  17285. </field>
  17286. <field name="RM_WEBAPP_UI_ACTIONS_ENABLED" type="java.lang.String"
  17287. transient="false" volatile="false"
  17288. static="true" final="true" visibility="public"
  17289. deprecated="not deprecated">
  17290. <doc>
  17291. <![CDATA[Enable Resource Manager webapp ui actions]]>
  17292. </doc>
  17293. </field>
  17294. <field name="DEFAULT_RM_WEBAPP_UI_ACTIONS_ENABLED" type="boolean"
  17295. transient="false" volatile="false"
  17296. static="true" final="true" visibility="public"
  17297. deprecated="not deprecated">
  17298. </field>
  17299. <field name="RM_RESERVATION_SYSTEM_ENABLE" type="java.lang.String"
  17300. transient="false" volatile="false"
  17301. static="true" final="true" visibility="public"
  17302. deprecated="not deprecated">
  17303. <doc>
  17304. <![CDATA[Whether the RM should enable Reservation System]]>
  17305. </doc>
  17306. </field>
  17307. <field name="DEFAULT_RM_RESERVATION_SYSTEM_ENABLE" type="boolean"
  17308. transient="false" volatile="false"
  17309. static="true" final="true" visibility="public"
  17310. deprecated="not deprecated">
  17311. </field>
  17312. <field name="RM_RESERVATION_SYSTEM_CLASS" type="java.lang.String"
  17313. transient="false" volatile="false"
  17314. static="true" final="true" visibility="public"
  17315. deprecated="not deprecated">
  17316. <doc>
  17317. <![CDATA[The class to use as the Reservation System.]]>
  17318. </doc>
  17319. </field>
  17320. <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER" type="java.lang.String"
  17321. transient="false" volatile="false"
  17322. static="true" final="true" visibility="public"
  17323. deprecated="not deprecated">
  17324. <doc>
  17325. <![CDATA[The PlanFollower for the Reservation System.]]>
  17326. </doc>
  17327. </field>
  17328. <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="java.lang.String"
  17329. transient="false" volatile="false"
  17330. static="true" final="true" visibility="public"
  17331. deprecated="not deprecated">
  17332. <doc>
  17333. <![CDATA[The step size of the Reservation System.]]>
  17334. </doc>
  17335. </field>
  17336. <field name="DEFAULT_RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="long"
  17337. transient="false" volatile="false"
  17338. static="true" final="true" visibility="public"
  17339. deprecated="not deprecated">
  17340. </field>
  17341. <field name="RM_RESERVATION_SYSTEM_MAX_PERIODICITY" type="java.lang.String"
  17342. transient="false" volatile="false"
  17343. static="true" final="true" visibility="public"
  17344. deprecated="not deprecated">
  17345. <doc>
  17346. <![CDATA[The maximum periodicity for the Reservation System.]]>
  17347. </doc>
  17348. </field>
  17349. <field name="DEFAULT_RM_RESERVATION_SYSTEM_MAX_PERIODICITY" type="long"
  17350. transient="false" volatile="false"
  17351. static="true" final="true" visibility="public"
  17352. deprecated="not deprecated">
  17353. </field>
  17354. <field name="RM_SCHEDULER_ENABLE_MONITORS" type="java.lang.String"
  17355. transient="false" volatile="false"
  17356. static="true" final="true" visibility="public"
  17357. deprecated="not deprecated">
  17358. <doc>
  17359. <![CDATA[Enable periodic monitor threads.
  17360. @see #RM_SCHEDULER_MONITOR_POLICIES]]>
  17361. </doc>
  17362. </field>
  17363. <field name="DEFAULT_RM_SCHEDULER_ENABLE_MONITORS" type="boolean"
  17364. transient="false" volatile="false"
  17365. static="true" final="true" visibility="public"
  17366. deprecated="not deprecated">
  17367. </field>
  17368. <field name="RM_SCHEDULER_MONITOR_POLICIES" type="java.lang.String"
  17369. transient="false" volatile="false"
  17370. static="true" final="true" visibility="public"
  17371. deprecated="not deprecated">
  17372. <doc>
  17373. <![CDATA[List of SchedulingEditPolicy classes affecting the scheduler.]]>
  17374. </doc>
  17375. </field>
  17376. <field name="RM_WEBAPP_ADDRESS" type="java.lang.String"
  17377. transient="false" volatile="false"
  17378. static="true" final="true" visibility="public"
  17379. deprecated="not deprecated">
  17380. <doc>
  17381. <![CDATA[The address of the RM web application.]]>
  17382. </doc>
  17383. </field>
  17384. <field name="DEFAULT_RM_WEBAPP_PORT" type="int"
  17385. transient="false" volatile="false"
  17386. static="true" final="true" visibility="public"
  17387. deprecated="not deprecated">
  17388. </field>
  17389. <field name="DEFAULT_RM_WEBAPP_ADDRESS" type="java.lang.String"
  17390. transient="false" volatile="false"
  17391. static="true" final="true" visibility="public"
  17392. deprecated="not deprecated">
  17393. </field>
  17394. <field name="RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  17395. transient="false" volatile="false"
  17396. static="true" final="true" visibility="public"
  17397. deprecated="not deprecated">
  17398. <doc>
  17399. <![CDATA[The https address of the RM web application.]]>
  17400. </doc>
  17401. </field>
  17402. <field name="YARN_SSL_CLIENT_HTTPS_NEED_AUTH_DEFAULT" type="boolean"
  17403. transient="false" volatile="false"
  17404. static="true" final="true" visibility="public"
  17405. deprecated="not deprecated">
  17406. </field>
  17407. <field name="YARN_SSL_SERVER_RESOURCE_DEFAULT" type="java.lang.String"
  17408. transient="false" volatile="false"
  17409. static="true" final="true" visibility="public"
  17410. deprecated="not deprecated">
  17411. </field>
  17412. <field name="DEFAULT_RM_WEBAPP_HTTPS_PORT" type="int"
  17413. transient="false" volatile="false"
  17414. static="true" final="true" visibility="public"
  17415. deprecated="not deprecated">
  17416. </field>
  17417. <field name="DEFAULT_RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  17418. transient="false" volatile="false"
  17419. static="true" final="true" visibility="public"
  17420. deprecated="not deprecated">
  17421. </field>
  17422. <field name="YARN_WEBAPP_UI2_ENABLE" type="java.lang.String"
  17423. transient="false" volatile="false"
  17424. static="true" final="true" visibility="public"
  17425. deprecated="not deprecated">
  17426. <doc>
  17427. <![CDATA[Enable YARN WebApp V2.]]>
  17428. </doc>
  17429. </field>
  17430. <field name="DEFAULT_YARN_WEBAPP_UI2_ENABLE" type="boolean"
  17431. transient="false" volatile="false"
  17432. static="true" final="true" visibility="public"
  17433. deprecated="not deprecated">
  17434. </field>
  17435. <field name="YARN_WEBAPP_UI2_WARFILE_PATH" type="java.lang.String"
  17436. transient="false" volatile="false"
  17437. static="true" final="true" visibility="public"
  17438. deprecated="not deprecated">
  17439. </field>
  17440. <field name="YARN_API_SERVICES_ENABLE" type="java.lang.String"
  17441. transient="false" volatile="false"
  17442. static="true" final="true" visibility="public"
  17443. deprecated="not deprecated">
  17444. </field>
  17445. <field name="DEFAULT_YARN_API_SYSTEM_SERVICES_CLASS" type="java.lang.String"
  17446. transient="false" volatile="false"
  17447. static="true" final="true" visibility="public"
  17448. deprecated="not deprecated">
  17449. </field>
  17450. <field name="RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
  17451. transient="false" volatile="false"
  17452. static="true" final="true" visibility="public"
  17453. deprecated="not deprecated">
  17454. </field>
  17455. <field name="DEFAULT_RM_RESOURCE_TRACKER_PORT" type="int"
  17456. transient="false" volatile="false"
  17457. static="true" final="true" visibility="public"
  17458. deprecated="not deprecated">
  17459. </field>
  17460. <field name="DEFAULT_RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
  17461. transient="false" volatile="false"
  17462. static="true" final="true" visibility="public"
  17463. deprecated="not deprecated">
  17464. </field>
  17465. <field name="RM_AM_EXPIRY_INTERVAL_MS" type="java.lang.String"
  17466. transient="false" volatile="false"
  17467. static="true" final="true" visibility="public"
  17468. deprecated="not deprecated">
  17469. <doc>
  17470. <![CDATA[The expiry interval for application master reporting.]]>
  17471. </doc>
  17472. </field>
  17473. <field name="DEFAULT_RM_AM_EXPIRY_INTERVAL_MS" type="int"
  17474. transient="false" volatile="false"
  17475. static="true" final="true" visibility="public"
  17476. deprecated="not deprecated">
  17477. </field>
  17478. <field name="RM_NM_EXPIRY_INTERVAL_MS" type="java.lang.String"
  17479. transient="false" volatile="false"
  17480. static="true" final="true" visibility="public"
  17481. deprecated="not deprecated">
  17482. <doc>
  17483. <![CDATA[How long to wait until a node manager is considered dead.]]>
  17484. </doc>
  17485. </field>
  17486. <field name="DEFAULT_RM_NM_EXPIRY_INTERVAL_MS" type="int"
  17487. transient="false" volatile="false"
  17488. static="true" final="true" visibility="public"
  17489. deprecated="not deprecated">
  17490. </field>
  17491. <field name="YARN_ACL_ENABLE" type="java.lang.String"
  17492. transient="false" volatile="false"
  17493. static="true" final="true" visibility="public"
  17494. deprecated="not deprecated">
  17495. <doc>
  17496. <![CDATA[Are acls enabled.]]>
  17497. </doc>
  17498. </field>
  17499. <field name="DEFAULT_YARN_ACL_ENABLE" type="boolean"
  17500. transient="false" volatile="false"
  17501. static="true" final="true" visibility="public"
  17502. deprecated="not deprecated">
  17503. </field>
  17504. <field name="YARN_RESERVATION_ACL_ENABLE" type="java.lang.String"
  17505. transient="false" volatile="false"
  17506. static="true" final="true" visibility="public"
  17507. deprecated="not deprecated">
  17508. <doc>
  17509. <![CDATA[Are reservation acls enabled.]]>
  17510. </doc>
  17511. </field>
  17512. <field name="DEFAULT_YARN_RESERVATION_ACL_ENABLE" type="boolean"
  17513. transient="false" volatile="false"
  17514. static="true" final="true" visibility="public"
  17515. deprecated="not deprecated">
  17516. </field>
  17517. <field name="YARN_ADMIN_ACL" type="java.lang.String"
  17518. transient="false" volatile="false"
  17519. static="true" final="true" visibility="public"
  17520. deprecated="not deprecated">
  17521. <doc>
  17522. <![CDATA[ACL of who can be admin of YARN cluster.]]>
  17523. </doc>
  17524. </field>
  17525. <field name="DEFAULT_YARN_ADMIN_ACL" type="java.lang.String"
  17526. transient="false" volatile="false"
  17527. static="true" final="true" visibility="public"
  17528. deprecated="not deprecated">
  17529. </field>
  17530. <field name="DEFAULT_YARN_APP_ACL" type="java.lang.String"
  17531. transient="false" volatile="false"
  17532. static="true" final="true" visibility="public"
  17533. deprecated="not deprecated">
  17534. <doc>
  17535. <![CDATA[ACL used in case none is found. Allows nothing.]]>
  17536. </doc>
  17537. </field>
  17538. <field name="OPPORTUNISTIC_CONTAINER_ALLOCATION_ENABLED" type="java.lang.String"
  17539. transient="false" volatile="false"
  17540. static="true" final="true" visibility="public"
  17541. deprecated="not deprecated">
  17542. <doc>
  17543. <![CDATA[Setting that controls whether opportunistic container allocation
  17544. is enabled or not.]]>
  17545. </doc>
  17546. </field>
  17547. <field name="DEFAULT_OPPORTUNISTIC_CONTAINER_ALLOCATION_ENABLED" type="boolean"
  17548. transient="false" volatile="false"
  17549. static="true" final="true" visibility="public"
  17550. deprecated="not deprecated">
  17551. </field>
  17552. <field name="OPP_CONTAINER_ALLOCATION_NODES_NUMBER_USED" type="java.lang.String"
  17553. transient="false" volatile="false"
  17554. static="true" final="true" visibility="public"
  17555. deprecated="not deprecated">
  17556. <doc>
  17557. <![CDATA[Number of nodes to be used by the Opportunistic Container allocator for
  17558. dispatching containers during container allocation.]]>
  17559. </doc>
  17560. </field>
  17561. <field name="DEFAULT_OPP_CONTAINER_ALLOCATION_NODES_NUMBER_USED" type="int"
  17562. transient="false" volatile="false"
  17563. static="true" final="true" visibility="public"
  17564. deprecated="not deprecated">
  17565. </field>
  17566. <field name="NM_CONTAINER_QUEUING_SORTING_NODES_INTERVAL_MS" type="java.lang.String"
  17567. transient="false" volatile="false"
  17568. static="true" final="true" visibility="public"
  17569. deprecated="not deprecated">
  17570. <doc>
  17571. <![CDATA[Frequency for computing least loaded NMs.]]>
  17572. </doc>
  17573. </field>
  17574. <field name="DEFAULT_NM_CONTAINER_QUEUING_SORTING_NODES_INTERVAL_MS" type="long"
  17575. transient="false" volatile="false"
  17576. static="true" final="true" visibility="public"
  17577. deprecated="not deprecated">
  17578. </field>
  17579. <field name="NM_CONTAINER_QUEUING_LOAD_COMPARATOR" type="java.lang.String"
  17580. transient="false" volatile="false"
  17581. static="true" final="true" visibility="public"
  17582. deprecated="not deprecated">
  17583. <doc>
  17584. <![CDATA[Comparator for determining node load for scheduling of opportunistic
  17585. containers.]]>
  17586. </doc>
  17587. </field>
  17588. <field name="DEFAULT_NM_CONTAINER_QUEUING_LOAD_COMPARATOR" type="java.lang.String"
  17589. transient="false" volatile="false"
  17590. static="true" final="true" visibility="public"
  17591. deprecated="not deprecated">
  17592. </field>
  17593. <field name="NM_CONTAINER_QUEUING_LIMIT_STDEV" type="java.lang.String"
  17594. transient="false" volatile="false"
  17595. static="true" final="true" visibility="public"
  17596. deprecated="not deprecated">
  17597. <doc>
  17598. <![CDATA[Value of standard deviation used for calculation of queue limit
  17599. thresholds.]]>
  17600. </doc>
  17601. </field>
  17602. <field name="DEFAULT_NM_CONTAINER_QUEUING_LIMIT_STDEV" type="float"
  17603. transient="false" volatile="false"
  17604. static="true" final="true" visibility="public"
  17605. deprecated="not deprecated">
  17606. </field>
  17607. <field name="NM_CONTAINER_QUEUING_MIN_QUEUE_LENGTH" type="java.lang.String"
  17608. transient="false" volatile="false"
  17609. static="true" final="true" visibility="public"
  17610. deprecated="not deprecated">
  17611. <doc>
  17612. <![CDATA[Min length of container queue at NodeManager. This is a cluster-wide
  17613. configuration that acts as the lower-bound of optimal queue length
  17614. calculated by the NodeQueueLoadMonitor]]>
  17615. </doc>
  17616. </field>
  17617. <field name="DEFAULT_NM_CONTAINER_QUEUING_MIN_QUEUE_LENGTH" type="int"
  17618. transient="false" volatile="false"
  17619. static="true" final="true" visibility="public"
  17620. deprecated="not deprecated">
  17621. </field>
  17622. <field name="NM_CONTAINER_QUEUING_MAX_QUEUE_LENGTH" type="java.lang.String"
  17623. transient="false" volatile="false"
  17624. static="true" final="true" visibility="public"
  17625. deprecated="not deprecated">
  17626. <doc>
  17627. <![CDATA[Max length of container queue at NodeManager. This is a cluster-wide
  17628. configuration that acts as the upper-bound of optimal queue length
  17629. calculated by the NodeQueueLoadMonitor]]>
  17630. </doc>
  17631. </field>
  17632. <field name="DEFAULT_NM_CONTAINER_QUEUING_MAX_QUEUE_LENGTH" type="int"
  17633. transient="false" volatile="false"
  17634. static="true" final="true" visibility="public"
  17635. deprecated="not deprecated">
  17636. </field>
  17637. <field name="NM_CONTAINER_QUEUING_MIN_QUEUE_WAIT_TIME_MS" type="java.lang.String"
  17638. transient="false" volatile="false"
  17639. static="true" final="true" visibility="public"
  17640. deprecated="not deprecated">
  17641. <doc>
  17642. <![CDATA[Min queue wait time for a container at a NodeManager.]]>
  17643. </doc>
  17644. </field>
  17645. <field name="DEFAULT_NM_CONTAINER_QUEUING_MIN_QUEUE_WAIT_TIME_MS" type="int"
  17646. transient="false" volatile="false"
  17647. static="true" final="true" visibility="public"
  17648. deprecated="not deprecated">
  17649. </field>
  17650. <field name="NM_CONTAINER_QUEUING_MAX_QUEUE_WAIT_TIME_MS" type="java.lang.String"
  17651. transient="false" volatile="false"
  17652. static="true" final="true" visibility="public"
  17653. deprecated="not deprecated">
  17654. <doc>
  17655. <![CDATA[Max queue wait time for a container queue at a NodeManager.]]>
  17656. </doc>
  17657. </field>
  17658. <field name="DEFAULT_NM_CONTAINER_QUEUING_MAX_QUEUE_WAIT_TIME_MS" type="int"
  17659. transient="false" volatile="false"
  17660. static="true" final="true" visibility="public"
  17661. deprecated="not deprecated">
  17662. </field>
  17663. <field name="YARN_INTERMEDIATE_DATA_ENCRYPTION" type="java.lang.String"
  17664. transient="false" volatile="false"
  17665. static="true" final="true" visibility="public"
  17666. deprecated="not deprecated">
  17667. <doc>
  17668. <![CDATA[Enable/disable intermediate-data encryption at YARN level. For now, this
  17669. only is used by the FileSystemRMStateStore to setup right file-system
  17670. security attributes.]]>
  17671. </doc>
  17672. </field>
  17673. <field name="DEFAULT_YARN_INTERMEDIATE_DATA_ENCRYPTION" type="boolean"
  17674. transient="false" volatile="false"
  17675. static="true" final="true" visibility="public"
  17676. deprecated="not deprecated">
  17677. </field>
  17678. <field name="RM_ADMIN_ADDRESS" type="java.lang.String"
  17679. transient="false" volatile="false"
  17680. static="true" final="true" visibility="public"
  17681. deprecated="not deprecated">
  17682. <doc>
  17683. <![CDATA[The address of the RM admin interface.]]>
  17684. </doc>
  17685. </field>
  17686. <field name="DEFAULT_RM_ADMIN_PORT" type="int"
  17687. transient="false" volatile="false"
  17688. static="true" final="true" visibility="public"
  17689. deprecated="not deprecated">
  17690. </field>
  17691. <field name="DEFAULT_RM_ADMIN_ADDRESS" type="java.lang.String"
  17692. transient="false" volatile="false"
  17693. static="true" final="true" visibility="public"
  17694. deprecated="not deprecated">
  17695. </field>
  17696. <field name="RM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
  17697. transient="false" volatile="false"
  17698. static="true" final="true" visibility="public"
  17699. deprecated="not deprecated">
  17700. <doc>
  17701. <![CDATA[Number of threads used to handle RM admin interface.]]>
  17702. </doc>
  17703. </field>
  17704. <field name="DEFAULT_RM_ADMIN_CLIENT_THREAD_COUNT" type="int"
  17705. transient="false" volatile="false"
  17706. static="true" final="true" visibility="public"
  17707. deprecated="not deprecated">
  17708. </field>
  17709. <field name="RM_AM_MAX_ATTEMPTS" type="java.lang.String"
  17710. transient="false" volatile="false"
  17711. static="true" final="true" visibility="public"
  17712. deprecated="not deprecated">
  17713. <doc>
  17714. <![CDATA[The maximum number of application attempts for
  17715. an application, if unset by user.]]>
  17716. </doc>
  17717. </field>
  17718. <field name="DEFAULT_RM_AM_MAX_ATTEMPTS" type="int"
  17719. transient="false" volatile="false"
  17720. static="true" final="true" visibility="public"
  17721. deprecated="not deprecated">
  17722. </field>
  17723. <field name="GLOBAL_RM_AM_MAX_ATTEMPTS" type="java.lang.String"
  17724. transient="false" volatile="false"
  17725. static="true" final="true" visibility="public"
  17726. deprecated="not deprecated">
  17727. <doc>
  17728. <![CDATA[The maximum number of application attempts.
  17729. It's a global setting for all application masters.]]>
  17730. </doc>
  17731. </field>
  17732. <field name="RM_KEYTAB" type="java.lang.String"
  17733. transient="false" volatile="false"
  17734. static="true" final="true" visibility="public"
  17735. deprecated="not deprecated">
  17736. <doc>
  17737. <![CDATA[The keytab for the resource manager.]]>
  17738. </doc>
  17739. </field>
  17740. <field name="RM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
  17741. transient="false" volatile="false"
  17742. static="true" final="true" visibility="public"
  17743. deprecated="not deprecated">
  17744. <doc>
  17745. <![CDATA[The kerberos principal to be used for spnego filter for RM.]]>
  17746. </doc>
  17747. </field>
  17748. <field name="RM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
  17749. transient="false" volatile="false"
  17750. static="true" final="true" visibility="public"
  17751. deprecated="not deprecated">
  17752. <doc>
  17753. <![CDATA[The kerberos keytab to be used for spnego filter for RM.]]>
  17754. </doc>
  17755. </field>
  17756. <field name="RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="java.lang.String"
  17757. transient="false" volatile="false"
  17758. static="true" final="true" visibility="public"
  17759. deprecated="not deprecated">
  17760. <doc>
  17761. <![CDATA[Flag to enable override of the default kerberos authentication filter with
  17762. the RM authentication filter to allow authentication using delegation
  17763. tokens(fallback to kerberos if the tokens are missing). Only applicable
  17764. when the http authentication type is kerberos.]]>
  17765. </doc>
  17766. </field>
  17767. <field name="DEFAULT_RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="boolean"
  17768. transient="false" volatile="false"
  17769. static="true" final="true" visibility="public"
  17770. deprecated="not deprecated">
  17771. </field>
  17772. <field name="RM_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
  17773. transient="false" volatile="false"
  17774. static="true" final="true" visibility="public"
  17775. deprecated="not deprecated">
  17776. <doc>
  17777. <![CDATA[Enable cross origin (CORS) support.]]>
  17778. </doc>
  17779. </field>
  17780. <field name="DEFAULT_RM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
  17781. transient="false" volatile="false"
  17782. static="true" final="true" visibility="public"
  17783. deprecated="not deprecated">
  17784. </field>
  17785. <field name="RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="java.lang.String"
  17786. transient="false" volatile="false"
  17787. static="true" final="true" visibility="public"
  17788. deprecated="not deprecated">
  17789. <doc>
  17790. <![CDATA[How long to wait until a container is considered dead.]]>
  17791. </doc>
  17792. </field>
  17793. <field name="DEFAULT_RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="int"
  17794. transient="false" volatile="false"
  17795. static="true" final="true" visibility="public"
  17796. deprecated="not deprecated">
  17797. </field>
  17798. <field name="RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
  17799. transient="false" volatile="false"
  17800. static="true" final="true" visibility="public"
  17801. deprecated="not deprecated">
  17802. <doc>
  17803. <![CDATA[Path to file with nodes to include.]]>
  17804. </doc>
  17805. </field>
  17806. <field name="DEFAULT_RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
  17807. transient="false" volatile="false"
  17808. static="true" final="true" visibility="public"
  17809. deprecated="not deprecated">
  17810. </field>
  17811. <field name="RM_SUBMISSION_PREPROCESSOR_ENABLED" type="java.lang.String"
  17812. transient="false" volatile="false"
  17813. static="true" final="true" visibility="public"
  17814. deprecated="not deprecated">
  17815. <doc>
  17816. <![CDATA[Enable submission pre-processor.]]>
  17817. </doc>
  17818. </field>
  17819. <field name="DEFAULT_RM_SUBMISSION_PREPROCESSOR_ENABLED" type="boolean"
  17820. transient="false" volatile="false"
  17821. static="true" final="true" visibility="public"
  17822. deprecated="not deprecated">
  17823. </field>
  17824. <field name="RM_SUBMISSION_PREPROCESSOR_FILE_PATH" type="java.lang.String"
  17825. transient="false" volatile="false"
  17826. static="true" final="true" visibility="public"
  17827. deprecated="not deprecated">
  17828. <doc>
  17829. <![CDATA[Path to file with hosts for the submission processor to handle.]]>
  17830. </doc>
  17831. </field>
  17832. <field name="DEFAULT_RM_SUBMISSION_PREPROCESSOR_FILE_PATH" type="java.lang.String"
  17833. transient="false" volatile="false"
  17834. static="true" final="true" visibility="public"
  17835. deprecated="not deprecated">
  17836. </field>
  17837. <field name="RM_SUBMISSION_PREPROCESSOR_REFRESH_INTERVAL_MS" type="java.lang.String"
  17838. transient="false" volatile="false"
  17839. static="true" final="true" visibility="public"
  17840. deprecated="not deprecated">
  17841. <doc>
  17842. <![CDATA[Submission processor refresh interval.]]>
  17843. </doc>
  17844. </field>
  17845. <field name="DEFAULT_RM_SUBMISSION_PREPROCESSOR_REFRESH_INTERVAL_MS" type="int"
  17846. transient="false" volatile="false"
  17847. static="true" final="true" visibility="public"
  17848. deprecated="not deprecated">
  17849. </field>
  17850. <field name="RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
  17851. transient="false" volatile="false"
  17852. static="true" final="true" visibility="public"
  17853. deprecated="not deprecated">
  17854. <doc>
  17855. <![CDATA[Path to file with nodes to exclude.]]>
  17856. </doc>
  17857. </field>
  17858. <field name="DEFAULT_RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
  17859. transient="false" volatile="false"
  17860. static="true" final="true" visibility="public"
  17861. deprecated="not deprecated">
  17862. </field>
  17863. <field name="RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="java.lang.String"
  17864. transient="false" volatile="false"
  17865. static="true" final="true" visibility="public"
  17866. deprecated="not deprecated">
  17867. <doc>
  17868. <![CDATA[Number of threads to handle resource tracker calls.]]>
  17869. </doc>
  17870. </field>
  17871. <field name="DEFAULT_RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="int"
  17872. transient="false" volatile="false"
  17873. static="true" final="true" visibility="public"
  17874. deprecated="not deprecated">
  17875. </field>
  17876. <field name="RM_SCHEDULER" type="java.lang.String"
  17877. transient="false" volatile="false"
  17878. static="true" final="true" visibility="public"
  17879. deprecated="not deprecated">
  17880. <doc>
  17881. <![CDATA[The class to use as the resource scheduler.]]>
  17882. </doc>
  17883. </field>
  17884. <field name="RM_PLACEMENT_CONSTRAINTS_HANDLER" type="java.lang.String"
  17885. transient="false" volatile="false"
  17886. static="true" final="true" visibility="public"
  17887. deprecated="not deprecated">
  17888. <doc>
  17889. <![CDATA[Specify which handler will be used to process PlacementConstraints.
  17890. For details on PlacementConstraints, please refer to
  17891. {@link org.apache.hadoop.yarn.api.resource.PlacementConstraint}]]>
  17892. </doc>
  17893. </field>
  17894. <field name="DISABLED_RM_PLACEMENT_CONSTRAINTS_HANDLER" type="java.lang.String"
  17895. transient="false" volatile="false"
  17896. static="true" final="true" visibility="public"
  17897. deprecated="not deprecated">
  17898. <doc>
  17899. <![CDATA[This handler rejects all allocate calls made by an application, if they
  17900. contain a {@link org.apache.hadoop.yarn.api.records.SchedulingRequest}.]]>
  17901. </doc>
  17902. </field>
  17903. <field name="PROCESSOR_RM_PLACEMENT_CONSTRAINTS_HANDLER" type="java.lang.String"
  17904. transient="false" volatile="false"
  17905. static="true" final="true" visibility="public"
  17906. deprecated="not deprecated">
  17907. <doc>
  17908. <![CDATA[Using this handler, the placement of containers with constraints is
  17909. determined as a pre-processing step before the capacity or the fair
  17910. scheduler is called. Once the placement is decided, the capacity/fair
  17911. scheduler is invoked to perform the actual allocation. The advantage of
  17912. this approach is that it supports all constraint types (affinity,
  17913. anti-affinity, cardinality). Moreover, it considers multiple containers at
  17914. a time, which allows to satisfy more constraints than a container-at-a-time
  17915. approach can achieve. As it sits outside the main scheduler, it can be used
  17916. by both the capacity and fair schedulers. Note that at the moment it does
  17917. not account for task priorities within an application, given that such
  17918. priorities might be conflicting with the placement constraints.]]>
  17919. </doc>
  17920. </field>
  17921. <field name="SCHEDULER_RM_PLACEMENT_CONSTRAINTS_HANDLER" type="java.lang.String"
  17922. transient="false" volatile="false"
  17923. static="true" final="true" visibility="public"
  17924. deprecated="not deprecated">
  17925. <doc>
  17926. <![CDATA[Using this handler, containers with constraints will be placed by the main
  17927. scheduler. If the configured RM scheduler
  17928. <pre>yarn.resourcemanager.scheduler.class</pre>
  17929. cannot handle placement constraints, the corresponding SchedulingRequests
  17930. will be rejected. As of now, only the capacity scheduler supports
  17931. SchedulingRequests. In particular, it currently supports anti-affinity
  17932. constraints (no affinity or cardinality) and places one container at a
  17933. time. The advantage of this handler compared to the placement-processor is
  17934. that it follows the same ordering rules for queues (sorted by utilization,
  17935. priority) and apps (sorted by FIFO/fairness/priority) as the ones followed
  17936. by the main scheduler.]]>
  17937. </doc>
  17938. </field>
  17939. <field name="RM_PLACEMENT_CONSTRAINTS_ALGORITHM_CLASS" type="java.lang.String"
  17940. transient="false" volatile="false"
  17941. static="true" final="true" visibility="public"
  17942. deprecated="not deprecated">
  17943. <doc>
  17944. <![CDATA[Placement Algorithm.]]>
  17945. </doc>
  17946. </field>
  17947. <field name="RM_PLACEMENT_CONSTRAINTS_ALGORITHM_ITERATOR" type="java.lang.String"
  17948. transient="false" volatile="false"
  17949. static="true" final="true" visibility="public"
  17950. deprecated="not deprecated">
  17951. <doc>
  17952. <![CDATA[Used for BasicPlacementAlgorithm - default SERIAL.]]>
  17953. </doc>
  17954. </field>
  17955. <field name="RM_PLACEMENT_CONSTRAINTS_RETRY_ATTEMPTS" type="java.lang.String"
  17956. transient="false" volatile="false"
  17957. static="true" final="true" visibility="public"
  17958. deprecated="not deprecated">
  17959. </field>
  17960. <field name="DEFAULT_RM_PLACEMENT_CONSTRAINTS_RETRY_ATTEMPTS" type="int"
  17961. transient="false" volatile="false"
  17962. static="true" final="true" visibility="public"
  17963. deprecated="not deprecated">
  17964. </field>
  17965. <field name="RM_PLACEMENT_CONSTRAINTS_ALGORITHM_POOL_SIZE" type="java.lang.String"
  17966. transient="false" volatile="false"
  17967. static="true" final="true" visibility="public"
  17968. deprecated="not deprecated">
  17969. </field>
  17970. <field name="DEFAULT_RM_PLACEMENT_CONSTRAINTS_ALGORITHM_POOL_SIZE" type="int"
  17971. transient="false" volatile="false"
  17972. static="true" final="true" visibility="public"
  17973. deprecated="not deprecated">
  17974. </field>
  17975. <field name="RM_PLACEMENT_CONSTRAINTS_SCHEDULER_POOL_SIZE" type="java.lang.String"
  17976. transient="false" volatile="false"
  17977. static="true" final="true" visibility="public"
  17978. deprecated="not deprecated">
  17979. </field>
  17980. <field name="DEFAULT_RM_PLACEMENT_CONSTRAINTS_SCHEDULER_POOL_SIZE" type="int"
  17981. transient="false" volatile="false"
  17982. static="true" final="true" visibility="public"
  17983. deprecated="not deprecated">
  17984. </field>
  17985. <field name="DEFAULT_RM_SCHEDULER" type="java.lang.String"
  17986. transient="false" volatile="false"
  17987. static="true" final="true" visibility="public"
  17988. deprecated="not deprecated">
  17989. </field>
  17990. <field name="RM_NM_HEARTBEAT_INTERVAL_MS" type="java.lang.String"
  17991. transient="false" volatile="false"
  17992. static="true" final="true" visibility="public"
  17993. deprecated="not deprecated">
  17994. <doc>
  17995. <![CDATA[RM set next Heartbeat interval for NM]]>
  17996. </doc>
  17997. </field>
  17998. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MS" type="long"
  17999. transient="false" volatile="false"
  18000. static="true" final="true" visibility="public"
  18001. deprecated="not deprecated">
  18002. </field>
  18003. <field name="RM_NM_HEARTBEAT_INTERVAL_SCALING_ENABLE" type="java.lang.String"
  18004. transient="false" volatile="false"
  18005. static="true" final="true" visibility="public"
  18006. deprecated="not deprecated">
  18007. <doc>
  18008. <![CDATA[Enable Heartbeat Interval Scaling based on cpu utilization.]]>
  18009. </doc>
  18010. </field>
  18011. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_SCALING_ENABLE" type="boolean"
  18012. transient="false" volatile="false"
  18013. static="true" final="true" visibility="public"
  18014. deprecated="not deprecated">
  18015. </field>
  18016. <field name="RM_NM_HEARTBEAT_INTERVAL_MIN_MS" type="java.lang.String"
  18017. transient="false" volatile="false"
  18018. static="true" final="true" visibility="public"
  18019. deprecated="not deprecated">
  18020. </field>
  18021. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MIN_MS" type="long"
  18022. transient="false" volatile="false"
  18023. static="true" final="true" visibility="public"
  18024. deprecated="not deprecated">
  18025. </field>
  18026. <field name="RM_NM_HEARTBEAT_INTERVAL_MAX_MS" type="java.lang.String"
  18027. transient="false" volatile="false"
  18028. static="true" final="true" visibility="public"
  18029. deprecated="not deprecated">
  18030. </field>
  18031. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MAX_MS" type="long"
  18032. transient="false" volatile="false"
  18033. static="true" final="true" visibility="public"
  18034. deprecated="not deprecated">
  18035. </field>
  18036. <field name="RM_NM_HEARTBEAT_INTERVAL_SPEEDUP_FACTOR" type="java.lang.String"
  18037. transient="false" volatile="false"
  18038. static="true" final="true" visibility="public"
  18039. deprecated="not deprecated">
  18040. </field>
  18041. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_SPEEDUP_FACTOR" type="float"
  18042. transient="false" volatile="false"
  18043. static="true" final="true" visibility="public"
  18044. deprecated="not deprecated">
  18045. </field>
  18046. <field name="RM_NM_HEARTBEAT_INTERVAL_SLOWDOWN_FACTOR" type="java.lang.String"
  18047. transient="false" volatile="false"
  18048. static="true" final="true" visibility="public"
  18049. deprecated="not deprecated">
  18050. </field>
  18051. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_SLOWDOWN_FACTOR" type="float"
  18052. transient="false" volatile="false"
  18053. static="true" final="true" visibility="public"
  18054. deprecated="not deprecated">
  18055. </field>
  18056. <field name="RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="java.lang.String"
  18057. transient="false" volatile="false"
  18058. static="true" final="true" visibility="public"
  18059. deprecated="not deprecated">
  18060. <doc>
  18061. <![CDATA[Number of worker threads that write the history data.]]>
  18062. </doc>
  18063. </field>
  18064. <field name="DEFAULT_RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="int"
  18065. transient="false" volatile="false"
  18066. static="true" final="true" visibility="public"
  18067. deprecated="not deprecated">
  18068. </field>
  18069. <field name="RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="java.lang.String"
  18070. transient="false" volatile="false"
  18071. static="true" final="true" visibility="public"
  18072. deprecated="not deprecated">
  18073. <doc>
  18074. <![CDATA[The setting that controls whether yarn system metrics is published on the
  18075. timeline server or not by RM. This configuration setting is for ATS V1.
  18076. This is now deprecated in favor of SYSTEM_METRICS_PUBLISHER_ENABLED.]]>
  18077. </doc>
  18078. </field>
  18079. <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="boolean"
  18080. transient="false" volatile="false"
  18081. static="true" final="true" visibility="public"
  18082. deprecated="not deprecated">
  18083. </field>
  18084. <field name="SYSTEM_METRICS_PUBLISHER_ENABLED" type="java.lang.String"
  18085. transient="false" volatile="false"
  18086. static="true" final="true" visibility="public"
  18087. deprecated="not deprecated">
  18088. <doc>
  18089. <![CDATA[The setting that controls whether yarn system metrics is published on the
  18090. timeline server or not by RM and NM. This configuration setting is for
  18091. ATS v2.]]>
  18092. </doc>
  18093. </field>
  18094. <field name="DEFAULT_SYSTEM_METRICS_PUBLISHER_ENABLED" type="boolean"
  18095. transient="false" volatile="false"
  18096. static="true" final="true" visibility="public"
  18097. deprecated="not deprecated">
  18098. </field>
  18099. <field name="RM_PUBLISH_CONTAINER_EVENTS_ENABLED" type="java.lang.String"
  18100. transient="false" volatile="false"
  18101. static="true" final="true" visibility="public"
  18102. deprecated="not deprecated">
  18103. <doc>
  18104. <![CDATA[The setting that controls whether yarn container events are published to
  18105. the timeline service or not by RM. This configuration setting is for ATS
  18106. V2]]>
  18107. </doc>
  18108. </field>
  18109. <field name="DEFAULT_RM_PUBLISH_CONTAINER_EVENTS_ENABLED" type="boolean"
  18110. transient="false" volatile="false"
  18111. static="true" final="true" visibility="public"
  18112. deprecated="not deprecated">
  18113. </field>
  18114. <field name="RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="java.lang.String"
  18115. transient="false" volatile="false"
  18116. static="true" final="true" visibility="public"
  18117. deprecated="not deprecated">
  18118. </field>
  18119. <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="int"
  18120. transient="false" volatile="false"
  18121. static="true" final="true" visibility="public"
  18122. deprecated="not deprecated">
  18123. </field>
  18124. <field name="RM_TIMELINE_SERVER_V1_PUBLISHER_DISPATCHER_BATCH_SIZE" type="java.lang.String"
  18125. transient="false" volatile="false"
  18126. static="true" final="true" visibility="public"
  18127. deprecated="not deprecated">
  18128. </field>
  18129. <field name="DEFAULT_RM_TIMELINE_SERVER_V1_PUBLISHER_DISPATCHER_BATCH_SIZE" type="int"
  18130. transient="false" volatile="false"
  18131. static="true" final="true" visibility="public"
  18132. deprecated="not deprecated">
  18133. </field>
  18134. <field name="RM_TIMELINE_SERVER_V1_PUBLISHER_INTERVAL" type="java.lang.String"
  18135. transient="false" volatile="false"
  18136. static="true" final="true" visibility="public"
  18137. deprecated="not deprecated">
  18138. </field>
  18139. <field name="DEFAULT_RM_TIMELINE_SERVER_V1_PUBLISHER_INTERVAL" type="int"
  18140. transient="false" volatile="false"
  18141. static="true" final="true" visibility="public"
  18142. deprecated="not deprecated">
  18143. </field>
  18144. <field name="RM_TIMELINE_SERVER_V1_PUBLISHER_BATCH_ENABLED" type="java.lang.String"
  18145. transient="false" volatile="false"
  18146. static="true" final="true" visibility="public"
  18147. deprecated="not deprecated">
  18148. </field>
  18149. <field name="DEFAULT_RM_TIMELINE_SERVER_V1_PUBLISHER_BATCH_ENABLED" type="boolean"
  18150. transient="false" volatile="false"
  18151. static="true" final="true" visibility="public"
  18152. deprecated="not deprecated">
  18153. </field>
  18154. <field name="RM_DELEGATION_KEY_UPDATE_INTERVAL_KEY" type="java.lang.String"
  18155. transient="false" volatile="false"
  18156. static="true" final="true" visibility="public"
  18157. deprecated="not deprecated">
  18158. </field>
  18159. <field name="RM_DELEGATION_KEY_UPDATE_INTERVAL_DEFAULT" type="long"
  18160. transient="false" volatile="false"
  18161. static="true" final="true" visibility="public"
  18162. deprecated="not deprecated">
  18163. </field>
  18164. <field name="RM_DELEGATION_TOKEN_RENEW_INTERVAL_KEY" type="java.lang.String"
  18165. transient="false" volatile="false"
  18166. static="true" final="true" visibility="public"
  18167. deprecated="not deprecated">
  18168. </field>
  18169. <field name="RM_DELEGATION_TOKEN_RENEW_INTERVAL_DEFAULT" type="long"
  18170. transient="false" volatile="false"
  18171. static="true" final="true" visibility="public"
  18172. deprecated="not deprecated">
  18173. </field>
  18174. <field name="RM_DELEGATION_TOKEN_MAX_LIFETIME_KEY" type="java.lang.String"
  18175. transient="false" volatile="false"
  18176. static="true" final="true" visibility="public"
  18177. deprecated="not deprecated">
  18178. </field>
  18179. <field name="RM_DELEGATION_TOKEN_MAX_LIFETIME_DEFAULT" type="long"
  18180. transient="false" volatile="false"
  18181. static="true" final="true" visibility="public"
  18182. deprecated="not deprecated">
  18183. </field>
  18184. <field name="RM_DELEGATION_TOKEN_MAX_CONF_SIZE" type="java.lang.String"
  18185. transient="false" volatile="false"
  18186. static="true" final="true" visibility="public"
  18187. deprecated="not deprecated">
  18188. </field>
  18189. <field name="DEFAULT_RM_DELEGATION_TOKEN_MAX_CONF_SIZE_BYTES" type="int"
  18190. transient="false" volatile="false"
  18191. static="true" final="true" visibility="public"
  18192. deprecated="not deprecated">
  18193. </field>
  18194. <field name="RM_DELEGATION_TOKEN_ALWAYS_CANCEL" type="java.lang.String"
  18195. transient="false" volatile="false"
  18196. static="true" final="true" visibility="public"
  18197. deprecated="not deprecated">
  18198. </field>
  18199. <field name="DEFAULT_RM_DELEGATION_TOKEN_ALWAYS_CANCEL" type="boolean"
  18200. transient="false" volatile="false"
  18201. static="true" final="true" visibility="public"
  18202. deprecated="not deprecated">
  18203. </field>
  18204. <field name="RECOVERY_ENABLED" type="java.lang.String"
  18205. transient="false" volatile="false"
  18206. static="true" final="true" visibility="public"
  18207. deprecated="not deprecated">
  18208. </field>
  18209. <field name="DEFAULT_RM_RECOVERY_ENABLED" type="boolean"
  18210. transient="false" volatile="false"
  18211. static="true" final="true" visibility="public"
  18212. deprecated="not deprecated">
  18213. </field>
  18214. <field name="YARN_FAIL_FAST" type="java.lang.String"
  18215. transient="false" volatile="false"
  18216. static="true" final="true" visibility="public"
  18217. deprecated="not deprecated">
  18218. </field>
  18219. <field name="DEFAULT_YARN_FAIL_FAST" type="boolean"
  18220. transient="false" volatile="false"
  18221. static="true" final="true" visibility="public"
  18222. deprecated="not deprecated">
  18223. </field>
  18224. <field name="RM_FAIL_FAST" type="java.lang.String"
  18225. transient="false" volatile="false"
  18226. static="true" final="true" visibility="public"
  18227. deprecated="not deprecated">
  18228. </field>
  18229. <field name="RM_WORK_PRESERVING_RECOVERY_ENABLED" type="java.lang.String"
  18230. transient="false" volatile="false"
  18231. static="true" final="true" visibility="public"
  18232. deprecated="not deprecated">
  18233. </field>
  18234. <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_ENABLED" type="boolean"
  18235. transient="false" volatile="false"
  18236. static="true" final="true" visibility="public"
  18237. deprecated="not deprecated">
  18238. </field>
  18239. <field name="RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="java.lang.String"
  18240. transient="false" volatile="false"
  18241. static="true" final="true" visibility="public"
  18242. deprecated="not deprecated">
  18243. </field>
  18244. <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="long"
  18245. transient="false" volatile="false"
  18246. static="true" final="true" visibility="public"
  18247. deprecated="not deprecated">
  18248. </field>
  18249. <field name="RM_ZK_PREFIX" type="java.lang.String"
  18250. transient="false" volatile="false"
  18251. static="true" final="true" visibility="public"
  18252. deprecated="not deprecated">
  18253. <doc>
  18254. <![CDATA[Zookeeper interaction configs]]>
  18255. </doc>
  18256. </field>
  18257. <field name="RM_ZK_ADDRESS" type="java.lang.String"
  18258. transient="false" volatile="false"
  18259. static="true" final="true" visibility="public"
  18260. deprecated="not deprecated">
  18261. </field>
  18262. <field name="RM_ZK_NUM_RETRIES" type="java.lang.String"
  18263. transient="false" volatile="false"
  18264. static="true" final="true" visibility="public"
  18265. deprecated="not deprecated">
  18266. </field>
  18267. <field name="DEFAULT_ZK_RM_NUM_RETRIES" type="int"
  18268. transient="false" volatile="false"
  18269. static="true" final="true" visibility="public"
  18270. deprecated="not deprecated">
  18271. </field>
  18272. <field name="RM_ZK_ZNODE_SIZE_LIMIT_BYTES" type="java.lang.String"
  18273. transient="false" volatile="false"
  18274. static="true" final="true" visibility="public"
  18275. deprecated="not deprecated">
  18276. <doc>
  18277. <![CDATA[Zookeeper znode limit]]>
  18278. </doc>
  18279. </field>
  18280. <field name="DEFAULT_RM_ZK_ZNODE_SIZE_LIMIT_BYTES" type="int"
  18281. transient="false" volatile="false"
  18282. static="true" final="true" visibility="public"
  18283. deprecated="not deprecated">
  18284. </field>
  18285. <field name="RM_ZK_RETRY_INTERVAL_MS" type="java.lang.String"
  18286. transient="false" volatile="false"
  18287. static="true" final="true" visibility="public"
  18288. deprecated="not deprecated">
  18289. </field>
  18290. <field name="DEFAULT_RM_ZK_RETRY_INTERVAL_MS" type="int"
  18291. transient="false" volatile="false"
  18292. static="true" final="true" visibility="public"
  18293. deprecated="not deprecated">
  18294. </field>
  18295. <field name="RM_ZK_TIMEOUT_MS" type="java.lang.String"
  18296. transient="false" volatile="false"
  18297. static="true" final="true" visibility="public"
  18298. deprecated="not deprecated">
  18299. </field>
  18300. <field name="DEFAULT_RM_ZK_TIMEOUT_MS" type="int"
  18301. transient="false" volatile="false"
  18302. static="true" final="true" visibility="public"
  18303. deprecated="not deprecated">
  18304. </field>
  18305. <field name="ZK_APPID_NODE_SPLIT_INDEX" type="java.lang.String"
  18306. transient="false" volatile="false"
  18307. static="true" final="true" visibility="public"
  18308. deprecated="not deprecated">
  18309. </field>
  18310. <field name="DEFAULT_ZK_APPID_NODE_SPLIT_INDEX" type="int"
  18311. transient="false" volatile="false"
  18312. static="true" final="true" visibility="public"
  18313. deprecated="not deprecated">
  18314. </field>
  18315. <field name="ZK_DELEGATION_TOKEN_NODE_SPLIT_INDEX" type="java.lang.String"
  18316. transient="false" volatile="false"
  18317. static="true" final="true" visibility="public"
  18318. deprecated="not deprecated">
  18319. <doc>
  18320. <![CDATA[Index at which the RM Delegation Token ids will be split so that the
  18321. delegation token znodes stored in the zookeeper RM state store will be
  18322. stored as two different znodes (parent-child).]]>
  18323. </doc>
  18324. </field>
  18325. <field name="DEFAULT_ZK_DELEGATION_TOKEN_NODE_SPLIT_INDEX" type="int"
  18326. transient="false" volatile="false"
  18327. static="true" final="true" visibility="public"
  18328. deprecated="not deprecated">
  18329. </field>
  18330. <field name="RM_ZK_ACL" type="java.lang.String"
  18331. transient="false" volatile="false"
  18332. static="true" final="true" visibility="public"
  18333. deprecated="not deprecated">
  18334. </field>
  18335. <field name="DEFAULT_RM_ZK_ACL" type="java.lang.String"
  18336. transient="false" volatile="false"
  18337. static="true" final="true" visibility="public"
  18338. deprecated="not deprecated">
  18339. </field>
  18340. <field name="RM_ZK_AUTH" type="java.lang.String"
  18341. transient="false" volatile="false"
  18342. static="true" final="true" visibility="public"
  18343. deprecated="not deprecated">
  18344. </field>
  18345. <field name="ZK_STATE_STORE_PREFIX" type="java.lang.String"
  18346. transient="false" volatile="false"
  18347. static="true" final="true" visibility="public"
  18348. deprecated="not deprecated">
  18349. </field>
  18350. <field name="ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
  18351. transient="false" volatile="false"
  18352. static="true" final="true" visibility="public"
  18353. deprecated="not deprecated">
  18354. <doc>
  18355. <![CDATA[Parent znode path under which ZKRMStateStore will create znodes]]>
  18356. </doc>
  18357. </field>
  18358. <field name="DEFAULT_ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
  18359. transient="false" volatile="false"
  18360. static="true" final="true" visibility="public"
  18361. deprecated="not deprecated">
  18362. </field>
  18363. <field name="ZK_RM_STATE_STORE_ROOT_NODE_ACL" type="java.lang.String"
  18364. transient="false" volatile="false"
  18365. static="true" final="true" visibility="public"
  18366. deprecated="not deprecated">
  18367. <doc>
  18368. <![CDATA[Root node ACLs for fencing]]>
  18369. </doc>
  18370. </field>
  18371. <field name="RM_HA_PREFIX" type="java.lang.String"
  18372. transient="false" volatile="false"
  18373. static="true" final="true" visibility="public"
  18374. deprecated="not deprecated">
  18375. <doc>
  18376. <![CDATA[HA related configs]]>
  18377. </doc>
  18378. </field>
  18379. <field name="RM_HA_ENABLED" type="java.lang.String"
  18380. transient="false" volatile="false"
  18381. static="true" final="true" visibility="public"
  18382. deprecated="not deprecated">
  18383. </field>
  18384. <field name="DEFAULT_RM_HA_ENABLED" type="boolean"
  18385. transient="false" volatile="false"
  18386. static="true" final="true" visibility="public"
  18387. deprecated="not deprecated">
  18388. </field>
  18389. <field name="RM_HA_IDS" type="java.lang.String"
  18390. transient="false" volatile="false"
  18391. static="true" final="true" visibility="public"
  18392. deprecated="not deprecated">
  18393. </field>
  18394. <field name="RM_HA_ID" type="java.lang.String"
  18395. transient="false" volatile="false"
  18396. static="true" final="true" visibility="public"
  18397. deprecated="not deprecated">
  18398. </field>
  18399. <field name="FS_BASED_RM_CONF_STORE" type="java.lang.String"
  18400. transient="false" volatile="false"
  18401. static="true" final="true" visibility="public"
  18402. deprecated="not deprecated">
  18403. <doc>
  18404. <![CDATA[Store the related configuration files in File System]]>
  18405. </doc>
  18406. </field>
  18407. <field name="DEFAULT_FS_BASED_RM_CONF_STORE" type="java.lang.String"
  18408. transient="false" volatile="false"
  18409. static="true" final="true" visibility="public"
  18410. deprecated="not deprecated">
  18411. </field>
  18412. <field name="RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
  18413. transient="false" volatile="false"
  18414. static="true" final="true" visibility="public"
  18415. deprecated="not deprecated">
  18416. </field>
  18417. <field name="DEFAULT_RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
  18418. transient="false" volatile="false"
  18419. static="true" final="true" visibility="public"
  18420. deprecated="not deprecated">
  18421. </field>
  18422. <field name="SCHEDULER_CONFIGURATION_STORE_CLASS" type="java.lang.String"
  18423. transient="false" volatile="false"
  18424. static="true" final="true" visibility="public"
  18425. deprecated="not deprecated">
  18426. </field>
  18427. <field name="FILE_CONFIGURATION_STORE" type="java.lang.String"
  18428. transient="false" volatile="false"
  18429. static="true" final="true" visibility="public"
  18430. deprecated="not deprecated">
  18431. </field>
  18432. <field name="MEMORY_CONFIGURATION_STORE" type="java.lang.String"
  18433. transient="false" volatile="false"
  18434. static="true" final="true" visibility="public"
  18435. deprecated="not deprecated">
  18436. </field>
  18437. <field name="FS_CONFIGURATION_STORE" type="java.lang.String"
  18438. transient="false" volatile="false"
  18439. static="true" final="true" visibility="public"
  18440. deprecated="not deprecated">
  18441. </field>
  18442. <field name="ZK_CONFIGURATION_STORE" type="java.lang.String"
  18443. transient="false" volatile="false"
  18444. static="true" final="true" visibility="public"
  18445. deprecated="not deprecated">
  18446. </field>
  18447. <field name="LEVELDB_CONFIGURATION_STORE" type="java.lang.String"
  18448. transient="false" volatile="false"
  18449. static="true" final="true" visibility="public"
  18450. deprecated="not deprecated">
  18451. </field>
  18452. <field name="DEFAULT_CONFIGURATION_STORE" type="java.lang.String"
  18453. transient="false" volatile="false"
  18454. static="true" final="true" visibility="public"
  18455. deprecated="not deprecated">
  18456. </field>
  18457. <field name="RM_SCHEDCONF_STORE_PATH" type="java.lang.String"
  18458. transient="false" volatile="false"
  18459. static="true" final="true" visibility="public"
  18460. deprecated="not deprecated">
  18461. </field>
  18462. <field name="RM_SCHEDCONF_LEVELDB_COMPACTION_INTERVAL_SECS" type="java.lang.String"
  18463. transient="false" volatile="false"
  18464. static="true" final="true" visibility="public"
  18465. deprecated="not deprecated">
  18466. </field>
  18467. <field name="DEFAULT_RM_SCHEDCONF_LEVELDB_COMPACTION_INTERVAL_SECS" type="long"
  18468. transient="false" volatile="false"
  18469. static="true" final="true" visibility="public"
  18470. deprecated="not deprecated">
  18471. </field>
  18472. <field name="RM_SCHEDCONF_MAX_LOGS" type="java.lang.String"
  18473. transient="false" volatile="false"
  18474. static="true" final="true" visibility="public"
  18475. deprecated="not deprecated">
  18476. </field>
  18477. <field name="DEFAULT_RM_SCHEDCONF_LEVELDB_MAX_LOGS" type="long"
  18478. transient="false" volatile="false"
  18479. static="true" final="true" visibility="public"
  18480. deprecated="not deprecated">
  18481. </field>
  18482. <field name="DEFAULT_RM_SCHEDCONF_ZK_MAX_LOGS" type="long"
  18483. transient="false" volatile="false"
  18484. static="true" final="true" visibility="public"
  18485. deprecated="not deprecated">
  18486. </field>
  18487. <field name="SCHEDULER_CONFIGURATION_FS_PATH" type="java.lang.String"
  18488. transient="false" volatile="false"
  18489. static="true" final="true" visibility="public"
  18490. deprecated="not deprecated">
  18491. </field>
  18492. <field name="SCHEDULER_CONFIGURATION_FS_MAX_VERSION" type="java.lang.String"
  18493. transient="false" volatile="false"
  18494. static="true" final="true" visibility="public"
  18495. deprecated="not deprecated">
  18496. </field>
  18497. <field name="DEFAULT_SCHEDULER_CONFIGURATION_FS_MAX_VERSION" type="int"
  18498. transient="false" volatile="false"
  18499. static="true" final="true" visibility="public"
  18500. deprecated="not deprecated">
  18501. </field>
  18502. <field name="RM_SCHEDCONF_STORE_ZK_PARENT_PATH" type="java.lang.String"
  18503. transient="false" volatile="false"
  18504. static="true" final="true" visibility="public"
  18505. deprecated="not deprecated">
  18506. <doc>
  18507. <![CDATA[Parent znode path under which ZKConfigurationStore will create znodes.]]>
  18508. </doc>
  18509. </field>
  18510. <field name="DEFAULT_RM_SCHEDCONF_STORE_ZK_PARENT_PATH" type="java.lang.String"
  18511. transient="false" volatile="false"
  18512. static="true" final="true" visibility="public"
  18513. deprecated="not deprecated">
  18514. </field>
  18515. <field name="RM_SCHEDULER_MUTATION_ACL_POLICY_CLASS" type="java.lang.String"
  18516. transient="false" volatile="false"
  18517. static="true" final="true" visibility="public"
  18518. deprecated="not deprecated">
  18519. </field>
  18520. <field name="YARN_AUTHORIZATION_PROVIDER" type="java.lang.String"
  18521. transient="false" volatile="false"
  18522. static="true" final="true" visibility="public"
  18523. deprecated="not deprecated">
  18524. </field>
  18525. <field name="AUTO_FAILOVER_PREFIX" type="java.lang.String"
  18526. transient="false" volatile="false"
  18527. static="true" final="true" visibility="public"
  18528. deprecated="not deprecated">
  18529. </field>
  18530. <field name="AUTO_FAILOVER_ENABLED" type="java.lang.String"
  18531. transient="false" volatile="false"
  18532. static="true" final="true" visibility="public"
  18533. deprecated="not deprecated">
  18534. </field>
  18535. <field name="DEFAULT_AUTO_FAILOVER_ENABLED" type="boolean"
  18536. transient="false" volatile="false"
  18537. static="true" final="true" visibility="public"
  18538. deprecated="not deprecated">
  18539. </field>
  18540. <field name="AUTO_FAILOVER_EMBEDDED" type="java.lang.String"
  18541. transient="false" volatile="false"
  18542. static="true" final="true" visibility="public"
  18543. deprecated="This property should never be set to {@code false}.">
  18544. <doc>
  18545. <![CDATA[This property controls whether {@link ActiveStandbyElector} leader
  18546. election should be used when {@link #CURATOR_LEADER_ELECTOR} is
  18547. {@code false}.
  18548. @deprecated This property should never be set to {@code false}.]]>
  18549. </doc>
  18550. </field>
  18551. <field name="DEFAULT_AUTO_FAILOVER_EMBEDDED" type="boolean"
  18552. transient="false" volatile="false"
  18553. static="true" final="true" visibility="public"
  18554. deprecated="The {@link #AUTO_FAILOVER_EMBEDDED} property is deprecated.">
  18555. <doc>
  18556. <![CDATA[The default value for {@link #AUTO_FAILOVER_EMBEDDED}.
  18557. @deprecated The {@link #AUTO_FAILOVER_EMBEDDED} property is deprecated.]]>
  18558. </doc>
  18559. </field>
  18560. <field name="AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
  18561. transient="false" volatile="false"
  18562. static="true" final="true" visibility="public"
  18563. deprecated="not deprecated">
  18564. </field>
  18565. <field name="DEFAULT_AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
  18566. transient="false" volatile="false"
  18567. static="true" final="true" visibility="public"
  18568. deprecated="not deprecated">
  18569. </field>
  18570. <field name="CLIENT_FAILOVER_PREFIX" type="java.lang.String"
  18571. transient="false" volatile="false"
  18572. static="true" final="true" visibility="public"
  18573. deprecated="not deprecated">
  18574. </field>
  18575. <field name="CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
  18576. transient="false" volatile="false"
  18577. static="true" final="true" visibility="public"
  18578. deprecated="not deprecated">
  18579. </field>
  18580. <field name="DEFAULT_CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
  18581. transient="false" volatile="false"
  18582. static="true" final="true" visibility="public"
  18583. deprecated="not deprecated">
  18584. </field>
  18585. <field name="CLIENT_FAILOVER_MAX_ATTEMPTS" type="java.lang.String"
  18586. transient="false" volatile="false"
  18587. static="true" final="true" visibility="public"
  18588. deprecated="not deprecated">
  18589. </field>
  18590. <field name="CLIENT_FAILOVER_SLEEPTIME_BASE_MS" type="java.lang.String"
  18591. transient="false" volatile="false"
  18592. static="true" final="true" visibility="public"
  18593. deprecated="not deprecated">
  18594. </field>
  18595. <field name="CLIENT_FAILOVER_SLEEPTIME_MAX_MS" type="java.lang.String"
  18596. transient="false" volatile="false"
  18597. static="true" final="true" visibility="public"
  18598. deprecated="not deprecated">
  18599. </field>
  18600. <field name="CLIENT_FAILOVER_RETRIES" type="java.lang.String"
  18601. transient="false" volatile="false"
  18602. static="true" final="true" visibility="public"
  18603. deprecated="not deprecated">
  18604. </field>
  18605. <field name="DEFAULT_CLIENT_FAILOVER_RETRIES" type="int"
  18606. transient="false" volatile="false"
  18607. static="true" final="true" visibility="public"
  18608. deprecated="not deprecated">
  18609. </field>
  18610. <field name="CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="java.lang.String"
  18611. transient="false" volatile="false"
  18612. static="true" final="true" visibility="public"
  18613. deprecated="not deprecated">
  18614. </field>
  18615. <field name="DEFAULT_CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="int"
  18616. transient="false" volatile="false"
  18617. static="true" final="true" visibility="public"
  18618. deprecated="not deprecated">
  18619. </field>
  18620. <field name="RM_HA_FC_ELECTOR_ZK_RETRIES_KEY" type="java.lang.String"
  18621. transient="false" volatile="false"
  18622. static="true" final="true" visibility="public"
  18623. deprecated="not deprecated">
  18624. <doc>
  18625. <![CDATA[number of zookeeper operation retry times in ActiveStandbyElector]]>
  18626. </doc>
  18627. </field>
  18628. <field name="CURATOR_LEADER_ELECTOR" type="java.lang.String"
  18629. transient="false" volatile="false"
  18630. static="true" final="true" visibility="public"
  18631. deprecated="Eventually, we want to default to the curator-based
  18632. implementation and remove the {@link ActiveStandbyElector} based
  18633. implementation. We should remove this config then.">
  18634. <doc>
  18635. <![CDATA[Whether to use the Curator-based elector for leader election.
  18636. @deprecated Eventually, we want to default to the curator-based
  18637. implementation and remove the {@link ActiveStandbyElector} based
  18638. implementation. We should remove this config then.]]>
  18639. </doc>
  18640. </field>
  18641. <field name="DEFAULT_CURATOR_LEADER_ELECTOR_ENABLED" type="boolean"
  18642. transient="false" volatile="false"
  18643. static="true" final="true" visibility="public"
  18644. deprecated="not deprecated">
  18645. </field>
  18646. <field name="RM_STORE" type="java.lang.String"
  18647. transient="false" volatile="false"
  18648. static="true" final="true" visibility="public"
  18649. deprecated="not deprecated">
  18650. <doc>
  18651. <![CDATA[The class to use as the persistent store.]]>
  18652. </doc>
  18653. </field>
  18654. <field name="FS_RM_STATE_STORE_URI" type="java.lang.String"
  18655. transient="false" volatile="false"
  18656. static="true" final="true" visibility="public"
  18657. deprecated="not deprecated">
  18658. <doc>
  18659. <![CDATA[URI for FileSystemRMStateStore]]>
  18660. </doc>
  18661. </field>
  18662. <field name="FS_RM_STATE_STORE_NUM_RETRIES" type="java.lang.String"
  18663. transient="false" volatile="false"
  18664. static="true" final="true" visibility="public"
  18665. deprecated="not deprecated">
  18666. </field>
  18667. <field name="DEFAULT_FS_RM_STATE_STORE_NUM_RETRIES" type="int"
  18668. transient="false" volatile="false"
  18669. static="true" final="true" visibility="public"
  18670. deprecated="not deprecated">
  18671. </field>
  18672. <field name="FS_RM_STATE_STORE_RETRY_INTERVAL_MS" type="java.lang.String"
  18673. transient="false" volatile="false"
  18674. static="true" final="true" visibility="public"
  18675. deprecated="not deprecated">
  18676. </field>
  18677. <field name="DEFAULT_FS_RM_STATE_STORE_RETRY_INTERVAL_MS" type="long"
  18678. transient="false" volatile="false"
  18679. static="true" final="true" visibility="public"
  18680. deprecated="not deprecated">
  18681. </field>
  18682. <field name="RM_LEVELDB_STORE_PATH" type="java.lang.String"
  18683. transient="false" volatile="false"
  18684. static="true" final="true" visibility="public"
  18685. deprecated="not deprecated">
  18686. </field>
  18687. <field name="RM_LEVELDB_COMPACTION_INTERVAL_SECS" type="java.lang.String"
  18688. transient="false" volatile="false"
  18689. static="true" final="true" visibility="public"
  18690. deprecated="not deprecated">
  18691. <doc>
  18692. <![CDATA[The time in seconds between full compactions of the leveldb database.
  18693. Setting the interval to zero disables the full compaction cycles.]]>
  18694. </doc>
  18695. </field>
  18696. <field name="DEFAULT_RM_LEVELDB_COMPACTION_INTERVAL_SECS" type="long"
  18697. transient="false" volatile="false"
  18698. static="true" final="true" visibility="public"
  18699. deprecated="not deprecated">
  18700. </field>
  18701. <field name="RM_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
  18702. transient="false" volatile="false"
  18703. static="true" final="true" visibility="public"
  18704. deprecated="not deprecated">
  18705. <doc>
  18706. <![CDATA[The maximum number of completed applications RM keeps. By default equals
  18707. to {@link #DEFAULT_RM_MAX_COMPLETED_APPLICATIONS}.]]>
  18708. </doc>
  18709. </field>
  18710. <field name="DEFAULT_RM_MAX_COMPLETED_APPLICATIONS" type="int"
  18711. transient="false" volatile="false"
  18712. static="true" final="true" visibility="public"
  18713. deprecated="not deprecated">
  18714. </field>
  18715. <field name="RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
  18716. transient="false" volatile="false"
  18717. static="true" final="true" visibility="public"
  18718. deprecated="not deprecated">
  18719. <doc>
  18720. <![CDATA[The maximum number of completed applications RM state store keeps. By
  18721. default equals to value of {@link #RM_MAX_COMPLETED_APPLICATIONS}.]]>
  18722. </doc>
  18723. </field>
  18724. <field name="DEFAULT_RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="int"
  18725. transient="false" volatile="false"
  18726. static="true" final="true" visibility="public"
  18727. deprecated="This default value is ignored and will be removed in a future
  18728. release. The default value of
  18729. {@code yarn.resourcemanager.state-store.max-completed-applications} is the
  18730. value of {@link #RM_MAX_COMPLETED_APPLICATIONS}.">
  18731. <doc>
  18732. <![CDATA[The default value for
  18733. {@code yarn.resourcemanager.state-store.max-completed-applications}.
  18734. @deprecated This default value is ignored and will be removed in a future
  18735. release. The default value of
  18736. {@code yarn.resourcemanager.state-store.max-completed-applications} is the
  18737. value of {@link #RM_MAX_COMPLETED_APPLICATIONS}.]]>
  18738. </doc>
  18739. </field>
  18740. <field name="DEFAULT_APPLICATION_NAME" type="java.lang.String"
  18741. transient="false" volatile="false"
  18742. static="true" final="true" visibility="public"
  18743. deprecated="not deprecated">
  18744. <doc>
  18745. <![CDATA[Default application name]]>
  18746. </doc>
  18747. </field>
  18748. <field name="DEFAULT_APPLICATION_TYPE" type="java.lang.String"
  18749. transient="false" volatile="false"
  18750. static="true" final="true" visibility="public"
  18751. deprecated="not deprecated">
  18752. <doc>
  18753. <![CDATA[Default application type]]>
  18754. </doc>
  18755. </field>
  18756. <field name="APPLICATION_TYPE_LENGTH" type="int"
  18757. transient="false" volatile="false"
  18758. static="true" final="true" visibility="public"
  18759. deprecated="not deprecated">
  18760. <doc>
  18761. <![CDATA[Default application type length]]>
  18762. </doc>
  18763. </field>
  18764. <field name="DEFAULT_QUEUE_NAME" type="java.lang.String"
  18765. transient="false" volatile="false"
  18766. static="true" final="true" visibility="public"
  18767. deprecated="not deprecated">
  18768. <doc>
  18769. <![CDATA[Default queue name]]>
  18770. </doc>
  18771. </field>
  18772. <field name="RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
  18773. transient="false" volatile="false"
  18774. static="true" final="true" visibility="public"
  18775. deprecated="not deprecated">
  18776. <doc>
  18777. <![CDATA[Buckets (in minutes) for the number of apps running in each queue.]]>
  18778. </doc>
  18779. </field>
  18780. <field name="DEFAULT_RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
  18781. transient="false" volatile="false"
  18782. static="true" final="true" visibility="public"
  18783. deprecated="not deprecated">
  18784. <doc>
  18785. <![CDATA[Default sizes of the runtime metric buckets in minutes.]]>
  18786. </doc>
  18787. </field>
  18788. <field name="RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  18789. transient="false" volatile="false"
  18790. static="true" final="true" visibility="public"
  18791. deprecated="not deprecated">
  18792. </field>
  18793. <field name="DEFAULT_RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  18794. transient="false" volatile="false"
  18795. static="true" final="true" visibility="public"
  18796. deprecated="not deprecated">
  18797. </field>
  18798. <field name="RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  18799. transient="false" volatile="false"
  18800. static="true" final="true" visibility="public"
  18801. deprecated="not deprecated">
  18802. </field>
  18803. <field name="DEFAULT_RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  18804. transient="false" volatile="false"
  18805. static="true" final="true" visibility="public"
  18806. deprecated="not deprecated">
  18807. </field>
  18808. <field name="RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  18809. transient="false" volatile="false"
  18810. static="true" final="true" visibility="public"
  18811. deprecated="not deprecated">
  18812. </field>
  18813. <field name="DEFAULT_RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  18814. transient="false" volatile="false"
  18815. static="true" final="true" visibility="public"
  18816. deprecated="not deprecated">
  18817. </field>
  18818. <field name="RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  18819. transient="false" volatile="false"
  18820. static="true" final="true" visibility="public"
  18821. deprecated="not deprecated">
  18822. </field>
  18823. <field name="DEFAULT_RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  18824. transient="false" volatile="false"
  18825. static="true" final="true" visibility="public"
  18826. deprecated="not deprecated">
  18827. </field>
  18828. <field name="RM_NODEMANAGER_UNTRACKED_REMOVAL_TIMEOUT_MSEC" type="java.lang.String"
  18829. transient="false" volatile="false"
  18830. static="true" final="true" visibility="public"
  18831. deprecated="not deprecated">
  18832. <doc>
  18833. <![CDATA[Timeout(msec) for an untracked node to remain in shutdown or decommissioned
  18834. state.]]>
  18835. </doc>
  18836. </field>
  18837. <field name="DEFAULT_RM_NODEMANAGER_UNTRACKED_REMOVAL_TIMEOUT_MSEC" type="int"
  18838. transient="false" volatile="false"
  18839. static="true" final="true" visibility="public"
  18840. deprecated="not deprecated">
  18841. </field>
  18842. <field name="RM_PROXY_USER_PREFIX" type="java.lang.String"
  18843. transient="false" volatile="false"
  18844. static="true" final="true" visibility="public"
  18845. deprecated="not deprecated">
  18846. <doc>
  18847. <![CDATA[RM proxy users' prefix]]>
  18848. </doc>
  18849. </field>
  18850. <field name="RM_RESOURCE_PROFILES_ENABLED" type="java.lang.String"
  18851. transient="false" volatile="false"
  18852. static="true" final="true" visibility="public"
  18853. deprecated="not deprecated">
  18854. <doc>
  18855. <![CDATA[Enable/disable resource profiles.]]>
  18856. </doc>
  18857. </field>
  18858. <field name="DEFAULT_RM_RESOURCE_PROFILES_ENABLED" type="boolean"
  18859. transient="false" volatile="false"
  18860. static="true" final="true" visibility="public"
  18861. deprecated="not deprecated">
  18862. </field>
  18863. <field name="RM_RESOURCE_PROFILES_SOURCE_FILE" type="java.lang.String"
  18864. transient="false" volatile="false"
  18865. static="true" final="true" visibility="public"
  18866. deprecated="not deprecated">
  18867. <doc>
  18868. <![CDATA[File containing resource profiles.]]>
  18869. </doc>
  18870. </field>
  18871. <field name="DEFAULT_RM_RESOURCE_PROFILES_SOURCE_FILE" type="java.lang.String"
  18872. transient="false" volatile="false"
  18873. static="true" final="true" visibility="public"
  18874. deprecated="not deprecated">
  18875. </field>
  18876. <field name="YARN_CLIENT_LOAD_RESOURCETYPES_FROM_SERVER" type="java.lang.String"
  18877. transient="false" volatile="false"
  18878. static="true" final="true" visibility="public"
  18879. deprecated="not deprecated">
  18880. <doc>
  18881. <![CDATA[Enable/disable loading resource-types.xml at client side.]]>
  18882. </doc>
  18883. </field>
  18884. <field name="DEFAULT_YARN_CLIENT_LOAD_RESOURCETYPES_FROM_SERVER" type="boolean"
  18885. transient="false" volatile="false"
  18886. static="true" final="true" visibility="public"
  18887. deprecated="not deprecated">
  18888. </field>
  18889. <field name="RM_NODE_GRACEFUL_DECOMMISSION_TIMEOUT" type="java.lang.String"
  18890. transient="false" volatile="false"
  18891. static="true" final="true" visibility="public"
  18892. deprecated="not deprecated">
  18893. <doc>
  18894. <![CDATA[Timeout in seconds for YARN node graceful decommission.
  18895. This is the maximal time to wait for running containers and applications
  18896. to complete before transition a DECOMMISSIONING node into DECOMMISSIONED.]]>
  18897. </doc>
  18898. </field>
  18899. <field name="DEFAULT_RM_NODE_GRACEFUL_DECOMMISSION_TIMEOUT" type="int"
  18900. transient="false" volatile="false"
  18901. static="true" final="true" visibility="public"
  18902. deprecated="not deprecated">
  18903. </field>
  18904. <field name="RM_DECOMMISSIONING_NODES_WATCHER_POLL_INTERVAL" type="java.lang.String"
  18905. transient="false" volatile="false"
  18906. static="true" final="true" visibility="public"
  18907. deprecated="not deprecated">
  18908. <doc>
  18909. <![CDATA[Period in seconds of the poll timer task inside DecommissioningNodesWatcher
  18910. to identify and take care of DECOMMISSIONING nodes missing regular heart beat.]]>
  18911. </doc>
  18912. </field>
  18913. <field name="DEFAULT_RM_DECOMMISSIONING_NODES_WATCHER_POLL_INTERVAL" type="int"
  18914. transient="false" volatile="false"
  18915. static="true" final="true" visibility="public"
  18916. deprecated="not deprecated">
  18917. </field>
  18918. <field name="NM_PREFIX" type="java.lang.String"
  18919. transient="false" volatile="false"
  18920. static="true" final="true" visibility="public"
  18921. deprecated="not deprecated">
  18922. <doc>
  18923. <![CDATA[Prefix for all node manager configs.]]>
  18924. </doc>
  18925. </field>
  18926. <field name="NM_OPPORTUNISTIC_CONTAINERS_MAX_QUEUE_LENGTH" type="java.lang.String"
  18927. transient="false" volatile="false"
  18928. static="true" final="true" visibility="public"
  18929. deprecated="not deprecated">
  18930. <doc>
  18931. <![CDATA[Max Queue length of <code>OPPORTUNISTIC</code> containers on the NM.]]>
  18932. </doc>
  18933. </field>
  18934. <field name="DEFAULT_NM_OPPORTUNISTIC_CONTAINERS_MAX_QUEUE_LENGTH" type="int"
  18935. transient="false" volatile="false"
  18936. static="true" final="true" visibility="public"
  18937. deprecated="not deprecated">
  18938. </field>
  18939. <field name="DIST_SCHEDULING_ENABLED" type="java.lang.String"
  18940. transient="false" volatile="false"
  18941. static="true" final="true" visibility="public"
  18942. deprecated="not deprecated">
  18943. <doc>
  18944. <![CDATA[Setting that controls whether distributed scheduling is enabled or not.]]>
  18945. </doc>
  18946. </field>
  18947. <field name="DEFAULT_DIST_SCHEDULING_ENABLED" type="boolean"
  18948. transient="false" volatile="false"
  18949. static="true" final="true" visibility="public"
  18950. deprecated="not deprecated">
  18951. </field>
  18952. <field name="NM_ADMIN_USER_ENV" type="java.lang.String"
  18953. transient="false" volatile="false"
  18954. static="true" final="true" visibility="public"
  18955. deprecated="not deprecated">
  18956. <doc>
  18957. <![CDATA[Environment variables that will be sent to containers.]]>
  18958. </doc>
  18959. </field>
  18960. <field name="DEFAULT_NM_ADMIN_USER_ENV" type="java.lang.String"
  18961. transient="false" volatile="false"
  18962. static="true" final="true" visibility="public"
  18963. deprecated="not deprecated">
  18964. </field>
  18965. <field name="NM_ADMIN_FORCE_PATH" type="java.lang.String"
  18966. transient="false" volatile="false"
  18967. static="true" final="true" visibility="public"
  18968. deprecated="not deprecated">
  18969. <doc>
  18970. <![CDATA[PATH components that will be prepended to the user's path.
  18971. If this is defined and the user does not define PATH, NM will also
  18972. append ":$PATH" to prevent this from eclipsing the PATH defined in
  18973. the container. This feature is only available for Linux.]]>
  18974. </doc>
  18975. </field>
  18976. <field name="DEFAULT_NM_ADMIN_FORCE_PATH" type="java.lang.String"
  18977. transient="false" volatile="false"
  18978. static="true" final="true" visibility="public"
  18979. deprecated="not deprecated">
  18980. </field>
  18981. <field name="NM_ENV_WHITELIST" type="java.lang.String"
  18982. transient="false" volatile="false"
  18983. static="true" final="true" visibility="public"
  18984. deprecated="not deprecated">
  18985. <doc>
  18986. <![CDATA[Environment variables that containers may override rather than use NodeManager's default.]]>
  18987. </doc>
  18988. </field>
  18989. <field name="DEFAULT_NM_ENV_WHITELIST" type="java.lang.String"
  18990. transient="false" volatile="false"
  18991. static="true" final="true" visibility="public"
  18992. deprecated="not deprecated">
  18993. </field>
  18994. <field name="NM_ADDRESS" type="java.lang.String"
  18995. transient="false" volatile="false"
  18996. static="true" final="true" visibility="public"
  18997. deprecated="not deprecated">
  18998. <doc>
  18999. <![CDATA[address of node manager IPC.]]>
  19000. </doc>
  19001. </field>
  19002. <field name="DEFAULT_NM_PORT" type="int"
  19003. transient="false" volatile="false"
  19004. static="true" final="true" visibility="public"
  19005. deprecated="not deprecated">
  19006. </field>
  19007. <field name="DEFAULT_NM_ADDRESS" type="java.lang.String"
  19008. transient="false" volatile="false"
  19009. static="true" final="true" visibility="public"
  19010. deprecated="not deprecated">
  19011. </field>
  19012. <field name="NM_BIND_HOST" type="java.lang.String"
  19013. transient="false" volatile="false"
  19014. static="true" final="true" visibility="public"
  19015. deprecated="not deprecated">
  19016. <doc>
  19017. <![CDATA[The actual bind address for the NM.]]>
  19018. </doc>
  19019. </field>
  19020. <field name="NM_CONTAINER_EXECUTOR" type="java.lang.String"
  19021. transient="false" volatile="false"
  19022. static="true" final="true" visibility="public"
  19023. deprecated="not deprecated">
  19024. <doc>
  19025. <![CDATA[who will execute(launch) the containers.]]>
  19026. </doc>
  19027. </field>
  19028. <field name="NM_CONTAINER_STATE_TRANSITION_LISTENERS" type="java.lang.String"
  19029. transient="false" volatile="false"
  19030. static="true" final="true" visibility="public"
  19031. deprecated="not deprecated">
  19032. <doc>
  19033. <![CDATA[List of container state transition listeners.]]>
  19034. </doc>
  19035. </field>
  19036. <field name="NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="java.lang.String"
  19037. transient="false" volatile="false"
  19038. static="true" final="true" visibility="public"
  19039. deprecated="not deprecated">
  19040. <doc>
  19041. <![CDATA[Adjustment to make to the container os scheduling priority.
  19042. The valid values for this could vary depending on the platform.
  19043. On Linux, higher values mean run the containers at a less
  19044. favorable priority than the NM.
  19045. The value specified is an int.]]>
  19046. </doc>
  19047. </field>
  19048. <field name="DEFAULT_NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="int"
  19049. transient="false" volatile="false"
  19050. static="true" final="true" visibility="public"
  19051. deprecated="not deprecated">
  19052. </field>
  19053. <field name="NM_CONTAINER_MGR_THREAD_COUNT" type="java.lang.String"
  19054. transient="false" volatile="false"
  19055. static="true" final="true" visibility="public"
  19056. deprecated="not deprecated">
  19057. <doc>
  19058. <![CDATA[Number of threads container manager uses.]]>
  19059. </doc>
  19060. </field>
  19061. <field name="DEFAULT_NM_CONTAINER_MGR_THREAD_COUNT" type="int"
  19062. transient="false" volatile="false"
  19063. static="true" final="true" visibility="public"
  19064. deprecated="not deprecated">
  19065. </field>
  19066. <field name="NM_COLLECTOR_SERVICE_THREAD_COUNT" type="java.lang.String"
  19067. transient="false" volatile="false"
  19068. static="true" final="true" visibility="public"
  19069. deprecated="not deprecated">
  19070. <doc>
  19071. <![CDATA[Number of threads container manager uses.]]>
  19072. </doc>
  19073. </field>
  19074. <field name="DEFAULT_NM_COLLECTOR_SERVICE_THREAD_COUNT" type="int"
  19075. transient="false" volatile="false"
  19076. static="true" final="true" visibility="public"
  19077. deprecated="not deprecated">
  19078. </field>
  19079. <field name="NM_DELETE_THREAD_COUNT" type="java.lang.String"
  19080. transient="false" volatile="false"
  19081. static="true" final="true" visibility="public"
  19082. deprecated="not deprecated">
  19083. <doc>
  19084. <![CDATA[Number of threads used in cleanup.]]>
  19085. </doc>
  19086. </field>
  19087. <field name="DEFAULT_NM_DELETE_THREAD_COUNT" type="int"
  19088. transient="false" volatile="false"
  19089. static="true" final="true" visibility="public"
  19090. deprecated="not deprecated">
  19091. </field>
  19092. <field name="NM_KEYTAB" type="java.lang.String"
  19093. transient="false" volatile="false"
  19094. static="true" final="true" visibility="public"
  19095. deprecated="not deprecated">
  19096. <doc>
  19097. <![CDATA[Keytab for NM.]]>
  19098. </doc>
  19099. </field>
  19100. <field name="NM_LOCAL_DIRS" type="java.lang.String"
  19101. transient="false" volatile="false"
  19102. static="true" final="true" visibility="public"
  19103. deprecated="not deprecated">
  19104. <doc>
  19105. <![CDATA[List of directories to store localized files in.]]>
  19106. </doc>
  19107. </field>
  19108. <field name="DEFAULT_NM_LOCAL_DIRS" type="java.lang.String"
  19109. transient="false" volatile="false"
  19110. static="true" final="true" visibility="public"
  19111. deprecated="not deprecated">
  19112. </field>
  19113. <field name="NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="java.lang.String"
  19114. transient="false" volatile="false"
  19115. static="true" final="true" visibility="public"
  19116. deprecated="not deprecated">
  19117. <doc>
  19118. <![CDATA[Number of files in each localized directories
  19119. Avoid tuning this too low.]]>
  19120. </doc>
  19121. </field>
  19122. <field name="DEFAULT_NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="int"
  19123. transient="false" volatile="false"
  19124. static="true" final="true" visibility="public"
  19125. deprecated="not deprecated">
  19126. </field>
  19127. <field name="NM_LOCALIZER_ADDRESS" type="java.lang.String"
  19128. transient="false" volatile="false"
  19129. static="true" final="true" visibility="public"
  19130. deprecated="not deprecated">
  19131. <doc>
  19132. <![CDATA[Address where the localizer IPC is.]]>
  19133. </doc>
  19134. </field>
  19135. <field name="DEFAULT_NM_LOCALIZER_PORT" type="int"
  19136. transient="false" volatile="false"
  19137. static="true" final="true" visibility="public"
  19138. deprecated="not deprecated">
  19139. </field>
  19140. <field name="DEFAULT_NM_LOCALIZER_ADDRESS" type="java.lang.String"
  19141. transient="false" volatile="false"
  19142. static="true" final="true" visibility="public"
  19143. deprecated="not deprecated">
  19144. </field>
  19145. <field name="NM_COLLECTOR_SERVICE_ADDRESS" type="java.lang.String"
  19146. transient="false" volatile="false"
  19147. static="true" final="true" visibility="public"
  19148. deprecated="not deprecated">
  19149. <doc>
  19150. <![CDATA[Address where the collector service IPC is.]]>
  19151. </doc>
  19152. </field>
  19153. <field name="DEFAULT_NM_COLLECTOR_SERVICE_PORT" type="int"
  19154. transient="false" volatile="false"
  19155. static="true" final="true" visibility="public"
  19156. deprecated="not deprecated">
  19157. </field>
  19158. <field name="DEFAULT_NM_COLLECTOR_SERVICE_ADDRESS" type="java.lang.String"
  19159. transient="false" volatile="false"
  19160. static="true" final="true" visibility="public"
  19161. deprecated="not deprecated">
  19162. </field>
  19163. <field name="NM_PUBLISH_CONTAINER_EVENTS_ENABLED" type="java.lang.String"
  19164. transient="false" volatile="false"
  19165. static="true" final="true" visibility="public"
  19166. deprecated="not deprecated">
  19167. <doc>
  19168. <![CDATA[The setting that controls whether yarn container events are published to
  19169. the timeline service or not by NM. This configuration setting is for ATS
  19170. V2]]>
  19171. </doc>
  19172. </field>
  19173. <field name="DEFAULT_NM_PUBLISH_CONTAINER_EVENTS_ENABLED" type="boolean"
  19174. transient="false" volatile="false"
  19175. static="true" final="true" visibility="public"
  19176. deprecated="not deprecated">
  19177. </field>
  19178. <field name="NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="java.lang.String"
  19179. transient="false" volatile="false"
  19180. static="true" final="true" visibility="public"
  19181. deprecated="not deprecated">
  19182. <doc>
  19183. <![CDATA[Interval in between cache cleanups.]]>
  19184. </doc>
  19185. </field>
  19186. <field name="DEFAULT_NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="long"
  19187. transient="false" volatile="false"
  19188. static="true" final="true" visibility="public"
  19189. deprecated="not deprecated">
  19190. </field>
  19191. <field name="NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="java.lang.String"
  19192. transient="false" volatile="false"
  19193. static="true" final="true" visibility="public"
  19194. deprecated="not deprecated">
  19195. <doc>
  19196. <![CDATA[Target size of localizer cache in MB, per nodemanager. It is a target
  19197. retention size that only includes resources with PUBLIC and PRIVATE
  19198. visibility and excludes resources with APPLICATION visibility]]>
  19199. </doc>
  19200. </field>
  19201. <field name="DEFAULT_NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="long"
  19202. transient="false" volatile="false"
  19203. static="true" final="true" visibility="public"
  19204. deprecated="not deprecated">
  19205. </field>
  19206. <field name="NM_LOCALIZER_CLIENT_THREAD_COUNT" type="java.lang.String"
  19207. transient="false" volatile="false"
  19208. static="true" final="true" visibility="public"
  19209. deprecated="not deprecated">
  19210. <doc>
  19211. <![CDATA[Number of threads to handle localization requests.]]>
  19212. </doc>
  19213. </field>
  19214. <field name="DEFAULT_NM_LOCALIZER_CLIENT_THREAD_COUNT" type="int"
  19215. transient="false" volatile="false"
  19216. static="true" final="true" visibility="public"
  19217. deprecated="not deprecated">
  19218. </field>
  19219. <field name="NM_LOCALIZER_FETCH_THREAD_COUNT" type="java.lang.String"
  19220. transient="false" volatile="false"
  19221. static="true" final="true" visibility="public"
  19222. deprecated="not deprecated">
  19223. <doc>
  19224. <![CDATA[Number of threads to use for localization fetching.]]>
  19225. </doc>
  19226. </field>
  19227. <field name="DEFAULT_NM_LOCALIZER_FETCH_THREAD_COUNT" type="int"
  19228. transient="false" volatile="false"
  19229. static="true" final="true" visibility="public"
  19230. deprecated="not deprecated">
  19231. </field>
  19232. <field name="NM_LOG_DIRS" type="java.lang.String"
  19233. transient="false" volatile="false"
  19234. static="true" final="true" visibility="public"
  19235. deprecated="not deprecated">
  19236. <doc>
  19237. <![CDATA[Where to store container logs.]]>
  19238. </doc>
  19239. </field>
  19240. <field name="DEFAULT_NM_LOG_DIRS" type="java.lang.String"
  19241. transient="false" volatile="false"
  19242. static="true" final="true" visibility="public"
  19243. deprecated="not deprecated">
  19244. </field>
  19245. <field name="NM_LOG_AGGREGATION_THREAD_POOL_SIZE" type="java.lang.String"
  19246. transient="false" volatile="false"
  19247. static="true" final="true" visibility="public"
  19248. deprecated="not deprecated">
  19249. <doc>
  19250. <![CDATA[The number of threads to handle log aggregation in node manager.]]>
  19251. </doc>
  19252. </field>
  19253. <field name="DEFAULT_NM_LOG_AGGREGATION_THREAD_POOL_SIZE" type="int"
  19254. transient="false" volatile="false"
  19255. static="true" final="true" visibility="public"
  19256. deprecated="not deprecated">
  19257. </field>
  19258. <field name="NM_DEFAULT_CONTAINER_EXECUTOR_PREFIX" type="java.lang.String"
  19259. transient="false" volatile="false"
  19260. static="true" final="true" visibility="public"
  19261. deprecated="not deprecated">
  19262. <doc>
  19263. <![CDATA[Default permissions for container logs.]]>
  19264. </doc>
  19265. </field>
  19266. <field name="NM_DEFAULT_CONTAINER_EXECUTOR_LOG_DIRS_PERMISSIONS" type="java.lang.String"
  19267. transient="false" volatile="false"
  19268. static="true" final="true" visibility="public"
  19269. deprecated="not deprecated">
  19270. </field>
  19271. <field name="NM_DEFAULT_CONTAINER_EXECUTOR_LOG_DIRS_PERMISSIONS_DEFAULT" type="java.lang.String"
  19272. transient="false" volatile="false"
  19273. static="true" final="true" visibility="public"
  19274. deprecated="not deprecated">
  19275. </field>
  19276. <field name="NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  19277. transient="false" volatile="false"
  19278. static="true" final="true" visibility="public"
  19279. deprecated="not deprecated">
  19280. </field>
  19281. <field name="DEFAULT_NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  19282. transient="false" volatile="false"
  19283. static="true" final="true" visibility="public"
  19284. deprecated="not deprecated">
  19285. </field>
  19286. <field name="DISK_VALIDATOR" type="java.lang.String"
  19287. transient="false" volatile="false"
  19288. static="true" final="true" visibility="public"
  19289. deprecated="not deprecated">
  19290. <doc>
  19291. <![CDATA[Disk Validator.]]>
  19292. </doc>
  19293. </field>
  19294. <field name="DEFAULT_DISK_VALIDATOR" type="java.lang.String"
  19295. transient="false" volatile="false"
  19296. static="true" final="true" visibility="public"
  19297. deprecated="not deprecated">
  19298. </field>
  19299. <field name="NM_CONTAINER_DIAGNOSTICS_MAXIMUM_SIZE" type="java.lang.String"
  19300. transient="false" volatile="false"
  19301. static="true" final="true" visibility="public"
  19302. deprecated="not deprecated">
  19303. <doc>
  19304. <![CDATA[Maximum size of contain's diagnostics to keep for relaunching container
  19305. case.]]>
  19306. </doc>
  19307. </field>
  19308. <field name="DEFAULT_NM_CONTAINER_DIAGNOSTICS_MAXIMUM_SIZE" type="int"
  19309. transient="false" volatile="false"
  19310. static="true" final="true" visibility="public"
  19311. deprecated="not deprecated">
  19312. </field>
  19313. <field name="NM_CONTAINER_RETRY_MINIMUM_INTERVAL_MS" type="java.lang.String"
  19314. transient="false" volatile="false"
  19315. static="true" final="true" visibility="public"
  19316. deprecated="not deprecated">
  19317. <doc>
  19318. <![CDATA[Minimum container restart interval.]]>
  19319. </doc>
  19320. </field>
  19321. <field name="DEFAULT_NM_CONTAINER_RETRY_MINIMUM_INTERVAL_MS" type="int"
  19322. transient="false" volatile="false"
  19323. static="true" final="true" visibility="public"
  19324. deprecated="not deprecated">
  19325. </field>
  19326. <field name="NM_CONTAINER_QUEUING_USE_PAUSE_FOR_PREEMPTION" type="java.lang.String"
  19327. transient="false" volatile="false"
  19328. static="true" final="true" visibility="public"
  19329. deprecated="not deprecated">
  19330. <doc>
  19331. <![CDATA[Use container pause as the preemption policy over kill in the container
  19332. queue at a NodeManager.]]>
  19333. </doc>
  19334. </field>
  19335. <field name="DEFAULT_NM_CONTAINER_QUEUING_USE_PAUSE_FOR_PREEMPTION" type="boolean"
  19336. transient="false" volatile="false"
  19337. static="true" final="true" visibility="public"
  19338. deprecated="not deprecated">
  19339. </field>
  19340. <field name="RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="java.lang.String"
  19341. transient="false" volatile="false"
  19342. static="true" final="true" visibility="public"
  19343. deprecated="not deprecated">
  19344. <doc>
  19345. <![CDATA[Interval at which the delayed token removal thread runs]]>
  19346. </doc>
  19347. </field>
  19348. <field name="DEFAULT_RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="long"
  19349. transient="false" volatile="false"
  19350. static="true" final="true" visibility="public"
  19351. deprecated="not deprecated">
  19352. </field>
  19353. <field name="RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="java.lang.String"
  19354. transient="false" volatile="false"
  19355. static="true" final="true" visibility="public"
  19356. deprecated="not deprecated">
  19357. <doc>
  19358. <![CDATA[Delegation Token renewer thread count]]>
  19359. </doc>
  19360. </field>
  19361. <field name="DEFAULT_RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="int"
  19362. transient="false" volatile="false"
  19363. static="true" final="true" visibility="public"
  19364. deprecated="not deprecated">
  19365. </field>
  19366. <field name="RM_PROXY_USER_PRIVILEGES_ENABLED" type="java.lang.String"
  19367. transient="false" volatile="false"
  19368. static="true" final="true" visibility="public"
  19369. deprecated="not deprecated">
  19370. </field>
  19371. <field name="DEFAULT_RM_PROXY_USER_PRIVILEGES_ENABLED" type="boolean"
  19372. transient="false" volatile="false"
  19373. static="true" final="true" visibility="public"
  19374. deprecated="not deprecated">
  19375. </field>
  19376. <field name="RM_NODE_IP_CACHE_EXPIRY_INTERVAL_SECS" type="java.lang.String"
  19377. transient="false" volatile="false"
  19378. static="true" final="true" visibility="public"
  19379. deprecated="not deprecated">
  19380. <doc>
  19381. <![CDATA[The expiry interval for node IP caching. -1 disables the caching]]>
  19382. </doc>
  19383. </field>
  19384. <field name="DEFAULT_RM_NODE_IP_CACHE_EXPIRY_INTERVAL_SECS" type="int"
  19385. transient="false" volatile="false"
  19386. static="true" final="true" visibility="public"
  19387. deprecated="not deprecated">
  19388. </field>
  19389. <field name="RM_MAX_LOG_AGGREGATION_DIAGNOSTICS_IN_MEMORY" type="java.lang.String"
  19390. transient="false" volatile="false"
  19391. static="true" final="true" visibility="public"
  19392. deprecated="not deprecated">
  19393. <doc>
  19394. <![CDATA[How many diagnostics/failure messages can be saved in RM for
  19395. log aggregation. It also defines the number of diagnostics/failure
  19396. messages can be shown in log aggregation web ui.]]>
  19397. </doc>
  19398. </field>
  19399. <field name="DEFAULT_RM_MAX_LOG_AGGREGATION_DIAGNOSTICS_IN_MEMORY" type="int"
  19400. transient="false" volatile="false"
  19401. static="true" final="true" visibility="public"
  19402. deprecated="not deprecated">
  19403. </field>
  19404. <field name="LOG_AGGREGATION_ENABLED" type="java.lang.String"
  19405. transient="false" volatile="false"
  19406. static="true" final="true" visibility="public"
  19407. deprecated="not deprecated">
  19408. <doc>
  19409. <![CDATA[Whether to enable log aggregation]]>
  19410. </doc>
  19411. </field>
  19412. <field name="DEFAULT_LOG_AGGREGATION_ENABLED" type="boolean"
  19413. transient="false" volatile="false"
  19414. static="true" final="true" visibility="public"
  19415. deprecated="not deprecated">
  19416. </field>
  19417. <field name="LOG_AGGREGATION_FILE_FORMATS" type="java.lang.String"
  19418. transient="false" volatile="false"
  19419. static="true" final="true" visibility="public"
  19420. deprecated="not deprecated">
  19421. </field>
  19422. <field name="LOG_AGGREGATION_FILE_CONTROLLER_FMT" type="java.lang.String"
  19423. transient="false" volatile="false"
  19424. static="true" final="true" visibility="public"
  19425. deprecated="not deprecated">
  19426. </field>
  19427. <field name="LOG_AGGREGATION_REMOTE_APP_LOG_DIR_FMT" type="java.lang.String"
  19428. transient="false" volatile="false"
  19429. static="true" final="true" visibility="public"
  19430. deprecated="not deprecated">
  19431. </field>
  19432. <field name="LOG_AGGREGATION_REMOTE_APP_LOG_DIR_SUFFIX_FMT" type="java.lang.String"
  19433. transient="false" volatile="false"
  19434. static="true" final="true" visibility="public"
  19435. deprecated="not deprecated">
  19436. </field>
  19437. <field name="LOG_AGGREGATION_RETAIN_SECONDS" type="java.lang.String"
  19438. transient="false" volatile="false"
  19439. static="true" final="true" visibility="public"
  19440. deprecated="not deprecated">
  19441. <doc>
  19442. <![CDATA[How long to wait before deleting aggregated logs, -1 disables.
  19443. Be careful set this too small and you will spam the name node.]]>
  19444. </doc>
  19445. </field>
  19446. <field name="DEFAULT_LOG_AGGREGATION_RETAIN_SECONDS" type="long"
  19447. transient="false" volatile="false"
  19448. static="true" final="true" visibility="public"
  19449. deprecated="not deprecated">
  19450. </field>
  19451. <field name="LOG_AGGREGATION_DEBUG_FILESIZE" type="java.lang.String"
  19452. transient="false" volatile="false"
  19453. static="true" final="true" visibility="public"
  19454. deprecated="not deprecated">
  19455. </field>
  19456. <field name="DEFAULT_LOG_AGGREGATION_DEBUG_FILESIZE" type="long"
  19457. transient="false" volatile="false"
  19458. static="true" final="true" visibility="public"
  19459. deprecated="not deprecated">
  19460. </field>
  19461. <field name="LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="java.lang.String"
  19462. transient="false" volatile="false"
  19463. static="true" final="true" visibility="public"
  19464. deprecated="not deprecated">
  19465. <doc>
  19466. <![CDATA[How long to wait between aggregated log retention checks. If set to
  19467. a value {@literal <=} 0 then the value is computed as one-tenth of the
  19468. log retention setting. Be careful set this too small and you will spam
  19469. the name node.]]>
  19470. </doc>
  19471. </field>
  19472. <field name="DEFAULT_LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="long"
  19473. transient="false" volatile="false"
  19474. static="true" final="true" visibility="public"
  19475. deprecated="not deprecated">
  19476. </field>
  19477. <field name="LOG_AGGREGATION_STATUS_TIME_OUT_MS" type="java.lang.String"
  19478. transient="false" volatile="false"
  19479. static="true" final="true" visibility="public"
  19480. deprecated="not deprecated">
  19481. <doc>
  19482. <![CDATA[How long for ResourceManager to wait for NodeManager to report its
  19483. log aggregation status. If waiting time of which the log aggregation status
  19484. is reported from NodeManager exceeds the configured value, RM will report
  19485. log aggregation status for this NodeManager as TIME_OUT.
  19486. This configuration will be used in NodeManager as well to decide
  19487. whether and when to delete the cached log aggregation status.]]>
  19488. </doc>
  19489. </field>
  19490. <field name="DEFAULT_LOG_AGGREGATION_STATUS_TIME_OUT_MS" type="long"
  19491. transient="false" volatile="false"
  19492. static="true" final="true" visibility="public"
  19493. deprecated="not deprecated">
  19494. </field>
  19495. <field name="NM_LOG_RETAIN_SECONDS" type="java.lang.String"
  19496. transient="false" volatile="false"
  19497. static="true" final="true" visibility="public"
  19498. deprecated="not deprecated">
  19499. <doc>
  19500. <![CDATA[Number of seconds to retain logs on the NodeManager. Only applicable if Log
  19501. aggregation is disabled]]>
  19502. </doc>
  19503. </field>
  19504. <field name="DEFAULT_NM_LOG_RETAIN_SECONDS" type="long"
  19505. transient="false" volatile="false"
  19506. static="true" final="true" visibility="public"
  19507. deprecated="not deprecated">
  19508. </field>
  19509. <field name="NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="java.lang.String"
  19510. transient="false" volatile="false"
  19511. static="true" final="true" visibility="public"
  19512. deprecated="not deprecated">
  19513. <doc>
  19514. <![CDATA[Define how often NMs wake up and upload log files]]>
  19515. </doc>
  19516. </field>
  19517. <field name="DEFAULT_NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="long"
  19518. transient="false" volatile="false"
  19519. static="true" final="true" visibility="public"
  19520. deprecated="not deprecated">
  19521. </field>
  19522. <field name="MIN_LOG_ROLLING_INTERVAL_SECONDS" type="java.lang.String"
  19523. transient="false" volatile="false"
  19524. static="true" final="true" visibility="public"
  19525. deprecated="not deprecated">
  19526. <doc>
  19527. <![CDATA[The allowed hard minimum limit for {@link
  19528. YarnConfiguration#NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS}.]]>
  19529. </doc>
  19530. </field>
  19531. <field name="MIN_LOG_ROLLING_INTERVAL_SECONDS_DEFAULT" type="long"
  19532. transient="false" volatile="false"
  19533. static="true" final="true" visibility="public"
  19534. deprecated="not deprecated">
  19535. </field>
  19536. <field name="NM_LOG_AGGREGATION_NUM_LOG_FILES_SIZE_PER_APP" type="java.lang.String"
  19537. transient="false" volatile="false"
  19538. static="true" final="true" visibility="public"
  19539. deprecated="not deprecated">
  19540. <doc>
  19541. <![CDATA[Define how many aggregated log files per application per NM we can have
  19542. in remote file system.]]>
  19543. </doc>
  19544. </field>
  19545. <field name="DEFAULT_NM_LOG_AGGREGATION_NUM_LOG_FILES_SIZE_PER_APP" type="int"
  19546. transient="false" volatile="false"
  19547. static="true" final="true" visibility="public"
  19548. deprecated="not deprecated">
  19549. </field>
  19550. <field name="NM_LOG_DELETION_THREADS_COUNT" type="java.lang.String"
  19551. transient="false" volatile="false"
  19552. static="true" final="true" visibility="public"
  19553. deprecated="not deprecated">
  19554. <doc>
  19555. <![CDATA[Number of threads used in log cleanup. Only applicable if Log aggregation
  19556. is disabled]]>
  19557. </doc>
  19558. </field>
  19559. <field name="DEFAULT_NM_LOG_DELETE_THREAD_COUNT" type="int"
  19560. transient="false" volatile="false"
  19561. static="true" final="true" visibility="public"
  19562. deprecated="not deprecated">
  19563. </field>
  19564. <field name="NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
  19565. transient="false" volatile="false"
  19566. static="true" final="true" visibility="public"
  19567. deprecated="not deprecated">
  19568. <doc>
  19569. <![CDATA[Where to aggregate logs to.]]>
  19570. </doc>
  19571. </field>
  19572. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
  19573. transient="false" volatile="false"
  19574. static="true" final="true" visibility="public"
  19575. deprecated="not deprecated">
  19576. </field>
  19577. <field name="NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
  19578. transient="false" volatile="false"
  19579. static="true" final="true" visibility="public"
  19580. deprecated="not deprecated">
  19581. <doc>
  19582. <![CDATA[The remote log dir will be created at
  19583. NM_REMOTE_APP_LOG_DIR/${user}/NM_REMOTE_APP_LOG_DIR_SUFFIX/${appId}]]>
  19584. </doc>
  19585. </field>
  19586. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
  19587. transient="false" volatile="false"
  19588. static="true" final="true" visibility="public"
  19589. deprecated="not deprecated">
  19590. </field>
  19591. <field name="YARN_LOG_SERVER_URL" type="java.lang.String"
  19592. transient="false" volatile="false"
  19593. static="true" final="true" visibility="public"
  19594. deprecated="not deprecated">
  19595. </field>
  19596. <field name="YARN_LOG_SERVER_WEBSERVICE_URL" type="java.lang.String"
  19597. transient="false" volatile="false"
  19598. static="true" final="true" visibility="public"
  19599. deprecated="not deprecated">
  19600. </field>
  19601. <field name="YARN_TRACKING_URL_GENERATOR" type="java.lang.String"
  19602. transient="false" volatile="false"
  19603. static="true" final="true" visibility="public"
  19604. deprecated="not deprecated">
  19605. </field>
  19606. <field name="NM_PMEM_MB" type="java.lang.String"
  19607. transient="false" volatile="false"
  19608. static="true" final="true" visibility="public"
  19609. deprecated="not deprecated">
  19610. <doc>
  19611. <![CDATA[Amount of memory in MB that can be allocated for containers.]]>
  19612. </doc>
  19613. </field>
  19614. <field name="DEFAULT_NM_PMEM_MB" type="int"
  19615. transient="false" volatile="false"
  19616. static="true" final="true" visibility="public"
  19617. deprecated="not deprecated">
  19618. </field>
  19619. <field name="NM_SYSTEM_RESERVED_PMEM_MB" type="java.lang.String"
  19620. transient="false" volatile="false"
  19621. static="true" final="true" visibility="public"
  19622. deprecated="not deprecated">
  19623. <doc>
  19624. <![CDATA[Amount of memory in MB that has been reserved for non-yarn use.]]>
  19625. </doc>
  19626. </field>
  19627. <field name="NM_PMEM_CHECK_ENABLED" type="java.lang.String"
  19628. transient="false" volatile="false"
  19629. static="true" final="true" visibility="public"
  19630. deprecated="not deprecated">
  19631. <doc>
  19632. <![CDATA[Specifies whether physical memory check is enabled.]]>
  19633. </doc>
  19634. </field>
  19635. <field name="DEFAULT_NM_PMEM_CHECK_ENABLED" type="boolean"
  19636. transient="false" volatile="false"
  19637. static="true" final="true" visibility="public"
  19638. deprecated="not deprecated">
  19639. </field>
  19640. <field name="NM_VMEM_CHECK_ENABLED" type="java.lang.String"
  19641. transient="false" volatile="false"
  19642. static="true" final="true" visibility="public"
  19643. deprecated="not deprecated">
  19644. <doc>
  19645. <![CDATA[Specifies whether physical memory check is enabled.]]>
  19646. </doc>
  19647. </field>
  19648. <field name="DEFAULT_NM_VMEM_CHECK_ENABLED" type="boolean"
  19649. transient="false" volatile="false"
  19650. static="true" final="true" visibility="public"
  19651. deprecated="not deprecated">
  19652. </field>
  19653. <field name="NM_VMEM_PMEM_RATIO" type="java.lang.String"
  19654. transient="false" volatile="false"
  19655. static="true" final="true" visibility="public"
  19656. deprecated="not deprecated">
  19657. <doc>
  19658. <![CDATA[Conversion ratio for physical memory to virtual memory.]]>
  19659. </doc>
  19660. </field>
  19661. <field name="DEFAULT_NM_VMEM_PMEM_RATIO" type="float"
  19662. transient="false" volatile="false"
  19663. static="true" final="true" visibility="public"
  19664. deprecated="not deprecated">
  19665. </field>
  19666. <field name="NM_ELASTIC_MEMORY_CONTROL_ENABLED" type="java.lang.String"
  19667. transient="false" volatile="false"
  19668. static="true" final="true" visibility="public"
  19669. deprecated="not deprecated">
  19670. <doc>
  19671. <![CDATA[Specifies whether to do memory check on overall usage.]]>
  19672. </doc>
  19673. </field>
  19674. <field name="DEFAULT_NM_ELASTIC_MEMORY_CONTROL_ENABLED" type="boolean"
  19675. transient="false" volatile="false"
  19676. static="true" final="true" visibility="public"
  19677. deprecated="not deprecated">
  19678. </field>
  19679. <field name="NM_ELASTIC_MEMORY_CONTROL_OOM_HANDLER" type="java.lang.String"
  19680. transient="false" volatile="false"
  19681. static="true" final="true" visibility="public"
  19682. deprecated="not deprecated">
  19683. <doc>
  19684. <![CDATA[Specifies the OOM handler code.]]>
  19685. </doc>
  19686. </field>
  19687. <field name="NM_ELASTIC_MEMORY_CONTROL_OOM_LISTENER_PATH" type="java.lang.String"
  19688. transient="false" volatile="false"
  19689. static="true" final="true" visibility="public"
  19690. deprecated="not deprecated">
  19691. <doc>
  19692. <![CDATA[The path to the OOM listener.]]>
  19693. </doc>
  19694. </field>
  19695. <field name="NM_ELASTIC_MEMORY_CONTROL_OOM_TIMEOUT_SEC" type="java.lang.String"
  19696. transient="false" volatile="false"
  19697. static="true" final="true" visibility="public"
  19698. deprecated="not deprecated">
  19699. <doc>
  19700. <![CDATA[Maximum time in seconds to resolve an OOM situation.]]>
  19701. </doc>
  19702. </field>
  19703. <field name="DEFAULT_NM_ELASTIC_MEMORY_CONTROL_OOM_TIMEOUT_SEC" type="java.lang.Integer"
  19704. transient="false" volatile="false"
  19705. static="true" final="true" visibility="public"
  19706. deprecated="not deprecated">
  19707. </field>
  19708. <field name="NM_VCORES" type="java.lang.String"
  19709. transient="false" volatile="false"
  19710. static="true" final="true" visibility="public"
  19711. deprecated="not deprecated">
  19712. <doc>
  19713. <![CDATA[Number of Virtual CPU Cores which can be allocated for containers.]]>
  19714. </doc>
  19715. </field>
  19716. <field name="DEFAULT_NM_VCORES" type="int"
  19717. transient="false" volatile="false"
  19718. static="true" final="true" visibility="public"
  19719. deprecated="not deprecated">
  19720. </field>
  19721. <field name="NM_COUNT_LOGICAL_PROCESSORS_AS_CORES" type="java.lang.String"
  19722. transient="false" volatile="false"
  19723. static="true" final="true" visibility="public"
  19724. deprecated="not deprecated">
  19725. <doc>
  19726. <![CDATA[Count logical processors(like hyperthreads) as cores.]]>
  19727. </doc>
  19728. </field>
  19729. <field name="DEFAULT_NM_COUNT_LOGICAL_PROCESSORS_AS_CORES" type="boolean"
  19730. transient="false" volatile="false"
  19731. static="true" final="true" visibility="public"
  19732. deprecated="not deprecated">
  19733. </field>
  19734. <field name="NM_PCORES_VCORES_MULTIPLIER" type="java.lang.String"
  19735. transient="false" volatile="false"
  19736. static="true" final="true" visibility="public"
  19737. deprecated="not deprecated">
  19738. <doc>
  19739. <![CDATA[Multiplier to convert physical cores to vcores.]]>
  19740. </doc>
  19741. </field>
  19742. <field name="DEFAULT_NM_PCORES_VCORES_MULTIPLIER" type="float"
  19743. transient="false" volatile="false"
  19744. static="true" final="true" visibility="public"
  19745. deprecated="not deprecated">
  19746. </field>
  19747. <field name="NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="java.lang.String"
  19748. transient="false" volatile="false"
  19749. static="true" final="true" visibility="public"
  19750. deprecated="not deprecated">
  19751. <doc>
  19752. <![CDATA[Percentage of overall CPU which can be allocated for containers.]]>
  19753. </doc>
  19754. </field>
  19755. <field name="DEFAULT_NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="int"
  19756. transient="false" volatile="false"
  19757. static="true" final="true" visibility="public"
  19758. deprecated="not deprecated">
  19759. </field>
  19760. <field name="NM_ENABLE_HARDWARE_CAPABILITY_DETECTION" type="java.lang.String"
  19761. transient="false" volatile="false"
  19762. static="true" final="true" visibility="public"
  19763. deprecated="not deprecated">
  19764. <doc>
  19765. <![CDATA[Enable or disable node hardware capability detection.]]>
  19766. </doc>
  19767. </field>
  19768. <field name="DEFAULT_NM_ENABLE_HARDWARE_CAPABILITY_DETECTION" type="boolean"
  19769. transient="false" volatile="false"
  19770. static="true" final="true" visibility="public"
  19771. deprecated="not deprecated">
  19772. </field>
  19773. <field name="NM_MEMORY_RESOURCE_PREFIX" type="java.lang.String"
  19774. transient="false" volatile="false"
  19775. static="true" final="true" visibility="public"
  19776. deprecated="not deprecated">
  19777. </field>
  19778. <field name="NM_MEMORY_RESOURCE_ENABLED" type="java.lang.String"
  19779. transient="false" volatile="false"
  19780. static="true" final="true" visibility="public"
  19781. deprecated="not deprecated">
  19782. </field>
  19783. <field name="DEFAULT_NM_MEMORY_RESOURCE_ENABLED" type="boolean"
  19784. transient="false" volatile="false"
  19785. static="true" final="true" visibility="public"
  19786. deprecated="not deprecated">
  19787. </field>
  19788. <field name="NM_MEMORY_RESOURCE_ENFORCED" type="java.lang.String"
  19789. transient="false" volatile="false"
  19790. static="true" final="true" visibility="public"
  19791. deprecated="not deprecated">
  19792. </field>
  19793. <field name="DEFAULT_NM_MEMORY_RESOURCE_ENFORCED" type="boolean"
  19794. transient="false" volatile="false"
  19795. static="true" final="true" visibility="public"
  19796. deprecated="not deprecated">
  19797. </field>
  19798. <field name="NM_MEMORY_RESOURCE_CGROUPS_SWAPPINESS" type="java.lang.String"
  19799. transient="false" volatile="false"
  19800. static="true" final="true" visibility="public"
  19801. deprecated="not deprecated">
  19802. </field>
  19803. <field name="DEFAULT_NM_MEMORY_RESOURCE_CGROUPS_SWAPPINESS" type="int"
  19804. transient="false" volatile="false"
  19805. static="true" final="true" visibility="public"
  19806. deprecated="not deprecated">
  19807. </field>
  19808. <field name="NM_MEMORY_RESOURCE_CGROUPS_SOFT_LIMIT_PERCENTAGE" type="java.lang.String"
  19809. transient="false" volatile="false"
  19810. static="true" final="true" visibility="public"
  19811. deprecated="not deprecated">
  19812. </field>
  19813. <field name="DEFAULT_NM_MEMORY_RESOURCE_CGROUPS_SOFT_LIMIT_PERCENTAGE" type="float"
  19814. transient="false" volatile="false"
  19815. static="true" final="true" visibility="public"
  19816. deprecated="not deprecated">
  19817. </field>
  19818. <field name="NM_CPU_RESOURCE_PREFIX" type="java.lang.String"
  19819. transient="false" volatile="false"
  19820. static="true" final="true" visibility="public"
  19821. deprecated="not deprecated">
  19822. </field>
  19823. <field name="NM_CPU_RESOURCE_ENABLED" type="java.lang.String"
  19824. transient="false" volatile="false"
  19825. static="true" final="true" visibility="public"
  19826. deprecated="not deprecated">
  19827. <doc>
  19828. <![CDATA[Enable cpu isolation.]]>
  19829. </doc>
  19830. </field>
  19831. <field name="DEFAULT_NM_CPU_RESOURCE_ENABLED" type="boolean"
  19832. transient="false" volatile="false"
  19833. static="true" final="true" visibility="public"
  19834. deprecated="not deprecated">
  19835. </field>
  19836. <field name="NM_DISK_RESOURCE_PREFIX" type="java.lang.String"
  19837. transient="false" volatile="false"
  19838. static="true" final="true" visibility="public"
  19839. deprecated="not deprecated">
  19840. <doc>
  19841. <![CDATA[Prefix for disk configurations. Work in progress: This configuration
  19842. parameter may be changed/removed in the future.]]>
  19843. </doc>
  19844. </field>
  19845. <field name="NM_DISK_RESOURCE_ENABLED" type="java.lang.String"
  19846. transient="false" volatile="false"
  19847. static="true" final="true" visibility="public"
  19848. deprecated="not deprecated">
  19849. <doc>
  19850. <![CDATA[This setting controls if resource handling for disk operations is enabled.
  19851. Work in progress: This configuration parameter may be changed/removed in
  19852. the future]]>
  19853. </doc>
  19854. </field>
  19855. <field name="DEFAULT_NM_DISK_RESOURCE_ENABLED" type="boolean"
  19856. transient="false" volatile="false"
  19857. static="true" final="true" visibility="public"
  19858. deprecated="not deprecated">
  19859. <doc>
  19860. <![CDATA[Disk as a resource is disabled by default.]]>
  19861. </doc>
  19862. </field>
  19863. <field name="NM_NETWORK_RESOURCE_PREFIX" type="java.lang.String"
  19864. transient="false" volatile="false"
  19865. static="true" final="true" visibility="public"
  19866. deprecated="not deprecated">
  19867. </field>
  19868. <field name="NM_NETWORK_RESOURCE_ENABLED" type="java.lang.String"
  19869. transient="false" volatile="false"
  19870. static="true" final="true" visibility="public"
  19871. deprecated="not deprecated">
  19872. <doc>
  19873. <![CDATA[This setting controls if resource handling for network bandwidth is
  19874. enabled. Work in progress: This configuration parameter may be
  19875. changed/removed in the future]]>
  19876. </doc>
  19877. </field>
  19878. <field name="DEFAULT_NM_NETWORK_RESOURCE_ENABLED" type="boolean"
  19879. transient="false" volatile="false"
  19880. static="true" final="true" visibility="public"
  19881. deprecated="not deprecated">
  19882. <doc>
  19883. <![CDATA[Network as a resource is disabled by default.]]>
  19884. </doc>
  19885. </field>
  19886. <field name="NM_NETWORK_RESOURCE_INTERFACE" type="java.lang.String"
  19887. transient="false" volatile="false"
  19888. static="true" final="true" visibility="public"
  19889. deprecated="not deprecated">
  19890. <doc>
  19891. <![CDATA[Specifies the interface to be used for applying network throttling rules.
  19892. Work in progress: This configuration parameter may be changed/removed in
  19893. the future]]>
  19894. </doc>
  19895. </field>
  19896. <field name="DEFAULT_NM_NETWORK_RESOURCE_INTERFACE" type="java.lang.String"
  19897. transient="false" volatile="false"
  19898. static="true" final="true" visibility="public"
  19899. deprecated="not deprecated">
  19900. </field>
  19901. <field name="NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT" type="java.lang.String"
  19902. transient="false" volatile="false"
  19903. static="true" final="true" visibility="public"
  19904. deprecated="not deprecated">
  19905. <doc>
  19906. <![CDATA[Specifies the total available outbound bandwidth on the node. Work in
  19907. progress: This configuration parameter may be changed/removed in the future]]>
  19908. </doc>
  19909. </field>
  19910. <field name="DEFAULT_NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT" type="int"
  19911. transient="false" volatile="false"
  19912. static="true" final="true" visibility="public"
  19913. deprecated="not deprecated">
  19914. </field>
  19915. <field name="NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_YARN_MBIT" type="java.lang.String"
  19916. transient="false" volatile="false"
  19917. static="true" final="true" visibility="public"
  19918. deprecated="not deprecated">
  19919. <doc>
  19920. <![CDATA[Specifies the total outbound bandwidth available to YARN containers.
  19921. defaults to NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT if not specified.
  19922. Work in progress: This configuration parameter may be changed/removed in
  19923. the future]]>
  19924. </doc>
  19925. </field>
  19926. <field name="NM_RESOURCE_PLUGINS" type="java.lang.String"
  19927. transient="false" volatile="false"
  19928. static="true" final="true" visibility="public"
  19929. deprecated="not deprecated">
  19930. <doc>
  19931. <![CDATA[Prefix for computation resources, example of computation resources like
  19932. GPU / FPGA / TPU, etc.]]>
  19933. </doc>
  19934. </field>
  19935. <field name="NM_RESOURCE_PLUGINS_FAIL_FAST" type="java.lang.String"
  19936. transient="false" volatile="false"
  19937. static="true" final="true" visibility="public"
  19938. deprecated="not deprecated">
  19939. <doc>
  19940. <![CDATA[Specifies whether the initialization of the Node Manager should continue
  19941. if a certain device (GPU, FPGA, etc) was not found in the system. If set
  19942. to "true", then an exception will be thrown if a device is missing or
  19943. an error occurred during discovery.]]>
  19944. </doc>
  19945. </field>
  19946. <field name="DEFAULT_NM_RESOURCE_PLUGINS_FAIL_FAST" type="boolean"
  19947. transient="false" volatile="false"
  19948. static="true" final="true" visibility="public"
  19949. deprecated="not deprecated">
  19950. </field>
  19951. <field name="NM_GPU_RESOURCE_PREFIX" type="java.lang.String"
  19952. transient="false" volatile="false"
  19953. static="true" final="true" visibility="public"
  19954. deprecated="not deprecated">
  19955. <doc>
  19956. <![CDATA[Prefix for gpu configurations. Work in progress: This configuration
  19957. parameter may be changed/removed in the future.]]>
  19958. </doc>
  19959. </field>
  19960. <field name="NM_GPU_ALLOWED_DEVICES" type="java.lang.String"
  19961. transient="false" volatile="false"
  19962. static="true" final="true" visibility="public"
  19963. deprecated="not deprecated">
  19964. </field>
  19965. <field name="AUTOMATICALLY_DISCOVER_GPU_DEVICES" type="java.lang.String"
  19966. transient="false" volatile="false"
  19967. static="true" final="true" visibility="public"
  19968. deprecated="not deprecated">
  19969. </field>
  19970. <field name="NM_GPU_PATH_TO_EXEC" type="java.lang.String"
  19971. transient="false" volatile="false"
  19972. static="true" final="true" visibility="public"
  19973. deprecated="not deprecated">
  19974. <doc>
  19975. <![CDATA[This setting controls where to how to invoke GPU binaries]]>
  19976. </doc>
  19977. </field>
  19978. <field name="NM_GPU_DOCKER_PLUGIN_IMPL" type="java.lang.String"
  19979. transient="false" volatile="false"
  19980. static="true" final="true" visibility="public"
  19981. deprecated="not deprecated">
  19982. <doc>
  19983. <![CDATA[Settings to control which implementation of docker plugin for GPU will be
  19984. used.
  19985. By default uses NVIDIA docker v1.]]>
  19986. </doc>
  19987. </field>
  19988. <field name="NVIDIA_DOCKER_V1" type="java.lang.String"
  19989. transient="false" volatile="false"
  19990. static="true" final="true" visibility="public"
  19991. deprecated="not deprecated">
  19992. </field>
  19993. <field name="NVIDIA_DOCKER_V2" type="java.lang.String"
  19994. transient="false" volatile="false"
  19995. static="true" final="true" visibility="public"
  19996. deprecated="not deprecated">
  19997. </field>
  19998. <field name="DEFAULT_NM_GPU_DOCKER_PLUGIN_IMPL" type="java.lang.String"
  19999. transient="false" volatile="false"
  20000. static="true" final="true" visibility="public"
  20001. deprecated="not deprecated">
  20002. </field>
  20003. <field name="NVIDIA_DOCKER_PLUGIN_V1_ENDPOINT" type="java.lang.String"
  20004. transient="false" volatile="false"
  20005. static="true" final="true" visibility="public"
  20006. deprecated="not deprecated">
  20007. <doc>
  20008. <![CDATA[This setting controls end point of nvidia-docker-v1 plugin]]>
  20009. </doc>
  20010. </field>
  20011. <field name="DEFAULT_NVIDIA_DOCKER_PLUGIN_V1_ENDPOINT" type="java.lang.String"
  20012. transient="false" volatile="false"
  20013. static="true" final="true" visibility="public"
  20014. deprecated="not deprecated">
  20015. </field>
  20016. <field name="NM_FPGA_RESOURCE_PREFIX" type="java.lang.String"
  20017. transient="false" volatile="false"
  20018. static="true" final="true" visibility="public"
  20019. deprecated="not deprecated">
  20020. <doc>
  20021. <![CDATA[Prefix for FPGA configurations. Work in progress: This configuration
  20022. parameter may be changed/removed in the future.]]>
  20023. </doc>
  20024. </field>
  20025. <field name="NM_FPGA_ALLOWED_DEVICES" type="java.lang.String"
  20026. transient="false" volatile="false"
  20027. static="true" final="true" visibility="public"
  20028. deprecated="not deprecated">
  20029. </field>
  20030. <field name="NM_FPGA_PATH_TO_EXEC" type="java.lang.String"
  20031. transient="false" volatile="false"
  20032. static="true" final="true" visibility="public"
  20033. deprecated="not deprecated">
  20034. </field>
  20035. <field name="NM_FPGA_VENDOR_PLUGIN" type="java.lang.String"
  20036. transient="false" volatile="false"
  20037. static="true" final="true" visibility="public"
  20038. deprecated="not deprecated">
  20039. </field>
  20040. <field name="DEFAULT_NM_FPGA_VENDOR_PLUGIN" type="java.lang.String"
  20041. transient="false" volatile="false"
  20042. static="true" final="true" visibility="public"
  20043. deprecated="not deprecated">
  20044. </field>
  20045. <field name="NM_NETWORK_TAG_PREFIX" type="java.lang.String"
  20046. transient="false" volatile="false"
  20047. static="true" final="true" visibility="public"
  20048. deprecated="not deprecated">
  20049. </field>
  20050. <field name="NM_NETWORK_TAG_HANDLER_ENABLED" type="java.lang.String"
  20051. transient="false" volatile="false"
  20052. static="true" final="true" visibility="public"
  20053. deprecated="not deprecated">
  20054. </field>
  20055. <field name="DEFAULT_NM_NETWORK_TAG_HANDLER_ENABLED" type="boolean"
  20056. transient="false" volatile="false"
  20057. static="true" final="true" visibility="public"
  20058. deprecated="not deprecated">
  20059. </field>
  20060. <field name="NM_NETWORK_TAG_MAPPING_MANAGER" type="java.lang.String"
  20061. transient="false" volatile="false"
  20062. static="true" final="true" visibility="public"
  20063. deprecated="not deprecated">
  20064. </field>
  20065. <field name="NM_NETWORK_TAG_MAPPING_FILE_PATH" type="java.lang.String"
  20066. transient="false" volatile="false"
  20067. static="true" final="true" visibility="public"
  20068. deprecated="not deprecated">
  20069. </field>
  20070. <field name="DEFAULT_NM_NETWORK_RESOURCE_TAG_MAPPING_FILE_PATH" type="java.lang.String"
  20071. transient="false" volatile="false"
  20072. static="true" final="true" visibility="public"
  20073. deprecated="not deprecated">
  20074. </field>
  20075. <field name="NM_WEBAPP_ADDRESS" type="java.lang.String"
  20076. transient="false" volatile="false"
  20077. static="true" final="true" visibility="public"
  20078. deprecated="not deprecated">
  20079. <doc>
  20080. <![CDATA[NM Webapp address.]]>
  20081. </doc>
  20082. </field>
  20083. <field name="DEFAULT_NM_WEBAPP_PORT" type="int"
  20084. transient="false" volatile="false"
  20085. static="true" final="true" visibility="public"
  20086. deprecated="not deprecated">
  20087. </field>
  20088. <field name="DEFAULT_NM_WEBAPP_ADDRESS" type="java.lang.String"
  20089. transient="false" volatile="false"
  20090. static="true" final="true" visibility="public"
  20091. deprecated="not deprecated">
  20092. </field>
  20093. <field name="NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  20094. transient="false" volatile="false"
  20095. static="true" final="true" visibility="public"
  20096. deprecated="not deprecated">
  20097. <doc>
  20098. <![CDATA[NM Webapp https address.]]>
  20099. </doc>
  20100. </field>
  20101. <field name="DEFAULT_NM_WEBAPP_HTTPS_PORT" type="int"
  20102. transient="false" volatile="false"
  20103. static="true" final="true" visibility="public"
  20104. deprecated="not deprecated">
  20105. </field>
  20106. <field name="DEFAULT_NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  20107. transient="false" volatile="false"
  20108. static="true" final="true" visibility="public"
  20109. deprecated="not deprecated">
  20110. </field>
  20111. <field name="NM_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
  20112. transient="false" volatile="false"
  20113. static="true" final="true" visibility="public"
  20114. deprecated="not deprecated">
  20115. <doc>
  20116. <![CDATA[Enable/disable CORS filter.]]>
  20117. </doc>
  20118. </field>
  20119. <field name="DEFAULT_NM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
  20120. transient="false" volatile="false"
  20121. static="true" final="true" visibility="public"
  20122. deprecated="not deprecated">
  20123. </field>
  20124. <field name="NM_RESOURCE_MON_INTERVAL_MS" type="java.lang.String"
  20125. transient="false" volatile="false"
  20126. static="true" final="true" visibility="public"
  20127. deprecated="not deprecated">
  20128. <doc>
  20129. <![CDATA[How often to monitor resource in a node.]]>
  20130. </doc>
  20131. </field>
  20132. <field name="DEFAULT_NM_RESOURCE_MON_INTERVAL_MS" type="int"
  20133. transient="false" volatile="false"
  20134. static="true" final="true" visibility="public"
  20135. deprecated="not deprecated">
  20136. </field>
  20137. <field name="NM_CONTAINER_MONITOR_ENABLED" type="java.lang.String"
  20138. transient="false" volatile="false"
  20139. static="true" final="true" visibility="public"
  20140. deprecated="not deprecated">
  20141. </field>
  20142. <field name="DEFAULT_NM_CONTAINER_MONITOR_ENABLED" type="boolean"
  20143. transient="false" volatile="false"
  20144. static="true" final="true" visibility="public"
  20145. deprecated="not deprecated">
  20146. </field>
  20147. <field name="NM_CONTAINER_MON_INTERVAL_MS" type="java.lang.String"
  20148. transient="false" volatile="false"
  20149. static="true" final="true" visibility="public"
  20150. deprecated="not deprecated">
  20151. <doc>
  20152. <![CDATA[How often to monitor containers.]]>
  20153. </doc>
  20154. </field>
  20155. <field name="DEFAULT_NM_CONTAINER_MON_INTERVAL_MS" type="int"
  20156. transient="false" volatile="false"
  20157. static="true" final="true" visibility="public"
  20158. deprecated="not deprecated">
  20159. </field>
  20160. <field name="NM_MON_RESOURCE_CALCULATOR" type="java.lang.String"
  20161. transient="false" volatile="false"
  20162. static="true" final="true" visibility="public"
  20163. deprecated="not deprecated">
  20164. <doc>
  20165. <![CDATA[Class that calculates current resource utilization.]]>
  20166. </doc>
  20167. </field>
  20168. <field name="NM_CONTAINER_MON_RESOURCE_CALCULATOR" type="java.lang.String"
  20169. transient="false" volatile="false"
  20170. static="true" final="true" visibility="public"
  20171. deprecated="not deprecated">
  20172. <doc>
  20173. <![CDATA[Class that calculates containers current resource utilization.]]>
  20174. </doc>
  20175. </field>
  20176. <field name="NM_CONTAINER_MON_PROCESS_TREE" type="java.lang.String"
  20177. transient="false" volatile="false"
  20178. static="true" final="true" visibility="public"
  20179. deprecated="not deprecated">
  20180. <doc>
  20181. <![CDATA[Class that calculates process tree resource utilization.]]>
  20182. </doc>
  20183. </field>
  20184. <field name="PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="java.lang.String"
  20185. transient="false" volatile="false"
  20186. static="true" final="true" visibility="public"
  20187. deprecated="not deprecated">
  20188. </field>
  20189. <field name="DEFAULT_PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="boolean"
  20190. transient="false" volatile="false"
  20191. static="true" final="true" visibility="public"
  20192. deprecated="not deprecated">
  20193. </field>
  20194. <field name="NM_CONTAINER_LOG_MONITOR_ENABLED" type="java.lang.String"
  20195. transient="false" volatile="false"
  20196. static="true" final="true" visibility="public"
  20197. deprecated="not deprecated">
  20198. <doc>
  20199. <![CDATA[Enable switch for container log monitoring.]]>
  20200. </doc>
  20201. </field>
  20202. <field name="DEFAULT_NM_CONTAINER_LOG_MONITOR_ENABLED" type="boolean"
  20203. transient="false" volatile="false"
  20204. static="true" final="true" visibility="public"
  20205. deprecated="not deprecated">
  20206. </field>
  20207. <field name="NM_CONTAINER_LOG_MON_INTERVAL_MS" type="java.lang.String"
  20208. transient="false" volatile="false"
  20209. static="true" final="true" visibility="public"
  20210. deprecated="not deprecated">
  20211. <doc>
  20212. <![CDATA[How often to monitor logs generated by containers.]]>
  20213. </doc>
  20214. </field>
  20215. <field name="DEFAULT_NM_CONTAINER_LOG_MON_INTERVAL_MS" type="int"
  20216. transient="false" volatile="false"
  20217. static="true" final="true" visibility="public"
  20218. deprecated="not deprecated">
  20219. </field>
  20220. <field name="NM_CONTAINER_LOG_DIR_SIZE_LIMIT_BYTES" type="java.lang.String"
  20221. transient="false" volatile="false"
  20222. static="true" final="true" visibility="public"
  20223. deprecated="not deprecated">
  20224. <doc>
  20225. <![CDATA[The disk space limit for a single container log directory.]]>
  20226. </doc>
  20227. </field>
  20228. <field name="DEFAULT_NM_CONTAINER_LOG_DIR_SIZE_LIMIT_BYTES" type="long"
  20229. transient="false" volatile="false"
  20230. static="true" final="true" visibility="public"
  20231. deprecated="not deprecated">
  20232. </field>
  20233. <field name="NM_CONTAINER_LOG_TOTAL_SIZE_LIMIT_BYTES" type="java.lang.String"
  20234. transient="false" volatile="false"
  20235. static="true" final="true" visibility="public"
  20236. deprecated="not deprecated">
  20237. <doc>
  20238. <![CDATA[The disk space limit for all of a container's logs.]]>
  20239. </doc>
  20240. </field>
  20241. <field name="DEFAULT_NM_CONTAINER_LOG_TOTAL_SIZE_LIMIT_BYTES" type="long"
  20242. transient="false" volatile="false"
  20243. static="true" final="true" visibility="public"
  20244. deprecated="not deprecated">
  20245. </field>
  20246. <field name="NM_CONTAINER_METRICS_ENABLE" type="java.lang.String"
  20247. transient="false" volatile="false"
  20248. static="true" final="true" visibility="public"
  20249. deprecated="not deprecated">
  20250. <doc>
  20251. <![CDATA[Enable/disable container metrics.]]>
  20252. </doc>
  20253. </field>
  20254. <field name="DEFAULT_NM_CONTAINER_METRICS_ENABLE" type="boolean"
  20255. transient="false" volatile="false"
  20256. static="true" final="true" visibility="public"
  20257. deprecated="not deprecated">
  20258. </field>
  20259. <field name="NM_CONTAINER_METRICS_PERIOD_MS" type="java.lang.String"
  20260. transient="false" volatile="false"
  20261. static="true" final="true" visibility="public"
  20262. deprecated="not deprecated">
  20263. <doc>
  20264. <![CDATA[Container metrics flush period. -1 for flush on completion.]]>
  20265. </doc>
  20266. </field>
  20267. <field name="DEFAULT_NM_CONTAINER_METRICS_PERIOD_MS" type="int"
  20268. transient="false" volatile="false"
  20269. static="true" final="true" visibility="public"
  20270. deprecated="not deprecated">
  20271. </field>
  20272. <field name="NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="java.lang.String"
  20273. transient="false" volatile="false"
  20274. static="true" final="true" visibility="public"
  20275. deprecated="not deprecated">
  20276. <doc>
  20277. <![CDATA[The delay time ms to unregister container metrics after completion.]]>
  20278. </doc>
  20279. </field>
  20280. <field name="DEFAULT_NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="int"
  20281. transient="false" volatile="false"
  20282. static="true" final="true" visibility="public"
  20283. deprecated="not deprecated">
  20284. </field>
  20285. <field name="NM_DISK_HEALTH_CHECK_ENABLE" type="java.lang.String"
  20286. transient="false" volatile="false"
  20287. static="true" final="true" visibility="public"
  20288. deprecated="not deprecated">
  20289. <doc>
  20290. <![CDATA[Enable/Disable disks' health checker. Default is true. An expert level
  20291. configuration property.]]>
  20292. </doc>
  20293. </field>
  20294. <field name="NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
  20295. transient="false" volatile="false"
  20296. static="true" final="true" visibility="public"
  20297. deprecated="not deprecated">
  20298. <doc>
  20299. <![CDATA[Frequency of running disks' health checker.]]>
  20300. </doc>
  20301. </field>
  20302. <field name="DEFAULT_NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="long"
  20303. transient="false" volatile="false"
  20304. static="true" final="true" visibility="public"
  20305. deprecated="not deprecated">
  20306. <doc>
  20307. <![CDATA[By default, disks' health is checked every 2 minutes.]]>
  20308. </doc>
  20309. </field>
  20310. <field name="NM_MIN_HEALTHY_DISKS_FRACTION" type="java.lang.String"
  20311. transient="false" volatile="false"
  20312. static="true" final="true" visibility="public"
  20313. deprecated="not deprecated">
  20314. <doc>
  20315. <![CDATA[The minimum fraction of number of disks to be healthy for the nodemanager
  20316. to launch new containers. This applies to nm-local-dirs and nm-log-dirs.]]>
  20317. </doc>
  20318. </field>
  20319. <field name="DEFAULT_NM_MIN_HEALTHY_DISKS_FRACTION" type="float"
  20320. transient="false" volatile="false"
  20321. static="true" final="true" visibility="public"
  20322. deprecated="not deprecated">
  20323. <doc>
  20324. <![CDATA[By default, at least 25% of disks are to be healthy to say that the node is
  20325. healthy in terms of disks.]]>
  20326. </doc>
  20327. </field>
  20328. <field name="NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="java.lang.String"
  20329. transient="false" volatile="false"
  20330. static="true" final="true" visibility="public"
  20331. deprecated="not deprecated">
  20332. <doc>
  20333. <![CDATA[The maximum percentage of disk space that can be used after which a disk is
  20334. marked as offline. Values can range from 0.0 to 100.0. If the value is
  20335. greater than or equal to 100, NM will check for full disk. This applies to
  20336. nm-local-dirs and nm-log-dirs.
  20337. This applies when disk-utilization-threshold.enabled is true.]]>
  20338. </doc>
  20339. </field>
  20340. <field name="DEFAULT_NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="float"
  20341. transient="false" volatile="false"
  20342. static="true" final="true" visibility="public"
  20343. deprecated="not deprecated">
  20344. <doc>
  20345. <![CDATA[By default, 90% of the disk can be used before it is marked as offline.]]>
  20346. </doc>
  20347. </field>
  20348. <field name="NM_DISK_UTILIZATION_THRESHOLD_ENABLED" type="java.lang.String"
  20349. transient="false" volatile="false"
  20350. static="true" final="true" visibility="public"
  20351. deprecated="not deprecated">
  20352. <doc>
  20353. <![CDATA[Enable/Disable the disk utilisation percentage
  20354. threshold for disk health checker.]]>
  20355. </doc>
  20356. </field>
  20357. <field name="DEFAULT_NM_DISK_UTILIZATION_THRESHOLD_ENABLED" type="boolean"
  20358. transient="false" volatile="false"
  20359. static="true" final="true" visibility="public"
  20360. deprecated="not deprecated">
  20361. </field>
  20362. <field name="NM_WM_LOW_PER_DISK_UTILIZATION_PERCENTAGE" type="java.lang.String"
  20363. transient="false" volatile="false"
  20364. static="true" final="true" visibility="public"
  20365. deprecated="not deprecated">
  20366. <doc>
  20367. <![CDATA[The low threshold percentage of disk space used when an offline disk is
  20368. marked as online. Values can range from 0.0 to 100.0. The value shouldn't
  20369. be more than NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE. If its value is
  20370. more than NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE or not set, it will be
  20371. set to the same value as NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE.
  20372. This applies to nm-local-dirs and nm-log-dirs.]]>
  20373. </doc>
  20374. </field>
  20375. <field name="NM_MIN_PER_DISK_FREE_SPACE_MB" type="java.lang.String"
  20376. transient="false" volatile="false"
  20377. static="true" final="true" visibility="public"
  20378. deprecated="not deprecated">
  20379. <doc>
  20380. <![CDATA[The minimum space that must be available on a local dir for it to be used.
  20381. This applies to nm-local-dirs and nm-log-dirs.
  20382. This applies when disk-free-space-threshold.enabled is true.]]>
  20383. </doc>
  20384. </field>
  20385. <field name="NM_DISK_FREE_SPACE_THRESHOLD_ENABLED" type="java.lang.String"
  20386. transient="false" volatile="false"
  20387. static="true" final="true" visibility="public"
  20388. deprecated="not deprecated">
  20389. <doc>
  20390. <![CDATA[Enable/Disable the minimum disk free
  20391. space threshold for disk health checker.]]>
  20392. </doc>
  20393. </field>
  20394. <field name="DEFAULT_NM_DISK_FREE_SPACE_THRESHOLD_ENABLED" type="boolean"
  20395. transient="false" volatile="false"
  20396. static="true" final="true" visibility="public"
  20397. deprecated="not deprecated">
  20398. </field>
  20399. <field name="NM_WM_HIGH_PER_DISK_FREE_SPACE_MB" type="java.lang.String"
  20400. transient="false" volatile="false"
  20401. static="true" final="true" visibility="public"
  20402. deprecated="not deprecated">
  20403. <doc>
  20404. <![CDATA[The minimum space that must be available on an offline
  20405. disk for it to be marked as online. The value should not be less
  20406. than NM_MIN_PER_DISK_FREE_SPACE_MB. If its value is less than
  20407. NM_MIN_PER_DISK_FREE_SPACE_MB or is not set, it will be set to the
  20408. same value as NM_MIN_PER_DISK_FREE_SPACE_MB.
  20409. This applies to nm-local-dirs and nm-log-dirs.]]>
  20410. </doc>
  20411. </field>
  20412. <field name="DEFAULT_NM_MIN_PER_DISK_FREE_SPACE_MB" type="long"
  20413. transient="false" volatile="false"
  20414. static="true" final="true" visibility="public"
  20415. deprecated="not deprecated">
  20416. <doc>
  20417. <![CDATA[By default, all of the disk can be used before it is marked as offline.]]>
  20418. </doc>
  20419. </field>
  20420. <field name="NM_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
  20421. transient="false" volatile="false"
  20422. static="true" final="true" visibility="public"
  20423. deprecated="not deprecated">
  20424. <doc>
  20425. <![CDATA[Frequency of running node health script.]]>
  20426. </doc>
  20427. </field>
  20428. <field name="DEFAULT_NM_HEALTH_CHECK_INTERVAL_MS" type="long"
  20429. transient="false" volatile="false"
  20430. static="true" final="true" visibility="public"
  20431. deprecated="not deprecated">
  20432. </field>
  20433. <field name="NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="java.lang.String"
  20434. transient="false" volatile="false"
  20435. static="true" final="true" visibility="public"
  20436. deprecated="not deprecated">
  20437. <doc>
  20438. <![CDATA[Health check script time out period.]]>
  20439. </doc>
  20440. </field>
  20441. <field name="DEFAULT_NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="long"
  20442. transient="false" volatile="false"
  20443. static="true" final="true" visibility="public"
  20444. deprecated="not deprecated">
  20445. </field>
  20446. <field name="NM_HEALTH_CHECK_RUN_BEFORE_STARTUP" type="java.lang.String"
  20447. transient="false" volatile="false"
  20448. static="true" final="true" visibility="public"
  20449. deprecated="not deprecated">
  20450. <doc>
  20451. <![CDATA[Whether or not to run the node health script before the NM
  20452. starts up.]]>
  20453. </doc>
  20454. </field>
  20455. <field name="DEFAULT_NM_HEALTH_CHECK_RUN_BEFORE_STARTUP" type="boolean"
  20456. transient="false" volatile="false"
  20457. static="true" final="true" visibility="public"
  20458. deprecated="not deprecated">
  20459. </field>
  20460. <field name="NM_HEALTH_CHECK_SCRIPT_PATH" type="java.lang.String"
  20461. transient="false" volatile="false"
  20462. static="true" final="true" visibility="public"
  20463. deprecated="not deprecated">
  20464. <doc>
  20465. <![CDATA[The health check script to run.]]>
  20466. </doc>
  20467. </field>
  20468. <field name="NM_HEALTH_CHECK_SCRIPT_OPTS" type="java.lang.String"
  20469. transient="false" volatile="false"
  20470. static="true" final="true" visibility="public"
  20471. deprecated="not deprecated">
  20472. <doc>
  20473. <![CDATA[The arguments to pass to the health check script.]]>
  20474. </doc>
  20475. </field>
  20476. <field name="NM_CONTAINER_LOCALIZER_JAVA_OPTS_KEY" type="java.lang.String"
  20477. transient="false" volatile="false"
  20478. static="true" final="true" visibility="public"
  20479. deprecated="not deprecated">
  20480. <doc>
  20481. <![CDATA[The JVM options used on forking ContainerLocalizer process
  20482. by container executor.]]>
  20483. </doc>
  20484. </field>
  20485. <field name="NM_CONTAINER_LOCALIZER_JAVA_OPTS_DEFAULT" type="java.lang.String"
  20486. transient="false" volatile="false"
  20487. static="true" final="true" visibility="public"
  20488. deprecated="not deprecated">
  20489. </field>
  20490. <field name="NM_CONTAINER_LOCALIZER_LOG_LEVEL" type="java.lang.String"
  20491. transient="false" volatile="false"
  20492. static="true" final="true" visibility="public"
  20493. deprecated="not deprecated">
  20494. <doc>
  20495. <![CDATA[The log level of container localizer process.]]>
  20496. </doc>
  20497. </field>
  20498. <field name="NM_CONTAINER_LOCALIZER_LOG_LEVEL_DEFAULT" type="java.lang.String"
  20499. transient="false" volatile="false"
  20500. static="true" final="true" visibility="public"
  20501. deprecated="not deprecated">
  20502. </field>
  20503. <field name="LINUX_CONTAINER_RUNTIME_PREFIX" type="java.lang.String"
  20504. transient="false" volatile="false"
  20505. static="true" final="true" visibility="public"
  20506. deprecated="not deprecated">
  20507. <doc>
  20508. <![CDATA[Prefix for runtime configuration constants.]]>
  20509. </doc>
  20510. </field>
  20511. <field name="LINUX_CONTAINER_RUNTIME_ALLOWED_RUNTIMES" type="java.lang.String"
  20512. transient="false" volatile="false"
  20513. static="true" final="true" visibility="public"
  20514. deprecated="not deprecated">
  20515. <doc>
  20516. <![CDATA[Comma separated list of runtimes that are allowed when using
  20517. LinuxContainerExecutor. The standard values are:
  20518. <ul>
  20519. <li>default</li>
  20520. <li>docker</li>
  20521. <li>javasandbox</li>
  20522. </ul>]]>
  20523. </doc>
  20524. </field>
  20525. <field name="LINUX_CONTAINER_RUNTIME_CLASS_FMT" type="java.lang.String"
  20526. transient="false" volatile="false"
  20527. static="true" final="true" visibility="public"
  20528. deprecated="not deprecated">
  20529. </field>
  20530. <field name="DEFAULT_LINUX_CONTAINER_RUNTIME_ALLOWED_RUNTIMES" type="java.lang.String[]"
  20531. transient="false" volatile="false"
  20532. static="true" final="true" visibility="public"
  20533. deprecated="not deprecated">
  20534. <doc>
  20535. <![CDATA[The default list of allowed runtimes when using LinuxContainerExecutor.]]>
  20536. </doc>
  20537. </field>
  20538. <field name="LINUX_CONTAINER_RUNTIME_TYPE" type="java.lang.String"
  20539. transient="false" volatile="false"
  20540. static="true" final="true" visibility="public"
  20541. deprecated="not deprecated">
  20542. <doc>
  20543. <![CDATA[Default runtime to be used.]]>
  20544. </doc>
  20545. </field>
  20546. <field name="DOCKER_CONTAINER_RUNTIME_PREFIX" type="java.lang.String"
  20547. transient="false" volatile="false"
  20548. static="true" final="true" visibility="public"
  20549. deprecated="not deprecated">
  20550. </field>
  20551. <field name="NM_DOCKER_IMAGE_NAME" type="java.lang.String"
  20552. transient="false" volatile="false"
  20553. static="true" final="true" visibility="public"
  20554. deprecated="not deprecated">
  20555. <doc>
  20556. <![CDATA[Default docker image to be used.]]>
  20557. </doc>
  20558. </field>
  20559. <field name="NM_DOCKER_CONTAINER_CAPABILITIES" type="java.lang.String"
  20560. transient="false" volatile="false"
  20561. static="true" final="true" visibility="public"
  20562. deprecated="not deprecated">
  20563. <doc>
  20564. <![CDATA[Capabilities allowed (and added by default) for docker containers.]]>
  20565. </doc>
  20566. </field>
  20567. <field name="DEFAULT_NM_DOCKER_CONTAINER_CAPABILITIES" type="java.lang.String[]"
  20568. transient="false" volatile="false"
  20569. static="true" final="true" visibility="public"
  20570. deprecated="not deprecated">
  20571. <doc>
  20572. <![CDATA[These are the default capabilities added by docker. We'll use the same
  20573. set here. While these may not be case-sensitive from a docker
  20574. perspective, it is best to keep these uppercase.]]>
  20575. </doc>
  20576. </field>
  20577. <field name="NM_DOCKER_ALLOW_PRIVILEGED_CONTAINERS" type="java.lang.String"
  20578. transient="false" volatile="false"
  20579. static="true" final="true" visibility="public"
  20580. deprecated="not deprecated">
  20581. <doc>
  20582. <![CDATA[Allow privileged containers. Use with extreme care.]]>
  20583. </doc>
  20584. </field>
  20585. <field name="DEFAULT_NM_DOCKER_ALLOW_PRIVILEGED_CONTAINERS" type="boolean"
  20586. transient="false" volatile="false"
  20587. static="true" final="true" visibility="public"
  20588. deprecated="not deprecated">
  20589. <doc>
  20590. <![CDATA[Privileged containers are disabled by default.]]>
  20591. </doc>
  20592. </field>
  20593. <field name="NM_DOCKER_ENABLE_USER_REMAPPING" type="java.lang.String"
  20594. transient="false" volatile="false"
  20595. static="true" final="true" visibility="public"
  20596. deprecated="not deprecated">
  20597. <doc>
  20598. <![CDATA[enable user remapping.]]>
  20599. </doc>
  20600. </field>
  20601. <field name="DEFAULT_NM_DOCKER_ENABLE_USER_REMAPPING" type="boolean"
  20602. transient="false" volatile="false"
  20603. static="true" final="true" visibility="public"
  20604. deprecated="not deprecated">
  20605. <doc>
  20606. <![CDATA[Set enable user remapping as false by default.]]>
  20607. </doc>
  20608. </field>
  20609. <field name="NM_DOCKER_USER_REMAPPING_UID_THRESHOLD" type="java.lang.String"
  20610. transient="false" volatile="false"
  20611. static="true" final="true" visibility="public"
  20612. deprecated="not deprecated">
  20613. <doc>
  20614. <![CDATA[lower limit for acceptable uids of user remapped user.]]>
  20615. </doc>
  20616. </field>
  20617. <field name="DEFAULT_NM_DOCKER_USER_REMAPPING_UID_THRESHOLD" type="int"
  20618. transient="false" volatile="false"
  20619. static="true" final="true" visibility="public"
  20620. deprecated="not deprecated">
  20621. <doc>
  20622. <![CDATA[Set user remapping lower uid limit to 1 by default.]]>
  20623. </doc>
  20624. </field>
  20625. <field name="NM_DOCKER_USER_REMAPPING_GID_THRESHOLD" type="java.lang.String"
  20626. transient="false" volatile="false"
  20627. static="true" final="true" visibility="public"
  20628. deprecated="not deprecated">
  20629. <doc>
  20630. <![CDATA[lower limit for acceptable gids of user remapped user.]]>
  20631. </doc>
  20632. </field>
  20633. <field name="DEFAULT_NM_DOCKER_USER_REMAPPING_GID_THRESHOLD" type="int"
  20634. transient="false" volatile="false"
  20635. static="true" final="true" visibility="public"
  20636. deprecated="not deprecated">
  20637. <doc>
  20638. <![CDATA[Set user remapping lower gid limit to 1 by default.]]>
  20639. </doc>
  20640. </field>
  20641. <field name="NM_DOCKER_PRIVILEGED_CONTAINERS_ACL" type="java.lang.String"
  20642. transient="false" volatile="false"
  20643. static="true" final="true" visibility="public"
  20644. deprecated="not deprecated">
  20645. <doc>
  20646. <![CDATA[ACL list for users allowed to run privileged containers.]]>
  20647. </doc>
  20648. </field>
  20649. <field name="DEFAULT_NM_DOCKER_PRIVILEGED_CONTAINERS_ACL" type="java.lang.String"
  20650. transient="false" volatile="false"
  20651. static="true" final="true" visibility="public"
  20652. deprecated="not deprecated">
  20653. <doc>
  20654. <![CDATA[Default list for users allowed to run privileged containers is empty.]]>
  20655. </doc>
  20656. </field>
  20657. <field name="NM_DOCKER_ALLOWED_CONTAINER_NETWORKS" type="java.lang.String"
  20658. transient="false" volatile="false"
  20659. static="true" final="true" visibility="public"
  20660. deprecated="not deprecated">
  20661. <doc>
  20662. <![CDATA[The set of networks allowed when launching containers using the
  20663. DockerContainerRuntime.]]>
  20664. </doc>
  20665. </field>
  20666. <field name="DEFAULT_NM_DOCKER_ALLOWED_CONTAINER_NETWORKS" type="java.lang.String[]"
  20667. transient="false" volatile="false"
  20668. static="true" final="true" visibility="public"
  20669. deprecated="not deprecated">
  20670. <doc>
  20671. <![CDATA[The set of networks allowed when launching containers using the
  20672. DockerContainerRuntime.]]>
  20673. </doc>
  20674. </field>
  20675. <field name="NM_DOCKER_DEFAULT_CONTAINER_NETWORK" type="java.lang.String"
  20676. transient="false" volatile="false"
  20677. static="true" final="true" visibility="public"
  20678. deprecated="not deprecated">
  20679. <doc>
  20680. <![CDATA[The network used when launching containers using the
  20681. DockerContainerRuntime when no network is specified in the request. This
  20682. network must be one of the (configurable) set of allowed container
  20683. networks.]]>
  20684. </doc>
  20685. </field>
  20686. <field name="DEFAULT_NM_DOCKER_DEFAULT_CONTAINER_NETWORK" type="java.lang.String"
  20687. transient="false" volatile="false"
  20688. static="true" final="true" visibility="public"
  20689. deprecated="not deprecated">
  20690. <doc>
  20691. <![CDATA[The network used when launching containers using the
  20692. DockerContainerRuntime when no network is specified in the request and
  20693. no default network is configured.
  20694. .]]>
  20695. </doc>
  20696. </field>
  20697. <field name="NM_DOCKER_ALLOW_HOST_PID_NAMESPACE" type="java.lang.String"
  20698. transient="false" volatile="false"
  20699. static="true" final="true" visibility="public"
  20700. deprecated="not deprecated">
  20701. <doc>
  20702. <![CDATA[Allow host pid namespace for containers. Use with care.]]>
  20703. </doc>
  20704. </field>
  20705. <field name="DEFAULT_NM_DOCKER_ALLOW_HOST_PID_NAMESPACE" type="boolean"
  20706. transient="false" volatile="false"
  20707. static="true" final="true" visibility="public"
  20708. deprecated="not deprecated">
  20709. <doc>
  20710. <![CDATA[Host pid namespace for containers is disabled by default.]]>
  20711. </doc>
  20712. </field>
  20713. <field name="NM_DOCKER_ALLOW_DELAYED_REMOVAL" type="java.lang.String"
  20714. transient="false" volatile="false"
  20715. static="true" final="true" visibility="public"
  20716. deprecated="not deprecated">
  20717. <doc>
  20718. <![CDATA[Whether or not users are allowed to request that Docker containers honor
  20719. the debug deletion delay. This is useful for troubleshooting Docker
  20720. container related launch failures.]]>
  20721. </doc>
  20722. </field>
  20723. <field name="DEFAULT_NM_DOCKER_ALLOW_DELAYED_REMOVAL" type="boolean"
  20724. transient="false" volatile="false"
  20725. static="true" final="true" visibility="public"
  20726. deprecated="not deprecated">
  20727. <doc>
  20728. <![CDATA[The default value on whether or not a user can request that Docker
  20729. containers honor the debug deletion delay.]]>
  20730. </doc>
  20731. </field>
  20732. <field name="NM_DOCKER_STOP_GRACE_PERIOD" type="java.lang.String"
  20733. transient="false" volatile="false"
  20734. static="true" final="true" visibility="public"
  20735. deprecated="use {@link YarnConfiguration#NM_SLEEP_DELAY_BEFORE_SIGKILL_MS}">
  20736. <doc>
  20737. <![CDATA[A configurable value to pass to the Docker Stop command. This value
  20738. defines the number of seconds between the docker stop command sending
  20739. a SIGTERM and a SIGKILL.
  20740. @deprecated use {@link YarnConfiguration#NM_SLEEP_DELAY_BEFORE_SIGKILL_MS}]]>
  20741. </doc>
  20742. </field>
  20743. <field name="DEFAULT_NM_DOCKER_STOP_GRACE_PERIOD" type="int"
  20744. transient="false" volatile="false"
  20745. static="true" final="true" visibility="public"
  20746. deprecated="not deprecated">
  20747. <doc>
  20748. <![CDATA[The default value for the grace period between the SIGTERM and the
  20749. SIGKILL in the Docker Stop command.]]>
  20750. </doc>
  20751. </field>
  20752. <field name="NM_DOCKER_DEFAULT_RO_MOUNTS" type="java.lang.String"
  20753. transient="false" volatile="false"
  20754. static="true" final="true" visibility="public"
  20755. deprecated="not deprecated">
  20756. <doc>
  20757. <![CDATA[The default list of read-only mounts to be bind-mounted into all
  20758. Docker containers that use DockerContainerRuntime.]]>
  20759. </doc>
  20760. </field>
  20761. <field name="NM_DOCKER_DEFAULT_RW_MOUNTS" type="java.lang.String"
  20762. transient="false" volatile="false"
  20763. static="true" final="true" visibility="public"
  20764. deprecated="not deprecated">
  20765. <doc>
  20766. <![CDATA[The default list of read-write mounts to be bind-mounted into all
  20767. Docker containers that use DockerContainerRuntime.]]>
  20768. </doc>
  20769. </field>
  20770. <field name="NM_DOCKER_DEFAULT_TMPFS_MOUNTS" type="java.lang.String"
  20771. transient="false" volatile="false"
  20772. static="true" final="true" visibility="public"
  20773. deprecated="not deprecated">
  20774. <doc>
  20775. <![CDATA[The default list of tmpfs mounts to be mounted into all
  20776. Docker containers that use DockerContainerRuntime.]]>
  20777. </doc>
  20778. </field>
  20779. <field name="YARN_CONTAINER_SANDBOX" type="java.lang.String"
  20780. transient="false" volatile="false"
  20781. static="true" final="true" visibility="public"
  20782. deprecated="not deprecated">
  20783. <doc>
  20784. <![CDATA[The mode in which the Java Container Sandbox should run detailed by
  20785. the JavaSandboxLinuxContainerRuntime.]]>
  20786. </doc>
  20787. </field>
  20788. <field name="DEFAULT_YARN_CONTAINER_SANDBOX" type="java.lang.String"
  20789. transient="false" volatile="false"
  20790. static="true" final="true" visibility="public"
  20791. deprecated="not deprecated">
  20792. </field>
  20793. <field name="YARN_CONTAINER_SANDBOX_FILE_PERMISSIONS" type="java.lang.String"
  20794. transient="false" volatile="false"
  20795. static="true" final="true" visibility="public"
  20796. deprecated="not deprecated">
  20797. <doc>
  20798. <![CDATA[Permissions for application local directories.]]>
  20799. </doc>
  20800. </field>
  20801. <field name="DEFAULT_YARN_CONTAINER_SANDBOX_FILE_PERMISSIONS" type="java.lang.String"
  20802. transient="false" volatile="false"
  20803. static="true" final="true" visibility="public"
  20804. deprecated="not deprecated">
  20805. </field>
  20806. <field name="YARN_CONTAINER_SANDBOX_POLICY" type="java.lang.String"
  20807. transient="false" volatile="false"
  20808. static="true" final="true" visibility="public"
  20809. deprecated="not deprecated">
  20810. <doc>
  20811. <![CDATA[Location for non-default java policy file.]]>
  20812. </doc>
  20813. </field>
  20814. <field name="YARN_CONTAINER_SANDBOX_POLICY_GROUP_PREFIX" type="java.lang.String"
  20815. transient="false" volatile="false"
  20816. static="true" final="true" visibility="public"
  20817. deprecated="not deprecated">
  20818. <doc>
  20819. <![CDATA[Prefix for group to policy file mapping.]]>
  20820. </doc>
  20821. </field>
  20822. <field name="YARN_CONTAINER_SANDBOX_WHITELIST_GROUP" type="java.lang.String"
  20823. transient="false" volatile="false"
  20824. static="true" final="true" visibility="public"
  20825. deprecated="not deprecated">
  20826. <doc>
  20827. <![CDATA[The group which will run by default without the java security manager.]]>
  20828. </doc>
  20829. </field>
  20830. <field name="NM_LINUX_CONTAINER_EXECUTOR_PATH" type="java.lang.String"
  20831. transient="false" volatile="false"
  20832. static="true" final="true" visibility="public"
  20833. deprecated="not deprecated">
  20834. <doc>
  20835. <![CDATA[The path to the Linux container executor.]]>
  20836. </doc>
  20837. </field>
  20838. <field name="NM_NONSECURE_MODE_LIMIT_USERS" type="java.lang.String"
  20839. transient="false" volatile="false"
  20840. static="true" final="true" visibility="public"
  20841. deprecated="not deprecated">
  20842. <doc>
  20843. <![CDATA[True if linux-container-executor should limit itself to one user
  20844. when running in non-secure mode.]]>
  20845. </doc>
  20846. </field>
  20847. <field name="DEFAULT_NM_NONSECURE_MODE_LIMIT_USERS" type="boolean"
  20848. transient="false" volatile="false"
  20849. static="true" final="true" visibility="public"
  20850. deprecated="not deprecated">
  20851. </field>
  20852. <field name="NM_NONSECURE_MODE_LOCAL_USER_KEY" type="java.lang.String"
  20853. transient="false" volatile="false"
  20854. static="true" final="true" visibility="public"
  20855. deprecated="not deprecated">
  20856. <doc>
  20857. <![CDATA[The UNIX user that containers will run as when Linux-container-executor
  20858. is used in nonsecure mode (a use case for this is using cgroups).]]>
  20859. </doc>
  20860. </field>
  20861. <field name="DEFAULT_NM_NONSECURE_MODE_LOCAL_USER" type="java.lang.String"
  20862. transient="false" volatile="false"
  20863. static="true" final="true" visibility="public"
  20864. deprecated="not deprecated">
  20865. </field>
  20866. <field name="NM_NONSECURE_MODE_USER_PATTERN_KEY" type="java.lang.String"
  20867. transient="false" volatile="false"
  20868. static="true" final="true" visibility="public"
  20869. deprecated="not deprecated">
  20870. <doc>
  20871. <![CDATA[The allowed pattern for UNIX user names enforced by
  20872. Linux-container-executor when used in nonsecure mode (use case for this
  20873. is using cgroups). The default value is taken from /usr/sbin/adduser]]>
  20874. </doc>
  20875. </field>
  20876. <field name="DEFAULT_NM_NONSECURE_MODE_USER_PATTERN" type="java.lang.String"
  20877. transient="false" volatile="false"
  20878. static="true" final="true" visibility="public"
  20879. deprecated="not deprecated">
  20880. </field>
  20881. <field name="NM_LINUX_CONTAINER_RESOURCES_HANDLER" type="java.lang.String"
  20882. transient="false" volatile="false"
  20883. static="true" final="true" visibility="public"
  20884. deprecated="not deprecated">
  20885. <doc>
  20886. <![CDATA[The type of resource enforcement to use with the
  20887. linux container executor.]]>
  20888. </doc>
  20889. </field>
  20890. <field name="NM_LINUX_CONTAINER_CGROUPS_HIERARCHY" type="java.lang.String"
  20891. transient="false" volatile="false"
  20892. static="true" final="true" visibility="public"
  20893. deprecated="not deprecated">
  20894. <doc>
  20895. <![CDATA[The path the linux container executor should use for cgroups]]>
  20896. </doc>
  20897. </field>
  20898. <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT" type="java.lang.String"
  20899. transient="false" volatile="false"
  20900. static="true" final="true" visibility="public"
  20901. deprecated="not deprecated">
  20902. <doc>
  20903. <![CDATA[Whether the linux container executor should mount cgroups if not found]]>
  20904. </doc>
  20905. </field>
  20906. <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT_PATH" type="java.lang.String"
  20907. transient="false" volatile="false"
  20908. static="true" final="true" visibility="public"
  20909. deprecated="not deprecated">
  20910. <doc>
  20911. <![CDATA[Where the linux container executor should mount cgroups if not found]]>
  20912. </doc>
  20913. </field>
  20914. <field name="NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="java.lang.String"
  20915. transient="false" volatile="false"
  20916. static="true" final="true" visibility="public"
  20917. deprecated="not deprecated">
  20918. <doc>
  20919. <![CDATA[Whether the apps should run in strict resource usage mode(not allowed to
  20920. use spare CPU)]]>
  20921. </doc>
  20922. </field>
  20923. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="boolean"
  20924. transient="false" volatile="false"
  20925. static="true" final="true" visibility="public"
  20926. deprecated="not deprecated">
  20927. </field>
  20928. <field name="RM_APPLICATION_MONITOR_INTERVAL_MS" type="java.lang.String"
  20929. transient="false" volatile="false"
  20930. static="true" final="true" visibility="public"
  20931. deprecated="not deprecated">
  20932. </field>
  20933. <field name="DEFAULT_RM_APPLICATION_MONITOR_INTERVAL_MS" type="long"
  20934. transient="false" volatile="false"
  20935. static="true" final="true" visibility="public"
  20936. deprecated="not deprecated">
  20937. </field>
  20938. <field name="RM_PROXY_TIMEOUT_ENABLED" type="java.lang.String"
  20939. transient="false" volatile="false"
  20940. static="true" final="true" visibility="public"
  20941. deprecated="not deprecated">
  20942. </field>
  20943. <field name="DEFALUT_RM_PROXY_TIMEOUT_ENABLED" type="boolean"
  20944. transient="false" volatile="false"
  20945. static="true" final="true" visibility="public"
  20946. deprecated="not deprecated">
  20947. </field>
  20948. <field name="RM_PROXY_CONNECTION_TIMEOUT" type="java.lang.String"
  20949. transient="false" volatile="false"
  20950. static="true" final="true" visibility="public"
  20951. deprecated="not deprecated">
  20952. </field>
  20953. <field name="DEFAULT_RM_PROXY_CONNECTION_TIMEOUT" type="int"
  20954. transient="false" volatile="false"
  20955. static="true" final="true" visibility="public"
  20956. deprecated="not deprecated">
  20957. </field>
  20958. <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="java.lang.String"
  20959. transient="false" volatile="false"
  20960. static="true" final="true" visibility="public"
  20961. deprecated="not deprecated">
  20962. <doc>
  20963. <![CDATA[Interval of time the linux container executor should try cleaning up
  20964. cgroups entry when cleaning up a container. This is required due to what
  20965. it seems a race condition because the SIGTERM/SIGKILL is asynch.]]>
  20966. </doc>
  20967. </field>
  20968. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="long"
  20969. transient="false" volatile="false"
  20970. static="true" final="true" visibility="public"
  20971. deprecated="not deprecated">
  20972. </field>
  20973. <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="java.lang.String"
  20974. transient="false" volatile="false"
  20975. static="true" final="true" visibility="public"
  20976. deprecated="not deprecated">
  20977. <doc>
  20978. <![CDATA[Delay between attempts to remove linux cgroup.]]>
  20979. </doc>
  20980. </field>
  20981. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="long"
  20982. transient="false" volatile="false"
  20983. static="true" final="true" visibility="public"
  20984. deprecated="not deprecated">
  20985. </field>
  20986. <field name="NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="java.lang.String"
  20987. transient="false" volatile="false"
  20988. static="true" final="true" visibility="public"
  20989. deprecated="not deprecated">
  20990. <doc>
  20991. <![CDATA[Indicates if memory and CPU limits will be set for the Windows Job
  20992. Object for the containers launched by the default container executor.]]>
  20993. </doc>
  20994. </field>
  20995. <field name="DEFAULT_NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="boolean"
  20996. transient="false" volatile="false"
  20997. static="true" final="true" visibility="public"
  20998. deprecated="not deprecated">
  20999. </field>
  21000. <field name="NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="java.lang.String"
  21001. transient="false" volatile="false"
  21002. static="true" final="true" visibility="public"
  21003. deprecated="not deprecated">
  21004. </field>
  21005. <field name="DEFAULT_NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="boolean"
  21006. transient="false" volatile="false"
  21007. static="true" final="true" visibility="public"
  21008. deprecated="not deprecated">
  21009. </field>
  21010. <field name="NM_WINDOWS_SECURE_CONTAINER_GROUP" type="java.lang.String"
  21011. transient="false" volatile="false"
  21012. static="true" final="true" visibility="public"
  21013. deprecated="not deprecated">
  21014. <doc>
  21015. <![CDATA[/* The Windows group that the windows-secure-container-executor should run as.]]>
  21016. </doc>
  21017. </field>
  21018. <field name="NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
  21019. transient="false" volatile="false"
  21020. static="true" final="true" visibility="public"
  21021. deprecated="not deprecated">
  21022. <doc>
  21023. <![CDATA[T-file compression types used to compress aggregated logs.]]>
  21024. </doc>
  21025. </field>
  21026. <field name="DEFAULT_NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
  21027. transient="false" volatile="false"
  21028. static="true" final="true" visibility="public"
  21029. deprecated="not deprecated">
  21030. </field>
  21031. <field name="NM_PRINCIPAL" type="java.lang.String"
  21032. transient="false" volatile="false"
  21033. static="true" final="true" visibility="public"
  21034. deprecated="not deprecated">
  21035. <doc>
  21036. <![CDATA[The kerberos principal for the node manager.]]>
  21037. </doc>
  21038. </field>
  21039. <field name="NM_AUX_SERVICES" type="java.lang.String"
  21040. transient="false" volatile="false"
  21041. static="true" final="true" visibility="public"
  21042. deprecated="not deprecated">
  21043. </field>
  21044. <field name="NM_AUX_SERVICE_FMT" type="java.lang.String"
  21045. transient="false" volatile="false"
  21046. static="true" final="true" visibility="public"
  21047. deprecated="not deprecated">
  21048. </field>
  21049. <field name="NM_AUX_SERVICES_CLASSPATH" type="java.lang.String"
  21050. transient="false" volatile="false"
  21051. static="true" final="true" visibility="public"
  21052. deprecated="not deprecated">
  21053. </field>
  21054. <field name="NM_AUX_SERVICE_REMOTE_CLASSPATH" type="java.lang.String"
  21055. transient="false" volatile="false"
  21056. static="true" final="true" visibility="public"
  21057. deprecated="not deprecated">
  21058. </field>
  21059. <field name="NM_AUX_SERVICES_SYSTEM_CLASSES" type="java.lang.String"
  21060. transient="false" volatile="false"
  21061. static="true" final="true" visibility="public"
  21062. deprecated="not deprecated">
  21063. </field>
  21064. <field name="NM_USER_HOME_DIR" type="java.lang.String"
  21065. transient="false" volatile="false"
  21066. static="true" final="true" visibility="public"
  21067. deprecated="not deprecated">
  21068. </field>
  21069. <field name="NM_CONTAINER_STDERR_PATTERN" type="java.lang.String"
  21070. transient="false" volatile="false"
  21071. static="true" final="true" visibility="public"
  21072. deprecated="not deprecated">
  21073. </field>
  21074. <field name="DEFAULT_NM_CONTAINER_STDERR_PATTERN" type="java.lang.String"
  21075. transient="false" volatile="false"
  21076. static="true" final="true" visibility="public"
  21077. deprecated="not deprecated">
  21078. </field>
  21079. <field name="NM_CONTAINER_STDERR_BYTES" type="java.lang.String"
  21080. transient="false" volatile="false"
  21081. static="true" final="true" visibility="public"
  21082. deprecated="not deprecated">
  21083. </field>
  21084. <field name="DEFAULT_NM_CONTAINER_STDERR_BYTES" type="long"
  21085. transient="false" volatile="false"
  21086. static="true" final="true" visibility="public"
  21087. deprecated="not deprecated">
  21088. </field>
  21089. <field name="NM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
  21090. transient="false" volatile="false"
  21091. static="true" final="true" visibility="public"
  21092. deprecated="not deprecated">
  21093. <doc>
  21094. <![CDATA[The kerberos principal to be used for spnego filter for NM.]]>
  21095. </doc>
  21096. </field>
  21097. <field name="NM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
  21098. transient="false" volatile="false"
  21099. static="true" final="true" visibility="public"
  21100. deprecated="not deprecated">
  21101. <doc>
  21102. <![CDATA[The kerberos keytab to be used for spnego filter for NM.]]>
  21103. </doc>
  21104. </field>
  21105. <field name="DEFAULT_NM_USER_HOME_DIR" type="java.lang.String"
  21106. transient="false" volatile="false"
  21107. static="true" final="true" visibility="public"
  21108. deprecated="not deprecated">
  21109. </field>
  21110. <field name="NM_RECOVERY_PREFIX" type="java.lang.String"
  21111. transient="false" volatile="false"
  21112. static="true" final="true" visibility="public"
  21113. deprecated="not deprecated">
  21114. </field>
  21115. <field name="NM_RECOVERY_ENABLED" type="java.lang.String"
  21116. transient="false" volatile="false"
  21117. static="true" final="true" visibility="public"
  21118. deprecated="not deprecated">
  21119. </field>
  21120. <field name="DEFAULT_NM_RECOVERY_ENABLED" type="boolean"
  21121. transient="false" volatile="false"
  21122. static="true" final="true" visibility="public"
  21123. deprecated="not deprecated">
  21124. </field>
  21125. <field name="NM_RECOVERY_DIR" type="java.lang.String"
  21126. transient="false" volatile="false"
  21127. static="true" final="true" visibility="public"
  21128. deprecated="not deprecated">
  21129. </field>
  21130. <field name="NM_RECOVERY_COMPACTION_INTERVAL_SECS" type="java.lang.String"
  21131. transient="false" volatile="false"
  21132. static="true" final="true" visibility="public"
  21133. deprecated="not deprecated">
  21134. <doc>
  21135. <![CDATA[The time in seconds between full compactions of the NM state database.
  21136. Setting the interval to zero disables the full compaction cycles.]]>
  21137. </doc>
  21138. </field>
  21139. <field name="DEFAULT_NM_RECOVERY_COMPACTION_INTERVAL_SECS" type="int"
  21140. transient="false" volatile="false"
  21141. static="true" final="true" visibility="public"
  21142. deprecated="not deprecated">
  21143. </field>
  21144. <field name="NM_RECOVERY_SUPERVISED" type="java.lang.String"
  21145. transient="false" volatile="false"
  21146. static="true" final="true" visibility="public"
  21147. deprecated="not deprecated">
  21148. </field>
  21149. <field name="DEFAULT_NM_RECOVERY_SUPERVISED" type="boolean"
  21150. transient="false" volatile="false"
  21151. static="true" final="true" visibility="public"
  21152. deprecated="not deprecated">
  21153. </field>
  21154. <field name="NM_LOG_AGG_POLICY_CLASS" type="java.lang.String"
  21155. transient="false" volatile="false"
  21156. static="true" final="true" visibility="public"
  21157. deprecated="not deprecated">
  21158. </field>
  21159. <field name="NM_LOG_AGG_POLICY_CLASS_PARAMETERS" type="java.lang.String"
  21160. transient="false" volatile="false"
  21161. static="true" final="true" visibility="public"
  21162. deprecated="not deprecated">
  21163. </field>
  21164. <field name="PROXY_PREFIX" type="java.lang.String"
  21165. transient="false" volatile="false"
  21166. static="true" final="true" visibility="public"
  21167. deprecated="not deprecated">
  21168. </field>
  21169. <field name="PROXY_PRINCIPAL" type="java.lang.String"
  21170. transient="false" volatile="false"
  21171. static="true" final="true" visibility="public"
  21172. deprecated="not deprecated">
  21173. <doc>
  21174. <![CDATA[The kerberos principal for the proxy.]]>
  21175. </doc>
  21176. </field>
  21177. <field name="PROXY_KEYTAB" type="java.lang.String"
  21178. transient="false" volatile="false"
  21179. static="true" final="true" visibility="public"
  21180. deprecated="not deprecated">
  21181. <doc>
  21182. <![CDATA[Keytab for Proxy.]]>
  21183. </doc>
  21184. </field>
  21185. <field name="PROXY_ADDRESS" type="java.lang.String"
  21186. transient="false" volatile="false"
  21187. static="true" final="true" visibility="public"
  21188. deprecated="not deprecated">
  21189. <doc>
  21190. <![CDATA[The address for the web proxy.]]>
  21191. </doc>
  21192. </field>
  21193. <field name="DEFAULT_PROXY_PORT" type="int"
  21194. transient="false" volatile="false"
  21195. static="true" final="true" visibility="public"
  21196. deprecated="not deprecated">
  21197. </field>
  21198. <field name="DEFAULT_PROXY_ADDRESS" type="java.lang.String"
  21199. transient="false" volatile="false"
  21200. static="true" final="true" visibility="public"
  21201. deprecated="not deprecated">
  21202. </field>
  21203. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCETRACKER_PROTOCOL" type="java.lang.String"
  21204. transient="false" volatile="false"
  21205. static="true" final="true" visibility="public"
  21206. deprecated="not deprecated">
  21207. <doc>
  21208. <![CDATA[YARN Service Level Authorization]]>
  21209. </doc>
  21210. </field>
  21211. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONCLIENT_PROTOCOL" type="java.lang.String"
  21212. transient="false" volatile="false"
  21213. static="true" final="true" visibility="public"
  21214. deprecated="not deprecated">
  21215. </field>
  21216. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCEMANAGER_ADMINISTRATION_PROTOCOL" type="java.lang.String"
  21217. transient="false" volatile="false"
  21218. static="true" final="true" visibility="public"
  21219. deprecated="not deprecated">
  21220. </field>
  21221. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONMASTER_PROTOCOL" type="java.lang.String"
  21222. transient="false" volatile="false"
  21223. static="true" final="true" visibility="public"
  21224. deprecated="not deprecated">
  21225. </field>
  21226. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_DISTRIBUTEDSCHEDULING_PROTOCOL" type="java.lang.String"
  21227. transient="false" volatile="false"
  21228. static="true" final="true" visibility="public"
  21229. deprecated="not deprecated">
  21230. </field>
  21231. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_CONTAINER_MANAGEMENT_PROTOCOL" type="java.lang.String"
  21232. transient="false" volatile="false"
  21233. static="true" final="true" visibility="public"
  21234. deprecated="not deprecated">
  21235. </field>
  21236. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCE_LOCALIZER" type="java.lang.String"
  21237. transient="false" volatile="false"
  21238. static="true" final="true" visibility="public"
  21239. deprecated="not deprecated">
  21240. </field>
  21241. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONHISTORY_PROTOCOL" type="java.lang.String"
  21242. transient="false" volatile="false"
  21243. static="true" final="true" visibility="public"
  21244. deprecated="not deprecated">
  21245. </field>
  21246. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_COLLECTOR_NODEMANAGER_PROTOCOL" type="java.lang.String"
  21247. transient="false" volatile="false"
  21248. static="true" final="true" visibility="public"
  21249. deprecated="not deprecated">
  21250. </field>
  21251. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONMASTER_NODEMANAGER_PROTOCOL" type="java.lang.String"
  21252. transient="false" volatile="false"
  21253. static="true" final="true" visibility="public"
  21254. deprecated="not deprecated">
  21255. </field>
  21256. <field name="NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="java.lang.String"
  21257. transient="false" volatile="false"
  21258. static="true" final="true" visibility="public"
  21259. deprecated="not deprecated">
  21260. <doc>
  21261. <![CDATA[No. of milliseconds to wait between sending a SIGTERM and SIGKILL
  21262. to a running container]]>
  21263. </doc>
  21264. </field>
  21265. <field name="DEFAULT_NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="long"
  21266. transient="false" volatile="false"
  21267. static="true" final="true" visibility="public"
  21268. deprecated="not deprecated">
  21269. </field>
  21270. <field name="NM_PROCESS_KILL_WAIT_MS" type="java.lang.String"
  21271. transient="false" volatile="false"
  21272. static="true" final="true" visibility="public"
  21273. deprecated="not deprecated">
  21274. <doc>
  21275. <![CDATA[Max time to wait for a process to come up when trying to cleanup
  21276. container resources]]>
  21277. </doc>
  21278. </field>
  21279. <field name="DEFAULT_NM_PROCESS_KILL_WAIT_MS" type="long"
  21280. transient="false" volatile="false"
  21281. static="true" final="true" visibility="public"
  21282. deprecated="not deprecated">
  21283. </field>
  21284. <field name="RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  21285. transient="false" volatile="false"
  21286. static="true" final="true" visibility="public"
  21287. deprecated="not deprecated">
  21288. <doc>
  21289. <![CDATA[Max time to wait to establish a connection to RM]]>
  21290. </doc>
  21291. </field>
  21292. <field name="DEFAULT_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="long"
  21293. transient="false" volatile="false"
  21294. static="true" final="true" visibility="public"
  21295. deprecated="not deprecated">
  21296. </field>
  21297. <field name="RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  21298. transient="false" volatile="false"
  21299. static="true" final="true" visibility="public"
  21300. deprecated="not deprecated">
  21301. <doc>
  21302. <![CDATA[Time interval between each attempt to connect to RM]]>
  21303. </doc>
  21304. </field>
  21305. <field name="DEFAULT_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="long"
  21306. transient="false" volatile="false"
  21307. static="true" final="true" visibility="public"
  21308. deprecated="not deprecated">
  21309. </field>
  21310. <field name="DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="java.lang.String"
  21311. transient="false" volatile="false"
  21312. static="true" final="true" visibility="public"
  21313. deprecated="not deprecated">
  21314. </field>
  21315. <field name="DEFAULT_DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="long"
  21316. transient="false" volatile="false"
  21317. static="true" final="true" visibility="public"
  21318. deprecated="not deprecated">
  21319. </field>
  21320. <field name="YARN_DISPATCHER_PRINT_EVENTS_INFO_THRESHOLD" type="java.lang.String"
  21321. transient="false" volatile="false"
  21322. static="true" final="true" visibility="public"
  21323. deprecated="not deprecated">
  21324. <doc>
  21325. <![CDATA[The threshold used to trigger the logging of event types and counts
  21326. in RM's main event dispatcher. Default value is 5000,
  21327. which means RM will print events info when the queue size cumulatively
  21328. reaches 5000 every time. Such info can be used to reveal what
  21329. kind of events that RM is stuck at processing mostly,
  21330. it can help to narrow down certain performance issues.]]>
  21331. </doc>
  21332. </field>
  21333. <field name="DEFAULT_YARN_DISPATCHER_PRINT_EVENTS_INFO_THRESHOLD" type="int"
  21334. transient="false" volatile="false"
  21335. static="true" final="true" visibility="public"
  21336. deprecated="not deprecated">
  21337. </field>
  21338. <field name="YARN_DISPATCHER_CPU_MONITOR_SAMPLES_PER_MIN" type="java.lang.String"
  21339. transient="false" volatile="false"
  21340. static="true" final="true" visibility="public"
  21341. deprecated="not deprecated">
  21342. <doc>
  21343. <![CDATA[Resource manager dispatcher thread monitor sampling rate.
  21344. Units are samples per minute. This controls how often to sample
  21345. the cpu utilization of the resource manager dispatcher thread.
  21346. The cpu utilization is displayed on the RM UI as scheduler busy %.
  21347. Set to zero to disable the dispatcher thread monitor.]]>
  21348. </doc>
  21349. </field>
  21350. <field name="DEFAULT_YARN_DISPATCHER_CPU_MONITOR_SAMPLES_PER_MIN" type="int"
  21351. transient="false" volatile="false"
  21352. static="true" final="true" visibility="public"
  21353. deprecated="not deprecated">
  21354. </field>
  21355. <field name="YARN_APPLICATION_CLASSPATH" type="java.lang.String"
  21356. transient="false" volatile="false"
  21357. static="true" final="true" visibility="public"
  21358. deprecated="not deprecated">
  21359. <doc>
  21360. <![CDATA[CLASSPATH for YARN applications. A comma-separated list of CLASSPATH
  21361. entries]]>
  21362. </doc>
  21363. </field>
  21364. <field name="AMRM_PROXY_ENABLED" type="java.lang.String"
  21365. transient="false" volatile="false"
  21366. static="true" final="true" visibility="public"
  21367. deprecated="not deprecated">
  21368. <doc>
  21369. <![CDATA[The setting that controls whether AMRMProxy is enabled or not.]]>
  21370. </doc>
  21371. </field>
  21372. <field name="DEFAULT_AMRM_PROXY_ENABLED" type="boolean"
  21373. transient="false" volatile="false"
  21374. static="true" final="true" visibility="public"
  21375. deprecated="not deprecated">
  21376. </field>
  21377. <field name="AMRM_PROXY_ADDRESS" type="java.lang.String"
  21378. transient="false" volatile="false"
  21379. static="true" final="true" visibility="public"
  21380. deprecated="not deprecated">
  21381. </field>
  21382. <field name="DEFAULT_AMRM_PROXY_PORT" type="int"
  21383. transient="false" volatile="false"
  21384. static="true" final="true" visibility="public"
  21385. deprecated="not deprecated">
  21386. </field>
  21387. <field name="DEFAULT_AMRM_PROXY_ADDRESS" type="java.lang.String"
  21388. transient="false" volatile="false"
  21389. static="true" final="true" visibility="public"
  21390. deprecated="not deprecated">
  21391. </field>
  21392. <field name="AMRM_PROXY_CLIENT_THREAD_COUNT" type="java.lang.String"
  21393. transient="false" volatile="false"
  21394. static="true" final="true" visibility="public"
  21395. deprecated="not deprecated">
  21396. </field>
  21397. <field name="DEFAULT_AMRM_PROXY_CLIENT_THREAD_COUNT" type="int"
  21398. transient="false" volatile="false"
  21399. static="true" final="true" visibility="public"
  21400. deprecated="not deprecated">
  21401. </field>
  21402. <field name="AMRM_PROXY_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  21403. transient="false" volatile="false"
  21404. static="true" final="true" visibility="public"
  21405. deprecated="not deprecated">
  21406. </field>
  21407. <field name="DEFAULT_AMRM_PROXY_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  21408. transient="false" volatile="false"
  21409. static="true" final="true" visibility="public"
  21410. deprecated="not deprecated">
  21411. </field>
  21412. <field name="AMRM_PROXY_HA_ENABLED" type="java.lang.String"
  21413. transient="false" volatile="false"
  21414. static="true" final="true" visibility="public"
  21415. deprecated="not deprecated">
  21416. </field>
  21417. <field name="DEFAULT_AMRM_PROXY_HA_ENABLED" type="boolean"
  21418. transient="false" volatile="false"
  21419. static="true" final="true" visibility="public"
  21420. deprecated="not deprecated">
  21421. </field>
  21422. <field name="DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH" type="java.lang.String[]"
  21423. transient="false" volatile="false"
  21424. static="true" final="true" visibility="public"
  21425. deprecated="not deprecated">
  21426. <doc>
  21427. <![CDATA[Default platform-agnostic CLASSPATH for YARN applications. A
  21428. comma-separated list of CLASSPATH entries. The parameter expansion marker
  21429. will be replaced with real parameter expansion marker ('%' for Windows and
  21430. '$' for Linux) by NodeManager on container launch. For example: {{VAR}}
  21431. will be replaced as $VAR on Linux, and %VAR% on Windows.]]>
  21432. </doc>
  21433. </field>
  21434. <field name="DEFAULT_YARN_APPLICATION_CLASSPATH" type="java.lang.String[]"
  21435. transient="false" volatile="false"
  21436. static="true" final="true" visibility="public"
  21437. deprecated="not deprecated">
  21438. <doc>
  21439. <![CDATA[<p>
  21440. Default platform-specific CLASSPATH for YARN applications. A
  21441. comma-separated list of CLASSPATH entries constructed based on the client
  21442. OS environment expansion syntax.
  21443. </p>
  21444. <p>
  21445. Note: Use {@link #DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH} for
  21446. cross-platform practice i.e. submit an application from a Windows client to
  21447. a Linux/Unix server or vice versa.
  21448. </p>]]>
  21449. </doc>
  21450. </field>
  21451. <field name="DEFAULT_CONTAINER_TEMP_DIR" type="java.lang.String"
  21452. transient="false" volatile="false"
  21453. static="true" final="true" visibility="public"
  21454. deprecated="not deprecated">
  21455. <doc>
  21456. <![CDATA[Container temp directory]]>
  21457. </doc>
  21458. </field>
  21459. <field name="IS_MINI_YARN_CLUSTER" type="java.lang.String"
  21460. transient="false" volatile="false"
  21461. static="true" final="true" visibility="public"
  21462. deprecated="not deprecated">
  21463. </field>
  21464. <field name="YARN_MC_PREFIX" type="java.lang.String"
  21465. transient="false" volatile="false"
  21466. static="true" final="true" visibility="public"
  21467. deprecated="not deprecated">
  21468. </field>
  21469. <field name="YARN_MINICLUSTER_FIXED_PORTS" type="java.lang.String"
  21470. transient="false" volatile="false"
  21471. static="true" final="true" visibility="public"
  21472. deprecated="not deprecated">
  21473. <doc>
  21474. <![CDATA[Whether to use fixed ports with the minicluster.]]>
  21475. </doc>
  21476. </field>
  21477. <field name="DEFAULT_YARN_MINICLUSTER_FIXED_PORTS" type="boolean"
  21478. transient="false" volatile="false"
  21479. static="true" final="true" visibility="public"
  21480. deprecated="not deprecated">
  21481. <doc>
  21482. <![CDATA[Default is false to be able to run tests concurrently without port
  21483. conflicts.]]>
  21484. </doc>
  21485. </field>
  21486. <field name="YARN_MINICLUSTER_USE_RPC" type="java.lang.String"
  21487. transient="false" volatile="false"
  21488. static="true" final="true" visibility="public"
  21489. deprecated="not deprecated">
  21490. <doc>
  21491. <![CDATA[Whether the NM should use RPC to connect to the RM. Default is false.
  21492. Can be set to true only when using fixed ports.]]>
  21493. </doc>
  21494. </field>
  21495. <field name="DEFAULT_YARN_MINICLUSTER_USE_RPC" type="boolean"
  21496. transient="false" volatile="false"
  21497. static="true" final="true" visibility="public"
  21498. deprecated="not deprecated">
  21499. </field>
  21500. <field name="YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="java.lang.String"
  21501. transient="false" volatile="false"
  21502. static="true" final="true" visibility="public"
  21503. deprecated="not deprecated">
  21504. <doc>
  21505. <![CDATA[Whether users are explicitly trying to control resource monitoring
  21506. configuration for the MiniYARNCluster. Disabled by default.]]>
  21507. </doc>
  21508. </field>
  21509. <field name="DEFAULT_YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="boolean"
  21510. transient="false" volatile="false"
  21511. static="true" final="true" visibility="public"
  21512. deprecated="not deprecated">
  21513. </field>
  21514. <field name="YARN_MINICLUSTER_NM_PMEM_MB" type="java.lang.String"
  21515. transient="false" volatile="false"
  21516. static="true" final="true" visibility="public"
  21517. deprecated="not deprecated">
  21518. <doc>
  21519. <![CDATA[Allow changing the memory for the NodeManager in the MiniYARNCluster]]>
  21520. </doc>
  21521. </field>
  21522. <field name="DEFAULT_YARN_MINICLUSTER_NM_PMEM_MB" type="int"
  21523. transient="false" volatile="false"
  21524. static="true" final="true" visibility="public"
  21525. deprecated="not deprecated">
  21526. </field>
  21527. <field name="YARN_APP_CONTAINER_LOG_DIR" type="java.lang.String"
  21528. transient="false" volatile="false"
  21529. static="true" final="true" visibility="public"
  21530. deprecated="not deprecated">
  21531. <doc>
  21532. <![CDATA[The log directory for the containers]]>
  21533. </doc>
  21534. </field>
  21535. <field name="YARN_APP_CONTAINER_LOG_SIZE" type="java.lang.String"
  21536. transient="false" volatile="false"
  21537. static="true" final="true" visibility="public"
  21538. deprecated="not deprecated">
  21539. </field>
  21540. <field name="YARN_APP_CONTAINER_LOG_BACKUPS" type="java.lang.String"
  21541. transient="false" volatile="false"
  21542. static="true" final="true" visibility="public"
  21543. deprecated="not deprecated">
  21544. </field>
  21545. <field name="TIMELINE_SERVICE_PREFIX" type="java.lang.String"
  21546. transient="false" volatile="false"
  21547. static="true" final="true" visibility="public"
  21548. deprecated="not deprecated">
  21549. </field>
  21550. <field name="TIMELINE_SERVICE_VERSION" type="java.lang.String"
  21551. transient="false" volatile="false"
  21552. static="true" final="true" visibility="public"
  21553. deprecated="not deprecated">
  21554. </field>
  21555. <field name="DEFAULT_TIMELINE_SERVICE_VERSION" type="float"
  21556. transient="false" volatile="false"
  21557. static="true" final="true" visibility="public"
  21558. deprecated="not deprecated">
  21559. </field>
  21560. <field name="TIMELINE_SERVICE_VERSIONS" type="java.lang.String"
  21561. transient="false" volatile="false"
  21562. static="true" final="true" visibility="public"
  21563. deprecated="not deprecated">
  21564. </field>
  21565. <field name="TIMELINE_SERVICE_UI_NAMES" type="java.lang.String"
  21566. transient="false" volatile="false"
  21567. static="true" final="true" visibility="public"
  21568. deprecated="not deprecated">
  21569. <doc>
  21570. <![CDATA[Comma separated list of names for UIs hosted in the timeline server
  21571. (For pluggable UIs).]]>
  21572. </doc>
  21573. </field>
  21574. <field name="TIMELINE_SERVICE_UI_WEB_PATH_PREFIX" type="java.lang.String"
  21575. transient="false" volatile="false"
  21576. static="true" final="true" visibility="public"
  21577. deprecated="not deprecated">
  21578. <doc>
  21579. <![CDATA[Relative web path that will serve up this UI (For pluggable UIs).]]>
  21580. </doc>
  21581. </field>
  21582. <field name="TIMELINE_SERVICE_CLIENT_PREFIX" type="java.lang.String"
  21583. transient="false" volatile="false"
  21584. static="true" final="true" visibility="public"
  21585. deprecated="not deprecated">
  21586. <doc>
  21587. <![CDATA[Timeline client settings.]]>
  21588. </doc>
  21589. </field>
  21590. <field name="TIMELINE_SERVICE_UI_ON_DISK_PATH_PREFIX" type="java.lang.String"
  21591. transient="false" volatile="false"
  21592. static="true" final="true" visibility="public"
  21593. deprecated="not deprecated">
  21594. <doc>
  21595. <![CDATA[Path to war file or static content directory for this UI
  21596. (For pluggable UIs).]]>
  21597. </doc>
  21598. </field>
  21599. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX" type="java.lang.String"
  21600. transient="false" volatile="false"
  21601. static="true" final="true" visibility="public"
  21602. deprecated="not deprecated">
  21603. <doc>
  21604. <![CDATA[The setting for timeline service v1.5]]>
  21605. </doc>
  21606. </field>
  21607. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CACHE_STORE" type="java.lang.String"
  21608. transient="false" volatile="false"
  21609. static="true" final="true" visibility="public"
  21610. deprecated="not deprecated">
  21611. </field>
  21612. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_ACTIVE_DIR" type="java.lang.String"
  21613. transient="false" volatile="false"
  21614. static="true" final="true" visibility="public"
  21615. deprecated="not deprecated">
  21616. </field>
  21617. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_ACTIVE_DIR_DEFAULT" type="java.lang.String"
  21618. transient="false" volatile="false"
  21619. static="true" final="true" visibility="public"
  21620. deprecated="not deprecated">
  21621. </field>
  21622. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_DONE_DIR" type="java.lang.String"
  21623. transient="false" volatile="false"
  21624. static="true" final="true" visibility="public"
  21625. deprecated="not deprecated">
  21626. </field>
  21627. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_DONE_DIR_DEFAULT" type="java.lang.String"
  21628. transient="false" volatile="false"
  21629. static="true" final="true" visibility="public"
  21630. deprecated="not deprecated">
  21631. </field>
  21632. <field name="TIMELINE_SERVICE_ENTITY_GROUP_PLUGIN_CLASSES" type="java.lang.String"
  21633. transient="false" volatile="false"
  21634. static="true" final="true" visibility="public"
  21635. deprecated="not deprecated">
  21636. </field>
  21637. <field name="TIMELINE_SERVICE_ENTITY_GROUP_PLUGIN_CLASSPATH" type="java.lang.String"
  21638. transient="false" volatile="false"
  21639. static="true" final="true" visibility="public"
  21640. deprecated="not deprecated">
  21641. </field>
  21642. <field name="TIMELINE_SERVICE_ENTITY_GROUP_PLUGIN_SYSTEM_CLASSES" type="java.lang.String"
  21643. transient="false" volatile="false"
  21644. static="true" final="true" visibility="public"
  21645. deprecated="not deprecated">
  21646. </field>
  21647. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SUMMARY_STORE" type="java.lang.String"
  21648. transient="false" volatile="false"
  21649. static="true" final="true" visibility="public"
  21650. deprecated="not deprecated">
  21651. </field>
  21652. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SUMMARY_ENTITY_TYPES" type="java.lang.String"
  21653. transient="false" volatile="false"
  21654. static="true" final="true" visibility="public"
  21655. deprecated="not deprecated">
  21656. </field>
  21657. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SCAN_INTERVAL_SECONDS" type="java.lang.String"
  21658. transient="false" volatile="false"
  21659. static="true" final="true" visibility="public"
  21660. deprecated="not deprecated">
  21661. </field>
  21662. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SCAN_INTERVAL_SECONDS_DEFAULT" type="long"
  21663. transient="false" volatile="false"
  21664. static="true" final="true" visibility="public"
  21665. deprecated="not deprecated">
  21666. </field>
  21667. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_THREADS" type="java.lang.String"
  21668. transient="false" volatile="false"
  21669. static="true" final="true" visibility="public"
  21670. deprecated="not deprecated">
  21671. </field>
  21672. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_THREADS_DEFAULT" type="int"
  21673. transient="false" volatile="false"
  21674. static="true" final="true" visibility="public"
  21675. deprecated="not deprecated">
  21676. </field>
  21677. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_APP_CACHE_SIZE" type="java.lang.String"
  21678. transient="false" volatile="false"
  21679. static="true" final="true" visibility="public"
  21680. deprecated="not deprecated">
  21681. </field>
  21682. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_APP_CACHE_SIZE_DEFAULT" type="int"
  21683. transient="false" volatile="false"
  21684. static="true" final="true" visibility="public"
  21685. deprecated="not deprecated">
  21686. </field>
  21687. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CLEANER_INTERVAL_SECONDS" type="java.lang.String"
  21688. transient="false" volatile="false"
  21689. static="true" final="true" visibility="public"
  21690. deprecated="not deprecated">
  21691. </field>
  21692. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CLEANER_INTERVAL_SECONDS_DEFAULT" type="int"
  21693. transient="false" volatile="false"
  21694. static="true" final="true" visibility="public"
  21695. deprecated="not deprecated">
  21696. </field>
  21697. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETAIN_SECONDS" type="java.lang.String"
  21698. transient="false" volatile="false"
  21699. static="true" final="true" visibility="public"
  21700. deprecated="not deprecated">
  21701. </field>
  21702. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETAIN_SECONDS_DEFAULT" type="int"
  21703. transient="false" volatile="false"
  21704. static="true" final="true" visibility="public"
  21705. deprecated="not deprecated">
  21706. </field>
  21707. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_UNKNOWN_ACTIVE_SECONDS" type="java.lang.String"
  21708. transient="false" volatile="false"
  21709. static="true" final="true" visibility="public"
  21710. deprecated="not deprecated">
  21711. </field>
  21712. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_UNKNOWN_ACTIVE_SECONDS_DEFAULT" type="int"
  21713. transient="false" volatile="false"
  21714. static="true" final="true" visibility="public"
  21715. deprecated="not deprecated">
  21716. </field>
  21717. <field name="TIMELINE_SERVICE_LEVELDB_CACHE_READ_CACHE_SIZE" type="java.lang.String"
  21718. transient="false" volatile="false"
  21719. static="true" final="true" visibility="public"
  21720. deprecated="not deprecated">
  21721. </field>
  21722. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_CACHE_READ_CACHE_SIZE" type="long"
  21723. transient="false" volatile="false"
  21724. static="true" final="true" visibility="public"
  21725. deprecated="not deprecated">
  21726. </field>
  21727. <field name="TIMELINE_SERVICE_CLIENT_FD_FLUSH_INTERVAL_SECS" type="java.lang.String"
  21728. transient="false" volatile="false"
  21729. static="true" final="true" visibility="public"
  21730. deprecated="not deprecated">
  21731. </field>
  21732. <field name="TIMELINE_SERVICE_CLIENT_FD_FLUSH_INTERVAL_SECS_DEFAULT" type="long"
  21733. transient="false" volatile="false"
  21734. static="true" final="true" visibility="public"
  21735. deprecated="not deprecated">
  21736. </field>
  21737. <field name="TIMELINE_SERVICE_CLIENT_FD_CLEAN_INTERVAL_SECS" type="java.lang.String"
  21738. transient="false" volatile="false"
  21739. static="true" final="true" visibility="public"
  21740. deprecated="not deprecated">
  21741. </field>
  21742. <field name="TIMELINE_SERVICE_CLIENT_FD_CLEAN_INTERVAL_SECS_DEFAULT" type="long"
  21743. transient="false" volatile="false"
  21744. static="true" final="true" visibility="public"
  21745. deprecated="not deprecated">
  21746. </field>
  21747. <field name="TIMELINE_SERVICE_CLIENT_FD_RETAIN_SECS" type="java.lang.String"
  21748. transient="false" volatile="false"
  21749. static="true" final="true" visibility="public"
  21750. deprecated="not deprecated">
  21751. </field>
  21752. <field name="TIMELINE_SERVICE_CLIENT_FD_RETAIN_SECS_DEFAULT" type="long"
  21753. transient="false" volatile="false"
  21754. static="true" final="true" visibility="public"
  21755. deprecated="not deprecated">
  21756. </field>
  21757. <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_TIMERS_TTL_SECS" type="java.lang.String"
  21758. transient="false" volatile="false"
  21759. static="true" final="true" visibility="public"
  21760. deprecated="not deprecated">
  21761. </field>
  21762. <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_TIMERS_TTL_SECS_DEFAULT" type="long"
  21763. transient="false" volatile="false"
  21764. static="true" final="true" visibility="public"
  21765. deprecated="not deprecated">
  21766. </field>
  21767. <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_ATTEMPT_DIR_CACHE_SIZE" type="java.lang.String"
  21768. transient="false" volatile="false"
  21769. static="true" final="true" visibility="public"
  21770. deprecated="not deprecated">
  21771. </field>
  21772. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_INTERNAL_ATTEMPT_DIR_CACHE_SIZE" type="int"
  21773. transient="false" volatile="false"
  21774. static="true" final="true" visibility="public"
  21775. deprecated="not deprecated">
  21776. </field>
  21777. <field name="TIMELINE_SERVICE_ENTITYFILE_FS_SUPPORT_APPEND" type="java.lang.String"
  21778. transient="false" volatile="false"
  21779. static="true" final="true" visibility="public"
  21780. deprecated="not deprecated">
  21781. </field>
  21782. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_WITH_USER_DIR" type="java.lang.String"
  21783. transient="false" volatile="false"
  21784. static="true" final="true" visibility="public"
  21785. deprecated="not deprecated">
  21786. </field>
  21787. <field name="TIMELINE_SERVICE_READER_PREFIX" type="java.lang.String"
  21788. transient="false" volatile="false"
  21789. static="true" final="true" visibility="public"
  21790. deprecated="not deprecated">
  21791. <doc>
  21792. <![CDATA[Settings for timeline service v2.0.]]>
  21793. </doc>
  21794. </field>
  21795. <field name="TIMELINE_SERVICE_WRITER_CLASS" type="java.lang.String"
  21796. transient="false" volatile="false"
  21797. static="true" final="true" visibility="public"
  21798. deprecated="not deprecated">
  21799. </field>
  21800. <field name="DEFAULT_TIMELINE_SERVICE_WRITER_CLASS" type="java.lang.String"
  21801. transient="false" volatile="false"
  21802. static="true" final="true" visibility="public"
  21803. deprecated="not deprecated">
  21804. </field>
  21805. <field name="TIMELINE_SERVICE_READER_CLASS" type="java.lang.String"
  21806. transient="false" volatile="false"
  21807. static="true" final="true" visibility="public"
  21808. deprecated="not deprecated">
  21809. </field>
  21810. <field name="DEFAULT_TIMELINE_SERVICE_READER_CLASS" type="java.lang.String"
  21811. transient="false" volatile="false"
  21812. static="true" final="true" visibility="public"
  21813. deprecated="not deprecated">
  21814. </field>
  21815. <field name="DEFAULT_TIMELINE_SERVICE_HBASE_SCHEMA_PREFIX" type="java.lang.String"
  21816. transient="false" volatile="false"
  21817. static="true" final="true" visibility="public"
  21818. deprecated="not deprecated">
  21819. <doc>
  21820. <![CDATA[default schema prefix for hbase tables.]]>
  21821. </doc>
  21822. </field>
  21823. <field name="TIMELINE_SERVICE_HBASE_SCHEMA_PREFIX_NAME" type="java.lang.String"
  21824. transient="false" volatile="false"
  21825. static="true" final="true" visibility="public"
  21826. deprecated="not deprecated">
  21827. <doc>
  21828. <![CDATA[config param name to override schema prefix.]]>
  21829. </doc>
  21830. </field>
  21831. <field name="TIMELINE_SERVICE_WRITER_FLUSH_INTERVAL_SECONDS" type="java.lang.String"
  21832. transient="false" volatile="false"
  21833. static="true" final="true" visibility="public"
  21834. deprecated="not deprecated">
  21835. <doc>
  21836. <![CDATA[The setting that controls how often the timeline collector flushes the
  21837. timeline writer.]]>
  21838. </doc>
  21839. </field>
  21840. <field name="DEFAULT_TIMELINE_SERVICE_WRITER_FLUSH_INTERVAL_SECONDS" type="int"
  21841. transient="false" volatile="false"
  21842. static="true" final="true" visibility="public"
  21843. deprecated="not deprecated">
  21844. </field>
  21845. <field name="TIMELINE_SERVICE_WRITER_ASYNC_QUEUE_CAPACITY" type="java.lang.String"
  21846. transient="false" volatile="false"
  21847. static="true" final="true" visibility="public"
  21848. deprecated="not deprecated">
  21849. <doc>
  21850. <![CDATA[The setting that controls the capacity of the queue for async writes
  21851. to timeline collector.]]>
  21852. </doc>
  21853. </field>
  21854. <field name="DEFAULT_TIMELINE_SERVICE_WRITER_ASYNC_QUEUE_CAPACITY" type="int"
  21855. transient="false" volatile="false"
  21856. static="true" final="true" visibility="public"
  21857. deprecated="not deprecated">
  21858. </field>
  21859. <field name="APP_FINAL_VALUE_RETENTION_THRESHOLD" type="java.lang.String"
  21860. transient="false" volatile="false"
  21861. static="true" final="true" visibility="public"
  21862. deprecated="not deprecated">
  21863. <doc>
  21864. <![CDATA[The name for setting that controls how long the final value of
  21865. a metric of a completed app is retained before merging
  21866. into the flow sum.]]>
  21867. </doc>
  21868. </field>
  21869. <field name="FLOW_RUN_COPROCESSOR_JAR_HDFS_LOCATION" type="java.lang.String"
  21870. transient="false" volatile="false"
  21871. static="true" final="true" visibility="public"
  21872. deprecated="not deprecated">
  21873. <doc>
  21874. <![CDATA[The name of the setting for the location of the coprocessor
  21875. jar on hdfs.]]>
  21876. </doc>
  21877. </field>
  21878. <field name="DEFAULT_HDFS_LOCATION_FLOW_RUN_COPROCESSOR_JAR" type="java.lang.String"
  21879. transient="false" volatile="false"
  21880. static="true" final="true" visibility="public"
  21881. deprecated="not deprecated">
  21882. <doc>
  21883. <![CDATA[default hdfs location for flowrun coprocessor jar.]]>
  21884. </doc>
  21885. </field>
  21886. <field name="FLOW_NAME_MAX_SIZE" type="java.lang.String"
  21887. transient="false" volatile="false"
  21888. static="true" final="true" visibility="public"
  21889. deprecated="not deprecated">
  21890. <doc>
  21891. <![CDATA[This setting controls the max size of the flow name getting generated
  21892. in ATSv2 after removing UUID if present.]]>
  21893. </doc>
  21894. </field>
  21895. <field name="FLOW_NAME_DEFAULT_MAX_SIZE" type="int"
  21896. transient="false" volatile="false"
  21897. static="true" final="true" visibility="public"
  21898. deprecated="not deprecated">
  21899. <doc>
  21900. <![CDATA[Default setting for flow name size has no size restriction
  21901. after removing UUID if present.]]>
  21902. </doc>
  21903. </field>
  21904. <field name="TIMELINE_SERVICE_HBASE_CONFIGURATION_FILE" type="java.lang.String"
  21905. transient="false" volatile="false"
  21906. static="true" final="true" visibility="public"
  21907. deprecated="not deprecated">
  21908. <doc>
  21909. <![CDATA[The name for setting that points to an optional HBase configuration
  21910. (hbase-site.xml file) with settings that will override the ones found on
  21911. the classpath.]]>
  21912. </doc>
  21913. </field>
  21914. <field name="TIMELINE_SERVICE_READ_AUTH_ENABLED" type="java.lang.String"
  21915. transient="false" volatile="false"
  21916. static="true" final="true" visibility="public"
  21917. deprecated="not deprecated">
  21918. <doc>
  21919. <![CDATA[The name for setting that enables or disables authentication checks
  21920. for reading timeline service v2 data.]]>
  21921. </doc>
  21922. </field>
  21923. <field name="TIMELINE_SERVICE_AGGREGATION_INTERVAL_SECS" type="java.lang.String"
  21924. transient="false" volatile="false"
  21925. static="true" final="true" visibility="public"
  21926. deprecated="not deprecated">
  21927. <doc>
  21928. <![CDATA[The name for setting that controls how often in-memory app level
  21929. aggregation is kicked off in timeline collector.]]>
  21930. </doc>
  21931. </field>
  21932. <field name="DEFAULT_TIMELINE_SERVICE_AGGREGATION_INTERVAL_SECS" type="int"
  21933. transient="false" volatile="false"
  21934. static="true" final="true" visibility="public"
  21935. deprecated="not deprecated">
  21936. </field>
  21937. <field name="DEFAULT_TIMELINE_SERVICE_READ_AUTH_ENABLED" type="java.lang.Boolean"
  21938. transient="false" volatile="false"
  21939. static="true" final="true" visibility="public"
  21940. deprecated="not deprecated">
  21941. <doc>
  21942. <![CDATA[The default setting for authentication checks for reading timeline
  21943. service v2 data.]]>
  21944. </doc>
  21945. </field>
  21946. <field name="TIMELINE_SERVICE_READ_ALLOWED_USERS" type="java.lang.String"
  21947. transient="false" volatile="false"
  21948. static="true" final="true" visibility="public"
  21949. deprecated="not deprecated">
  21950. <doc>
  21951. <![CDATA[The name for setting that lists the users and groups who are allowed
  21952. to read timeline service v2 data. It is a comma separated list of
  21953. user, followed by space, then comma separated list of groups.
  21954. It will allow this list of users and groups to read the data
  21955. and reject everyone else.]]>
  21956. </doc>
  21957. </field>
  21958. <field name="DEFAULT_TIMELINE_SERVICE_READ_ALLOWED_USERS" type="java.lang.String"
  21959. transient="false" volatile="false"
  21960. static="true" final="true" visibility="public"
  21961. deprecated="not deprecated">
  21962. <doc>
  21963. <![CDATA[The default value for list of the users who are allowed to read
  21964. timeline service v2 data.]]>
  21965. </doc>
  21966. </field>
  21967. <field name="DEFAULT_APP_FINAL_VALUE_RETENTION_THRESHOLD" type="long"
  21968. transient="false" volatile="false"
  21969. static="true" final="true" visibility="public"
  21970. deprecated="not deprecated">
  21971. <doc>
  21972. <![CDATA[The setting that controls how long the final value of a metric of a
  21973. completed app is retained before merging into the flow sum. Up to this time
  21974. after an application is completed out-of-order values that arrive can be
  21975. recognized and discarded at the cost of increased storage.]]>
  21976. </doc>
  21977. </field>
  21978. <field name="ATS_APP_COLLECTOR_LINGER_PERIOD_IN_MS" type="java.lang.String"
  21979. transient="false" volatile="false"
  21980. static="true" final="true" visibility="public"
  21981. deprecated="not deprecated">
  21982. </field>
  21983. <field name="DEFAULT_ATS_APP_COLLECTOR_LINGER_PERIOD_IN_MS" type="int"
  21984. transient="false" volatile="false"
  21985. static="true" final="true" visibility="public"
  21986. deprecated="not deprecated">
  21987. </field>
  21988. <field name="NUMBER_OF_ASYNC_ENTITIES_TO_MERGE" type="java.lang.String"
  21989. transient="false" volatile="false"
  21990. static="true" final="true" visibility="public"
  21991. deprecated="not deprecated">
  21992. </field>
  21993. <field name="DEFAULT_NUMBER_OF_ASYNC_ENTITIES_TO_MERGE" type="int"
  21994. transient="false" volatile="false"
  21995. static="true" final="true" visibility="public"
  21996. deprecated="not deprecated">
  21997. </field>
  21998. <field name="DEFAULT_FLOW_VERSION" type="java.lang.String"
  21999. transient="false" volatile="false"
  22000. static="true" final="true" visibility="public"
  22001. deprecated="not deprecated">
  22002. <doc>
  22003. <![CDATA[default version for any flow.]]>
  22004. </doc>
  22005. </field>
  22006. <field name="TIMELINE_V2_CLIENT_DRAIN_TIME_MILLIS" type="java.lang.String"
  22007. transient="false" volatile="false"
  22008. static="true" final="true" visibility="public"
  22009. deprecated="not deprecated">
  22010. <doc>
  22011. <![CDATA[The time period for which timeline v2 client will wait for draining
  22012. leftover entities after stop.]]>
  22013. </doc>
  22014. </field>
  22015. <field name="DEFAULT_TIMELINE_V2_CLIENT_DRAIN_TIME_MILLIS" type="long"
  22016. transient="false" volatile="false"
  22017. static="true" final="true" visibility="public"
  22018. deprecated="not deprecated">
  22019. </field>
  22020. <field name="APPLICATION_HISTORY_PREFIX" type="java.lang.String"
  22021. transient="false" volatile="false"
  22022. static="true" final="true" visibility="public"
  22023. deprecated="not deprecated">
  22024. </field>
  22025. <field name="APPLICATION_HISTORY_ENABLED" type="java.lang.String"
  22026. transient="false" volatile="false"
  22027. static="true" final="true" visibility="public"
  22028. deprecated="not deprecated">
  22029. <doc>
  22030. <![CDATA[The setting that controls whether application history service is
  22031. enabled or not.]]>
  22032. </doc>
  22033. </field>
  22034. <field name="DEFAULT_APPLICATION_HISTORY_ENABLED" type="boolean"
  22035. transient="false" volatile="false"
  22036. static="true" final="true" visibility="public"
  22037. deprecated="not deprecated">
  22038. </field>
  22039. <field name="APPLICATION_HISTORY_STORE" type="java.lang.String"
  22040. transient="false" volatile="false"
  22041. static="true" final="true" visibility="public"
  22042. deprecated="not deprecated">
  22043. <doc>
  22044. <![CDATA[Application history store class]]>
  22045. </doc>
  22046. </field>
  22047. <field name="APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="java.lang.String"
  22048. transient="false" volatile="false"
  22049. static="true" final="true" visibility="public"
  22050. deprecated="not deprecated">
  22051. <doc>
  22052. <![CDATA[Save container meta-info in the application history store.]]>
  22053. </doc>
  22054. </field>
  22055. <field name="DEFAULT_APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="boolean"
  22056. transient="false" volatile="false"
  22057. static="true" final="true" visibility="public"
  22058. deprecated="not deprecated">
  22059. </field>
  22060. <field name="FS_APPLICATION_HISTORY_STORE_URI" type="java.lang.String"
  22061. transient="false" volatile="false"
  22062. static="true" final="true" visibility="public"
  22063. deprecated="not deprecated">
  22064. <doc>
  22065. <![CDATA[URI for FileSystemApplicationHistoryStore]]>
  22066. </doc>
  22067. </field>
  22068. <field name="FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
  22069. transient="false" volatile="false"
  22070. static="true" final="true" visibility="public"
  22071. deprecated="not deprecated">
  22072. <doc>
  22073. <![CDATA[T-file compression types used to compress history data.]]>
  22074. </doc>
  22075. </field>
  22076. <field name="DEFAULT_FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
  22077. transient="false" volatile="false"
  22078. static="true" final="true" visibility="public"
  22079. deprecated="not deprecated">
  22080. </field>
  22081. <field name="TIMELINE_SERVICE_ENABLED" type="java.lang.String"
  22082. transient="false" volatile="false"
  22083. static="true" final="true" visibility="public"
  22084. deprecated="not deprecated">
  22085. <doc>
  22086. <![CDATA[The setting that controls whether timeline service is enabled or not.]]>
  22087. </doc>
  22088. </field>
  22089. <field name="DEFAULT_TIMELINE_SERVICE_ENABLED" type="boolean"
  22090. transient="false" volatile="false"
  22091. static="true" final="true" visibility="public"
  22092. deprecated="not deprecated">
  22093. </field>
  22094. <field name="TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
  22095. transient="false" volatile="false"
  22096. static="true" final="true" visibility="public"
  22097. deprecated="not deprecated">
  22098. <doc>
  22099. <![CDATA[host:port address for timeline service RPC APIs.]]>
  22100. </doc>
  22101. </field>
  22102. <field name="DEFAULT_TIMELINE_SERVICE_PORT" type="int"
  22103. transient="false" volatile="false"
  22104. static="true" final="true" visibility="public"
  22105. deprecated="not deprecated">
  22106. </field>
  22107. <field name="DEFAULT_TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
  22108. transient="false" volatile="false"
  22109. static="true" final="true" visibility="public"
  22110. deprecated="not deprecated">
  22111. </field>
  22112. <field name="TIMELINE_SERVICE_BIND_HOST" type="java.lang.String"
  22113. transient="false" volatile="false"
  22114. static="true" final="true" visibility="public"
  22115. deprecated="not deprecated">
  22116. <doc>
  22117. <![CDATA[The listening endpoint for the timeline service application.]]>
  22118. </doc>
  22119. </field>
  22120. <field name="DEFAULT_TIMELINE_SERVICE_BIND_HOST" type="java.lang.String"
  22121. transient="false" volatile="false"
  22122. static="true" final="true" visibility="public"
  22123. deprecated="not deprecated">
  22124. </field>
  22125. <field name="TIMELINE_SERVICE_HANDLER_THREAD_COUNT" type="java.lang.String"
  22126. transient="false" volatile="false"
  22127. static="true" final="true" visibility="public"
  22128. deprecated="not deprecated">
  22129. <doc>
  22130. <![CDATA[The number of threads to handle client RPC API requests.]]>
  22131. </doc>
  22132. </field>
  22133. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_THREAD_COUNT" type="int"
  22134. transient="false" volatile="false"
  22135. static="true" final="true" visibility="public"
  22136. deprecated="not deprecated">
  22137. </field>
  22138. <field name="TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
  22139. transient="false" volatile="false"
  22140. static="true" final="true" visibility="public"
  22141. deprecated="not deprecated">
  22142. <doc>
  22143. <![CDATA[The address of the timeline service web application.]]>
  22144. </doc>
  22145. </field>
  22146. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_PORT" type="int"
  22147. transient="false" volatile="false"
  22148. static="true" final="true" visibility="public"
  22149. deprecated="not deprecated">
  22150. </field>
  22151. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
  22152. transient="false" volatile="false"
  22153. static="true" final="true" visibility="public"
  22154. deprecated="not deprecated">
  22155. </field>
  22156. <field name="TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  22157. transient="false" volatile="false"
  22158. static="true" final="true" visibility="public"
  22159. deprecated="not deprecated">
  22160. <doc>
  22161. <![CDATA[The https address of the timeline service web application.]]>
  22162. </doc>
  22163. </field>
  22164. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_PORT" type="int"
  22165. transient="false" volatile="false"
  22166. static="true" final="true" visibility="public"
  22167. deprecated="not deprecated">
  22168. </field>
  22169. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  22170. transient="false" volatile="false"
  22171. static="true" final="true" visibility="public"
  22172. deprecated="not deprecated">
  22173. </field>
  22174. <field name="APPLICATION_HISTORY_MAX_APPS" type="java.lang.String"
  22175. transient="false" volatile="false"
  22176. static="true" final="true" visibility="public"
  22177. deprecated="not deprecated">
  22178. <doc>
  22179. <![CDATA[Defines the max number of applications could be fetched using
  22180. REST API or application history protocol and shown in timeline
  22181. server web ui.]]>
  22182. </doc>
  22183. </field>
  22184. <field name="DEFAULT_APPLICATION_HISTORY_MAX_APPS" type="long"
  22185. transient="false" volatile="false"
  22186. static="true" final="true" visibility="public"
  22187. deprecated="not deprecated">
  22188. </field>
  22189. <field name="TIMELINE_SERVICE_STORE" type="java.lang.String"
  22190. transient="false" volatile="false"
  22191. static="true" final="true" visibility="public"
  22192. deprecated="not deprecated">
  22193. <doc>
  22194. <![CDATA[Timeline service store class.]]>
  22195. </doc>
  22196. </field>
  22197. <field name="TIMELINE_SERVICE_TTL_ENABLE" type="java.lang.String"
  22198. transient="false" volatile="false"
  22199. static="true" final="true" visibility="public"
  22200. deprecated="not deprecated">
  22201. <doc>
  22202. <![CDATA[Timeline service enable data age off]]>
  22203. </doc>
  22204. </field>
  22205. <field name="TIMELINE_SERVICE_TTL_MS" type="java.lang.String"
  22206. transient="false" volatile="false"
  22207. static="true" final="true" visibility="public"
  22208. deprecated="not deprecated">
  22209. <doc>
  22210. <![CDATA[Timeline service length of time to retain data]]>
  22211. </doc>
  22212. </field>
  22213. <field name="DEFAULT_TIMELINE_SERVICE_TTL_MS" type="long"
  22214. transient="false" volatile="false"
  22215. static="true" final="true" visibility="public"
  22216. deprecated="not deprecated">
  22217. </field>
  22218. <field name="TIMELINE_SERVICE_ROLLING_PERIOD" type="java.lang.String"
  22219. transient="false" volatile="false"
  22220. static="true" final="true" visibility="public"
  22221. deprecated="not deprecated">
  22222. <doc>
  22223. <![CDATA[Timeline service rolling period. Valid values are daily, half_daily,
  22224. quarter_daily, and hourly.]]>
  22225. </doc>
  22226. </field>
  22227. <field name="DEFAULT_TIMELINE_SERVICE_ROLLING_PERIOD" type="java.lang.String"
  22228. transient="false" volatile="false"
  22229. static="true" final="true" visibility="public"
  22230. deprecated="not deprecated">
  22231. <doc>
  22232. <![CDATA[Roll a new database each hour.]]>
  22233. </doc>
  22234. </field>
  22235. <field name="TIMELINE_SERVICE_LEVELDB_PREFIX" type="java.lang.String"
  22236. transient="false" volatile="false"
  22237. static="true" final="true" visibility="public"
  22238. deprecated="not deprecated">
  22239. <doc>
  22240. <![CDATA[Implementation specific configuration prefix for Timeline Service
  22241. leveldb.]]>
  22242. </doc>
  22243. </field>
  22244. <field name="TIMELINE_SERVICE_LEVELDB_PATH" type="java.lang.String"
  22245. transient="false" volatile="false"
  22246. static="true" final="true" visibility="public"
  22247. deprecated="not deprecated">
  22248. <doc>
  22249. <![CDATA[Timeline service leveldb path]]>
  22250. </doc>
  22251. </field>
  22252. <field name="TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="java.lang.String"
  22253. transient="false" volatile="false"
  22254. static="true" final="true" visibility="public"
  22255. deprecated="not deprecated">
  22256. <doc>
  22257. <![CDATA[Timeline service leveldb read cache (uncompressed blocks). This is
  22258. per rolling instance so should be tuned if using rolling leveldb
  22259. timeline store]]>
  22260. </doc>
  22261. </field>
  22262. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="long"
  22263. transient="false" volatile="false"
  22264. static="true" final="true" visibility="public"
  22265. deprecated="not deprecated">
  22266. <doc>
  22267. <![CDATA[Default leveldb read cache size if no configuration is specified.]]>
  22268. </doc>
  22269. </field>
  22270. <field name="TIMELINE_SERVICE_LEVELDB_WRITE_BUFFER_SIZE" type="java.lang.String"
  22271. transient="false" volatile="false"
  22272. static="true" final="true" visibility="public"
  22273. deprecated="not deprecated">
  22274. <doc>
  22275. <![CDATA[Timeline service leveldb write buffer size.]]>
  22276. </doc>
  22277. </field>
  22278. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_WRITE_BUFFER_SIZE" type="int"
  22279. transient="false" volatile="false"
  22280. static="true" final="true" visibility="public"
  22281. deprecated="not deprecated">
  22282. <doc>
  22283. <![CDATA[Default leveldb write buffer size if no configuration is specified. This
  22284. is per rolling instance so should be tuned if using rolling leveldb
  22285. timeline store.]]>
  22286. </doc>
  22287. </field>
  22288. <field name="TIMELINE_SERVICE_LEVELDB_WRITE_BATCH_SIZE" type="java.lang.String"
  22289. transient="false" volatile="false"
  22290. static="true" final="true" visibility="public"
  22291. deprecated="not deprecated">
  22292. <doc>
  22293. <![CDATA[Timeline service leveldb write batch size. This value can be tuned down
  22294. to reduce lock time for ttl eviction.]]>
  22295. </doc>
  22296. </field>
  22297. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_WRITE_BATCH_SIZE" type="int"
  22298. transient="false" volatile="false"
  22299. static="true" final="true" visibility="public"
  22300. deprecated="not deprecated">
  22301. <doc>
  22302. <![CDATA[Default leveldb write batch size is no configuration is specified]]>
  22303. </doc>
  22304. </field>
  22305. <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="java.lang.String"
  22306. transient="false" volatile="false"
  22307. static="true" final="true" visibility="public"
  22308. deprecated="not deprecated">
  22309. <doc>
  22310. <![CDATA[Timeline service leveldb start time read cache (number of entities)]]>
  22311. </doc>
  22312. </field>
  22313. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="int"
  22314. transient="false" volatile="false"
  22315. static="true" final="true" visibility="public"
  22316. deprecated="not deprecated">
  22317. </field>
  22318. <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="java.lang.String"
  22319. transient="false" volatile="false"
  22320. static="true" final="true" visibility="public"
  22321. deprecated="not deprecated">
  22322. <doc>
  22323. <![CDATA[Timeline service leveldb start time write cache (number of entities)]]>
  22324. </doc>
  22325. </field>
  22326. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="int"
  22327. transient="false" volatile="false"
  22328. static="true" final="true" visibility="public"
  22329. deprecated="not deprecated">
  22330. </field>
  22331. <field name="TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="java.lang.String"
  22332. transient="false" volatile="false"
  22333. static="true" final="true" visibility="public"
  22334. deprecated="not deprecated">
  22335. <doc>
  22336. <![CDATA[Timeline service leveldb interval to wait between deletion rounds]]>
  22337. </doc>
  22338. </field>
  22339. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="long"
  22340. transient="false" volatile="false"
  22341. static="true" final="true" visibility="public"
  22342. deprecated="not deprecated">
  22343. </field>
  22344. <field name="TIMELINE_SERVICE_LEVELDB_MAX_OPEN_FILES" type="java.lang.String"
  22345. transient="false" volatile="false"
  22346. static="true" final="true" visibility="public"
  22347. deprecated="not deprecated">
  22348. <doc>
  22349. <![CDATA[Timeline service leveldb number of concurrent open files. Tuned this
  22350. configuration to stay within system limits. This is per rolling instance
  22351. so should be tuned if using rolling leveldb timeline store.]]>
  22352. </doc>
  22353. </field>
  22354. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_MAX_OPEN_FILES" type="int"
  22355. transient="false" volatile="false"
  22356. static="true" final="true" visibility="public"
  22357. deprecated="not deprecated">
  22358. <doc>
  22359. <![CDATA[Default leveldb max open files if no configuration is specified.]]>
  22360. </doc>
  22361. </field>
  22362. <field name="TIMELINE_SERVICE_PRINCIPAL" type="java.lang.String"
  22363. transient="false" volatile="false"
  22364. static="true" final="true" visibility="public"
  22365. deprecated="not deprecated">
  22366. <doc>
  22367. <![CDATA[The Kerberos principal for the timeline server.]]>
  22368. </doc>
  22369. </field>
  22370. <field name="TIMELINE_SERVICE_KEYTAB" type="java.lang.String"
  22371. transient="false" volatile="false"
  22372. static="true" final="true" visibility="public"
  22373. deprecated="not deprecated">
  22374. <doc>
  22375. <![CDATA[The Kerberos keytab for the timeline server.]]>
  22376. </doc>
  22377. </field>
  22378. <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED" type="java.lang.String"
  22379. transient="false" volatile="false"
  22380. static="true" final="true" visibility="public"
  22381. deprecated="not deprecated">
  22382. <doc>
  22383. <![CDATA[Enables cross origin support for timeline server.]]>
  22384. </doc>
  22385. </field>
  22386. <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED_DEFAULT" type="boolean"
  22387. transient="false" volatile="false"
  22388. static="true" final="true" visibility="public"
  22389. deprecated="not deprecated">
  22390. <doc>
  22391. <![CDATA[Default value for cross origin support for timeline server.]]>
  22392. </doc>
  22393. </field>
  22394. <field name="TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="java.lang.String"
  22395. transient="false" volatile="false"
  22396. static="true" final="true" visibility="public"
  22397. deprecated="not deprecated">
  22398. <doc>
  22399. <![CDATA[Timeline client call, max retries (-1 means no limit)]]>
  22400. </doc>
  22401. </field>
  22402. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="int"
  22403. transient="false" volatile="false"
  22404. static="true" final="true" visibility="public"
  22405. deprecated="not deprecated">
  22406. </field>
  22407. <field name="TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="java.lang.String"
  22408. transient="false" volatile="false"
  22409. static="true" final="true" visibility="public"
  22410. deprecated="not deprecated">
  22411. <doc>
  22412. <![CDATA[Timeline client call, retry interval]]>
  22413. </doc>
  22414. </field>
  22415. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="long"
  22416. transient="false" volatile="false"
  22417. static="true" final="true" visibility="public"
  22418. deprecated="not deprecated">
  22419. </field>
  22420. <field name="TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="java.lang.String"
  22421. transient="false" volatile="false"
  22422. static="true" final="true" visibility="public"
  22423. deprecated="not deprecated">
  22424. <doc>
  22425. <![CDATA[Timeline client policy for whether connections are fatal]]>
  22426. </doc>
  22427. </field>
  22428. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="boolean"
  22429. transient="false" volatile="false"
  22430. static="true" final="true" visibility="public"
  22431. deprecated="not deprecated">
  22432. </field>
  22433. <field name="TIMELINE_SERVICE_RECOVERY_ENABLED" type="java.lang.String"
  22434. transient="false" volatile="false"
  22435. static="true" final="true" visibility="public"
  22436. deprecated="not deprecated">
  22437. <doc>
  22438. <![CDATA[Flag to enable recovery of timeline service]]>
  22439. </doc>
  22440. </field>
  22441. <field name="DEFAULT_TIMELINE_SERVICE_RECOVERY_ENABLED" type="boolean"
  22442. transient="false" volatile="false"
  22443. static="true" final="true" visibility="public"
  22444. deprecated="not deprecated">
  22445. </field>
  22446. <field name="TIMELINE_SERVICE_STATE_STORE_CLASS" type="java.lang.String"
  22447. transient="false" volatile="false"
  22448. static="true" final="true" visibility="public"
  22449. deprecated="not deprecated">
  22450. <doc>
  22451. <![CDATA[Timeline service state store class]]>
  22452. </doc>
  22453. </field>
  22454. <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PREFIX" type="java.lang.String"
  22455. transient="false" volatile="false"
  22456. static="true" final="true" visibility="public"
  22457. deprecated="not deprecated">
  22458. </field>
  22459. <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PATH" type="java.lang.String"
  22460. transient="false" volatile="false"
  22461. static="true" final="true" visibility="public"
  22462. deprecated="not deprecated">
  22463. <doc>
  22464. <![CDATA[Timeline service state store leveldb path]]>
  22465. </doc>
  22466. </field>
  22467. <field name="TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="java.lang.String"
  22468. transient="false" volatile="false"
  22469. static="true" final="true" visibility="public"
  22470. deprecated="not deprecated">
  22471. </field>
  22472. <field name="DEFAULT_TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="long"
  22473. transient="false" volatile="false"
  22474. static="true" final="true" visibility="public"
  22475. deprecated="not deprecated">
  22476. </field>
  22477. <field name="TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="java.lang.String"
  22478. transient="false" volatile="false"
  22479. static="true" final="true" visibility="public"
  22480. deprecated="not deprecated">
  22481. </field>
  22482. <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="long"
  22483. transient="false" volatile="false"
  22484. static="true" final="true" visibility="public"
  22485. deprecated="not deprecated">
  22486. </field>
  22487. <field name="TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="java.lang.String"
  22488. transient="false" volatile="false"
  22489. static="true" final="true" visibility="public"
  22490. deprecated="not deprecated">
  22491. </field>
  22492. <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="long"
  22493. transient="false" volatile="false"
  22494. static="true" final="true" visibility="public"
  22495. deprecated="not deprecated">
  22496. </field>
  22497. <field name="TIMELINE_OFFLINE_AGGREGATION_PREFIX" type="java.lang.String"
  22498. transient="false" volatile="false"
  22499. static="true" final="true" visibility="public"
  22500. deprecated="not deprecated">
  22501. </field>
  22502. <field name="PHOENIX_OFFLINE_STORAGE_CONN_STR" type="java.lang.String"
  22503. transient="false" volatile="false"
  22504. static="true" final="true" visibility="public"
  22505. deprecated="not deprecated">
  22506. </field>
  22507. <field name="PHOENIX_OFFLINE_STORAGE_CONN_STR_DEFAULT" type="java.lang.String"
  22508. transient="false" volatile="false"
  22509. static="true" final="true" visibility="public"
  22510. deprecated="not deprecated">
  22511. </field>
  22512. <field name="SHARED_CACHE_PREFIX" type="java.lang.String"
  22513. transient="false" volatile="false"
  22514. static="true" final="true" visibility="public"
  22515. deprecated="not deprecated">
  22516. </field>
  22517. <field name="SHARED_CACHE_ENABLED" type="java.lang.String"
  22518. transient="false" volatile="false"
  22519. static="true" final="true" visibility="public"
  22520. deprecated="not deprecated">
  22521. <doc>
  22522. <![CDATA[whether the shared cache is enabled/disabled]]>
  22523. </doc>
  22524. </field>
  22525. <field name="DEFAULT_SHARED_CACHE_ENABLED" type="boolean"
  22526. transient="false" volatile="false"
  22527. static="true" final="true" visibility="public"
  22528. deprecated="not deprecated">
  22529. </field>
  22530. <field name="SHARED_CACHE_ROOT" type="java.lang.String"
  22531. transient="false" volatile="false"
  22532. static="true" final="true" visibility="public"
  22533. deprecated="not deprecated">
  22534. <doc>
  22535. <![CDATA[The config key for the shared cache root directory.]]>
  22536. </doc>
  22537. </field>
  22538. <field name="DEFAULT_SHARED_CACHE_ROOT" type="java.lang.String"
  22539. transient="false" volatile="false"
  22540. static="true" final="true" visibility="public"
  22541. deprecated="not deprecated">
  22542. </field>
  22543. <field name="SHARED_CACHE_NESTED_LEVEL" type="java.lang.String"
  22544. transient="false" volatile="false"
  22545. static="true" final="true" visibility="public"
  22546. deprecated="not deprecated">
  22547. <doc>
  22548. <![CDATA[The config key for the level of nested directories before getting to the
  22549. checksum directory.]]>
  22550. </doc>
  22551. </field>
  22552. <field name="DEFAULT_SHARED_CACHE_NESTED_LEVEL" type="int"
  22553. transient="false" volatile="false"
  22554. static="true" final="true" visibility="public"
  22555. deprecated="not deprecated">
  22556. </field>
  22557. <field name="SCM_STORE_PREFIX" type="java.lang.String"
  22558. transient="false" volatile="false"
  22559. static="true" final="true" visibility="public"
  22560. deprecated="not deprecated">
  22561. </field>
  22562. <field name="SCM_STORE_CLASS" type="java.lang.String"
  22563. transient="false" volatile="false"
  22564. static="true" final="true" visibility="public"
  22565. deprecated="not deprecated">
  22566. </field>
  22567. <field name="DEFAULT_SCM_STORE_CLASS" type="java.lang.String"
  22568. transient="false" volatile="false"
  22569. static="true" final="true" visibility="public"
  22570. deprecated="not deprecated">
  22571. </field>
  22572. <field name="SCM_APP_CHECKER_CLASS" type="java.lang.String"
  22573. transient="false" volatile="false"
  22574. static="true" final="true" visibility="public"
  22575. deprecated="not deprecated">
  22576. </field>
  22577. <field name="DEFAULT_SCM_APP_CHECKER_CLASS" type="java.lang.String"
  22578. transient="false" volatile="false"
  22579. static="true" final="true" visibility="public"
  22580. deprecated="not deprecated">
  22581. </field>
  22582. <field name="SCM_ADMIN_ADDRESS" type="java.lang.String"
  22583. transient="false" volatile="false"
  22584. static="true" final="true" visibility="public"
  22585. deprecated="not deprecated">
  22586. <doc>
  22587. <![CDATA[The address of the SCM admin interface.]]>
  22588. </doc>
  22589. </field>
  22590. <field name="DEFAULT_SCM_ADMIN_PORT" type="int"
  22591. transient="false" volatile="false"
  22592. static="true" final="true" visibility="public"
  22593. deprecated="not deprecated">
  22594. </field>
  22595. <field name="DEFAULT_SCM_ADMIN_ADDRESS" type="java.lang.String"
  22596. transient="false" volatile="false"
  22597. static="true" final="true" visibility="public"
  22598. deprecated="not deprecated">
  22599. </field>
  22600. <field name="SCM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
  22601. transient="false" volatile="false"
  22602. static="true" final="true" visibility="public"
  22603. deprecated="not deprecated">
  22604. <doc>
  22605. <![CDATA[Number of threads used to handle SCM admin interface.]]>
  22606. </doc>
  22607. </field>
  22608. <field name="DEFAULT_SCM_ADMIN_CLIENT_THREAD_COUNT" type="int"
  22609. transient="false" volatile="false"
  22610. static="true" final="true" visibility="public"
  22611. deprecated="not deprecated">
  22612. </field>
  22613. <field name="SCM_WEBAPP_ADDRESS" type="java.lang.String"
  22614. transient="false" volatile="false"
  22615. static="true" final="true" visibility="public"
  22616. deprecated="not deprecated">
  22617. <doc>
  22618. <![CDATA[The address of the SCM web application.]]>
  22619. </doc>
  22620. </field>
  22621. <field name="DEFAULT_SCM_WEBAPP_PORT" type="int"
  22622. transient="false" volatile="false"
  22623. static="true" final="true" visibility="public"
  22624. deprecated="not deprecated">
  22625. </field>
  22626. <field name="DEFAULT_SCM_WEBAPP_ADDRESS" type="java.lang.String"
  22627. transient="false" volatile="false"
  22628. static="true" final="true" visibility="public"
  22629. deprecated="not deprecated">
  22630. </field>
  22631. <field name="IN_MEMORY_STORE_PREFIX" type="java.lang.String"
  22632. transient="false" volatile="false"
  22633. static="true" final="true" visibility="public"
  22634. deprecated="not deprecated">
  22635. </field>
  22636. <field name="IN_MEMORY_STALENESS_PERIOD_MINS" type="java.lang.String"
  22637. transient="false" volatile="false"
  22638. static="true" final="true" visibility="public"
  22639. deprecated="not deprecated">
  22640. <doc>
  22641. <![CDATA[A resource in the InMemorySCMStore is considered stale if the time since
  22642. the last reference exceeds the staleness period. This value is specified in
  22643. minutes.]]>
  22644. </doc>
  22645. </field>
  22646. <field name="DEFAULT_IN_MEMORY_STALENESS_PERIOD_MINS" type="int"
  22647. transient="false" volatile="false"
  22648. static="true" final="true" visibility="public"
  22649. deprecated="not deprecated">
  22650. </field>
  22651. <field name="IN_MEMORY_INITIAL_DELAY_MINS" type="java.lang.String"
  22652. transient="false" volatile="false"
  22653. static="true" final="true" visibility="public"
  22654. deprecated="not deprecated">
  22655. <doc>
  22656. <![CDATA[Initial delay before the in-memory store runs its first check to remove
  22657. dead initial applications. Specified in minutes.]]>
  22658. </doc>
  22659. </field>
  22660. <field name="DEFAULT_IN_MEMORY_INITIAL_DELAY_MINS" type="int"
  22661. transient="false" volatile="false"
  22662. static="true" final="true" visibility="public"
  22663. deprecated="not deprecated">
  22664. </field>
  22665. <field name="IN_MEMORY_CHECK_PERIOD_MINS" type="java.lang.String"
  22666. transient="false" volatile="false"
  22667. static="true" final="true" visibility="public"
  22668. deprecated="not deprecated">
  22669. <doc>
  22670. <![CDATA[The frequency at which the in-memory store checks to remove dead initial
  22671. applications. Specified in minutes.]]>
  22672. </doc>
  22673. </field>
  22674. <field name="DEFAULT_IN_MEMORY_CHECK_PERIOD_MINS" type="int"
  22675. transient="false" volatile="false"
  22676. static="true" final="true" visibility="public"
  22677. deprecated="not deprecated">
  22678. </field>
  22679. <field name="SCM_CLEANER_PERIOD_MINS" type="java.lang.String"
  22680. transient="false" volatile="false"
  22681. static="true" final="true" visibility="public"
  22682. deprecated="not deprecated">
  22683. <doc>
  22684. <![CDATA[The frequency at which a cleaner task runs. Specified in minutes.]]>
  22685. </doc>
  22686. </field>
  22687. <field name="DEFAULT_SCM_CLEANER_PERIOD_MINS" type="int"
  22688. transient="false" volatile="false"
  22689. static="true" final="true" visibility="public"
  22690. deprecated="not deprecated">
  22691. </field>
  22692. <field name="SCM_CLEANER_INITIAL_DELAY_MINS" type="java.lang.String"
  22693. transient="false" volatile="false"
  22694. static="true" final="true" visibility="public"
  22695. deprecated="not deprecated">
  22696. <doc>
  22697. <![CDATA[Initial delay before the first cleaner task is scheduled. Specified in
  22698. minutes.]]>
  22699. </doc>
  22700. </field>
  22701. <field name="DEFAULT_SCM_CLEANER_INITIAL_DELAY_MINS" type="int"
  22702. transient="false" volatile="false"
  22703. static="true" final="true" visibility="public"
  22704. deprecated="not deprecated">
  22705. </field>
  22706. <field name="SCM_CLEANER_RESOURCE_SLEEP_MS" type="java.lang.String"
  22707. transient="false" volatile="false"
  22708. static="true" final="true" visibility="public"
  22709. deprecated="not deprecated">
  22710. <doc>
  22711. <![CDATA[The time to sleep between processing each shared cache resource. Specified
  22712. in milliseconds.]]>
  22713. </doc>
  22714. </field>
  22715. <field name="DEFAULT_SCM_CLEANER_RESOURCE_SLEEP_MS" type="long"
  22716. transient="false" volatile="false"
  22717. static="true" final="true" visibility="public"
  22718. deprecated="not deprecated">
  22719. </field>
  22720. <field name="SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
  22721. transient="false" volatile="false"
  22722. static="true" final="true" visibility="public"
  22723. deprecated="not deprecated">
  22724. <doc>
  22725. <![CDATA[The address of the node manager interface in the SCM.]]>
  22726. </doc>
  22727. </field>
  22728. <field name="DEFAULT_SCM_UPLOADER_SERVER_PORT" type="int"
  22729. transient="false" volatile="false"
  22730. static="true" final="true" visibility="public"
  22731. deprecated="not deprecated">
  22732. </field>
  22733. <field name="DEFAULT_SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
  22734. transient="false" volatile="false"
  22735. static="true" final="true" visibility="public"
  22736. deprecated="not deprecated">
  22737. </field>
  22738. <field name="SCM_UPLOADER_SERVER_THREAD_COUNT" type="java.lang.String"
  22739. transient="false" volatile="false"
  22740. static="true" final="true" visibility="public"
  22741. deprecated="not deprecated">
  22742. <doc>
  22743. <![CDATA[The number of SCM threads used to handle notify requests from the node
  22744. manager.]]>
  22745. </doc>
  22746. </field>
  22747. <field name="DEFAULT_SCM_UPLOADER_SERVER_THREAD_COUNT" type="int"
  22748. transient="false" volatile="false"
  22749. static="true" final="true" visibility="public"
  22750. deprecated="not deprecated">
  22751. </field>
  22752. <field name="SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
  22753. transient="false" volatile="false"
  22754. static="true" final="true" visibility="public"
  22755. deprecated="not deprecated">
  22756. <doc>
  22757. <![CDATA[The address of the client interface in the SCM.]]>
  22758. </doc>
  22759. </field>
  22760. <field name="DEFAULT_SCM_CLIENT_SERVER_PORT" type="int"
  22761. transient="false" volatile="false"
  22762. static="true" final="true" visibility="public"
  22763. deprecated="not deprecated">
  22764. </field>
  22765. <field name="DEFAULT_SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
  22766. transient="false" volatile="false"
  22767. static="true" final="true" visibility="public"
  22768. deprecated="not deprecated">
  22769. </field>
  22770. <field name="SCM_CLIENT_SERVER_THREAD_COUNT" type="java.lang.String"
  22771. transient="false" volatile="false"
  22772. static="true" final="true" visibility="public"
  22773. deprecated="not deprecated">
  22774. <doc>
  22775. <![CDATA[The number of threads used to handle shared cache manager requests.]]>
  22776. </doc>
  22777. </field>
  22778. <field name="DEFAULT_SCM_CLIENT_SERVER_THREAD_COUNT" type="int"
  22779. transient="false" volatile="false"
  22780. static="true" final="true" visibility="public"
  22781. deprecated="not deprecated">
  22782. </field>
  22783. <field name="SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
  22784. transient="false" volatile="false"
  22785. static="true" final="true" visibility="public"
  22786. deprecated="not deprecated">
  22787. <doc>
  22788. <![CDATA[the checksum algorithm implementation]]>
  22789. </doc>
  22790. </field>
  22791. <field name="DEFAULT_SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
  22792. transient="false" volatile="false"
  22793. static="true" final="true" visibility="public"
  22794. deprecated="not deprecated">
  22795. </field>
  22796. <field name="SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="java.lang.String"
  22797. transient="false" volatile="false"
  22798. static="true" final="true" visibility="public"
  22799. deprecated="not deprecated">
  22800. <doc>
  22801. <![CDATA[The replication factor for the node manager uploader for the shared cache.]]>
  22802. </doc>
  22803. </field>
  22804. <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="int"
  22805. transient="false" volatile="false"
  22806. static="true" final="true" visibility="public"
  22807. deprecated="not deprecated">
  22808. </field>
  22809. <field name="SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="java.lang.String"
  22810. transient="false" volatile="false"
  22811. static="true" final="true" visibility="public"
  22812. deprecated="not deprecated">
  22813. </field>
  22814. <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="int"
  22815. transient="false" volatile="false"
  22816. static="true" final="true" visibility="public"
  22817. deprecated="not deprecated">
  22818. </field>
  22819. <field name="FEDERATION_PREFIX" type="java.lang.String"
  22820. transient="false" volatile="false"
  22821. static="true" final="true" visibility="public"
  22822. deprecated="not deprecated">
  22823. </field>
  22824. <field name="FEDERATION_ENABLED" type="java.lang.String"
  22825. transient="false" volatile="false"
  22826. static="true" final="true" visibility="public"
  22827. deprecated="not deprecated">
  22828. </field>
  22829. <field name="DEFAULT_FEDERATION_ENABLED" type="boolean"
  22830. transient="false" volatile="false"
  22831. static="true" final="true" visibility="public"
  22832. deprecated="not deprecated">
  22833. </field>
  22834. <field name="FEDERATION_FAILOVER_ENABLED" type="java.lang.String"
  22835. transient="false" volatile="false"
  22836. static="true" final="true" visibility="public"
  22837. deprecated="not deprecated">
  22838. </field>
  22839. <field name="DEFAULT_FEDERATION_FAILOVER_ENABLED" type="boolean"
  22840. transient="false" volatile="false"
  22841. static="true" final="true" visibility="public"
  22842. deprecated="not deprecated">
  22843. </field>
  22844. <field name="FEDERATION_STATESTORE_CLIENT_CLASS" type="java.lang.String"
  22845. transient="false" volatile="false"
  22846. static="true" final="true" visibility="public"
  22847. deprecated="not deprecated">
  22848. </field>
  22849. <field name="DEFAULT_FEDERATION_STATESTORE_CLIENT_CLASS" type="java.lang.String"
  22850. transient="false" volatile="false"
  22851. static="true" final="true" visibility="public"
  22852. deprecated="not deprecated">
  22853. </field>
  22854. <field name="FEDERATION_CACHE_TIME_TO_LIVE_SECS" type="java.lang.String"
  22855. transient="false" volatile="false"
  22856. static="true" final="true" visibility="public"
  22857. deprecated="not deprecated">
  22858. </field>
  22859. <field name="DEFAULT_FEDERATION_CACHE_TIME_TO_LIVE_SECS" type="int"
  22860. transient="false" volatile="false"
  22861. static="true" final="true" visibility="public"
  22862. deprecated="not deprecated">
  22863. </field>
  22864. <field name="FEDERATION_FLUSH_CACHE_FOR_RM_ADDR" type="java.lang.String"
  22865. transient="false" volatile="false"
  22866. static="true" final="true" visibility="public"
  22867. deprecated="not deprecated">
  22868. </field>
  22869. <field name="DEFAULT_FEDERATION_FLUSH_CACHE_FOR_RM_ADDR" type="boolean"
  22870. transient="false" volatile="false"
  22871. static="true" final="true" visibility="public"
  22872. deprecated="not deprecated">
  22873. </field>
  22874. <field name="FEDERATION_REGISTRY_BASE_KEY" type="java.lang.String"
  22875. transient="false" volatile="false"
  22876. static="true" final="true" visibility="public"
  22877. deprecated="not deprecated">
  22878. </field>
  22879. <field name="DEFAULT_FEDERATION_REGISTRY_BASE_KEY" type="java.lang.String"
  22880. transient="false" volatile="false"
  22881. static="true" final="true" visibility="public"
  22882. deprecated="not deprecated">
  22883. </field>
  22884. <field name="FEDERATION_STATESTORE_HEARTBEAT_INTERVAL_SECS" type="java.lang.String"
  22885. transient="false" volatile="false"
  22886. static="true" final="true" visibility="public"
  22887. deprecated="not deprecated">
  22888. </field>
  22889. <field name="DEFAULT_FEDERATION_STATESTORE_HEARTBEAT_INTERVAL_SECS" type="int"
  22890. transient="false" volatile="false"
  22891. static="true" final="true" visibility="public"
  22892. deprecated="not deprecated">
  22893. </field>
  22894. <field name="FEDERATION_MACHINE_LIST" type="java.lang.String"
  22895. transient="false" volatile="false"
  22896. static="true" final="true" visibility="public"
  22897. deprecated="not deprecated">
  22898. </field>
  22899. <field name="FEDERATION_CLUSTER_RESOLVER_CLASS" type="java.lang.String"
  22900. transient="false" volatile="false"
  22901. static="true" final="true" visibility="public"
  22902. deprecated="not deprecated">
  22903. </field>
  22904. <field name="DEFAULT_FEDERATION_CLUSTER_RESOLVER_CLASS" type="java.lang.String"
  22905. transient="false" volatile="false"
  22906. static="true" final="true" visibility="public"
  22907. deprecated="not deprecated">
  22908. </field>
  22909. <field name="FEDERATION_AMRMPROXY_HB_MAX_WAIT_MS" type="java.lang.String"
  22910. transient="false" volatile="false"
  22911. static="true" final="true" visibility="public"
  22912. deprecated="not deprecated">
  22913. </field>
  22914. <field name="DEFAULT_FEDERATION_AMRMPROXY_HB_MAX_WAIT_MS" type="long"
  22915. transient="false" volatile="false"
  22916. static="true" final="true" visibility="public"
  22917. deprecated="not deprecated">
  22918. </field>
  22919. <field name="FEDERATION_AMRMPROXY_SUBCLUSTER_TIMEOUT" type="java.lang.String"
  22920. transient="false" volatile="false"
  22921. static="true" final="true" visibility="public"
  22922. deprecated="not deprecated">
  22923. </field>
  22924. <field name="DEFAULT_FEDERATION_AMRMPROXY_SUBCLUSTER_TIMEOUT" type="long"
  22925. transient="false" volatile="false"
  22926. static="true" final="true" visibility="public"
  22927. deprecated="not deprecated">
  22928. </field>
  22929. <field name="DEFAULT_FEDERATION_POLICY_KEY" type="java.lang.String"
  22930. transient="false" volatile="false"
  22931. static="true" final="true" visibility="public"
  22932. deprecated="not deprecated">
  22933. </field>
  22934. <field name="FEDERATION_POLICY_MANAGER" type="java.lang.String"
  22935. transient="false" volatile="false"
  22936. static="true" final="true" visibility="public"
  22937. deprecated="not deprecated">
  22938. </field>
  22939. <field name="DEFAULT_FEDERATION_POLICY_MANAGER" type="java.lang.String"
  22940. transient="false" volatile="false"
  22941. static="true" final="true" visibility="public"
  22942. deprecated="not deprecated">
  22943. </field>
  22944. <field name="FEDERATION_POLICY_MANAGER_PARAMS" type="java.lang.String"
  22945. transient="false" volatile="false"
  22946. static="true" final="true" visibility="public"
  22947. deprecated="not deprecated">
  22948. </field>
  22949. <field name="DEFAULT_FEDERATION_POLICY_MANAGER_PARAMS" type="java.lang.String"
  22950. transient="false" volatile="false"
  22951. static="true" final="true" visibility="public"
  22952. deprecated="not deprecated">
  22953. </field>
  22954. <field name="FEDERATION_STATESTORE_ZK_PREFIX" type="java.lang.String"
  22955. transient="false" volatile="false"
  22956. static="true" final="true" visibility="public"
  22957. deprecated="not deprecated">
  22958. </field>
  22959. <field name="FEDERATION_STATESTORE_ZK_PARENT_PATH" type="java.lang.String"
  22960. transient="false" volatile="false"
  22961. static="true" final="true" visibility="public"
  22962. deprecated="not deprecated">
  22963. <doc>
  22964. <![CDATA[Parent znode path under which ZKRMStateStore will create znodes.]]>
  22965. </doc>
  22966. </field>
  22967. <field name="DEFAULT_FEDERATION_STATESTORE_ZK_PARENT_PATH" type="java.lang.String"
  22968. transient="false" volatile="false"
  22969. static="true" final="true" visibility="public"
  22970. deprecated="not deprecated">
  22971. </field>
  22972. <field name="FEDERATION_STATESTORE_SQL_USERNAME" type="java.lang.String"
  22973. transient="false" volatile="false"
  22974. static="true" final="true" visibility="public"
  22975. deprecated="not deprecated">
  22976. </field>
  22977. <field name="FEDERATION_STATESTORE_SQL_PASSWORD" type="java.lang.String"
  22978. transient="false" volatile="false"
  22979. static="true" final="true" visibility="public"
  22980. deprecated="not deprecated">
  22981. </field>
  22982. <field name="FEDERATION_STATESTORE_SQL_URL" type="java.lang.String"
  22983. transient="false" volatile="false"
  22984. static="true" final="true" visibility="public"
  22985. deprecated="not deprecated">
  22986. </field>
  22987. <field name="FEDERATION_STATESTORE_SQL_JDBC_CLASS" type="java.lang.String"
  22988. transient="false" volatile="false"
  22989. static="true" final="true" visibility="public"
  22990. deprecated="not deprecated">
  22991. </field>
  22992. <field name="DEFAULT_FEDERATION_STATESTORE_SQL_JDBC_CLASS" type="java.lang.String"
  22993. transient="false" volatile="false"
  22994. static="true" final="true" visibility="public"
  22995. deprecated="not deprecated">
  22996. </field>
  22997. <field name="FEDERATION_STATESTORE_SQL_MAXCONNECTIONS" type="java.lang.String"
  22998. transient="false" volatile="false"
  22999. static="true" final="true" visibility="public"
  23000. deprecated="not deprecated">
  23001. </field>
  23002. <field name="DEFAULT_FEDERATION_STATESTORE_SQL_MAXCONNECTIONS" type="int"
  23003. transient="false" volatile="false"
  23004. static="true" final="true" visibility="public"
  23005. deprecated="not deprecated">
  23006. </field>
  23007. <field name="ROUTER_PREFIX" type="java.lang.String"
  23008. transient="false" volatile="false"
  23009. static="true" final="true" visibility="public"
  23010. deprecated="not deprecated">
  23011. </field>
  23012. <field name="ROUTER_BIND_HOST" type="java.lang.String"
  23013. transient="false" volatile="false"
  23014. static="true" final="true" visibility="public"
  23015. deprecated="not deprecated">
  23016. </field>
  23017. <field name="ROUTER_CLIENTRM_PREFIX" type="java.lang.String"
  23018. transient="false" volatile="false"
  23019. static="true" final="true" visibility="public"
  23020. deprecated="not deprecated">
  23021. </field>
  23022. <field name="ROUTER_CLIENTRM_ADDRESS" type="java.lang.String"
  23023. transient="false" volatile="false"
  23024. static="true" final="true" visibility="public"
  23025. deprecated="not deprecated">
  23026. </field>
  23027. <field name="DEFAULT_ROUTER_CLIENTRM_PORT" type="int"
  23028. transient="false" volatile="false"
  23029. static="true" final="true" visibility="public"
  23030. deprecated="not deprecated">
  23031. </field>
  23032. <field name="DEFAULT_ROUTER_CLIENTRM_ADDRESS" type="java.lang.String"
  23033. transient="false" volatile="false"
  23034. static="true" final="true" visibility="public"
  23035. deprecated="not deprecated">
  23036. </field>
  23037. <field name="ROUTER_CLIENTRM_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  23038. transient="false" volatile="false"
  23039. static="true" final="true" visibility="public"
  23040. deprecated="not deprecated">
  23041. </field>
  23042. <field name="DEFAULT_ROUTER_CLIENTRM_INTERCEPTOR_CLASS" type="java.lang.String"
  23043. transient="false" volatile="false"
  23044. static="true" final="true" visibility="public"
  23045. deprecated="not deprecated">
  23046. </field>
  23047. <field name="ROUTER_PIPELINE_CACHE_MAX_SIZE" type="java.lang.String"
  23048. transient="false" volatile="false"
  23049. static="true" final="true" visibility="public"
  23050. deprecated="not deprecated">
  23051. </field>
  23052. <field name="DEFAULT_ROUTER_PIPELINE_CACHE_MAX_SIZE" type="int"
  23053. transient="false" volatile="false"
  23054. static="true" final="true" visibility="public"
  23055. deprecated="not deprecated">
  23056. </field>
  23057. <field name="ROUTER_RMADMIN_PREFIX" type="java.lang.String"
  23058. transient="false" volatile="false"
  23059. static="true" final="true" visibility="public"
  23060. deprecated="not deprecated">
  23061. </field>
  23062. <field name="ROUTER_RMADMIN_ADDRESS" type="java.lang.String"
  23063. transient="false" volatile="false"
  23064. static="true" final="true" visibility="public"
  23065. deprecated="not deprecated">
  23066. </field>
  23067. <field name="DEFAULT_ROUTER_RMADMIN_PORT" type="int"
  23068. transient="false" volatile="false"
  23069. static="true" final="true" visibility="public"
  23070. deprecated="not deprecated">
  23071. </field>
  23072. <field name="DEFAULT_ROUTER_RMADMIN_ADDRESS" type="java.lang.String"
  23073. transient="false" volatile="false"
  23074. static="true" final="true" visibility="public"
  23075. deprecated="not deprecated">
  23076. </field>
  23077. <field name="ROUTER_RMADMIN_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  23078. transient="false" volatile="false"
  23079. static="true" final="true" visibility="public"
  23080. deprecated="not deprecated">
  23081. </field>
  23082. <field name="DEFAULT_ROUTER_RMADMIN_INTERCEPTOR_CLASS" type="java.lang.String"
  23083. transient="false" volatile="false"
  23084. static="true" final="true" visibility="public"
  23085. deprecated="not deprecated">
  23086. </field>
  23087. <field name="ROUTER_CLIENTRM_SUBMIT_RETRY" type="java.lang.String"
  23088. transient="false" volatile="false"
  23089. static="true" final="true" visibility="public"
  23090. deprecated="not deprecated">
  23091. <doc>
  23092. <![CDATA[The number of retries for GetNewApplication and SubmitApplication in
  23093. {@code FederationClientInterceptor}.]]>
  23094. </doc>
  23095. </field>
  23096. <field name="DEFAULT_ROUTER_CLIENTRM_SUBMIT_RETRY" type="int"
  23097. transient="false" volatile="false"
  23098. static="true" final="true" visibility="public"
  23099. deprecated="not deprecated">
  23100. </field>
  23101. <field name="ROUTER_WEBAPP_PREFIX" type="java.lang.String"
  23102. transient="false" volatile="false"
  23103. static="true" final="true" visibility="public"
  23104. deprecated="not deprecated">
  23105. </field>
  23106. <field name="ROUTER_USER_CLIENT_THREADS_SIZE" type="java.lang.String"
  23107. transient="false" volatile="false"
  23108. static="true" final="true" visibility="public"
  23109. deprecated="not deprecated">
  23110. </field>
  23111. <field name="DEFAULT_ROUTER_USER_CLIENT_THREADS_SIZE" type="int"
  23112. transient="false" volatile="false"
  23113. static="true" final="true" visibility="public"
  23114. deprecated="not deprecated">
  23115. </field>
  23116. <field name="ROUTER_WEBAPP_ADDRESS" type="java.lang.String"
  23117. transient="false" volatile="false"
  23118. static="true" final="true" visibility="public"
  23119. deprecated="not deprecated">
  23120. <doc>
  23121. <![CDATA[The address of the Router web application.]]>
  23122. </doc>
  23123. </field>
  23124. <field name="DEFAULT_ROUTER_WEBAPP_PORT" type="int"
  23125. transient="false" volatile="false"
  23126. static="true" final="true" visibility="public"
  23127. deprecated="not deprecated">
  23128. </field>
  23129. <field name="DEFAULT_ROUTER_WEBAPP_ADDRESS" type="java.lang.String"
  23130. transient="false" volatile="false"
  23131. static="true" final="true" visibility="public"
  23132. deprecated="not deprecated">
  23133. </field>
  23134. <field name="ROUTER_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  23135. transient="false" volatile="false"
  23136. static="true" final="true" visibility="public"
  23137. deprecated="not deprecated">
  23138. <doc>
  23139. <![CDATA[The https address of the Router web application.]]>
  23140. </doc>
  23141. </field>
  23142. <field name="DEFAULT_ROUTER_WEBAPP_HTTPS_PORT" type="int"
  23143. transient="false" volatile="false"
  23144. static="true" final="true" visibility="public"
  23145. deprecated="not deprecated">
  23146. </field>
  23147. <field name="DEFAULT_ROUTER_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  23148. transient="false" volatile="false"
  23149. static="true" final="true" visibility="public"
  23150. deprecated="not deprecated">
  23151. </field>
  23152. <field name="ROUTER_WEBAPP_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  23153. transient="false" volatile="false"
  23154. static="true" final="true" visibility="public"
  23155. deprecated="not deprecated">
  23156. </field>
  23157. <field name="DEFAULT_ROUTER_WEBAPP_INTERCEPTOR_CLASS" type="java.lang.String"
  23158. transient="false" volatile="false"
  23159. static="true" final="true" visibility="public"
  23160. deprecated="not deprecated">
  23161. </field>
  23162. <field name="ROUTER_WEBAPP_DEFAULT_INTERCEPTOR_CLASS" type="java.lang.String"
  23163. transient="false" volatile="false"
  23164. static="true" final="true" visibility="public"
  23165. deprecated="not deprecated">
  23166. <doc>
  23167. <![CDATA[The interceptor class used in FederationInterceptorREST to communicate with
  23168. each SubCluster.]]>
  23169. </doc>
  23170. </field>
  23171. <field name="DEFAULT_ROUTER_WEBAPP_DEFAULT_INTERCEPTOR_CLASS" type="java.lang.String"
  23172. transient="false" volatile="false"
  23173. static="true" final="true" visibility="public"
  23174. deprecated="not deprecated">
  23175. </field>
  23176. <field name="ROUTER_WEBAPP_PARTIAL_RESULTS_ENABLED" type="java.lang.String"
  23177. transient="false" volatile="false"
  23178. static="true" final="true" visibility="public"
  23179. deprecated="not deprecated">
  23180. <doc>
  23181. <![CDATA[The interceptor class used in FederationInterceptorREST should return
  23182. partial AppReports.]]>
  23183. </doc>
  23184. </field>
  23185. <field name="DEFAULT_ROUTER_WEBAPP_PARTIAL_RESULTS_ENABLED" type="boolean"
  23186. transient="false" volatile="false"
  23187. static="true" final="true" visibility="public"
  23188. deprecated="not deprecated">
  23189. </field>
  23190. <field name="YARN_REGISTRY_CLASS" type="java.lang.String"
  23191. transient="false" volatile="false"
  23192. static="true" final="true" visibility="public"
  23193. deprecated="not deprecated">
  23194. </field>
  23195. <field name="DEFAULT_YARN_REGISTRY_CLASS" type="java.lang.String"
  23196. transient="false" volatile="false"
  23197. static="true" final="true" visibility="public"
  23198. deprecated="not deprecated">
  23199. </field>
  23200. <field name="YARN_CLIENT_APP_SUBMISSION_POLL_INTERVAL_MS" type="java.lang.String"
  23201. transient="false" volatile="false"
  23202. static="true" final="true" visibility="public"
  23203. deprecated="not deprecated">
  23204. <doc>
  23205. <![CDATA[Use YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS instead.
  23206. The interval of the yarn client's querying application state after
  23207. application submission. The unit is millisecond.]]>
  23208. </doc>
  23209. </field>
  23210. <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="java.lang.String"
  23211. transient="false" volatile="false"
  23212. static="true" final="true" visibility="public"
  23213. deprecated="not deprecated">
  23214. <doc>
  23215. <![CDATA[The interval that the yarn client library uses to poll the completion
  23216. status of the asynchronous API of application client protocol.]]>
  23217. </doc>
  23218. </field>
  23219. <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="long"
  23220. transient="false" volatile="false"
  23221. static="true" final="true" visibility="public"
  23222. deprecated="not deprecated">
  23223. </field>
  23224. <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="java.lang.String"
  23225. transient="false" volatile="false"
  23226. static="true" final="true" visibility="public"
  23227. deprecated="not deprecated">
  23228. <doc>
  23229. <![CDATA[The duration that the yarn client library waits, cumulatively across polls,
  23230. for an expected state change to occur. Defaults to -1, which indicates no
  23231. limit.]]>
  23232. </doc>
  23233. </field>
  23234. <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="long"
  23235. transient="false" volatile="false"
  23236. static="true" final="true" visibility="public"
  23237. deprecated="not deprecated">
  23238. </field>
  23239. <field name="NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="java.lang.String"
  23240. transient="false" volatile="false"
  23241. static="true" final="true" visibility="public"
  23242. deprecated="not deprecated">
  23243. <doc>
  23244. <![CDATA[Max number of threads in NMClientAsync to process container management
  23245. events]]>
  23246. </doc>
  23247. </field>
  23248. <field name="DEFAULT_NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="int"
  23249. transient="false" volatile="false"
  23250. static="true" final="true" visibility="public"
  23251. deprecated="not deprecated">
  23252. </field>
  23253. <field name="NM_CLIENT_MAX_NM_PROXIES" type="java.lang.String"
  23254. transient="false" volatile="false"
  23255. static="true" final="true" visibility="public"
  23256. deprecated="not deprecated">
  23257. <doc>
  23258. <![CDATA[Maximum number of proxy connections to cache for node managers. If set
  23259. to a value greater than zero then the cache is enabled and the NMClient
  23260. and MRAppMaster will cache the specified number of node manager proxies.
  23261. There will be at max one proxy per node manager. Ex. configuring it to a
  23262. value of 5 will make sure that client will at max have 5 proxies cached
  23263. with 5 different node managers. These connections for these proxies will
  23264. be timed out if idle for more than the system wide idle timeout period.
  23265. Note that this could cause issues on large clusters as many connections
  23266. could linger simultaneously and lead to a large number of connection
  23267. threads. The token used for authentication will be used only at
  23268. connection creation time. If a new token is received then the earlier
  23269. connection should be closed in order to use the new token. This and
  23270. {@link YarnConfiguration#NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE} are related
  23271. and should be in sync (no need for them to be equal).
  23272. If the value of this property is zero then the connection cache is
  23273. disabled and connections will use a zero idle timeout to prevent too
  23274. many connection threads on large clusters.]]>
  23275. </doc>
  23276. </field>
  23277. <field name="DEFAULT_NM_CLIENT_MAX_NM_PROXIES" type="int"
  23278. transient="false" volatile="false"
  23279. static="true" final="true" visibility="public"
  23280. deprecated="not deprecated">
  23281. </field>
  23282. <field name="CLIENT_NM_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  23283. transient="false" volatile="false"
  23284. static="true" final="true" visibility="public"
  23285. deprecated="not deprecated">
  23286. <doc>
  23287. <![CDATA[Max time to wait to establish a connection to NM]]>
  23288. </doc>
  23289. </field>
  23290. <field name="DEFAULT_CLIENT_NM_CONNECT_MAX_WAIT_MS" type="long"
  23291. transient="false" volatile="false"
  23292. static="true" final="true" visibility="public"
  23293. deprecated="not deprecated">
  23294. </field>
  23295. <field name="CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  23296. transient="false" volatile="false"
  23297. static="true" final="true" visibility="public"
  23298. deprecated="not deprecated">
  23299. <doc>
  23300. <![CDATA[Time interval between each attempt to connect to NM]]>
  23301. </doc>
  23302. </field>
  23303. <field name="DEFAULT_CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="long"
  23304. transient="false" volatile="false"
  23305. static="true" final="true" visibility="public"
  23306. deprecated="not deprecated">
  23307. </field>
  23308. <field name="YARN_HTTP_POLICY_KEY" type="java.lang.String"
  23309. transient="false" volatile="false"
  23310. static="true" final="true" visibility="public"
  23311. deprecated="not deprecated">
  23312. </field>
  23313. <field name="YARN_HTTP_POLICY_DEFAULT" type="java.lang.String"
  23314. transient="false" volatile="false"
  23315. static="true" final="true" visibility="public"
  23316. deprecated="not deprecated">
  23317. </field>
  23318. <field name="NM_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  23319. transient="false" volatile="false"
  23320. static="true" final="true" visibility="public"
  23321. deprecated="not deprecated">
  23322. <doc>
  23323. <![CDATA[Max time to wait for NM to connection to RM.
  23324. When not set, proxy will fall back to use value of
  23325. RESOURCEMANAGER_CONNECT_MAX_WAIT_MS.]]>
  23326. </doc>
  23327. </field>
  23328. <field name="NM_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  23329. transient="false" volatile="false"
  23330. static="true" final="true" visibility="public"
  23331. deprecated="not deprecated">
  23332. <doc>
  23333. <![CDATA[Time interval between each NM attempt to connection to RM.
  23334. When not set, proxy will fall back to use value of
  23335. RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS.]]>
  23336. </doc>
  23337. </field>
  23338. <field name="NODE_LABELS_PREFIX" type="java.lang.String"
  23339. transient="false" volatile="false"
  23340. static="true" final="true" visibility="public"
  23341. deprecated="not deprecated">
  23342. <doc>
  23343. <![CDATA[Node-labels configurations]]>
  23344. </doc>
  23345. </field>
  23346. <field name="FS_NODE_LABELS_STORE_IMPL_CLASS" type="java.lang.String"
  23347. transient="false" volatile="false"
  23348. static="true" final="true" visibility="public"
  23349. deprecated="not deprecated">
  23350. <doc>
  23351. <![CDATA[Node label store implementation class]]>
  23352. </doc>
  23353. </field>
  23354. <field name="DEFAULT_FS_NODE_LABELS_STORE_IMPL_CLASS" type="java.lang.String"
  23355. transient="false" volatile="false"
  23356. static="true" final="true" visibility="public"
  23357. deprecated="not deprecated">
  23358. </field>
  23359. <field name="FS_NODE_LABELS_STORE_ROOT_DIR" type="java.lang.String"
  23360. transient="false" volatile="false"
  23361. static="true" final="true" visibility="public"
  23362. deprecated="not deprecated">
  23363. <doc>
  23364. <![CDATA[URI for NodeLabelManager]]>
  23365. </doc>
  23366. </field>
  23367. <field name="NODE_ATTRIBUTE_PREFIX" type="java.lang.String"
  23368. transient="false" volatile="false"
  23369. static="true" final="true" visibility="public"
  23370. deprecated="not deprecated">
  23371. <doc>
  23372. <![CDATA[Node-attribute configurations.]]>
  23373. </doc>
  23374. </field>
  23375. <field name="FS_NODE_ATTRIBUTE_STORE_IMPL_CLASS" type="java.lang.String"
  23376. transient="false" volatile="false"
  23377. static="true" final="true" visibility="public"
  23378. deprecated="not deprecated">
  23379. <doc>
  23380. <![CDATA[Node attribute store implementation class.]]>
  23381. </doc>
  23382. </field>
  23383. <field name="FS_NODE_ATTRIBUTE_STORE_ROOT_DIR" type="java.lang.String"
  23384. transient="false" volatile="false"
  23385. static="true" final="true" visibility="public"
  23386. deprecated="not deprecated">
  23387. <doc>
  23388. <![CDATA[File system node attribute store directory.]]>
  23389. </doc>
  23390. </field>
  23391. <field name="NODE_LABELS_ENABLED" type="java.lang.String"
  23392. transient="false" volatile="false"
  23393. static="true" final="true" visibility="public"
  23394. deprecated="not deprecated">
  23395. <doc>
  23396. <![CDATA[Flag to indicate if the node labels feature enabled, by default it's
  23397. disabled]]>
  23398. </doc>
  23399. </field>
  23400. <field name="DEFAULT_NODE_LABELS_ENABLED" type="boolean"
  23401. transient="false" volatile="false"
  23402. static="true" final="true" visibility="public"
  23403. deprecated="not deprecated">
  23404. </field>
  23405. <field name="NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  23406. transient="false" volatile="false"
  23407. static="true" final="true" visibility="public"
  23408. deprecated="not deprecated">
  23409. </field>
  23410. <field name="CENTRALIZED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  23411. transient="false" volatile="false"
  23412. static="true" final="true" visibility="public"
  23413. deprecated="not deprecated">
  23414. </field>
  23415. <field name="DELEGATED_CENTALIZED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  23416. transient="false" volatile="false"
  23417. static="true" final="true" visibility="public"
  23418. deprecated="not deprecated">
  23419. </field>
  23420. <field name="DISTRIBUTED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  23421. transient="false" volatile="false"
  23422. static="true" final="true" visibility="public"
  23423. deprecated="not deprecated">
  23424. </field>
  23425. <field name="DEFAULT_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  23426. transient="false" volatile="false"
  23427. static="true" final="true" visibility="public"
  23428. deprecated="not deprecated">
  23429. </field>
  23430. <field name="EXCLUSIVE_ENFORCED_PARTITIONS_SUFFIX" type="java.lang.String"
  23431. transient="false" volatile="false"
  23432. static="true" final="true" visibility="public"
  23433. deprecated="not deprecated">
  23434. </field>
  23435. <field name="EXCLUSIVE_ENFORCED_PARTITIONS" type="java.lang.String"
  23436. transient="false" volatile="false"
  23437. static="true" final="true" visibility="public"
  23438. deprecated="not deprecated">
  23439. </field>
  23440. <field name="MAX_CLUSTER_LEVEL_APPLICATION_PRIORITY" type="java.lang.String"
  23441. transient="false" volatile="false"
  23442. static="true" final="true" visibility="public"
  23443. deprecated="not deprecated">
  23444. </field>
  23445. <field name="DEFAULT_CLUSTER_LEVEL_APPLICATION_PRIORITY" type="int"
  23446. transient="false" volatile="false"
  23447. static="true" final="true" visibility="public"
  23448. deprecated="not deprecated">
  23449. </field>
  23450. <field name="APP_ATTEMPT_DIAGNOSTICS_LIMIT_KC" type="java.lang.String"
  23451. transient="false" volatile="false"
  23452. static="true" final="true" visibility="public"
  23453. deprecated="not deprecated">
  23454. </field>
  23455. <field name="DEFAULT_APP_ATTEMPT_DIAGNOSTICS_LIMIT_KC" type="int"
  23456. transient="false" volatile="false"
  23457. static="true" final="true" visibility="public"
  23458. deprecated="not deprecated">
  23459. </field>
  23460. <field name="NM_NODE_LABELS_PROVIDER_CONFIG" type="java.lang.String"
  23461. transient="false" volatile="false"
  23462. static="true" final="true" visibility="public"
  23463. deprecated="not deprecated">
  23464. </field>
  23465. <field name="NM_NODE_ATTRIBUTES_PROVIDER_CONFIG" type="java.lang.String"
  23466. transient="false" volatile="false"
  23467. static="true" final="true" visibility="public"
  23468. deprecated="not deprecated">
  23469. </field>
  23470. <field name="CONFIG_NODE_DESCRIPTOR_PROVIDER" type="java.lang.String"
  23471. transient="false" volatile="false"
  23472. static="true" final="true" visibility="public"
  23473. deprecated="not deprecated">
  23474. </field>
  23475. <field name="SCRIPT_NODE_DESCRIPTOR_PROVIDER" type="java.lang.String"
  23476. transient="false" volatile="false"
  23477. static="true" final="true" visibility="public"
  23478. deprecated="not deprecated">
  23479. </field>
  23480. <field name="NM_NODE_LABELS_RESYNC_INTERVAL" type="java.lang.String"
  23481. transient="false" volatile="false"
  23482. static="true" final="true" visibility="public"
  23483. deprecated="not deprecated">
  23484. </field>
  23485. <field name="DEFAULT_NM_NODE_LABELS_RESYNC_INTERVAL" type="long"
  23486. transient="false" volatile="false"
  23487. static="true" final="true" visibility="public"
  23488. deprecated="not deprecated">
  23489. </field>
  23490. <field name="NM_NODE_ATTRIBUTES_RESYNC_INTERVAL" type="java.lang.String"
  23491. transient="false" volatile="false"
  23492. static="true" final="true" visibility="public"
  23493. deprecated="not deprecated">
  23494. </field>
  23495. <field name="DEFAULT_NM_NODE_ATTRIBUTES_RESYNC_INTERVAL" type="long"
  23496. transient="false" volatile="false"
  23497. static="true" final="true" visibility="public"
  23498. deprecated="not deprecated">
  23499. </field>
  23500. <field name="NM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="java.lang.String"
  23501. transient="false" volatile="false"
  23502. static="true" final="true" visibility="public"
  23503. deprecated="not deprecated">
  23504. </field>
  23505. <field name="NM_NODE_LABELS_PROVIDER_FETCH_TIMEOUT_MS" type="java.lang.String"
  23506. transient="false" volatile="false"
  23507. static="true" final="true" visibility="public"
  23508. deprecated="not deprecated">
  23509. </field>
  23510. <field name="DEFAULT_NM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="long"
  23511. transient="false" volatile="false"
  23512. static="true" final="true" visibility="public"
  23513. deprecated="not deprecated">
  23514. </field>
  23515. <field name="DEFAULT_NM_NODE_LABELS_PROVIDER_FETCH_TIMEOUT_MS" type="long"
  23516. transient="false" volatile="false"
  23517. static="true" final="true" visibility="public"
  23518. deprecated="not deprecated">
  23519. </field>
  23520. <field name="NM_PROVIDER_CONFIGURED_NODE_PARTITION" type="java.lang.String"
  23521. transient="false" volatile="false"
  23522. static="true" final="true" visibility="public"
  23523. deprecated="not deprecated">
  23524. </field>
  23525. <field name="NM_PROVIDER_CONFIGURED_NODE_ATTRIBUTES" type="java.lang.String"
  23526. transient="false" volatile="false"
  23527. static="true" final="true" visibility="public"
  23528. deprecated="not deprecated">
  23529. </field>
  23530. <field name="RM_NODE_LABELS_PROVIDER_CONFIG" type="java.lang.String"
  23531. transient="false" volatile="false"
  23532. static="true" final="true" visibility="public"
  23533. deprecated="not deprecated">
  23534. </field>
  23535. <field name="RM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="java.lang.String"
  23536. transient="false" volatile="false"
  23537. static="true" final="true" visibility="public"
  23538. deprecated="not deprecated">
  23539. </field>
  23540. <field name="DEFAULT_RM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="long"
  23541. transient="false" volatile="false"
  23542. static="true" final="true" visibility="public"
  23543. deprecated="not deprecated">
  23544. </field>
  23545. <field name="AM_SCHEDULING_NODE_BLACKLISTING_ENABLED" type="java.lang.String"
  23546. transient="false" volatile="false"
  23547. static="true" final="true" visibility="public"
  23548. deprecated="not deprecated">
  23549. </field>
  23550. <field name="DEFAULT_AM_SCHEDULING_NODE_BLACKLISTING_ENABLED" type="boolean"
  23551. transient="false" volatile="false"
  23552. static="true" final="true" visibility="public"
  23553. deprecated="not deprecated">
  23554. </field>
  23555. <field name="AM_SCHEDULING_NODE_BLACKLISTING_DISABLE_THRESHOLD" type="java.lang.String"
  23556. transient="false" volatile="false"
  23557. static="true" final="true" visibility="public"
  23558. deprecated="not deprecated">
  23559. </field>
  23560. <field name="DEFAULT_AM_SCHEDULING_NODE_BLACKLISTING_DISABLE_THRESHOLD" type="float"
  23561. transient="false" volatile="false"
  23562. static="true" final="true" visibility="public"
  23563. deprecated="not deprecated">
  23564. </field>
  23565. <field name="NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_PATH" type="java.lang.String"
  23566. transient="false" volatile="false"
  23567. static="true" final="true" visibility="public"
  23568. deprecated="not deprecated">
  23569. </field>
  23570. <field name="NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_SCRIPT_OPTS" type="java.lang.String"
  23571. transient="false" volatile="false"
  23572. static="true" final="true" visibility="public"
  23573. deprecated="not deprecated">
  23574. </field>
  23575. <field name="NM_NODE_ATTRIBUTES_PROVIDER_FETCH_INTERVAL_MS" type="java.lang.String"
  23576. transient="false" volatile="false"
  23577. static="true" final="true" visibility="public"
  23578. deprecated="not deprecated">
  23579. <doc>
  23580. <![CDATA[Node attribute provider fetch attributes interval and timeout.]]>
  23581. </doc>
  23582. </field>
  23583. <field name="DEFAULT_NM_NODE_ATTRIBUTES_PROVIDER_FETCH_INTERVAL_MS" type="long"
  23584. transient="false" volatile="false"
  23585. static="true" final="true" visibility="public"
  23586. deprecated="not deprecated">
  23587. </field>
  23588. <field name="NM_NODE_ATTRIBUTES_PROVIDER_FETCH_TIMEOUT_MS" type="java.lang.String"
  23589. transient="false" volatile="false"
  23590. static="true" final="true" visibility="public"
  23591. deprecated="not deprecated">
  23592. </field>
  23593. <field name="DEFAULT_NM_NODE_ATTRIBUTES_PROVIDER_FETCH_TIMEOUT_MS" type="long"
  23594. transient="false" volatile="false"
  23595. static="true" final="true" visibility="public"
  23596. deprecated="not deprecated">
  23597. </field>
  23598. <field name="NM_SCRIPT_BASED_NODE_ATTRIBUTES_PROVIDER_PATH" type="java.lang.String"
  23599. transient="false" volatile="false"
  23600. static="true" final="true" visibility="public"
  23601. deprecated="not deprecated">
  23602. </field>
  23603. <field name="NM_SCRIPT_BASED_NODE_ATTRIBUTES_PROVIDER_OPTS" type="java.lang.String"
  23604. transient="false" volatile="false"
  23605. static="true" final="true" visibility="public"
  23606. deprecated="not deprecated">
  23607. </field>
  23608. <field name="DISPLAY_APPS_FOR_LOGGED_IN_USER" type="java.lang.String"
  23609. transient="false" volatile="false"
  23610. static="true" final="true" visibility="public"
  23611. deprecated="not deprecated">
  23612. </field>
  23613. <field name="FILTER_ENTITY_LIST_BY_USER" type="java.lang.String"
  23614. transient="false" volatile="false"
  23615. static="true" final="true" visibility="public"
  23616. deprecated="not deprecated">
  23617. </field>
  23618. <field name="DEFAULT_DISPLAY_APPS_FOR_LOGGED_IN_USER" type="boolean"
  23619. transient="false" volatile="false"
  23620. static="true" final="true" visibility="public"
  23621. deprecated="not deprecated">
  23622. </field>
  23623. <field name="ENABLE_REST_APP_SUBMISSIONS" type="java.lang.String"
  23624. transient="false" volatile="false"
  23625. static="true" final="true" visibility="public"
  23626. deprecated="not deprecated">
  23627. </field>
  23628. <field name="DEFAULT_ENABLE_REST_APP_SUBMISSIONS" type="boolean"
  23629. transient="false" volatile="false"
  23630. static="true" final="true" visibility="public"
  23631. deprecated="not deprecated">
  23632. </field>
  23633. <field name="REST_CSRF" type="java.lang.String"
  23634. transient="false" volatile="false"
  23635. static="true" final="true" visibility="public"
  23636. deprecated="not deprecated">
  23637. </field>
  23638. <field name="RM_CSRF_PREFIX" type="java.lang.String"
  23639. transient="false" volatile="false"
  23640. static="true" final="true" visibility="public"
  23641. deprecated="not deprecated">
  23642. </field>
  23643. <field name="NM_CSRF_PREFIX" type="java.lang.String"
  23644. transient="false" volatile="false"
  23645. static="true" final="true" visibility="public"
  23646. deprecated="not deprecated">
  23647. </field>
  23648. <field name="TIMELINE_CSRF_PREFIX" type="java.lang.String"
  23649. transient="false" volatile="false"
  23650. static="true" final="true" visibility="public"
  23651. deprecated="not deprecated">
  23652. </field>
  23653. <field name="RM_CSRF_ENABLED" type="java.lang.String"
  23654. transient="false" volatile="false"
  23655. static="true" final="true" visibility="public"
  23656. deprecated="not deprecated">
  23657. </field>
  23658. <field name="NM_CSRF_ENABLED" type="java.lang.String"
  23659. transient="false" volatile="false"
  23660. static="true" final="true" visibility="public"
  23661. deprecated="not deprecated">
  23662. </field>
  23663. <field name="TIMELINE_CSRF_ENABLED" type="java.lang.String"
  23664. transient="false" volatile="false"
  23665. static="true" final="true" visibility="public"
  23666. deprecated="not deprecated">
  23667. </field>
  23668. <field name="RM_CSRF_CUSTOM_HEADER" type="java.lang.String"
  23669. transient="false" volatile="false"
  23670. static="true" final="true" visibility="public"
  23671. deprecated="not deprecated">
  23672. </field>
  23673. <field name="NM_CSRF_CUSTOM_HEADER" type="java.lang.String"
  23674. transient="false" volatile="false"
  23675. static="true" final="true" visibility="public"
  23676. deprecated="not deprecated">
  23677. </field>
  23678. <field name="TIMELINE_CSRF_CUSTOM_HEADER" type="java.lang.String"
  23679. transient="false" volatile="false"
  23680. static="true" final="true" visibility="public"
  23681. deprecated="not deprecated">
  23682. </field>
  23683. <field name="RM_CSRF_METHODS_TO_IGNORE" type="java.lang.String"
  23684. transient="false" volatile="false"
  23685. static="true" final="true" visibility="public"
  23686. deprecated="not deprecated">
  23687. </field>
  23688. <field name="NM_CSRF_METHODS_TO_IGNORE" type="java.lang.String"
  23689. transient="false" volatile="false"
  23690. static="true" final="true" visibility="public"
  23691. deprecated="not deprecated">
  23692. </field>
  23693. <field name="TIMELINE_CSRF_METHODS_TO_IGNORE" type="java.lang.String"
  23694. transient="false" volatile="false"
  23695. static="true" final="true" visibility="public"
  23696. deprecated="not deprecated">
  23697. </field>
  23698. <field name="XFS" type="java.lang.String"
  23699. transient="false" volatile="false"
  23700. static="true" final="true" visibility="public"
  23701. deprecated="not deprecated">
  23702. </field>
  23703. <field name="YARN_XFS_ENABLED" type="java.lang.String"
  23704. transient="false" volatile="false"
  23705. static="true" final="true" visibility="public"
  23706. deprecated="not deprecated">
  23707. </field>
  23708. <field name="RM_XFS_PREFIX" type="java.lang.String"
  23709. transient="false" volatile="false"
  23710. static="true" final="true" visibility="public"
  23711. deprecated="not deprecated">
  23712. </field>
  23713. <field name="NM_XFS_PREFIX" type="java.lang.String"
  23714. transient="false" volatile="false"
  23715. static="true" final="true" visibility="public"
  23716. deprecated="not deprecated">
  23717. </field>
  23718. <field name="TIMELINE_XFS_PREFIX" type="java.lang.String"
  23719. transient="false" volatile="false"
  23720. static="true" final="true" visibility="public"
  23721. deprecated="not deprecated">
  23722. </field>
  23723. <field name="RM_XFS_OPTIONS" type="java.lang.String"
  23724. transient="false" volatile="false"
  23725. static="true" final="true" visibility="public"
  23726. deprecated="not deprecated">
  23727. </field>
  23728. <field name="NM_XFS_OPTIONS" type="java.lang.String"
  23729. transient="false" volatile="false"
  23730. static="true" final="true" visibility="public"
  23731. deprecated="not deprecated">
  23732. </field>
  23733. <field name="TIMELINE_XFS_OPTIONS" type="java.lang.String"
  23734. transient="false" volatile="false"
  23735. static="true" final="true" visibility="public"
  23736. deprecated="not deprecated">
  23737. </field>
  23738. <field name="TIMELINE_SERVICE_READER_BIND_HOST" type="java.lang.String"
  23739. transient="false" volatile="false"
  23740. static="true" final="true" visibility="public"
  23741. deprecated="not deprecated">
  23742. <doc>
  23743. <![CDATA[Settings for timeline reader.]]>
  23744. </doc>
  23745. </field>
  23746. <field name="TIMELINE_SERVICE_READER_WEBAPP_ADDRESS" type="java.lang.String"
  23747. transient="false" volatile="false"
  23748. static="true" final="true" visibility="public"
  23749. deprecated="not deprecated">
  23750. </field>
  23751. <field name="DEFAULT_TIMELINE_SERVICE_READER_WEBAPP_ADDRESS" type="java.lang.String"
  23752. transient="false" volatile="false"
  23753. static="true" final="true" visibility="public"
  23754. deprecated="not deprecated">
  23755. </field>
  23756. <field name="TIMELINE_SERVICE_READER_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  23757. transient="false" volatile="false"
  23758. static="true" final="true" visibility="public"
  23759. deprecated="not deprecated">
  23760. </field>
  23761. <field name="DEFAULT_TIMELINE_SERVICE_READER_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  23762. transient="false" volatile="false"
  23763. static="true" final="true" visibility="public"
  23764. deprecated="not deprecated">
  23765. </field>
  23766. <field name="TIMELINE_SERVICE_READER_STORAGE_MONITOR_INTERVAL_MS" type="java.lang.String"
  23767. transient="false" volatile="false"
  23768. static="true" final="true" visibility="public"
  23769. deprecated="not deprecated">
  23770. </field>
  23771. <field name="DEFAULT_TIMELINE_SERVICE_STORAGE_MONITOR_INTERVAL_MS" type="long"
  23772. transient="false" volatile="false"
  23773. static="true" final="true" visibility="public"
  23774. deprecated="not deprecated">
  23775. </field>
  23776. <field name="TIMELINE_SERVICE_COLLECTOR_PREFIX" type="java.lang.String"
  23777. transient="false" volatile="false"
  23778. static="true" final="true" visibility="public"
  23779. deprecated="not deprecated">
  23780. <doc>
  23781. <![CDATA[Marked collector properties as Private since it run as auxillary service.]]>
  23782. </doc>
  23783. </field>
  23784. <field name="TIMELINE_SERVICE_COLLECTOR_BIND_HOST" type="java.lang.String"
  23785. transient="false" volatile="false"
  23786. static="true" final="true" visibility="public"
  23787. deprecated="not deprecated">
  23788. </field>
  23789. <field name="TIMELINE_SERVICE_COLLECTOR_BIND_PORT_RANGES" type="java.lang.String"
  23790. transient="false" volatile="false"
  23791. static="true" final="true" visibility="public"
  23792. deprecated="not deprecated">
  23793. </field>
  23794. <field name="TIMELINE_SERVICE_COLLECTOR_WEBAPP_ADDRESS" type="java.lang.String"
  23795. transient="false" volatile="false"
  23796. static="true" final="true" visibility="public"
  23797. deprecated="not deprecated">
  23798. </field>
  23799. <field name="DEFAULT_TIMELINE_SERVICE_COLLECTOR_WEBAPP_ADDRESS" type="java.lang.String"
  23800. transient="false" volatile="false"
  23801. static="true" final="true" visibility="public"
  23802. deprecated="not deprecated">
  23803. </field>
  23804. <field name="TIMELINE_SERVICE_COLLECTOR_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  23805. transient="false" volatile="false"
  23806. static="true" final="true" visibility="public"
  23807. deprecated="not deprecated">
  23808. </field>
  23809. <field name="DEFAULT_TIMELINE_SERVICE_COLLECTOR_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  23810. transient="false" volatile="false"
  23811. static="true" final="true" visibility="public"
  23812. deprecated="not deprecated">
  23813. </field>
  23814. <field name="NM_NUMA_AWARENESS_ENABLED" type="java.lang.String"
  23815. transient="false" volatile="false"
  23816. static="true" final="true" visibility="public"
  23817. deprecated="not deprecated">
  23818. <doc>
  23819. <![CDATA[Settings for NUMA awareness.]]>
  23820. </doc>
  23821. </field>
  23822. <field name="DEFAULT_NM_NUMA_AWARENESS_ENABLED" type="boolean"
  23823. transient="false" volatile="false"
  23824. static="true" final="true" visibility="public"
  23825. deprecated="not deprecated">
  23826. </field>
  23827. <field name="NM_NUMA_AWARENESS_READ_TOPOLOGY" type="java.lang.String"
  23828. transient="false" volatile="false"
  23829. static="true" final="true" visibility="public"
  23830. deprecated="not deprecated">
  23831. </field>
  23832. <field name="DEFAULT_NM_NUMA_AWARENESS_READ_TOPOLOGY" type="boolean"
  23833. transient="false" volatile="false"
  23834. static="true" final="true" visibility="public"
  23835. deprecated="not deprecated">
  23836. </field>
  23837. <field name="NM_NUMA_AWARENESS_NODE_IDS" type="java.lang.String"
  23838. transient="false" volatile="false"
  23839. static="true" final="true" visibility="public"
  23840. deprecated="not deprecated">
  23841. </field>
  23842. <field name="NM_NUMA_AWARENESS_NUMACTL_CMD" type="java.lang.String"
  23843. transient="false" volatile="false"
  23844. static="true" final="true" visibility="public"
  23845. deprecated="not deprecated">
  23846. </field>
  23847. <field name="DEFAULT_NM_NUMA_AWARENESS_NUMACTL_CMD" type="java.lang.String"
  23848. transient="false" volatile="false"
  23849. static="true" final="true" visibility="public"
  23850. deprecated="not deprecated">
  23851. </field>
  23852. <field name="NM_CONTAINERS_LAUNCHER_CLASS" type="java.lang.String"
  23853. transient="false" volatile="false"
  23854. static="true" final="true" visibility="public"
  23855. deprecated="not deprecated">
  23856. <doc>
  23857. <![CDATA[Containers launcher implementation to use.]]>
  23858. </doc>
  23859. </field>
  23860. <field name="YARN_WORKFLOW_ID_TAG_PREFIX" type="java.lang.String"
  23861. transient="false" volatile="false"
  23862. static="true" final="true" visibility="public"
  23863. deprecated="not deprecated">
  23864. </field>
  23865. <field name="DEFAULT_YARN_WORKFLOW_ID_TAG_PREFIX" type="java.lang.String"
  23866. transient="false" volatile="false"
  23867. static="true" final="true" visibility="public"
  23868. deprecated="not deprecated">
  23869. </field>
  23870. </class>
  23871. <!-- end class org.apache.hadoop.yarn.conf.YarnConfiguration -->
  23872. </package>
  23873. <package name="org.apache.hadoop.yarn.exceptions">
  23874. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
  23875. <class name="ApplicationAttemptNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  23876. abstract="false"
  23877. static="false" final="false" visibility="public"
  23878. deprecated="not deprecated">
  23879. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.Throwable"
  23880. static="false" final="false" visibility="public"
  23881. deprecated="not deprecated">
  23882. </constructor>
  23883. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String"
  23884. static="false" final="false" visibility="public"
  23885. deprecated="not deprecated">
  23886. </constructor>
  23887. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String, java.lang.Throwable"
  23888. static="false" final="false" visibility="public"
  23889. deprecated="not deprecated">
  23890. </constructor>
  23891. <doc>
  23892. <![CDATA[This exception is thrown on
  23893. {@link ApplicationHistoryProtocol#getApplicationAttemptReport (GetApplicationAttemptReportRequest)}
  23894. API when the Application Attempt doesn't exist in Application History Server or
  23895. {@link ApplicationMasterProtocol#allocate(AllocateRequest)} if application
  23896. doesn't exist in RM.]]>
  23897. </doc>
  23898. </class>
  23899. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
  23900. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
  23901. <class name="ApplicationIdNotProvidedException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  23902. abstract="false"
  23903. static="false" final="false" visibility="public"
  23904. deprecated="not deprecated">
  23905. <constructor name="ApplicationIdNotProvidedException" type="java.lang.Throwable"
  23906. static="false" final="false" visibility="public"
  23907. deprecated="not deprecated">
  23908. </constructor>
  23909. <constructor name="ApplicationIdNotProvidedException" type="java.lang.String"
  23910. static="false" final="false" visibility="public"
  23911. deprecated="not deprecated">
  23912. </constructor>
  23913. <constructor name="ApplicationIdNotProvidedException" type="java.lang.String, java.lang.Throwable"
  23914. static="false" final="false" visibility="public"
  23915. deprecated="not deprecated">
  23916. </constructor>
  23917. <doc>
  23918. <![CDATA[Exception to be thrown when Client submit an application without
  23919. providing {@link ApplicationId} in {@link ApplicationSubmissionContext}.]]>
  23920. </doc>
  23921. </class>
  23922. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
  23923. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
  23924. <class name="ApplicationNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  23925. abstract="false"
  23926. static="false" final="false" visibility="public"
  23927. deprecated="not deprecated">
  23928. <constructor name="ApplicationNotFoundException" type="java.lang.Throwable"
  23929. static="false" final="false" visibility="public"
  23930. deprecated="not deprecated">
  23931. </constructor>
  23932. <constructor name="ApplicationNotFoundException" type="java.lang.String"
  23933. static="false" final="false" visibility="public"
  23934. deprecated="not deprecated">
  23935. </constructor>
  23936. <constructor name="ApplicationNotFoundException" type="java.lang.String, java.lang.Throwable"
  23937. static="false" final="false" visibility="public"
  23938. deprecated="not deprecated">
  23939. </constructor>
  23940. <doc>
  23941. <![CDATA[This exception is thrown on
  23942. {@link ApplicationClientProtocol#getApplicationReport
  23943. (GetApplicationReportRequest)} API
  23944. when the Application doesn't exist in RM and AHS]]>
  23945. </doc>
  23946. </class>
  23947. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
  23948. <!-- start class org.apache.hadoop.yarn.exceptions.ConfigurationException -->
  23949. <class name="ConfigurationException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  23950. abstract="false"
  23951. static="false" final="false" visibility="public"
  23952. deprecated="not deprecated">
  23953. <constructor name="ConfigurationException" type="java.lang.Throwable"
  23954. static="false" final="false" visibility="public"
  23955. deprecated="not deprecated">
  23956. </constructor>
  23957. <constructor name="ConfigurationException" type="java.lang.String"
  23958. static="false" final="false" visibility="public"
  23959. deprecated="not deprecated">
  23960. </constructor>
  23961. <constructor name="ConfigurationException" type="java.lang.String, java.lang.Throwable"
  23962. static="false" final="false" visibility="public"
  23963. deprecated="not deprecated">
  23964. </constructor>
  23965. <doc>
  23966. <![CDATA[This exception is thrown on unrecoverable configuration errors.
  23967. An example is container launch error due to configuration.]]>
  23968. </doc>
  23969. </class>
  23970. <!-- end class org.apache.hadoop.yarn.exceptions.ConfigurationException -->
  23971. <!-- start class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
  23972. <class name="ContainerNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  23973. abstract="false"
  23974. static="false" final="false" visibility="public"
  23975. deprecated="not deprecated">
  23976. <constructor name="ContainerNotFoundException" type="java.lang.Throwable"
  23977. static="false" final="false" visibility="public"
  23978. deprecated="not deprecated">
  23979. </constructor>
  23980. <constructor name="ContainerNotFoundException" type="java.lang.String"
  23981. static="false" final="false" visibility="public"
  23982. deprecated="not deprecated">
  23983. </constructor>
  23984. <constructor name="ContainerNotFoundException" type="java.lang.String, java.lang.Throwable"
  23985. static="false" final="false" visibility="public"
  23986. deprecated="not deprecated">
  23987. </constructor>
  23988. <doc>
  23989. <![CDATA[This exception is thrown on
  23990. {@link ApplicationHistoryProtocol#getContainerReport (GetContainerReportRequest)}
  23991. API when the container doesn't exist in AHS]]>
  23992. </doc>
  23993. </class>
  23994. <!-- end class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
  23995. <!-- start class org.apache.hadoop.yarn.exceptions.ResourceNotFoundException -->
  23996. <class name="ResourceNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnRuntimeException"
  23997. abstract="false"
  23998. static="false" final="false" visibility="public"
  23999. deprecated="not deprecated">
  24000. <constructor name="ResourceNotFoundException" type="org.apache.hadoop.yarn.api.records.Resource, java.lang.String"
  24001. static="false" final="false" visibility="public"
  24002. deprecated="not deprecated">
  24003. </constructor>
  24004. <constructor name="ResourceNotFoundException" type="org.apache.hadoop.yarn.api.records.Resource, java.lang.String, java.lang.Throwable"
  24005. static="false" final="false" visibility="public"
  24006. deprecated="not deprecated">
  24007. </constructor>
  24008. <constructor name="ResourceNotFoundException" type="java.lang.String"
  24009. static="false" final="false" visibility="public"
  24010. deprecated="not deprecated">
  24011. </constructor>
  24012. <doc>
  24013. <![CDATA[This exception is thrown when details of an unknown resource type
  24014. are requested.]]>
  24015. </doc>
  24016. </class>
  24017. <!-- end class org.apache.hadoop.yarn.exceptions.ResourceNotFoundException -->
  24018. <!-- start class org.apache.hadoop.yarn.exceptions.YarnException -->
  24019. <class name="YarnException" extends="java.lang.Exception"
  24020. abstract="false"
  24021. static="false" final="false" visibility="public"
  24022. deprecated="not deprecated">
  24023. <constructor name="YarnException"
  24024. static="false" final="false" visibility="public"
  24025. deprecated="not deprecated">
  24026. </constructor>
  24027. <constructor name="YarnException" type="java.lang.String"
  24028. static="false" final="false" visibility="public"
  24029. deprecated="not deprecated">
  24030. </constructor>
  24031. <constructor name="YarnException" type="java.lang.Throwable"
  24032. static="false" final="false" visibility="public"
  24033. deprecated="not deprecated">
  24034. </constructor>
  24035. <constructor name="YarnException" type="java.lang.String, java.lang.Throwable"
  24036. static="false" final="false" visibility="public"
  24037. deprecated="not deprecated">
  24038. </constructor>
  24039. <doc>
  24040. <![CDATA[YarnException indicates exceptions from yarn servers. On the other hand,
  24041. IOExceptions indicates exceptions from RPC layer.]]>
  24042. </doc>
  24043. </class>
  24044. <!-- end class org.apache.hadoop.yarn.exceptions.YarnException -->
  24045. <!-- start class org.apache.hadoop.yarn.exceptions.YARNFeatureNotEnabledException -->
  24046. <class name="YARNFeatureNotEnabledException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  24047. abstract="false"
  24048. static="false" final="false" visibility="public"
  24049. deprecated="not deprecated">
  24050. <constructor name="YARNFeatureNotEnabledException" type="java.lang.Throwable"
  24051. static="false" final="false" visibility="public"
  24052. deprecated="not deprecated">
  24053. </constructor>
  24054. <constructor name="YARNFeatureNotEnabledException" type="java.lang.String"
  24055. static="false" final="false" visibility="public"
  24056. deprecated="not deprecated">
  24057. </constructor>
  24058. <constructor name="YARNFeatureNotEnabledException" type="java.lang.String, java.lang.Throwable"
  24059. static="false" final="false" visibility="public"
  24060. deprecated="not deprecated">
  24061. </constructor>
  24062. <doc>
  24063. <![CDATA[This exception is thrown when a feature is being used which is not enabled
  24064. yet.]]>
  24065. </doc>
  24066. </class>
  24067. <!-- end class org.apache.hadoop.yarn.exceptions.YARNFeatureNotEnabledException -->
  24068. </package>
  24069. <package name="org.apache.hadoop.yarn.server.api">
  24070. <!-- start class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
  24071. <class name="ApplicationInitializationContext" extends="java.lang.Object"
  24072. abstract="false"
  24073. static="false" final="false" visibility="public"
  24074. deprecated="not deprecated">
  24075. <constructor name="ApplicationInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ApplicationId, java.nio.ByteBuffer"
  24076. static="false" final="false" visibility="public"
  24077. deprecated="not deprecated">
  24078. </constructor>
  24079. <method name="getUser" return="java.lang.String"
  24080. abstract="false" native="false" synchronized="false"
  24081. static="false" final="false" visibility="public"
  24082. deprecated="not deprecated">
  24083. <doc>
  24084. <![CDATA[Get the user-name of the application-submitter
  24085. @return user-name]]>
  24086. </doc>
  24087. </method>
  24088. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  24089. abstract="false" native="false" synchronized="false"
  24090. static="false" final="false" visibility="public"
  24091. deprecated="not deprecated">
  24092. <doc>
  24093. <![CDATA[Get {@link ApplicationId} of the application
  24094. @return applications ID]]>
  24095. </doc>
  24096. </method>
  24097. <method name="getApplicationDataForService" return="java.nio.ByteBuffer"
  24098. abstract="false" native="false" synchronized="false"
  24099. static="false" final="false" visibility="public"
  24100. deprecated="not deprecated">
  24101. <doc>
  24102. <![CDATA[Get the data sent to the NodeManager via
  24103. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  24104. as part of {@link ContainerLaunchContext#getServiceData()}
  24105. @return the servicesData for this application.]]>
  24106. </doc>
  24107. </method>
  24108. <doc>
  24109. <![CDATA[Initialization context for {@link AuxiliaryService} when starting an
  24110. application.]]>
  24111. </doc>
  24112. </class>
  24113. <!-- end class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
  24114. <!-- start class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
  24115. <class name="ApplicationTerminationContext" extends="java.lang.Object"
  24116. abstract="false"
  24117. static="false" final="false" visibility="public"
  24118. deprecated="not deprecated">
  24119. <constructor name="ApplicationTerminationContext" type="org.apache.hadoop.yarn.api.records.ApplicationId"
  24120. static="false" final="false" visibility="public"
  24121. deprecated="not deprecated">
  24122. </constructor>
  24123. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  24124. abstract="false" native="false" synchronized="false"
  24125. static="false" final="false" visibility="public"
  24126. deprecated="not deprecated">
  24127. <doc>
  24128. <![CDATA[Get {@link ApplicationId} of the application being stopped.
  24129. @return applications ID]]>
  24130. </doc>
  24131. </method>
  24132. <doc>
  24133. <![CDATA[Initialization context for {@link AuxiliaryService} when stopping an
  24134. application.]]>
  24135. </doc>
  24136. </class>
  24137. <!-- end class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
  24138. <!-- start interface org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler -->
  24139. <interface name="AuxiliaryLocalPathHandler" abstract="true"
  24140. static="false" final="false" visibility="public"
  24141. deprecated="not deprecated">
  24142. <method name="getLocalPathForRead" return="org.apache.hadoop.fs.Path"
  24143. abstract="true" native="false" synchronized="false"
  24144. static="false" final="false" visibility="public"
  24145. deprecated="not deprecated">
  24146. <param name="path" type="java.lang.String"/>
  24147. <exception name="IOException" type="java.io.IOException"/>
  24148. <doc>
  24149. <![CDATA[Get a path from the local FS for reading for a given Auxiliary Service.
  24150. @param path the requested path
  24151. @return the complete path to the file on a local disk
  24152. @throws IOException if the file read encounters a problem]]>
  24153. </doc>
  24154. </method>
  24155. <method name="getLocalPathForWrite" return="org.apache.hadoop.fs.Path"
  24156. abstract="true" native="false" synchronized="false"
  24157. static="false" final="false" visibility="public"
  24158. deprecated="not deprecated">
  24159. <param name="path" type="java.lang.String"/>
  24160. <exception name="IOException" type="java.io.IOException"/>
  24161. <doc>
  24162. <![CDATA[Get a path from the local FS for writing for a given Auxiliary Service.
  24163. @param path the requested path
  24164. @return the complete path to the file on a local disk
  24165. @throws IOException if the path creations fails]]>
  24166. </doc>
  24167. </method>
  24168. <method name="getLocalPathForWrite" return="org.apache.hadoop.fs.Path"
  24169. abstract="true" native="false" synchronized="false"
  24170. static="false" final="false" visibility="public"
  24171. deprecated="not deprecated">
  24172. <param name="path" type="java.lang.String"/>
  24173. <param name="size" type="long"/>
  24174. <exception name="IOException" type="java.io.IOException"/>
  24175. <doc>
  24176. <![CDATA[Get a path from the local FS for writing a file of an estimated size
  24177. for a given Auxiliary Service.
  24178. @param path the requested path
  24179. @param size the size of the file that is going to be written
  24180. @return the complete path to the file on a local disk
  24181. @throws IOException if the path creations fails]]>
  24182. </doc>
  24183. </method>
  24184. <method name="getAllLocalPathsForRead" return="java.lang.Iterable"
  24185. abstract="true" native="false" synchronized="false"
  24186. static="false" final="false" visibility="public"
  24187. deprecated="not deprecated">
  24188. <param name="path" type="java.lang.String"/>
  24189. <exception name="IOException" type="java.io.IOException"/>
  24190. <doc>
  24191. <![CDATA[Get all paths from the local FS for reading for a given Auxiliary Service.
  24192. @param path the requested path
  24193. @return the complete path list to the file on a local disk as an Iterable
  24194. @throws IOException if the file read encounters a problem]]>
  24195. </doc>
  24196. </method>
  24197. <doc>
  24198. <![CDATA[An Interface that can retrieve local directories to read from or write to.
  24199. Components can implement this interface to link it to
  24200. their own Directory Handler Service]]>
  24201. </doc>
  24202. </interface>
  24203. <!-- end interface org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler -->
  24204. <!-- start class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
  24205. <class name="AuxiliaryService" extends="org.apache.hadoop.service.AbstractService"
  24206. abstract="true"
  24207. static="false" final="false" visibility="public"
  24208. deprecated="not deprecated">
  24209. <constructor name="AuxiliaryService" type="java.lang.String"
  24210. static="false" final="false" visibility="protected"
  24211. deprecated="not deprecated">
  24212. </constructor>
  24213. <method name="getRecoveryPath" return="org.apache.hadoop.fs.Path"
  24214. abstract="false" native="false" synchronized="false"
  24215. static="false" final="false" visibility="protected"
  24216. deprecated="not deprecated">
  24217. <doc>
  24218. <![CDATA[Get the path specific to this auxiliary service to use for recovery.
  24219. @return state storage path or null if recovery is not enabled]]>
  24220. </doc>
  24221. </method>
  24222. <method name="initializeApplication"
  24223. abstract="true" native="false" synchronized="false"
  24224. static="false" final="false" visibility="public"
  24225. deprecated="not deprecated">
  24226. <param name="initAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationInitializationContext"/>
  24227. <doc>
  24228. <![CDATA[A new application is started on this NodeManager. This is a signal to
  24229. this {@link AuxiliaryService} about the application initialization.
  24230. @param initAppContext context for the application's initialization]]>
  24231. </doc>
  24232. </method>
  24233. <method name="stopApplication"
  24234. abstract="true" native="false" synchronized="false"
  24235. static="false" final="false" visibility="public"
  24236. deprecated="not deprecated">
  24237. <param name="stopAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationTerminationContext"/>
  24238. <doc>
  24239. <![CDATA[An application is finishing on this NodeManager. This is a signal to this
  24240. {@link AuxiliaryService} about the same.
  24241. @param stopAppContext context for the application termination]]>
  24242. </doc>
  24243. </method>
  24244. <method name="getMetaData" return="java.nio.ByteBuffer"
  24245. abstract="true" native="false" synchronized="false"
  24246. static="false" final="false" visibility="public"
  24247. deprecated="not deprecated">
  24248. <doc>
  24249. <![CDATA[Retrieve meta-data for this {@link AuxiliaryService}. Applications using
  24250. this {@link AuxiliaryService} SHOULD know the format of the meta-data -
  24251. ideally each service should provide a method to parse out the information
  24252. to the applications. One example of meta-data is contact information so
  24253. that applications can access the service remotely. This will only be called
  24254. after the service's {@link #start()} method has finished. the result may be
  24255. cached.
  24256. <p>
  24257. The information is passed along to applications via
  24258. {@link StartContainersResponse#getAllServicesMetaData()} that is returned by
  24259. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  24260. </p>
  24261. @return meta-data for this service that should be made available to
  24262. applications.]]>
  24263. </doc>
  24264. </method>
  24265. <method name="initializeContainer"
  24266. abstract="false" native="false" synchronized="false"
  24267. static="false" final="false" visibility="public"
  24268. deprecated="not deprecated">
  24269. <param name="initContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerInitializationContext"/>
  24270. <doc>
  24271. <![CDATA[A new container is started on this NodeManager. This is a signal to
  24272. this {@link AuxiliaryService} about the container initialization.
  24273. This method is called when the NodeManager receives the container launch
  24274. command from the ApplicationMaster and before the container process is
  24275. launched.
  24276. @param initContainerContext context for the container's initialization]]>
  24277. </doc>
  24278. </method>
  24279. <method name="stopContainer"
  24280. abstract="false" native="false" synchronized="false"
  24281. static="false" final="false" visibility="public"
  24282. deprecated="not deprecated">
  24283. <param name="stopContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerTerminationContext"/>
  24284. <doc>
  24285. <![CDATA[A container is finishing on this NodeManager. This is a signal to this
  24286. {@link AuxiliaryService} about the same.
  24287. @param stopContainerContext context for the container termination]]>
  24288. </doc>
  24289. </method>
  24290. <method name="setRecoveryPath"
  24291. abstract="false" native="false" synchronized="false"
  24292. static="false" final="false" visibility="public"
  24293. deprecated="not deprecated">
  24294. <param name="recoveryPath" type="org.apache.hadoop.fs.Path"/>
  24295. <doc>
  24296. <![CDATA[Set the path for this auxiliary service to use for storing state
  24297. that will be used during recovery.
  24298. @param recoveryPath where recoverable state should be stored]]>
  24299. </doc>
  24300. </method>
  24301. <method name="getAuxiliaryLocalPathHandler" return="org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler"
  24302. abstract="false" native="false" synchronized="false"
  24303. static="false" final="false" visibility="public"
  24304. deprecated="not deprecated">
  24305. <doc>
  24306. <![CDATA[Method that gets the local dirs path handler for this Auxiliary Service.
  24307. @return auxiliaryPathHandler object that is used to read from and write to
  24308. valid local Dirs.]]>
  24309. </doc>
  24310. </method>
  24311. <method name="setAuxiliaryLocalPathHandler"
  24312. abstract="false" native="false" synchronized="false"
  24313. static="false" final="false" visibility="public"
  24314. deprecated="not deprecated">
  24315. <param name="auxiliaryLocalPathHandler" type="org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler"/>
  24316. <doc>
  24317. <![CDATA[Method that sets the local dirs path handler for this Auxiliary Service.
  24318. @param auxiliaryLocalPathHandler the pathHandler for this auxiliary service]]>
  24319. </doc>
  24320. </method>
  24321. <doc>
  24322. <![CDATA[A generic service that will be started by the NodeManager. This is a service
  24323. that administrators have to configure on each node by setting
  24324. {@link YarnConfiguration#NM_AUX_SERVICES}.]]>
  24325. </doc>
  24326. </class>
  24327. <!-- end class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
  24328. <!-- start class org.apache.hadoop.yarn.server.api.ContainerContext -->
  24329. <class name="ContainerContext" extends="java.lang.Object"
  24330. abstract="false"
  24331. static="false" final="false" visibility="public"
  24332. deprecated="not deprecated">
  24333. <constructor name="ContainerContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  24334. static="false" final="false" visibility="public"
  24335. deprecated="not deprecated">
  24336. </constructor>
  24337. <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"
  24338. static="false" final="false" visibility="public"
  24339. deprecated="not deprecated">
  24340. </constructor>
  24341. <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, org.apache.hadoop.yarn.api.records.ExecutionType"
  24342. static="false" final="false" visibility="public"
  24343. deprecated="not deprecated">
  24344. </constructor>
  24345. <method name="getUser" return="java.lang.String"
  24346. abstract="false" native="false" synchronized="false"
  24347. static="false" final="false" visibility="public"
  24348. deprecated="not deprecated">
  24349. <doc>
  24350. <![CDATA[Get user of the container being initialized or stopped.
  24351. @return the user]]>
  24352. </doc>
  24353. </method>
  24354. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  24355. abstract="false" native="false" synchronized="false"
  24356. static="false" final="false" visibility="public"
  24357. deprecated="not deprecated">
  24358. <doc>
  24359. <![CDATA[Get {@link ContainerId} of the container being initialized or stopped.
  24360. @return the container ID]]>
  24361. </doc>
  24362. </method>
  24363. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  24364. abstract="false" native="false" synchronized="false"
  24365. static="false" final="false" visibility="public"
  24366. deprecated="not deprecated">
  24367. <doc>
  24368. <![CDATA[Get {@link Resource} the resource capability allocated to the container
  24369. being initialized or stopped.
  24370. @return the resource capability.]]>
  24371. </doc>
  24372. </method>
  24373. <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
  24374. abstract="false" native="false" synchronized="false"
  24375. static="false" final="false" visibility="public"
  24376. deprecated="not deprecated">
  24377. <doc>
  24378. <![CDATA[Get {@link ContainerType} the type of the container
  24379. being initialized or stopped.
  24380. @return the type of the container]]>
  24381. </doc>
  24382. </method>
  24383. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  24384. abstract="false" native="false" synchronized="false"
  24385. static="false" final="false" visibility="public"
  24386. deprecated="not deprecated">
  24387. <doc>
  24388. <![CDATA[Get {@link ExecutionType} the execution type of the container
  24389. being initialized or stopped.
  24390. @return the execution type of the container]]>
  24391. </doc>
  24392. </method>
  24393. <doc>
  24394. <![CDATA[Base context class for {@link AuxiliaryService} initializing and stopping a
  24395. container.]]>
  24396. </doc>
  24397. </class>
  24398. <!-- end class org.apache.hadoop.yarn.server.api.ContainerContext -->
  24399. <!-- start class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
  24400. <class name="ContainerInitializationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
  24401. abstract="false"
  24402. static="false" final="false" visibility="public"
  24403. deprecated="not deprecated">
  24404. <constructor name="ContainerInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  24405. static="false" final="false" visibility="public"
  24406. deprecated="not deprecated">
  24407. </constructor>
  24408. <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"
  24409. static="false" final="false" visibility="public"
  24410. deprecated="not deprecated">
  24411. </constructor>
  24412. <doc>
  24413. <![CDATA[Initialization context for {@link AuxiliaryService} when starting a
  24414. container.]]>
  24415. </doc>
  24416. </class>
  24417. <!-- end class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
  24418. <!-- start interface org.apache.hadoop.yarn.server.api.ContainerLogAggregationPolicy -->
  24419. <interface name="ContainerLogAggregationPolicy" abstract="true"
  24420. static="false" final="false" visibility="public"
  24421. deprecated="not deprecated">
  24422. <method name="parseParameters"
  24423. abstract="true" native="false" synchronized="false"
  24424. static="false" final="false" visibility="public"
  24425. deprecated="not deprecated">
  24426. <param name="parameters" type="java.lang.String"/>
  24427. <doc>
  24428. <![CDATA[<p>
  24429. The method used by the NodeManager log aggregation service
  24430. to initial the policy object with parameters specified by the application
  24431. or the cluster-wide setting.
  24432. </p>
  24433. @param parameters parameters with scheme defined by the policy class.]]>
  24434. </doc>
  24435. </method>
  24436. <method name="shouldDoLogAggregation" return="boolean"
  24437. abstract="true" native="false" synchronized="false"
  24438. static="false" final="false" visibility="public"
  24439. deprecated="not deprecated">
  24440. <param name="logContext" type="org.apache.hadoop.yarn.server.api.ContainerLogContext"/>
  24441. <doc>
  24442. <![CDATA[<p>
  24443. The method used by the NodeManager log aggregation service
  24444. to ask the policy object if a given container's logs should be aggregated.
  24445. </p>
  24446. @param logContext ContainerLogContext
  24447. @return Whether or not the container's logs should be aggregated.]]>
  24448. </doc>
  24449. </method>
  24450. <doc>
  24451. <![CDATA[This API is used by NodeManager to decide if a given container's logs
  24452. should be aggregated at run time.]]>
  24453. </doc>
  24454. </interface>
  24455. <!-- end interface org.apache.hadoop.yarn.server.api.ContainerLogAggregationPolicy -->
  24456. <!-- start class org.apache.hadoop.yarn.server.api.ContainerLogContext -->
  24457. <class name="ContainerLogContext" extends="java.lang.Object"
  24458. abstract="false"
  24459. static="false" final="false" visibility="public"
  24460. deprecated="not deprecated">
  24461. <constructor name="ContainerLogContext" type="org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.server.api.ContainerType, int"
  24462. static="false" final="false" visibility="public"
  24463. deprecated="not deprecated">
  24464. </constructor>
  24465. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  24466. abstract="false" native="false" synchronized="false"
  24467. static="false" final="false" visibility="public"
  24468. deprecated="not deprecated">
  24469. <doc>
  24470. <![CDATA[Get {@link ContainerId} of the container.
  24471. @return the container ID]]>
  24472. </doc>
  24473. </method>
  24474. <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
  24475. abstract="false" native="false" synchronized="false"
  24476. static="false" final="false" visibility="public"
  24477. deprecated="not deprecated">
  24478. <doc>
  24479. <![CDATA[Get {@link ContainerType} the type of the container.
  24480. @return the type of the container]]>
  24481. </doc>
  24482. </method>
  24483. <method name="getExitCode" return="int"
  24484. abstract="false" native="false" synchronized="false"
  24485. static="false" final="false" visibility="public"
  24486. deprecated="not deprecated">
  24487. <doc>
  24488. <![CDATA[Get the exit code of the container.
  24489. @return the exit code]]>
  24490. </doc>
  24491. </method>
  24492. <doc>
  24493. <![CDATA[Context class for {@link ContainerLogAggregationPolicy}.]]>
  24494. </doc>
  24495. </class>
  24496. <!-- end class org.apache.hadoop.yarn.server.api.ContainerLogContext -->
  24497. <!-- start class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
  24498. <class name="ContainerTerminationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
  24499. abstract="false"
  24500. static="false" final="false" visibility="public"
  24501. deprecated="not deprecated">
  24502. <constructor name="ContainerTerminationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  24503. static="false" final="false" visibility="public"
  24504. deprecated="not deprecated">
  24505. </constructor>
  24506. <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"
  24507. static="false" final="false" visibility="public"
  24508. deprecated="not deprecated">
  24509. </constructor>
  24510. <doc>
  24511. <![CDATA[Termination context for {@link AuxiliaryService} when stopping a
  24512. container.]]>
  24513. </doc>
  24514. </class>
  24515. <!-- end class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
  24516. <!-- start interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
  24517. <interface name="SCMAdminProtocol" abstract="true"
  24518. static="false" final="false" visibility="public"
  24519. deprecated="not deprecated">
  24520. <method name="runCleanerTask" return="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskResponse"
  24521. abstract="true" native="false" synchronized="false"
  24522. static="false" final="false" visibility="public"
  24523. deprecated="not deprecated">
  24524. <param name="request" type="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskRequest"/>
  24525. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  24526. <exception name="IOException" type="java.io.IOException"/>
  24527. <doc>
  24528. <![CDATA[<p>
  24529. The method used by administrators to ask SCM to run cleaner task right away
  24530. </p>
  24531. @param request request <code>SharedCacheManager</code> to run a cleaner task
  24532. @return <code>SharedCacheManager</code> returns an empty response
  24533. on success and throws an exception on rejecting the request
  24534. @throws YarnException
  24535. @throws IOException]]>
  24536. </doc>
  24537. </method>
  24538. <doc>
  24539. <![CDATA[<p>
  24540. The protocol between administrators and the <code>SharedCacheManager</code>
  24541. </p>]]>
  24542. </doc>
  24543. </interface>
  24544. <!-- end interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
  24545. </package>
  24546. <package name="org.apache.hadoop.yarn.util">
  24547. </package>
  24548. <package name="org.apache.hadoop.yarn.util.constraint">
  24549. <!-- start class org.apache.hadoop.yarn.util.constraint.PlacementConstraintParser -->
  24550. <class name="PlacementConstraintParser" extends="java.lang.Object"
  24551. abstract="false"
  24552. static="false" final="true" visibility="public"
  24553. deprecated="not deprecated">
  24554. <method name="parseExpression" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  24555. abstract="false" native="false" synchronized="false"
  24556. static="true" final="false" visibility="public"
  24557. deprecated="not deprecated">
  24558. <param name="constraintStr" type="java.lang.String"/>
  24559. <exception name="PlacementConstraintParseException" type="org.apache.hadoop.yarn.util.constraint.PlacementConstraintParseException"/>
  24560. <doc>
  24561. <![CDATA[Parses a given constraint expression to a {@link AbstractConstraint},
  24562. this expression can be any valid form of constraint expressions.
  24563. @param constraintStr expression string
  24564. @return a parsed {@link AbstractConstraint}
  24565. @throws PlacementConstraintParseException when given expression
  24566. is malformed]]>
  24567. </doc>
  24568. </method>
  24569. <method name="parsePlacementSpec" return="java.util.Map"
  24570. abstract="false" native="false" synchronized="false"
  24571. static="true" final="false" visibility="public"
  24572. deprecated="not deprecated">
  24573. <param name="expression" type="java.lang.String"/>
  24574. <exception name="PlacementConstraintParseException" type="org.apache.hadoop.yarn.util.constraint.PlacementConstraintParseException"/>
  24575. <doc>
  24576. <![CDATA[Parses a placement constraint specification. A placement constraint spec
  24577. is a composite expression which is composed by multiple sub constraint
  24578. expressions delimited by ":". With following syntax:
  24579. <p>Tag1(N1),P1:Tag2(N2),P2:...:TagN(Nn),Pn</p>
  24580. where <b>TagN(Nn)</b> is a key value pair to determine the source
  24581. allocation tag and the number of allocations, such as:
  24582. <p>foo(3)</p>
  24583. Optional when using NodeAttribute Constraint.
  24584. and where <b>Pn</b> can be any form of a valid constraint expression,
  24585. such as:
  24586. <ul>
  24587. <li>in,node,foo,bar</li>
  24588. <li>notin,node,foo,bar,1,2</li>
  24589. <li>and(notin,node,foo:notin,node,bar)</li>
  24590. </ul>
  24591. and NodeAttribute Constraint such as
  24592. <ul>
  24593. <li>yarn.rm.io/foo=true</li>
  24594. <li>java=1.7,1.8</li>
  24595. </ul>
  24596. @param expression expression string.
  24597. @return a map of source tags to placement constraint mapping.
  24598. @throws PlacementConstraintParseException]]>
  24599. </doc>
  24600. </method>
  24601. <field name="EXPRESSION_VAL_DELIM" type="char"
  24602. transient="false" volatile="false"
  24603. static="true" final="true" visibility="public"
  24604. deprecated="not deprecated">
  24605. </field>
  24606. <doc>
  24607. <![CDATA[Placement constraint expression parser.]]>
  24608. </doc>
  24609. </class>
  24610. <!-- end class org.apache.hadoop.yarn.util.constraint.PlacementConstraintParser -->
  24611. </package>
  24612. <package name="org.apache.hadoop.yarn.util.resource">
  24613. </package>
  24614. </api>