Apache_Hadoop_YARN_API_3.3.6.xml 1.1 MB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442244432444424445244462444724448244492445024451244522445324454244552445624457244582445924460244612446224463244642446524466244672446824469244702447124472244732447424475244762447724478244792448024481244822448324484244852448624487244882448924490244912449224493244942449524496244972449824499245002450124502245032450424505245062450724508245092451024511245122451324514245152451624517245182451924520245212452224523245242452524526245272452824529245302453124532245332453424535245362453724538245392454024541245422454324544245452454624547245482454924550245512455224553245542455524556245572455824559245602456124562245632456424565245662456724568245692457024571245722457324574245752457624577245782457924580245812458224583245842458524586245872458824589245902459124592245932459424595245962459724598245992460024601246022460324604246052460624607246082460924610246112461224613246142461524616246172461824619246202462124622246232462424625246262462724628246292463024631246322463324634246352463624637246382463924640246412464224643246442464524646246472464824649246502465124652246532465424655246562465724658246592466024661246622466324664246652466624667246682466924670246712467224673246742467524676246772467824679246802468124682246832468424685246862468724688246892469024691246922469324694246952469624697246982469924700247012470224703247042470524706247072470824709247102471124712247132471424715247162471724718247192472024721247222472324724247252472624727247282472924730247312473224733247342473524736247372473824739247402474124742247432474424745247462474724748247492475024751247522475324754247552475624757247582475924760247612476224763247642476524766247672476824769247702477124772247732477424775247762477724778247792478024781247822478324784247852478624787247882478924790247912479224793247942479524796247972479824799248002480124802248032480424805248062480724808248092481024811248122481324814248152481624817248182481924820248212482224823248242482524826248272482824829248302483124832248332483424835248362483724838248392484024841248422484324844248452484624847248482484924850248512485224853248542485524856248572485824859248602486124862248632486424865248662486724868248692487024871248722487324874248752487624877248782487924880248812488224883248842488524886248872488824889248902489124892248932489424895248962489724898248992490024901249022490324904249052490624907249082490924910249112491224913249142491524916249172491824919249202492124922249232492424925249262492724928249292493024931249322493324934249352493624937249382493924940249412494224943249442494524946249472494824949249502495124952249532495424955249562495724958249592496024961249622496324964249652496624967249682496924970249712497224973249742497524976249772497824979249802498124982249832498424985249862498724988249892499024991249922499324994249952499624997249982499925000250012500225003250042500525006250072500825009250102501125012250132501425015250162501725018250192502025021250222502325024250252502625027250282502925030250312503225033250342503525036250372503825039250402504125042250432504425045250462504725048250492505025051250522505325054250552505625057250582505925060250612506225063250642506525066250672506825069250702507125072250732507425075250762507725078250792508025081250822508325084250852508625087250882508925090250912509225093250942509525096250972509825099251002510125102251032510425105251062510725108251092511025111251122511325114251152511625117251182511925120251212512225123251242512525126251272512825129251302513125132251332513425135251362513725138251392514025141251422514325144251452514625147251482514925150251512515225153251542515525156251572515825159251602516125162251632516425165251662516725168251692517025171251722517325174251752517625177251782517925180251812518225183251842518525186251872518825189251902519125192251932519425195251962519725198251992520025201252022520325204252052520625207252082520925210252112521225213252142521525216252172521825219252202522125222252232522425225252262522725228252292523025231252322523325234252352523625237252382523925240252412524225243252442524525246252472524825249252502525125252252532525425255252562525725258252592526025261252622526325264252652526625267252682526925270252712527225273252742527525276252772527825279252802528125282252832528425285252862528725288252892529025291252922529325294252952529625297252982529925300253012530225303253042530525306253072530825309253102531125312253132531425315253162531725318253192532025321253222532325324253252532625327253282532925330253312533225333253342533525336253372533825339253402534125342253432534425345253462534725348253492535025351253522535325354253552535625357253582535925360253612536225363253642536525366253672536825369253702537125372253732537425375253762537725378253792538025381253822538325384253852538625387253882538925390253912539225393253942539525396253972539825399254002540125402254032540425405254062540725408254092541025411254122541325414254152541625417254182541925420254212542225423254242542525426254272542825429254302543125432254332543425435254362543725438254392544025441254422544325444254452544625447254482544925450254512545225453254542545525456254572545825459254602546125462254632546425465254662546725468254692547025471254722547325474254752547625477254782547925480254812548225483254842548525486254872548825489254902549125492254932549425495254962549725498254992550025501255022550325504255052550625507255082550925510255112551225513255142551525516255172551825519255202552125522255232552425525255262552725528255292553025531255322553325534255352553625537255382553925540255412554225543255442554525546255472554825549255502555125552255532555425555255562555725558255592556025561255622556325564255652556625567255682556925570255712557225573255742557525576255772557825579255802558125582255832558425585255862558725588255892559025591255922559325594255952559625597255982559925600256012560225603256042560525606256072560825609256102561125612256132561425615256162561725618256192562025621256222562325624256252562625627256282562925630256312563225633256342563525636256372563825639256402564125642256432564425645256462564725648256492565025651256522565325654256552565625657256582565925660256612566225663256642566525666256672566825669256702567125672256732567425675256762567725678256792568025681256822568325684256852568625687256882568925690256912569225693256942569525696256972569825699257002570125702257032570425705257062570725708257092571025711257122571325714257152571625717257182571925720257212572225723257242572525726257272572825729257302573125732257332573425735257362573725738257392574025741257422574325744257452574625747257482574925750257512575225753257542575525756257572575825759257602576125762257632576425765257662576725768257692577025771257722577325774257752577625777257782577925780257812578225783257842578525786257872578825789257902579125792257932579425795257962579725798257992580025801258022580325804258052580625807258082580925810258112581225813258142581525816258172581825819258202582125822258232582425825258262582725828258292583025831258322583325834258352583625837258382583925840258412584225843258442584525846258472584825849258502585125852258532585425855258562585725858258592586025861258622586325864258652586625867258682586925870258712587225873258742587525876258772587825879258802588125882258832588425885258862588725888258892589025891258922589325894258952589625897258982589925900259012590225903259042590525906259072590825909259102591125912259132591425915259162591725918259192592025921259222592325924259252592625927259282592925930259312593225933259342593525936259372593825939259402594125942259432594425945259462594725948259492595025951259522595325954259552595625957259582595925960259612596225963259642596525966259672596825969259702597125972259732597425975259762597725978259792598025981259822598325984259852598625987259882598925990259912599225993259942599525996259972599825999260002600126002260032600426005260062600726008260092601026011260122601326014260152601626017260182601926020260212602226023260242602526026260272602826029260302603126032260332603426035260362603726038260392604026041260422604326044260452604626047260482604926050260512605226053260542605526056260572605826059260602606126062260632606426065260662606726068260692607026071260722607326074260752607626077260782607926080260812608226083260842608526086260872608826089260902609126092260932609426095260962609726098260992610026101261022610326104261052610626107261082610926110261112611226113261142611526116261172611826119261202612126122261232612426125261262612726128261292613026131261322613326134261352613626137261382613926140261412614226143261442614526146261472614826149261502615126152261532615426155261562615726158261592616026161261622616326164261652616626167261682616926170261712617226173261742617526176261772617826179261802618126182261832618426185261862618726188261892619026191261922619326194261952619626197261982619926200262012620226203262042620526206262072620826209262102621126212262132621426215262162621726218262192622026221262222622326224262252622626227262282622926230262312623226233262342623526236262372623826239262402624126242262432624426245262462624726248262492625026251262522625326254262552625626257262582625926260262612626226263262642626526266262672626826269262702627126272262732627426275262762627726278262792628026281262822628326284262852628626287262882628926290262912629226293262942629526296262972629826299263002630126302263032630426305263062630726308263092631026311263122631326314263152631626317263182631926320263212632226323263242632526326263272632826329263302633126332263332633426335263362633726338263392634026341263422634326344263452634626347263482634926350263512635226353263542635526356263572635826359263602636126362263632636426365263662636726368263692637026371263722637326374263752637626377263782637926380263812638226383263842638526386263872638826389263902639126392263932639426395263962639726398263992640026401264022640326404264052640626407264082640926410264112641226413264142641526416264172641826419264202642126422264232642426425264262642726428264292643026431264322643326434264352643626437264382643926440
  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 Mon Jun 19 00:22:53 UTC 2023 -->
  5. <api
  6. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  7. xsi:noNamespaceSchemaLocation='api.xsd'
  8. name="Apache Hadoop YARN API 3.3.6"
  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/org/apache/hadoop/thirdparty/hadoop-shaded-guava/1.1.1/hadoop-shaded-guava-1.1.1.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.3.6.jar:/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/org/checkerframework/checker-qual/2.5.2/checker-qual-2.5.2.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-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.15/commons-codec-1.15.jar:/maven/commons-io/commons-io/2.8.0/commons-io-2.8.0.jar:/maven/commons-net/commons-net/3.9.0/commons-net-3.9.0.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/jakarta/activation/jakarta.activation-api/1.2.1/jakarta.activation-api-1.2.1.jar:/maven/org/eclipse/jetty/jetty-server/9.4.51.v20230217/jetty-server-9.4.51.v20230217.jar:/maven/org/eclipse/jetty/jetty-http/9.4.51.v20230217/jetty-http-9.4.51.v20230217.jar:/maven/org/eclipse/jetty/jetty-io/9.4.51.v20230217/jetty-io-9.4.51.v20230217.jar:/maven/org/eclipse/jetty/jetty-util/9.4.51.v20230217/jetty-util-9.4.51.v20230217.jar:/maven/org/eclipse/jetty/jetty-servlet/9.4.51.v20230217/jetty-servlet-9.4.51.v20230217.jar:/maven/org/eclipse/jetty/jetty-security/9.4.51.v20230217/jetty-security-9.4.51.v20230217.jar:/maven/org/eclipse/jetty/jetty-util-ajax/9.4.51.v20230217/jetty-util-ajax-9.4.51.v20230217.jar:/maven/org/eclipse/jetty/jetty-webapp/9.4.51.v20230217/jetty-webapp-9.4.51.v20230217.jar:/maven/org/eclipse/jetty/jetty-xml/9.4.51.v20230217/jetty-xml-9.4.51.v20230217.jar:/maven/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/maven/com/sun/jersey/jersey-core/1.19.4/jersey-core-1.19.4.jar:/maven/javax/ws/rs/jsr311-api/1.1.1/jsr311-api-1.1.1.jar:/maven/com/sun/jersey/jersey-servlet/1.19.4/jersey-servlet-1.19.4.jar:/maven/com/github/pjfanning/jersey-json/1.20/jersey-json-1.20.jar:/maven/org/codehaus/jettison/jettison/1.5.4/jettison-1.5.4.jar:/maven/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/maven/com/sun/jersey/jersey-server/1.19.4/jersey-server-1.19.4.jar:/maven/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/maven/ch/qos/reload4j/reload4j/1.2.22/reload4j-1.2.22.jar:/maven/commons-beanutils/commons-beanutils/1.9.4/commons-beanutils-1.9.4.jar:/maven/org/apache/commons/commons-configuration2/2.8.0/commons-configuration2-2.8.0.jar:/maven/org/apache/commons/commons-lang3/3.12.0/commons-lang3-3.12.0.jar:/maven/org/apache/commons/commons-text/1.10.0/commons-text-1.10.0.jar:/maven/org/slf4j/slf4j-api/1.7.36/slf4j-api-1.7.36.jar:/maven/org/apache/avro/avro/1.7.7/avro-1.7.7.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/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.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.3.6.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/org/apache/curator/curator-framework/5.2.0/curator-framework-5.2.0.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-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/jcraft/jsch/0.1.55/jsch-0.1.55.jar:/maven/org/apache/curator/curator-client/5.2.0/curator-client-5.2.0.jar:/maven/org/apache/curator/curator-recipes/5.2.0/curator-recipes-5.2.0.jar:/maven/com/google/code/findbugs/jsr305/3.0.2/jsr305-3.0.2.jar:/maven/org/apache/zookeeper/zookeeper/3.6.3/zookeeper-3.6.3.jar:/maven/org/apache/zookeeper/zookeeper-jute/3.6.3/zookeeper-jute-3.6.3.jar:/maven/org/apache/yetus/audience-annotations/0.5.0/audience-annotations-0.5.0.jar:/maven/io/dropwizard/metrics/metrics-core/3.2.4/metrics-core-3.2.4.jar:/maven/org/apache/commons/commons-compress/1.21/commons-compress-1.21.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/com/fasterxml/jackson/core/jackson-databind/2.12.7.1/jackson-databind-2.12.7.1.jar:/maven/com/fasterxml/jackson/core/jackson-core/2.12.7/jackson-core-2.12.7.jar:/maven/org/codehaus/woodstox/stax2-api/4.2.1/stax2-api-4.2.1.jar:/maven/com/fasterxml/woodstox/woodstox-core/5.4.0/woodstox-core-5.4.0.jar:/maven/dnsjava/dnsjava/2.1.7/dnsjava-2.1.7.jar:/maven/org/xerial/snappy/snappy-java/1.1.8.2/snappy-java-1.1.8.2.jar:/build/source/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-3.3.6.jar:/usr/lib/jvm/java-8-openjdk-arm64/lib/tools.jar:/maven/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar:/maven/org/apache/hadoop/thirdparty/hadoop-shaded-protobuf_3_7/1.1.1/hadoop-shaded-protobuf_3_7-1.1.1.jar:/maven/com/fasterxml/jackson/core/jackson-annotations/2.12.7/jackson-annotations-2.12.7.jar:/maven/xerces/xercesImpl/2.12.2/xercesImpl-2.12.2.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.3.6 -->
  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="KEYSTORE_FILE_LOCATION_ENV_NAME" 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 file into which the keystore containing the AM's certificate is
  648. written.]]>
  649. </doc>
  650. </field>
  651. <field name="KEYSTORE_PASSWORD_ENV_NAME" type="java.lang.String"
  652. transient="false" volatile="false"
  653. static="true" final="true" visibility="public"
  654. deprecated="not deprecated">
  655. <doc>
  656. <![CDATA[The password for the AM's keystore.]]>
  657. </doc>
  658. </field>
  659. <field name="TRUSTSTORE_FILE_LOCATION_ENV_NAME" type="java.lang.String"
  660. transient="false" volatile="false"
  661. static="true" final="true" visibility="public"
  662. deprecated="not deprecated">
  663. <doc>
  664. <![CDATA[The file into which the truststore containing the AM's certificate is
  665. written.]]>
  666. </doc>
  667. </field>
  668. <field name="TRUSTSTORE_PASSWORD_ENV_NAME" type="java.lang.String"
  669. transient="false" volatile="false"
  670. static="true" final="true" visibility="public"
  671. deprecated="not deprecated">
  672. <doc>
  673. <![CDATA[The password for the AM's truststore.]]>
  674. </doc>
  675. </field>
  676. <field name="APPLICATION_WEB_PROXY_BASE_ENV" type="java.lang.String"
  677. transient="false" volatile="false"
  678. static="true" final="true" visibility="public"
  679. deprecated="not deprecated">
  680. <doc>
  681. <![CDATA[The environmental variable for APPLICATION_WEB_PROXY_BASE. Set in
  682. ApplicationMaster's environment only. This states that for all non-relative
  683. web URLs in the app masters web UI what base should they have.]]>
  684. </doc>
  685. </field>
  686. <field name="LOG_DIR_EXPANSION_VAR" type="java.lang.String"
  687. transient="false" volatile="false"
  688. static="true" final="true" visibility="public"
  689. deprecated="not deprecated">
  690. <doc>
  691. <![CDATA[The temporary environmental variable for container log directory. This
  692. should be replaced by real container log directory on container launch.]]>
  693. </doc>
  694. </field>
  695. <field name="CLASS_PATH_SEPARATOR" type="java.lang.String"
  696. transient="false" volatile="false"
  697. static="true" final="true" visibility="public"
  698. deprecated="not deprecated">
  699. <doc>
  700. <![CDATA[This constant is used to construct class path and it will be replaced with
  701. real class path separator(':' for Linux and ';' for Windows) by
  702. NodeManager on container launch. User has to use this constant to construct
  703. class path if user wants cross-platform practice i.e. submit an application
  704. from a Windows client to a Linux/Unix server or vice versa.]]>
  705. </doc>
  706. </field>
  707. <field name="PARAMETER_EXPANSION_LEFT" type="java.lang.String"
  708. transient="false" volatile="false"
  709. static="true" final="true" visibility="public"
  710. deprecated="not deprecated">
  711. <doc>
  712. <![CDATA[The following two constants are used to expand parameter and it will be
  713. replaced with real parameter expansion marker ('%' for Windows and '$' for
  714. Linux) by NodeManager on container launch. For example: {{VAR}} will be
  715. replaced as $VAR on Linux, and %VAR% on Windows. User has to use this
  716. constant to construct class path if user wants cross-platform practice i.e.
  717. submit an application from a Windows client to a Linux/Unix server or vice
  718. versa.]]>
  719. </doc>
  720. </field>
  721. <field name="PARAMETER_EXPANSION_RIGHT" type="java.lang.String"
  722. transient="false" volatile="false"
  723. static="true" final="true" visibility="public"
  724. deprecated="not deprecated">
  725. <doc>
  726. <![CDATA[User has to use this constant to construct class path if user wants
  727. cross-platform practice i.e. submit an application from a Windows client to
  728. a Linux/Unix server or vice versa.]]>
  729. </doc>
  730. </field>
  731. <field name="STDERR" type="java.lang.String"
  732. transient="false" volatile="false"
  733. static="true" final="true" visibility="public"
  734. deprecated="not deprecated">
  735. </field>
  736. <field name="STDOUT" type="java.lang.String"
  737. transient="false" volatile="false"
  738. static="true" final="true" visibility="public"
  739. deprecated="not deprecated">
  740. </field>
  741. <doc>
  742. <![CDATA[This is the API for the applications comprising of constants that YARN sets
  743. up for the applications and the containers.
  744. TODO: Investigate the semantics and security of each cross-boundary refs.]]>
  745. </doc>
  746. </interface>
  747. <!-- end interface org.apache.hadoop.yarn.api.ApplicationConstants -->
  748. <!-- start class org.apache.hadoop.yarn.api.ApplicationConstants.ContainerLaunchType -->
  749. <class name="ApplicationConstants.ContainerLaunchType" extends="java.lang.Enum"
  750. abstract="false"
  751. static="true" final="true" visibility="public"
  752. deprecated="not deprecated">
  753. <method name="values" return="org.apache.hadoop.yarn.api.ApplicationConstants.ContainerLaunchType[]"
  754. abstract="false" native="false" synchronized="false"
  755. static="true" final="false" visibility="public"
  756. deprecated="not deprecated">
  757. </method>
  758. <method name="valueOf" return="org.apache.hadoop.yarn.api.ApplicationConstants.ContainerLaunchType"
  759. abstract="false" native="false" synchronized="false"
  760. static="true" final="false" visibility="public"
  761. deprecated="not deprecated">
  762. <param name="name" type="java.lang.String"/>
  763. </method>
  764. <doc>
  765. <![CDATA[The type of launch for the container.]]>
  766. </doc>
  767. </class>
  768. <!-- end class org.apache.hadoop.yarn.api.ApplicationConstants.ContainerLaunchType -->
  769. <!-- start interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
  770. <interface name="ApplicationHistoryProtocol" abstract="true"
  771. static="false" final="false" visibility="public"
  772. deprecated="not deprecated">
  773. <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
  774. <doc>
  775. <![CDATA[<p>
  776. The protocol between clients and the <code>ApplicationHistoryServer</code> to
  777. get the information of completed applications etc.
  778. </p>]]>
  779. </doc>
  780. </interface>
  781. <!-- end interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
  782. <!-- start interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
  783. <interface name="ApplicationMasterProtocol" abstract="true"
  784. static="false" final="false" visibility="public"
  785. deprecated="not deprecated">
  786. <method name="registerApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse"
  787. abstract="true" native="false" synchronized="false"
  788. static="false" final="false" visibility="public"
  789. deprecated="not deprecated">
  790. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"/>
  791. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  792. <exception name="IOException" type="java.io.IOException"/>
  793. <doc>
  794. <![CDATA[<p>
  795. The interface used by a new <code>ApplicationMaster</code> to register with
  796. the <code>ResourceManager</code>.
  797. </p>
  798. <p>
  799. The <code>ApplicationMaster</code> needs to provide details such as RPC
  800. Port, HTTP tracking url etc. as specified in
  801. {@link RegisterApplicationMasterRequest}.
  802. </p>
  803. <p>
  804. The <code>ResourceManager</code> responds with critical details such as
  805. maximum resource capabilities in the cluster as specified in
  806. {@link RegisterApplicationMasterResponse}.
  807. </p>
  808. <p>
  809. Re-register is only allowed for <code>Unmanaged Application Master</code>
  810. (UAM) HA, with
  811. {@link org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext#getKeepContainersAcrossApplicationAttempts()}
  812. set to true.
  813. </p>
  814. @param request registration request
  815. @return registration respose
  816. @throws YarnException
  817. @throws IOException
  818. @throws InvalidApplicationMasterRequestException The exception is thrown
  819. when an ApplicationMaster tries to register more then once.
  820. @see RegisterApplicationMasterRequest
  821. @see RegisterApplicationMasterResponse]]>
  822. </doc>
  823. </method>
  824. <method name="finishApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse"
  825. abstract="true" native="false" synchronized="false"
  826. static="false" final="false" visibility="public"
  827. deprecated="not deprecated">
  828. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"/>
  829. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  830. <exception name="IOException" type="java.io.IOException"/>
  831. <doc>
  832. <![CDATA[<p>The interface used by an <code>ApplicationMaster</code> to notify the
  833. <code>ResourceManager</code> about its completion (success or failed).</p>
  834. <p>The <code>ApplicationMaster</code> has to provide details such as
  835. final state, diagnostics (in case of failures) etc. as specified in
  836. {@link FinishApplicationMasterRequest}.</p>
  837. <p>The <code>ResourceManager</code> responds with
  838. {@link FinishApplicationMasterResponse}.</p>
  839. @param request completion request
  840. @return completion response
  841. @throws YarnException
  842. @throws IOException
  843. @see FinishApplicationMasterRequest
  844. @see FinishApplicationMasterResponse]]>
  845. </doc>
  846. </method>
  847. <method name="allocate" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  848. abstract="true" native="false" synchronized="false"
  849. static="false" final="false" visibility="public"
  850. deprecated="not deprecated">
  851. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"/>
  852. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  853. <exception name="IOException" type="java.io.IOException"/>
  854. <doc>
  855. <![CDATA[<p>
  856. The main interface between an <code>ApplicationMaster</code> and the
  857. <code>ResourceManager</code>.
  858. </p>
  859. <p>
  860. The <code>ApplicationMaster</code> uses this interface to provide a list of
  861. {@link ResourceRequest} and returns unused {@link Container} allocated to
  862. it via {@link AllocateRequest}. Optionally, the
  863. <code>ApplicationMaster</code> can also <em>blacklist</em> resources which
  864. it doesn't want to use.
  865. </p>
  866. <p>
  867. This also doubles up as a <em>heartbeat</em> to let the
  868. <code>ResourceManager</code> know that the <code>ApplicationMaster</code>
  869. is alive. Thus, applications should periodically make this call to be kept
  870. alive. The frequency depends on
  871. {@link YarnConfiguration#RM_AM_EXPIRY_INTERVAL_MS} which defaults to
  872. {@link YarnConfiguration#DEFAULT_RM_AM_EXPIRY_INTERVAL_MS}.
  873. </p>
  874. <p>
  875. The <code>ResourceManager</code> responds with list of allocated
  876. {@link Container}, status of completed containers and headroom information
  877. for the application.
  878. </p>
  879. <p>
  880. The <code>ApplicationMaster</code> can use the available headroom
  881. (resources) to decide how to utilized allocated resources and make informed
  882. decisions about future resource requests.
  883. </p>
  884. @param request
  885. allocation request
  886. @return allocation response
  887. @throws YarnException
  888. @throws IOException
  889. @throws InvalidApplicationMasterRequestException
  890. This exception is thrown when an ApplicationMaster calls allocate
  891. without registering first.
  892. @throws InvalidResourceBlacklistRequestException
  893. This exception is thrown when an application provides an invalid
  894. specification for blacklist of resources.
  895. @throws InvalidResourceRequestException
  896. This exception is thrown when a {@link ResourceRequest} is out of
  897. the range of the configured lower and upper limits on the
  898. resources.
  899. @see AllocateRequest
  900. @see AllocateResponse]]>
  901. </doc>
  902. </method>
  903. <doc>
  904. <![CDATA[<p>The protocol between a live instance of <code>ApplicationMaster</code>
  905. and the <code>ResourceManager</code>.</p>
  906. <p>This is used by the <code>ApplicationMaster</code> to register/unregister
  907. and to request and obtain resources in the cluster from the
  908. <code>ResourceManager</code>.</p>]]>
  909. </doc>
  910. </interface>
  911. <!-- end interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
  912. <!-- start interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
  913. <interface name="ClientSCMProtocol" abstract="true"
  914. static="false" final="false" visibility="public"
  915. deprecated="not deprecated">
  916. <method name="use" return="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse"
  917. abstract="true" native="false" synchronized="false"
  918. static="false" final="false" visibility="public"
  919. deprecated="not deprecated">
  920. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest"/>
  921. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  922. <exception name="IOException" type="java.io.IOException"/>
  923. <doc>
  924. <![CDATA[<p>
  925. The interface used by clients to claim a resource with the
  926. <code>SharedCacheManager.</code> The client uses a checksum to identify the
  927. resource and an {@link ApplicationId} to identify which application will be
  928. using the resource.
  929. </p>
  930. <p>
  931. The <code>SharedCacheManager</code> responds with whether or not the
  932. resource exists in the cache. If the resource exists, a <code>Path</code>
  933. to the resource in the shared cache is returned. If the resource does not
  934. exist, the response is empty.
  935. </p>
  936. @param request request to claim a resource in the shared cache
  937. @return response indicating if the resource is already in the cache
  938. @throws YarnException
  939. @throws IOException]]>
  940. </doc>
  941. </method>
  942. <method name="release" return="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse"
  943. abstract="true" native="false" synchronized="false"
  944. static="false" final="false" visibility="public"
  945. deprecated="not deprecated">
  946. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest"/>
  947. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  948. <exception name="IOException" type="java.io.IOException"/>
  949. <doc>
  950. <![CDATA[<p>
  951. The interface used by clients to release a resource with the
  952. <code>SharedCacheManager.</code> This method is called once an application
  953. is no longer using a claimed resource in the shared cache. The client uses
  954. a checksum to identify the resource and an {@link ApplicationId} to
  955. identify which application is releasing the resource.
  956. </p>
  957. <p>
  958. Note: This method is an optimization and the client is not required to call
  959. it for correctness.
  960. </p>
  961. <p>
  962. Currently the <code>SharedCacheManager</code> sends an empty response.
  963. </p>
  964. @param request request to release a resource in the shared cache
  965. @return (empty) response on releasing the resource
  966. @throws YarnException
  967. @throws IOException]]>
  968. </doc>
  969. </method>
  970. <doc>
  971. <![CDATA[<p>
  972. The protocol between clients and the <code>SharedCacheManager</code> to claim
  973. and release resources in the shared cache.
  974. </p>]]>
  975. </doc>
  976. </interface>
  977. <!-- end interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
  978. <!-- start interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
  979. <interface name="ContainerManagementProtocol" abstract="true"
  980. static="false" final="false" visibility="public"
  981. deprecated="not deprecated">
  982. <method name="startContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse"
  983. abstract="true" native="false" synchronized="false"
  984. static="false" final="false" visibility="public"
  985. deprecated="not deprecated">
  986. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"/>
  987. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  988. <exception name="IOException" type="java.io.IOException"/>
  989. <doc>
  990. <![CDATA[<p>
  991. The <code>ApplicationMaster</code> provides a list of
  992. {@link StartContainerRequest}s to a <code>NodeManager</code> to
  993. <em>start</em> {@link Container}s allocated to it using this interface.
  994. </p>
  995. <p>
  996. The <code>ApplicationMaster</code> has to provide details such as allocated
  997. resource capability, security tokens (if enabled), command to be executed
  998. to start the container, environment for the process, necessary
  999. binaries/jar/shared-objects etc. via the {@link ContainerLaunchContext} in
  1000. the {@link StartContainerRequest}.
  1001. </p>
  1002. <p>
  1003. The <code>NodeManager</code> sends a response via
  1004. {@link StartContainersResponse} which includes a list of
  1005. {@link Container}s of successfully launched {@link Container}s, a
  1006. containerId-to-exception map for each failed {@link StartContainerRequest} in
  1007. which the exception indicates errors from per container and a
  1008. allServicesMetaData map between the names of auxiliary services and their
  1009. corresponding meta-data. Note: None-container-specific exceptions will
  1010. still be thrown by the API method itself.
  1011. </p>
  1012. <p>
  1013. The <code>ApplicationMaster</code> can use
  1014. {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
  1015. statuses of the to-be-launched or launched containers.
  1016. </p>
  1017. @param request
  1018. request to start a list of containers
  1019. @return response including conatinerIds of all successfully launched
  1020. containers, a containerId-to-exception map for failed requests and
  1021. a allServicesMetaData map.
  1022. @throws YarnException
  1023. @throws IOException]]>
  1024. </doc>
  1025. </method>
  1026. <method name="stopContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse"
  1027. abstract="true" native="false" synchronized="false"
  1028. static="false" final="false" visibility="public"
  1029. deprecated="not deprecated">
  1030. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"/>
  1031. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1032. <exception name="IOException" type="java.io.IOException"/>
  1033. <doc>
  1034. <![CDATA[<p>
  1035. The <code>ApplicationMaster</code> requests a <code>NodeManager</code> to
  1036. <em>stop</em> a list of {@link Container}s allocated to it using this
  1037. interface.
  1038. </p>
  1039. <p>
  1040. The <code>ApplicationMaster</code> sends a {@link StopContainersRequest}
  1041. which includes the {@link ContainerId}s of the containers to be stopped.
  1042. </p>
  1043. <p>
  1044. The <code>NodeManager</code> sends a response via
  1045. {@link StopContainersResponse} which includes a list of {@link ContainerId}
  1046. s of successfully stopped containers, a containerId-to-exception map for
  1047. each failed request in which the exception indicates errors from per
  1048. container. Note: None-container-specific exceptions will still be thrown by
  1049. the API method itself. <code>ApplicationMaster</code> can use
  1050. {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
  1051. statuses of the containers.
  1052. </p>
  1053. @param request
  1054. request to stop a list of containers
  1055. @return response which includes a list of containerIds of successfully
  1056. stopped containers, a containerId-to-exception map for failed
  1057. requests.
  1058. @throws YarnException
  1059. @throws IOException]]>
  1060. </doc>
  1061. </method>
  1062. <method name="getContainerStatuses" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse"
  1063. abstract="true" native="false" synchronized="false"
  1064. static="false" final="false" visibility="public"
  1065. deprecated="not deprecated">
  1066. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"/>
  1067. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1068. <exception name="IOException" type="java.io.IOException"/>
  1069. <doc>
  1070. <![CDATA[<p>
  1071. The API used by the <code>ApplicationMaster</code> to request for current
  1072. statuses of <code>Container</code>s from the <code>NodeManager</code>.
  1073. </p>
  1074. <p>
  1075. The <code>ApplicationMaster</code> sends a
  1076. {@link GetContainerStatusesRequest} which includes the {@link ContainerId}s
  1077. of all containers whose statuses are needed.
  1078. </p>
  1079. <p>
  1080. The <code>NodeManager</code> responds with
  1081. {@link GetContainerStatusesResponse} which includes a list of
  1082. {@link ContainerStatus} of the successfully queried containers and a
  1083. containerId-to-exception map for each failed request in which the exception
  1084. indicates errors from per container. Note: None-container-specific
  1085. exceptions will still be thrown by the API method itself.
  1086. </p>
  1087. @param request
  1088. request to get <code>ContainerStatus</code>es of containers with
  1089. the specified <code>ContainerId</code>s
  1090. @return response containing the list of <code>ContainerStatus</code> of the
  1091. successfully queried containers and a containerId-to-exception map
  1092. for failed requests.
  1093. @throws YarnException
  1094. @throws IOException]]>
  1095. </doc>
  1096. </method>
  1097. <method name="increaseContainersResource" return="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse"
  1098. abstract="true" native="false" synchronized="false"
  1099. static="false" final="false" visibility="public"
  1100. deprecated="not deprecated">
  1101. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest"/>
  1102. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1103. <exception name="IOException" type="java.io.IOException"/>
  1104. <doc>
  1105. <![CDATA[<p>
  1106. The API used by the <code>ApplicationMaster</code> to request for
  1107. resource increase of running containers on the <code>NodeManager</code>.
  1108. </p>
  1109. @param request
  1110. request to increase resource of a list of containers
  1111. @return response which includes a list of containerIds of containers
  1112. whose resource has been successfully increased and a
  1113. containerId-to-exception map for failed requests.
  1114. @throws YarnException
  1115. @throws IOException]]>
  1116. </doc>
  1117. </method>
  1118. <method name="updateContainer" return="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse"
  1119. abstract="true" native="false" synchronized="false"
  1120. static="false" final="false" visibility="public"
  1121. deprecated="not deprecated">
  1122. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest"/>
  1123. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1124. <exception name="IOException" type="java.io.IOException"/>
  1125. <doc>
  1126. <![CDATA[<p>
  1127. The API used by the <code>ApplicationMaster</code> to request for
  1128. resource update of running containers on the <code>NodeManager</code>.
  1129. </p>
  1130. @param request
  1131. request to update resource of a list of containers
  1132. @return response which includes a list of containerIds of containers
  1133. whose resource has been successfully updated and a
  1134. containerId-to-exception map for failed requests.
  1135. @throws YarnException Exception specific to YARN
  1136. @throws IOException IOException thrown from NodeManager]]>
  1137. </doc>
  1138. </method>
  1139. <method name="signalToContainer" return="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse"
  1140. abstract="true" native="false" synchronized="false"
  1141. static="false" final="false" visibility="public"
  1142. deprecated="not deprecated">
  1143. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest"/>
  1144. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1145. <exception name="IOException" type="java.io.IOException"/>
  1146. </method>
  1147. <method name="localize" return="org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationResponse"
  1148. abstract="true" native="false" synchronized="false"
  1149. static="false" final="false" visibility="public"
  1150. deprecated="not deprecated">
  1151. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest"/>
  1152. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1153. <exception name="IOException" type="java.io.IOException"/>
  1154. <doc>
  1155. <![CDATA[Localize resources required by the container.
  1156. Currently, this API only works for running containers.
  1157. @param request Specify the resources to be localized.
  1158. @return Response that the localize request is accepted.
  1159. @throws YarnException Exception specific to YARN
  1160. @throws IOException IOException thrown from the RPC layer.]]>
  1161. </doc>
  1162. </method>
  1163. <method name="reInitializeContainer" return="org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerResponse"
  1164. abstract="true" native="false" synchronized="false"
  1165. static="false" final="false" visibility="public"
  1166. deprecated="not deprecated">
  1167. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest"/>
  1168. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1169. <exception name="IOException" type="java.io.IOException"/>
  1170. <doc>
  1171. <![CDATA[ReInitialize the Container with a new Launch Context.
  1172. @param request Specify the new ContainerLaunchContext.
  1173. @return Response that the ReInitialize request is accepted.
  1174. @throws YarnException Exception specific to YARN.
  1175. @throws IOException IOException thrown from the RPC layer.]]>
  1176. </doc>
  1177. </method>
  1178. <method name="restartContainer" return="org.apache.hadoop.yarn.api.protocolrecords.RestartContainerResponse"
  1179. abstract="true" native="false" synchronized="false"
  1180. static="false" final="false" visibility="public"
  1181. deprecated="not deprecated">
  1182. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  1183. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1184. <exception name="IOException" type="java.io.IOException"/>
  1185. <doc>
  1186. <![CDATA[Restart the container.
  1187. @param containerId Container Id.
  1188. @return Response that the restart request is accepted.
  1189. @throws YarnException Exception specific to YARN.
  1190. @throws IOException IOException thrown from the RPC layer.]]>
  1191. </doc>
  1192. </method>
  1193. <method name="rollbackLastReInitialization" return="org.apache.hadoop.yarn.api.protocolrecords.RollbackResponse"
  1194. abstract="true" native="false" synchronized="false"
  1195. static="false" final="false" visibility="public"
  1196. deprecated="not deprecated">
  1197. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  1198. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1199. <exception name="IOException" type="java.io.IOException"/>
  1200. <doc>
  1201. <![CDATA[Rollback the Last ReInitialization if possible.
  1202. @param containerId Container Id.
  1203. @return Response that the rollback request is accepted.
  1204. @throws YarnException Exception specific to YARN.
  1205. @throws IOException IOException thrown from the RPC layer.]]>
  1206. </doc>
  1207. </method>
  1208. <method name="commitLastReInitialization" return="org.apache.hadoop.yarn.api.protocolrecords.CommitResponse"
  1209. abstract="true" native="false" synchronized="false"
  1210. static="false" final="false" visibility="public"
  1211. deprecated="not deprecated">
  1212. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  1213. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1214. <exception name="IOException" type="java.io.IOException"/>
  1215. <doc>
  1216. <![CDATA[Commit the Last ReInitialization if possible. Once the reinitialization
  1217. has been committed, It cannot be rolled back.
  1218. @param containerId Container Id.
  1219. @return Response that the commit request is accepted.
  1220. @throws YarnException Exception specific to YARN.
  1221. @throws IOException IOException thrown from the RPC layer.]]>
  1222. </doc>
  1223. </method>
  1224. <method name="getLocalizationStatuses" return="org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesResponse"
  1225. abstract="true" native="false" synchronized="false"
  1226. static="false" final="false" visibility="public"
  1227. deprecated="not deprecated">
  1228. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesRequest"/>
  1229. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1230. <exception name="IOException" type="java.io.IOException"/>
  1231. <doc>
  1232. <![CDATA[API to request for the localization statuses of requested containers from
  1233. the Node Manager.
  1234. @param request {@link GetLocalizationStatusesRequest} which includes the
  1235. container ids of all the containers whose localization
  1236. statuses are needed.
  1237. @return {@link GetLocalizationStatusesResponse} which contains the
  1238. localization statuses of all the requested containers.
  1239. @throws YarnException Exception specific to YARN.
  1240. @throws IOException IOException thrown from the RPC layer.]]>
  1241. </doc>
  1242. </method>
  1243. <doc>
  1244. <![CDATA[<p>The protocol between an <code>ApplicationMaster</code> and a
  1245. <code>NodeManager</code> to start/stop and increase resource of containers
  1246. and to get status of running containers.</p>
  1247. <p>If security is enabled the <code>NodeManager</code> verifies that the
  1248. <code>ApplicationMaster</code> has truly been allocated the container
  1249. by the <code>ResourceManager</code> and also verifies all interactions such
  1250. as stopping the container or obtaining status information for the container.
  1251. </p>]]>
  1252. </doc>
  1253. </interface>
  1254. <!-- end interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
  1255. </package>
  1256. <package name="org.apache.hadoop.yarn.api.protocolrecords">
  1257. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
  1258. <class name="AllocateRequest" extends="java.lang.Object"
  1259. abstract="true"
  1260. static="false" final="false" visibility="public"
  1261. deprecated="not deprecated">
  1262. <constructor name="AllocateRequest"
  1263. static="false" final="false" visibility="public"
  1264. deprecated="not deprecated">
  1265. </constructor>
  1266. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1267. abstract="false" native="false" synchronized="false"
  1268. static="true" final="false" visibility="public"
  1269. deprecated="not deprecated">
  1270. <param name="responseID" type="int"/>
  1271. <param name="appProgress" type="float"/>
  1272. <param name="resourceAsk" type="java.util.List"/>
  1273. <param name="containersToBeReleased" type="java.util.List"/>
  1274. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1275. </method>
  1276. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1277. abstract="false" native="false" synchronized="false"
  1278. static="true" final="false" visibility="public"
  1279. deprecated="not deprecated">
  1280. <param name="responseID" type="int"/>
  1281. <param name="appProgress" type="float"/>
  1282. <param name="resourceAsk" type="java.util.List"/>
  1283. <param name="containersToBeReleased" type="java.util.List"/>
  1284. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1285. <param name="trackingUrl" type="java.lang.String"/>
  1286. </method>
  1287. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1288. abstract="false" native="false" synchronized="false"
  1289. static="true" final="false" visibility="public"
  1290. deprecated="not deprecated">
  1291. <param name="responseID" type="int"/>
  1292. <param name="appProgress" type="float"/>
  1293. <param name="resourceAsk" type="java.util.List"/>
  1294. <param name="containersToBeReleased" type="java.util.List"/>
  1295. <param name="updateRequests" type="java.util.List"/>
  1296. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1297. </method>
  1298. <method name="getResponseId" return="int"
  1299. abstract="true" native="false" synchronized="false"
  1300. static="false" final="false" visibility="public"
  1301. deprecated="not deprecated">
  1302. <doc>
  1303. <![CDATA[Get the <em>response id</em> used to track duplicate responses.
  1304. @return <em>response id</em>]]>
  1305. </doc>
  1306. </method>
  1307. <method name="setResponseId"
  1308. abstract="true" native="false" synchronized="false"
  1309. static="false" final="false" visibility="public"
  1310. deprecated="not deprecated">
  1311. <param name="id" type="int"/>
  1312. <doc>
  1313. <![CDATA[Set the <em>response id</em> used to track duplicate responses.
  1314. @param id <em>response id</em>]]>
  1315. </doc>
  1316. </method>
  1317. <method name="getProgress" return="float"
  1318. abstract="true" native="false" synchronized="false"
  1319. static="false" final="false" visibility="public"
  1320. deprecated="not deprecated">
  1321. <doc>
  1322. <![CDATA[Get the <em>current progress</em> of application.
  1323. @return <em>current progress</em> of application]]>
  1324. </doc>
  1325. </method>
  1326. <method name="setProgress"
  1327. abstract="true" native="false" synchronized="false"
  1328. static="false" final="false" visibility="public"
  1329. deprecated="not deprecated">
  1330. <param name="progress" type="float"/>
  1331. <doc>
  1332. <![CDATA[Set the <em>current progress</em> of application
  1333. @param progress <em>current progress</em> of application]]>
  1334. </doc>
  1335. </method>
  1336. <method name="getAskList" return="java.util.List"
  1337. abstract="true" native="false" synchronized="false"
  1338. static="false" final="false" visibility="public"
  1339. deprecated="not deprecated">
  1340. <doc>
  1341. <![CDATA[Get the list of <code>ResourceRequest</code> to update the
  1342. <code>ResourceManager</code> about the application's resource requirements.
  1343. @return the list of <code>ResourceRequest</code>
  1344. @see ResourceRequest]]>
  1345. </doc>
  1346. </method>
  1347. <method name="setAskList"
  1348. abstract="true" native="false" synchronized="false"
  1349. static="false" final="false" visibility="public"
  1350. deprecated="not deprecated">
  1351. <param name="resourceRequests" type="java.util.List"/>
  1352. <doc>
  1353. <![CDATA[Set list of <code>ResourceRequest</code> to update the
  1354. <code>ResourceManager</code> about the application's resource requirements.
  1355. @param resourceRequests list of <code>ResourceRequest</code> to update the
  1356. <code>ResourceManager</code> about the application's
  1357. resource requirements
  1358. @see ResourceRequest]]>
  1359. </doc>
  1360. </method>
  1361. <method name="getReleaseList" return="java.util.List"
  1362. abstract="true" native="false" synchronized="false"
  1363. static="false" final="false" visibility="public"
  1364. deprecated="not deprecated">
  1365. <doc>
  1366. <![CDATA[Get the list of <code>ContainerId</code> of containers being
  1367. released by the <code>ApplicationMaster</code>.
  1368. @return list of <code>ContainerId</code> of containers being
  1369. released by the <code>ApplicationMaster</code>]]>
  1370. </doc>
  1371. </method>
  1372. <method name="setReleaseList"
  1373. abstract="true" native="false" synchronized="false"
  1374. static="false" final="false" visibility="public"
  1375. deprecated="not deprecated">
  1376. <param name="releaseContainers" type="java.util.List"/>
  1377. <doc>
  1378. <![CDATA[Set the list of <code>ContainerId</code> of containers being
  1379. released by the <code>ApplicationMaster</code>
  1380. @param releaseContainers list of <code>ContainerId</code> of
  1381. containers being released by the
  1382. <code>ApplicationMaster</code>]]>
  1383. </doc>
  1384. </method>
  1385. <method name="getResourceBlacklistRequest" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
  1386. abstract="true" native="false" synchronized="false"
  1387. static="false" final="false" visibility="public"
  1388. deprecated="not deprecated">
  1389. <doc>
  1390. <![CDATA[Get the <code>ResourceBlacklistRequest</code> being sent by the
  1391. <code>ApplicationMaster</code>.
  1392. @return the <code>ResourceBlacklistRequest</code> being sent by the
  1393. <code>ApplicationMaster</code>
  1394. @see ResourceBlacklistRequest]]>
  1395. </doc>
  1396. </method>
  1397. <method name="setResourceBlacklistRequest"
  1398. abstract="true" native="false" synchronized="false"
  1399. static="false" final="false" visibility="public"
  1400. deprecated="not deprecated">
  1401. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1402. <doc>
  1403. <![CDATA[Set the <code>ResourceBlacklistRequest</code> to inform the
  1404. <code>ResourceManager</code> about the blacklist additions and removals
  1405. per the <code>ApplicationMaster</code>.
  1406. @param resourceBlacklistRequest the <code>ResourceBlacklistRequest</code>
  1407. to inform the <code>ResourceManager</code> about
  1408. the blacklist additions and removals
  1409. per the <code>ApplicationMaster</code>
  1410. @see ResourceBlacklistRequest]]>
  1411. </doc>
  1412. </method>
  1413. <method name="getUpdateRequests" return="java.util.List"
  1414. abstract="true" native="false" synchronized="false"
  1415. static="false" final="false" visibility="public"
  1416. deprecated="not deprecated">
  1417. <doc>
  1418. <![CDATA[Get the list of container update requests being sent by the
  1419. <code>ApplicationMaster</code>.
  1420. @return list of {@link UpdateContainerRequest}
  1421. being sent by the
  1422. <code>ApplicationMaster</code>.]]>
  1423. </doc>
  1424. </method>
  1425. <method name="setUpdateRequests"
  1426. abstract="true" native="false" synchronized="false"
  1427. static="false" final="false" visibility="public"
  1428. deprecated="not deprecated">
  1429. <param name="updateRequests" type="java.util.List"/>
  1430. <doc>
  1431. <![CDATA[Set the list of container update requests to inform the
  1432. <code>ResourceManager</code> about the containers that need to be
  1433. updated.
  1434. @param updateRequests list of <code>UpdateContainerRequest</code> for
  1435. containers to be updated]]>
  1436. </doc>
  1437. </method>
  1438. <method name="getSchedulingRequests" return="java.util.List"
  1439. abstract="false" native="false" synchronized="false"
  1440. static="false" final="false" visibility="public"
  1441. deprecated="not deprecated">
  1442. <doc>
  1443. <![CDATA[Get the list of Scheduling requests being sent by the
  1444. <code>ApplicationMaster</code>.
  1445. @return list of {@link SchedulingRequest} being sent by the
  1446. <code>ApplicationMaster</code>.]]>
  1447. </doc>
  1448. </method>
  1449. <method name="setSchedulingRequests"
  1450. abstract="false" native="false" synchronized="false"
  1451. static="false" final="false" visibility="public"
  1452. deprecated="not deprecated">
  1453. <param name="schedulingRequests" type="java.util.List"/>
  1454. <doc>
  1455. <![CDATA[Set the list of Scheduling requests to inform the
  1456. <code>ResourceManager</code> about the application's resource requirements
  1457. (potentially including allocation tags and placement constraints).
  1458. @param schedulingRequests list of {@link SchedulingRequest} to update
  1459. the <code>ResourceManager</code> about the application's resource
  1460. requirements.]]>
  1461. </doc>
  1462. </method>
  1463. <method name="getTrackingUrl" return="java.lang.String"
  1464. abstract="true" native="false" synchronized="false"
  1465. static="false" final="false" visibility="public"
  1466. deprecated="not deprecated">
  1467. <doc>
  1468. <![CDATA[Get the tracking url update for this heartbeat.
  1469. @return tracking url to update this application with]]>
  1470. </doc>
  1471. </method>
  1472. <method name="setTrackingUrl"
  1473. abstract="true" native="false" synchronized="false"
  1474. static="false" final="false" visibility="public"
  1475. deprecated="not deprecated">
  1476. <param name="trackingUrl" type="java.lang.String"/>
  1477. <doc>
  1478. <![CDATA[Set the new tracking url for this application.
  1479. @param trackingUrl the new tracking url]]>
  1480. </doc>
  1481. </method>
  1482. <method name="newBuilder" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1483. abstract="false" native="false" synchronized="false"
  1484. static="true" final="false" visibility="public"
  1485. deprecated="not deprecated">
  1486. </method>
  1487. <doc>
  1488. <![CDATA[<p>The core request sent by the <code>ApplicationMaster</code> to the
  1489. <code>ResourceManager</code> to obtain resources in the cluster.</p>
  1490. <p>The request includes:
  1491. <ul>
  1492. <li>A response id to track duplicate responses.</li>
  1493. <li>Progress information.</li>
  1494. <li>
  1495. A list of {@link ResourceRequest} to inform the
  1496. <code>ResourceManager</code> about the application's
  1497. resource requirements.
  1498. </li>
  1499. <li>
  1500. A list of unused {@link Container} which are being returned.
  1501. </li>
  1502. <li>
  1503. A list of {@link UpdateContainerRequest} to inform
  1504. the <code>ResourceManager</code> about the change in
  1505. requirements of running containers.
  1506. </li>
  1507. </ul>
  1508. @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
  1509. </doc>
  1510. </class>
  1511. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
  1512. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder -->
  1513. <class name="AllocateRequest.AllocateRequestBuilder" extends="java.lang.Object"
  1514. abstract="false"
  1515. static="true" final="true" visibility="public"
  1516. deprecated="not deprecated">
  1517. <method name="responseId" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1518. abstract="false" native="false" synchronized="false"
  1519. static="false" final="false" visibility="public"
  1520. deprecated="not deprecated">
  1521. <param name="responseId" type="int"/>
  1522. <doc>
  1523. <![CDATA[Set the <code>responseId</code> of the request.
  1524. @see AllocateRequest#setResponseId(int)
  1525. @param responseId <code>responseId</code> of the request
  1526. @return {@link AllocateRequestBuilder}]]>
  1527. </doc>
  1528. </method>
  1529. <method name="progress" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1530. abstract="false" native="false" synchronized="false"
  1531. static="false" final="false" visibility="public"
  1532. deprecated="not deprecated">
  1533. <param name="progress" type="float"/>
  1534. <doc>
  1535. <![CDATA[Set the <code>progress</code> of the request.
  1536. @see AllocateRequest#setProgress(float)
  1537. @param progress <code>progress</code> of the request
  1538. @return {@link AllocateRequestBuilder}]]>
  1539. </doc>
  1540. </method>
  1541. <method name="askList" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1542. abstract="false" native="false" synchronized="false"
  1543. static="false" final="false" visibility="public"
  1544. deprecated="not deprecated">
  1545. <param name="askList" type="java.util.List"/>
  1546. <doc>
  1547. <![CDATA[Set the <code>askList</code> of the request.
  1548. @see AllocateRequest#setAskList(List)
  1549. @param askList <code>askList</code> of the request
  1550. @return {@link AllocateRequestBuilder}]]>
  1551. </doc>
  1552. </method>
  1553. <method name="releaseList" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1554. abstract="false" native="false" synchronized="false"
  1555. static="false" final="false" visibility="public"
  1556. deprecated="not deprecated">
  1557. <param name="releaseList" type="java.util.List"/>
  1558. <doc>
  1559. <![CDATA[Set the <code>releaseList</code> of the request.
  1560. @see AllocateRequest#setReleaseList(List)
  1561. @param releaseList <code>releaseList</code> of the request
  1562. @return {@link AllocateRequestBuilder}]]>
  1563. </doc>
  1564. </method>
  1565. <method name="resourceBlacklistRequest" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1566. abstract="false" native="false" synchronized="false"
  1567. static="false" final="false" visibility="public"
  1568. deprecated="not deprecated">
  1569. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1570. <doc>
  1571. <![CDATA[Set the <code>resourceBlacklistRequest</code> of the request.
  1572. @see AllocateRequest#setResourceBlacklistRequest(
  1573. ResourceBlacklistRequest)
  1574. @param resourceBlacklistRequest
  1575. <code>resourceBlacklistRequest</code> of the request
  1576. @return {@link AllocateRequestBuilder}]]>
  1577. </doc>
  1578. </method>
  1579. <method name="updateRequests" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1580. abstract="false" native="false" synchronized="false"
  1581. static="false" final="false" visibility="public"
  1582. deprecated="not deprecated">
  1583. <param name="updateRequests" type="java.util.List"/>
  1584. <doc>
  1585. <![CDATA[Set the <code>updateRequests</code> of the request.
  1586. @see AllocateRequest#setUpdateRequests(List)
  1587. @param updateRequests <code>updateRequests</code> of the request
  1588. @return {@link AllocateRequestBuilder}]]>
  1589. </doc>
  1590. </method>
  1591. <method name="schedulingRequests" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1592. abstract="false" native="false" synchronized="false"
  1593. static="false" final="false" visibility="public"
  1594. deprecated="not deprecated">
  1595. <param name="schedulingRequests" type="java.util.List"/>
  1596. <doc>
  1597. <![CDATA[Set the <code>schedulingRequests</code> of the request.
  1598. @see AllocateRequest#setSchedulingRequests(List)
  1599. @param schedulingRequests <code>SchedulingRequest</code> of the request
  1600. @return {@link AllocateRequestBuilder}]]>
  1601. </doc>
  1602. </method>
  1603. <method name="trackingUrl" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1604. abstract="false" native="false" synchronized="false"
  1605. static="false" final="false" visibility="public"
  1606. deprecated="not deprecated">
  1607. <param name="trackingUrl" type="java.lang.String"/>
  1608. <doc>
  1609. <![CDATA[Set the <code>trackingUrl</code> of the request.
  1610. @see AllocateRequest#setTrackingUrl(String)
  1611. @param trackingUrl new tracking url
  1612. @return {@link AllocateRequestBuilder}]]>
  1613. </doc>
  1614. </method>
  1615. <method name="build" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1616. abstract="false" native="false" synchronized="false"
  1617. static="false" final="false" visibility="public"
  1618. deprecated="not deprecated">
  1619. <doc>
  1620. <![CDATA[Return generated {@link AllocateRequest} object.
  1621. @return {@link AllocateRequest}]]>
  1622. </doc>
  1623. </method>
  1624. <doc>
  1625. <![CDATA[Class to construct instances of {@link AllocateRequest} with specific
  1626. options.]]>
  1627. </doc>
  1628. </class>
  1629. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder -->
  1630. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
  1631. <class name="AllocateResponse" extends="java.lang.Object"
  1632. abstract="true"
  1633. static="false" final="false" visibility="public"
  1634. deprecated="not deprecated">
  1635. <constructor name="AllocateResponse"
  1636. static="false" final="false" visibility="public"
  1637. deprecated="not deprecated">
  1638. </constructor>
  1639. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1640. abstract="false" native="false" synchronized="false"
  1641. static="true" final="false" visibility="public"
  1642. deprecated="not deprecated">
  1643. <param name="responseId" type="int"/>
  1644. <param name="completedContainers" type="java.util.List"/>
  1645. <param name="allocatedContainers" type="java.util.List"/>
  1646. <param name="updatedNodes" type="java.util.List"/>
  1647. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1648. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1649. <param name="numClusterNodes" type="int"/>
  1650. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1651. <param name="nmTokens" type="java.util.List"/>
  1652. </method>
  1653. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1654. abstract="false" native="false" synchronized="false"
  1655. static="true" final="false" visibility="public"
  1656. deprecated="not deprecated">
  1657. <param name="responseId" type="int"/>
  1658. <param name="completedContainers" type="java.util.List"/>
  1659. <param name="allocatedContainers" type="java.util.List"/>
  1660. <param name="updatedNodes" type="java.util.List"/>
  1661. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1662. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1663. <param name="numClusterNodes" type="int"/>
  1664. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1665. <param name="nmTokens" type="java.util.List"/>
  1666. <param name="amRMToken" type="org.apache.hadoop.yarn.api.records.Token"/>
  1667. <param name="updatedContainers" type="java.util.List"/>
  1668. <param name="collectorInfo" type="org.apache.hadoop.yarn.api.records.CollectorInfo"/>
  1669. </method>
  1670. <method name="getAMCommand" return="org.apache.hadoop.yarn.api.records.AMCommand"
  1671. abstract="true" native="false" synchronized="false"
  1672. static="false" final="false" visibility="public"
  1673. deprecated="not deprecated">
  1674. <doc>
  1675. <![CDATA[If the <code>ResourceManager</code> needs the
  1676. <code>ApplicationMaster</code> to take some action then it will send an
  1677. AMCommand to the <code>ApplicationMaster</code>. See <code>AMCommand</code>
  1678. for details on commands and actions for them.
  1679. @return <code>AMCommand</code> if the <code>ApplicationMaster</code> should
  1680. take action, <code>null</code> otherwise
  1681. @see AMCommand]]>
  1682. </doc>
  1683. </method>
  1684. <method name="getResponseId" return="int"
  1685. abstract="true" native="false" synchronized="false"
  1686. static="false" final="false" visibility="public"
  1687. deprecated="not deprecated">
  1688. <doc>
  1689. <![CDATA[Get the <em>last response id</em>.
  1690. @return <em>last response id</em>]]>
  1691. </doc>
  1692. </method>
  1693. <method name="getAllocatedContainers" return="java.util.List"
  1694. abstract="true" native="false" synchronized="false"
  1695. static="false" final="false" visibility="public"
  1696. deprecated="not deprecated">
  1697. <doc>
  1698. <![CDATA[Get the list of <em>newly allocated</em> <code>Container</code> by the
  1699. <code>ResourceManager</code>.
  1700. @return list of <em>newly allocated</em> <code>Container</code>]]>
  1701. </doc>
  1702. </method>
  1703. <method name="getAvailableResources" return="org.apache.hadoop.yarn.api.records.Resource"
  1704. abstract="true" native="false" synchronized="false"
  1705. static="false" final="false" visibility="public"
  1706. deprecated="not deprecated">
  1707. <doc>
  1708. <![CDATA[Get the <em>available headroom</em> for resources in the cluster for the
  1709. application.
  1710. @return limit of available headroom for resources in the cluster for the
  1711. application]]>
  1712. </doc>
  1713. </method>
  1714. <method name="getCompletedContainersStatuses" return="java.util.List"
  1715. abstract="true" native="false" synchronized="false"
  1716. static="false" final="false" visibility="public"
  1717. deprecated="not deprecated">
  1718. <doc>
  1719. <![CDATA[Get the list of <em>completed containers' statuses</em>.
  1720. @return the list of <em>completed containers' statuses</em>]]>
  1721. </doc>
  1722. </method>
  1723. <method name="getUpdatedNodes" return="java.util.List"
  1724. abstract="true" native="false" synchronized="false"
  1725. static="false" final="false" visibility="public"
  1726. deprecated="not deprecated">
  1727. <doc>
  1728. <![CDATA[Get the list of <em>updated <code>NodeReport</code>s</em>. Updates could
  1729. be changes in health, availability etc of the nodes.
  1730. @return The delta of updated nodes since the last response]]>
  1731. </doc>
  1732. </method>
  1733. <method name="getNumClusterNodes" return="int"
  1734. abstract="true" native="false" synchronized="false"
  1735. static="false" final="false" visibility="public"
  1736. deprecated="not deprecated">
  1737. <doc>
  1738. <![CDATA[Get the number of hosts available on the cluster.
  1739. @return the available host count.]]>
  1740. </doc>
  1741. </method>
  1742. <method name="getPreemptionMessage" return="org.apache.hadoop.yarn.api.records.PreemptionMessage"
  1743. abstract="true" native="false" synchronized="false"
  1744. static="false" final="false" visibility="public"
  1745. deprecated="not deprecated">
  1746. <doc>
  1747. <![CDATA[Get the description of containers owned by the AM, but requested back by
  1748. the cluster. Note that the RM may have an inconsistent view of the
  1749. resources owned by the AM. These messages are advisory, and the AM may
  1750. elect to ignore them.
  1751. <p>
  1752. The message is a snapshot of the resources the RM wants back from the AM.
  1753. While demand persists, the RM will repeat its request; applications should
  1754. not interpret each message as a request for <em>additional</em>
  1755. resources on top of previous messages. Resources requested consistently
  1756. over some duration may be forcibly killed by the RM.
  1757. @return A specification of the resources to reclaim from this AM.]]>
  1758. </doc>
  1759. </method>
  1760. <method name="getNMTokens" return="java.util.List"
  1761. abstract="true" native="false" synchronized="false"
  1762. static="false" final="false" visibility="public"
  1763. deprecated="not deprecated">
  1764. <doc>
  1765. <![CDATA[Get the list of NMTokens required for communicating with NM. New NMTokens
  1766. issued only if
  1767. <p>
  1768. 1) AM is receiving first container on underlying NodeManager.<br>
  1769. OR<br>
  1770. 2) NMToken master key rolled over in ResourceManager and AM is getting new
  1771. container on the same underlying NodeManager.
  1772. <p>
  1773. AM will receive one NMToken per NM irrespective of the number of containers
  1774. issued on same NM. AM is expected to store these tokens until issued a
  1775. new token for the same NM.
  1776. @return list of NMTokens required for communicating with NM]]>
  1777. </doc>
  1778. </method>
  1779. <method name="getUpdatedContainers" return="java.util.List"
  1780. abstract="true" native="false" synchronized="false"
  1781. static="false" final="false" visibility="public"
  1782. deprecated="not deprecated">
  1783. <doc>
  1784. <![CDATA[Get the list of newly updated containers by
  1785. <code>ResourceManager</code>.
  1786. @return list of newly increased containers]]>
  1787. </doc>
  1788. </method>
  1789. <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
  1790. abstract="true" native="false" synchronized="false"
  1791. static="false" final="false" visibility="public"
  1792. deprecated="not deprecated">
  1793. <doc>
  1794. <![CDATA[The AMRMToken that belong to this attempt
  1795. @return The AMRMToken that belong to this attempt]]>
  1796. </doc>
  1797. </method>
  1798. <method name="getApplicationPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  1799. abstract="true" native="false" synchronized="false"
  1800. static="false" final="false" visibility="public"
  1801. deprecated="not deprecated">
  1802. <doc>
  1803. <![CDATA[Priority of the application
  1804. @return get application priority]]>
  1805. </doc>
  1806. </method>
  1807. <method name="getCollectorInfo" return="org.apache.hadoop.yarn.api.records.CollectorInfo"
  1808. abstract="true" native="false" synchronized="false"
  1809. static="false" final="false" visibility="public"
  1810. deprecated="not deprecated">
  1811. <doc>
  1812. <![CDATA[The data associated with the collector that belongs to this app. Contains
  1813. address and token alongwith identification information.
  1814. @return The data of collector that belong to this attempt]]>
  1815. </doc>
  1816. </method>
  1817. <method name="getUpdateErrors" return="java.util.List"
  1818. abstract="false" native="false" synchronized="false"
  1819. static="false" final="false" visibility="public"
  1820. deprecated="not deprecated">
  1821. <doc>
  1822. <![CDATA[Get the list of container update errors to inform the
  1823. Application Master about the container updates that could not be
  1824. satisfied due to error.
  1825. @return List of Update Container Errors.]]>
  1826. </doc>
  1827. </method>
  1828. <method name="setUpdateErrors"
  1829. abstract="false" native="false" synchronized="false"
  1830. static="false" final="false" visibility="public"
  1831. deprecated="not deprecated">
  1832. <param name="updateErrors" type="java.util.List"/>
  1833. <doc>
  1834. <![CDATA[Set the list of container update errors to inform the
  1835. Application Master about the container updates that could not be
  1836. satisfied due to error.
  1837. @param updateErrors list of <code>UpdateContainerError</code> for
  1838. containers updates requests that were in error]]>
  1839. </doc>
  1840. </method>
  1841. <method name="getContainersFromPreviousAttempts" return="java.util.List"
  1842. abstract="true" native="false" synchronized="false"
  1843. static="false" final="false" visibility="public"
  1844. deprecated="not deprecated">
  1845. <doc>
  1846. <![CDATA[Get the list of running containers as viewed by
  1847. <code>ResourceManager</code> from previous application attempts which
  1848. have not been reported to the Application Master yet.
  1849. <br>
  1850. These containers were recovered by the RM after the application master
  1851. had already registered. This may happen after RM restart when some NMs get
  1852. delayed in connecting to the RM and reporting the active containers.
  1853. Since they were not reported in the registration
  1854. response, they are reported in the response to the AM heartbeat.
  1855. @return the list of running containers as viewed by
  1856. <code>ResourceManager</code> from previous application attempts.]]>
  1857. </doc>
  1858. </method>
  1859. <method name="getRejectedSchedulingRequests" return="java.util.List"
  1860. abstract="false" native="false" synchronized="false"
  1861. static="false" final="false" visibility="public"
  1862. deprecated="not deprecated">
  1863. <doc>
  1864. <![CDATA[Get a list of all SchedulingRequests that the RM has rejected between
  1865. this allocate call and the previous one.
  1866. @return List of RejectedSchedulingRequests.]]>
  1867. </doc>
  1868. </method>
  1869. <doc>
  1870. <![CDATA[The response sent by the <code>ResourceManager</code> the
  1871. <code>ApplicationMaster</code> during resource negotiation.
  1872. <p>
  1873. The response, includes:
  1874. <ul>
  1875. <li>Response ID to track duplicate responses.</li>
  1876. <li>
  1877. An AMCommand sent by ResourceManager to let the
  1878. {@code ApplicationMaster} take some actions (resync, shutdown etc.).
  1879. </li>
  1880. <li>A list of newly allocated {@link Container}.</li>
  1881. <li>A list of completed {@link Container}s' statuses.</li>
  1882. <li>
  1883. The available headroom for resources in the cluster for the
  1884. application.
  1885. </li>
  1886. <li>A list of nodes whose status has been updated.</li>
  1887. <li>The number of available nodes in a cluster.</li>
  1888. <li>A description of resources requested back by the cluster</li>
  1889. <li>AMRMToken, if AMRMToken has been rolled over</li>
  1890. <li>
  1891. A list of {@link Container} representing the containers
  1892. whose resource has been increased.
  1893. </li>
  1894. <li>
  1895. A list of {@link Container} representing the containers
  1896. whose resource has been decreased.
  1897. </li>
  1898. </ul>
  1899. @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
  1900. </doc>
  1901. </class>
  1902. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
  1903. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
  1904. <class name="ApplicationsRequestScope" extends="java.lang.Enum"
  1905. abstract="false"
  1906. static="false" final="true" visibility="public"
  1907. deprecated="not deprecated">
  1908. <method name="values" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope[]"
  1909. abstract="false" native="false" synchronized="false"
  1910. static="true" final="false" visibility="public"
  1911. deprecated="not deprecated">
  1912. </method>
  1913. <method name="valueOf" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"
  1914. abstract="false" native="false" synchronized="false"
  1915. static="true" final="false" visibility="public"
  1916. deprecated="not deprecated">
  1917. <param name="name" type="java.lang.String"/>
  1918. </method>
  1919. <doc>
  1920. <![CDATA[Enumeration that controls the scope of applications fetched]]>
  1921. </doc>
  1922. </class>
  1923. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
  1924. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.CommitResponse -->
  1925. <class name="CommitResponse" extends="java.lang.Object"
  1926. abstract="true"
  1927. static="false" final="false" visibility="public"
  1928. deprecated="not deprecated">
  1929. <constructor name="CommitResponse"
  1930. static="false" final="false" visibility="public"
  1931. deprecated="not deprecated">
  1932. </constructor>
  1933. <doc>
  1934. <![CDATA[Response to Commit Container Request.]]>
  1935. </doc>
  1936. </class>
  1937. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.CommitResponse -->
  1938. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest -->
  1939. <class name="ContainerUpdateRequest" extends="java.lang.Object"
  1940. abstract="true"
  1941. static="false" final="false" visibility="public"
  1942. deprecated="not deprecated">
  1943. <constructor name="ContainerUpdateRequest"
  1944. static="false" final="false" visibility="public"
  1945. deprecated="not deprecated">
  1946. </constructor>
  1947. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest"
  1948. abstract="false" native="false" synchronized="false"
  1949. static="true" final="false" visibility="public"
  1950. deprecated="not deprecated">
  1951. <param name="containersToIncrease" type="java.util.List"/>
  1952. </method>
  1953. <method name="getContainersToUpdate" 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 a list of container tokens to be used for authorization during
  1959. container resource update.
  1960. <p>
  1961. Note: {@link NMToken} will be used for authenticating communication with
  1962. {@code NodeManager}.
  1963. @return the list of container tokens to be used for authorization during
  1964. container resource update.
  1965. @see NMToken]]>
  1966. </doc>
  1967. </method>
  1968. <method name="setContainersToUpdate"
  1969. abstract="true" native="false" synchronized="false"
  1970. static="false" final="false" visibility="public"
  1971. deprecated="not deprecated">
  1972. <param name="containersToUpdate" type="java.util.List"/>
  1973. <doc>
  1974. <![CDATA[Set container tokens to be used during container resource increase.
  1975. The token is acquired from
  1976. <code>AllocateResponse.getUpdatedContainers</code>.
  1977. The token contains the container id and resource capability required for
  1978. container resource update.
  1979. @param containersToUpdate the list of container tokens to be used
  1980. for container resource increase.]]>
  1981. </doc>
  1982. </method>
  1983. <doc>
  1984. <![CDATA[<p>The request sent by <code>Application Master</code> to the
  1985. <code>Node Manager</code> to change the resource quota of a container.</p>
  1986. @see ContainerManagementProtocol#updateContainer(ContainerUpdateRequest)]]>
  1987. </doc>
  1988. </class>
  1989. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest -->
  1990. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse -->
  1991. <class name="ContainerUpdateResponse" extends="java.lang.Object"
  1992. abstract="true"
  1993. static="false" final="false" visibility="public"
  1994. deprecated="not deprecated">
  1995. <constructor name="ContainerUpdateResponse"
  1996. static="false" final="false" visibility="public"
  1997. deprecated="not deprecated">
  1998. </constructor>
  1999. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse"
  2000. abstract="false" native="false" synchronized="false"
  2001. static="true" final="false" visibility="public"
  2002. deprecated="not deprecated">
  2003. <param name="successfullyUpdatedContainers" type="java.util.List"/>
  2004. <param name="failedRequests" type="java.util.Map"/>
  2005. </method>
  2006. <method name="getSuccessfullyUpdatedContainers" return="java.util.List"
  2007. abstract="true" native="false" synchronized="false"
  2008. static="false" final="false" visibility="public"
  2009. deprecated="not deprecated">
  2010. <doc>
  2011. <![CDATA[Get the list of containerIds of containers whose resource
  2012. have been successfully update.
  2013. @return the list of containerIds of containers whose resource have
  2014. been successfully updated.]]>
  2015. </doc>
  2016. </method>
  2017. <method name="getFailedRequests" return="java.util.Map"
  2018. abstract="true" native="false" synchronized="false"
  2019. static="false" final="false" visibility="public"
  2020. deprecated="not deprecated">
  2021. <doc>
  2022. <![CDATA[Get the containerId-to-exception map in which the exception indicates
  2023. error from each container for failed requests.
  2024. @return map of containerId-to-exception]]>
  2025. </doc>
  2026. </method>
  2027. <doc>
  2028. <![CDATA[<p>
  2029. The response sent by the <code>NodeManager</code> to the
  2030. <code>ApplicationMaster</code> when asked to update container resource.
  2031. </p>
  2032. @see ContainerManagementProtocol#updateContainer(ContainerUpdateRequest)]]>
  2033. </doc>
  2034. </class>
  2035. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse -->
  2036. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest -->
  2037. <class name="FailApplicationAttemptRequest" extends="java.lang.Object"
  2038. abstract="true"
  2039. static="false" final="false" visibility="public"
  2040. deprecated="not deprecated">
  2041. <constructor name="FailApplicationAttemptRequest"
  2042. static="false" final="false" visibility="public"
  2043. deprecated="not deprecated">
  2044. </constructor>
  2045. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest"
  2046. abstract="false" native="false" synchronized="false"
  2047. static="true" final="false" visibility="public"
  2048. deprecated="not deprecated">
  2049. <param name="attemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2050. </method>
  2051. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2052. abstract="true" native="false" synchronized="false"
  2053. static="false" final="false" visibility="public"
  2054. deprecated="not deprecated">
  2055. <doc>
  2056. <![CDATA[Get the <code>ApplicationAttemptId</code> of the attempt to be failed.
  2057. @return <code>ApplicationAttemptId</code> of the attempt.]]>
  2058. </doc>
  2059. </method>
  2060. <method name="setApplicationAttemptId"
  2061. abstract="true" native="false" synchronized="false"
  2062. static="false" final="false" visibility="public"
  2063. deprecated="not deprecated">
  2064. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2065. </method>
  2066. <doc>
  2067. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  2068. to fail an application attempt.</p>
  2069. <p>The request includes the {@link ApplicationAttemptId} of the attempt to
  2070. be failed.</p>
  2071. @see ApplicationClientProtocol#failApplicationAttempt(FailApplicationAttemptRequest)]]>
  2072. </doc>
  2073. </class>
  2074. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest -->
  2075. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptResponse -->
  2076. <class name="FailApplicationAttemptResponse" extends="java.lang.Object"
  2077. abstract="true"
  2078. static="false" final="false" visibility="public"
  2079. deprecated="not deprecated">
  2080. <constructor name="FailApplicationAttemptResponse"
  2081. static="false" final="false" visibility="public"
  2082. deprecated="not deprecated">
  2083. </constructor>
  2084. <doc>
  2085. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client
  2086. failing an application attempt.</p>
  2087. <p>Currently it's empty.</p>
  2088. @see ApplicationClientProtocol#failApplicationAttempt(FailApplicationAttemptRequest)]]>
  2089. </doc>
  2090. </class>
  2091. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptResponse -->
  2092. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
  2093. <class name="FinishApplicationMasterRequest" extends="java.lang.Object"
  2094. abstract="true"
  2095. static="false" final="false" visibility="public"
  2096. deprecated="not deprecated">
  2097. <constructor name="FinishApplicationMasterRequest"
  2098. static="false" final="false" visibility="public"
  2099. deprecated="not deprecated">
  2100. </constructor>
  2101. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"
  2102. abstract="false" native="false" synchronized="false"
  2103. static="true" final="false" visibility="public"
  2104. deprecated="not deprecated">
  2105. <param name="finalAppStatus" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
  2106. <param name="diagnostics" type="java.lang.String"/>
  2107. <param name="url" type="java.lang.String"/>
  2108. </method>
  2109. <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  2110. abstract="true" native="false" synchronized="false"
  2111. static="false" final="false" visibility="public"
  2112. deprecated="not deprecated">
  2113. <doc>
  2114. <![CDATA[Get <em>final state</em> of the <code>ApplicationMaster</code>.
  2115. @return <em>final state</em> of the <code>ApplicationMaster</code>]]>
  2116. </doc>
  2117. </method>
  2118. <method name="setFinalApplicationStatus"
  2119. abstract="true" native="false" synchronized="false"
  2120. static="false" final="false" visibility="public"
  2121. deprecated="not deprecated">
  2122. <param name="finalState" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
  2123. <doc>
  2124. <![CDATA[Set the <em>final state</em> of the <code>ApplicationMaster</code>
  2125. @param finalState <em>final state</em> of the <code>ApplicationMaster</code>]]>
  2126. </doc>
  2127. </method>
  2128. <method name="getDiagnostics" return="java.lang.String"
  2129. abstract="true" native="false" synchronized="false"
  2130. static="false" final="false" visibility="public"
  2131. deprecated="not deprecated">
  2132. <doc>
  2133. <![CDATA[Get <em>diagnostic information</em> on application failure.
  2134. @return <em>diagnostic information</em> on application failure]]>
  2135. </doc>
  2136. </method>
  2137. <method name="setDiagnostics"
  2138. abstract="true" native="false" synchronized="false"
  2139. static="false" final="false" visibility="public"
  2140. deprecated="not deprecated">
  2141. <param name="diagnostics" type="java.lang.String"/>
  2142. <doc>
  2143. <![CDATA[Set <em>diagnostic information</em> on application failure.
  2144. @param diagnostics <em>diagnostic information</em> on application failure]]>
  2145. </doc>
  2146. </method>
  2147. <method name="getTrackingUrl" return="java.lang.String"
  2148. abstract="true" native="false" synchronized="false"
  2149. static="false" final="false" visibility="public"
  2150. deprecated="not deprecated">
  2151. <doc>
  2152. <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
  2153. This url if contains scheme then that will be used by resource manager
  2154. web application proxy otherwise it will default to http.
  2155. @return <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  2156. </doc>
  2157. </method>
  2158. <method name="setTrackingUrl"
  2159. abstract="true" native="false" synchronized="false"
  2160. static="false" final="false" visibility="public"
  2161. deprecated="not deprecated">
  2162. <param name="url" type="java.lang.String"/>
  2163. <doc>
  2164. <![CDATA[Set the <em>final tracking URL</em>for the <code>ApplicationMaster</code>.
  2165. This is the web-URL to which ResourceManager or web-application proxy will
  2166. redirect client/users once the application is finished and the
  2167. <code>ApplicationMaster</code> is gone.
  2168. <p>
  2169. If the passed url has a scheme then that will be used by the
  2170. ResourceManager and web-application proxy, otherwise the scheme will
  2171. default to http.
  2172. </p>
  2173. <p>
  2174. Empty, null, "N/A" strings are all valid besides a real URL. In case an url
  2175. isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
  2176. <p>
  2177. @param url
  2178. <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  2179. </doc>
  2180. </method>
  2181. <doc>
  2182. <![CDATA[The finalization request sent by the {@code ApplicationMaster} to
  2183. inform the {@code ResourceManager} about its completion.
  2184. <p>
  2185. The final request includes details such:
  2186. <ul>
  2187. <li>Final state of the {@code ApplicationMaster}</li>
  2188. <li>
  2189. Diagnostic information in case of failure of the
  2190. {@code ApplicationMaster}
  2191. </li>
  2192. <li>Tracking URL</li>
  2193. </ul>
  2194. @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
  2195. </doc>
  2196. </class>
  2197. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
  2198. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
  2199. <class name="FinishApplicationMasterResponse" extends="java.lang.Object"
  2200. abstract="true"
  2201. static="false" final="false" visibility="public"
  2202. deprecated="not deprecated">
  2203. <constructor name="FinishApplicationMasterResponse"
  2204. static="false" final="false" visibility="public"
  2205. deprecated="not deprecated">
  2206. </constructor>
  2207. <method name="getIsUnregistered" return="boolean"
  2208. abstract="true" native="false" synchronized="false"
  2209. static="false" final="false" visibility="public"
  2210. deprecated="not deprecated">
  2211. <doc>
  2212. <![CDATA[Get the flag which indicates that the application has successfully
  2213. unregistered with the RM and the application can safely stop.
  2214. @return true if the application has unregistered with the RM,
  2215. false otherwise]]>
  2216. </doc>
  2217. </method>
  2218. <doc>
  2219. <![CDATA[The response sent by the <code>ResourceManager</code> to a
  2220. <code>ApplicationMaster</code> on it's completion.
  2221. <p>
  2222. The response, includes:
  2223. <ul>
  2224. <li>A flag which indicates that the application has successfully unregistered
  2225. with the RM and the application can safely stop.</li>
  2226. </ul>
  2227. <p>
  2228. Note: The flag indicates whether the application has successfully
  2229. unregistered and is safe to stop. The application may stop after the flag is
  2230. true. If the application stops before the flag is true then the RM may retry
  2231. the application.
  2232. @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
  2233. </doc>
  2234. </class>
  2235. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
  2236. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesRequest -->
  2237. <class name="GetAllResourceProfilesRequest" extends="java.lang.Object"
  2238. abstract="true"
  2239. static="false" final="false" visibility="public"
  2240. deprecated="not deprecated">
  2241. <constructor name="GetAllResourceProfilesRequest"
  2242. static="false" final="false" visibility="public"
  2243. deprecated="not deprecated">
  2244. </constructor>
  2245. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesRequest"
  2246. abstract="false" native="false" synchronized="false"
  2247. static="true" final="false" visibility="public"
  2248. deprecated="not deprecated">
  2249. </method>
  2250. <doc>
  2251. <![CDATA[Request class for getting all the resource profiles from the RM.]]>
  2252. </doc>
  2253. </class>
  2254. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesRequest -->
  2255. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesResponse -->
  2256. <class name="GetAllResourceProfilesResponse" extends="java.lang.Object"
  2257. abstract="true"
  2258. static="false" final="false" visibility="public"
  2259. deprecated="not deprecated">
  2260. <constructor name="GetAllResourceProfilesResponse"
  2261. static="false" final="false" visibility="public"
  2262. deprecated="not deprecated">
  2263. </constructor>
  2264. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesResponse"
  2265. abstract="false" native="false" synchronized="false"
  2266. static="true" final="false" visibility="public"
  2267. deprecated="not deprecated">
  2268. </method>
  2269. <method name="setResourceProfiles"
  2270. abstract="true" native="false" synchronized="false"
  2271. static="false" final="false" visibility="public"
  2272. deprecated="not deprecated">
  2273. <param name="profiles" type="java.util.Map"/>
  2274. </method>
  2275. <method name="getResourceProfiles" return="java.util.Map"
  2276. abstract="true" native="false" synchronized="false"
  2277. static="false" final="false" visibility="public"
  2278. deprecated="not deprecated">
  2279. </method>
  2280. <method name="equals" return="boolean"
  2281. abstract="false" native="false" synchronized="false"
  2282. static="false" final="false" visibility="public"
  2283. deprecated="not deprecated">
  2284. <param name="other" type="java.lang.Object"/>
  2285. </method>
  2286. <method name="hashCode" return="int"
  2287. abstract="false" native="false" synchronized="false"
  2288. static="false" final="false" visibility="public"
  2289. deprecated="not deprecated">
  2290. </method>
  2291. <doc>
  2292. <![CDATA[Response class for getting all the resource profiles from the RM.]]>
  2293. </doc>
  2294. </class>
  2295. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesResponse -->
  2296. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest -->
  2297. <class name="GetAllResourceTypeInfoRequest" extends="java.lang.Object"
  2298. abstract="true"
  2299. static="false" final="false" visibility="public"
  2300. deprecated="not deprecated">
  2301. <constructor name="GetAllResourceTypeInfoRequest"
  2302. static="false" final="false" visibility="public"
  2303. deprecated="not deprecated">
  2304. </constructor>
  2305. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest"
  2306. abstract="false" native="false" synchronized="false"
  2307. static="true" final="false" visibility="public"
  2308. deprecated="not deprecated">
  2309. </method>
  2310. <doc>
  2311. <![CDATA[Request class for getting all the resource profiles from the RM.]]>
  2312. </doc>
  2313. </class>
  2314. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest -->
  2315. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse -->
  2316. <class name="GetAllResourceTypeInfoResponse" extends="java.lang.Object"
  2317. abstract="true"
  2318. static="false" final="false" visibility="public"
  2319. deprecated="not deprecated">
  2320. <constructor name="GetAllResourceTypeInfoResponse"
  2321. static="false" final="false" visibility="public"
  2322. deprecated="not deprecated">
  2323. </constructor>
  2324. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse"
  2325. abstract="false" native="false" synchronized="false"
  2326. static="true" final="false" visibility="public"
  2327. deprecated="not deprecated">
  2328. </method>
  2329. <method name="setResourceTypeInfo"
  2330. abstract="true" native="false" synchronized="false"
  2331. static="false" final="false" visibility="public"
  2332. deprecated="not deprecated">
  2333. <param name="resourceTypes" type="java.util.List"/>
  2334. </method>
  2335. <method name="getResourceTypeInfo" return="java.util.List"
  2336. abstract="true" native="false" synchronized="false"
  2337. static="false" final="false" visibility="public"
  2338. deprecated="not deprecated">
  2339. </method>
  2340. <method name="equals" return="boolean"
  2341. abstract="false" native="false" synchronized="false"
  2342. static="false" final="false" visibility="public"
  2343. deprecated="not deprecated">
  2344. <param name="other" type="java.lang.Object"/>
  2345. </method>
  2346. <method name="hashCode" return="int"
  2347. abstract="false" native="false" synchronized="false"
  2348. static="false" final="false" visibility="public"
  2349. deprecated="not deprecated">
  2350. </method>
  2351. <doc>
  2352. <![CDATA[Response class for getting all the resource profiles from the RM.]]>
  2353. </doc>
  2354. </class>
  2355. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse -->
  2356. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
  2357. <class name="GetApplicationAttemptReportRequest" extends="java.lang.Object"
  2358. abstract="true"
  2359. static="false" final="false" visibility="public"
  2360. deprecated="not deprecated">
  2361. <constructor name="GetApplicationAttemptReportRequest"
  2362. static="false" final="false" visibility="public"
  2363. deprecated="not deprecated">
  2364. </constructor>
  2365. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"
  2366. abstract="false" native="false" synchronized="false"
  2367. static="true" final="false" visibility="public"
  2368. deprecated="not deprecated">
  2369. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2370. </method>
  2371. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2372. abstract="true" native="false" synchronized="false"
  2373. static="false" final="false" visibility="public"
  2374. deprecated="not deprecated">
  2375. <doc>
  2376. <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
  2377. @return <code>ApplicationAttemptId</code> of an application attempt]]>
  2378. </doc>
  2379. </method>
  2380. <method name="setApplicationAttemptId"
  2381. abstract="true" native="false" synchronized="false"
  2382. static="false" final="false" visibility="public"
  2383. deprecated="not deprecated">
  2384. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2385. <doc>
  2386. <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
  2387. @param applicationAttemptId
  2388. <code>ApplicationAttemptId</code> of an application attempt]]>
  2389. </doc>
  2390. </method>
  2391. <doc>
  2392. <![CDATA[<p>
  2393. The request sent by a client to the <code>ResourceManager</code> to get an
  2394. {@link ApplicationAttemptReport} for an application attempt.
  2395. </p>
  2396. <p>
  2397. The request should include the {@link ApplicationAttemptId} of the
  2398. application attempt.
  2399. </p>
  2400. @see ApplicationAttemptReport
  2401. @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
  2402. </doc>
  2403. </class>
  2404. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
  2405. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
  2406. <class name="GetApplicationAttemptReportResponse" extends="java.lang.Object"
  2407. abstract="true"
  2408. static="false" final="false" visibility="public"
  2409. deprecated="not deprecated">
  2410. <constructor name="GetApplicationAttemptReportResponse"
  2411. static="false" final="false" visibility="public"
  2412. deprecated="not deprecated">
  2413. </constructor>
  2414. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
  2415. abstract="false" native="false" synchronized="false"
  2416. static="true" final="false" visibility="public"
  2417. deprecated="not deprecated">
  2418. <param name="ApplicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
  2419. </method>
  2420. <method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
  2421. abstract="true" native="false" synchronized="false"
  2422. static="false" final="false" visibility="public"
  2423. deprecated="not deprecated">
  2424. <doc>
  2425. <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
  2426. @return <code>ApplicationAttemptReport</code> for the application attempt]]>
  2427. </doc>
  2428. </method>
  2429. <method name="setApplicationAttemptReport"
  2430. abstract="true" native="false" synchronized="false"
  2431. static="false" final="false" visibility="public"
  2432. deprecated="not deprecated">
  2433. <param name="applicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
  2434. <doc>
  2435. <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
  2436. @param applicationAttemptReport
  2437. <code>ApplicationAttemptReport</code> for the application attempt]]>
  2438. </doc>
  2439. </method>
  2440. <doc>
  2441. <![CDATA[<p>
  2442. The response sent by the <code>ResourceManager</code> to a client requesting
  2443. an application attempt report.
  2444. </p>
  2445. <p>
  2446. The response includes an {@link ApplicationAttemptReport} which has the
  2447. details about the particular application attempt
  2448. </p>
  2449. @see ApplicationAttemptReport
  2450. @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
  2451. </doc>
  2452. </class>
  2453. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
  2454. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
  2455. <class name="GetApplicationAttemptsRequest" extends="java.lang.Object"
  2456. abstract="true"
  2457. static="false" final="false" visibility="public"
  2458. deprecated="not deprecated">
  2459. <constructor name="GetApplicationAttemptsRequest"
  2460. static="false" final="false" visibility="public"
  2461. deprecated="not deprecated">
  2462. </constructor>
  2463. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"
  2464. abstract="false" native="false" synchronized="false"
  2465. static="true" final="false" visibility="public"
  2466. deprecated="not deprecated">
  2467. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2468. </method>
  2469. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2470. abstract="true" native="false" synchronized="false"
  2471. static="false" final="false" visibility="public"
  2472. deprecated="not deprecated">
  2473. <doc>
  2474. <![CDATA[Get the <code>ApplicationId</code> of an application
  2475. @return <code>ApplicationId</code> of an application]]>
  2476. </doc>
  2477. </method>
  2478. <method name="setApplicationId"
  2479. abstract="true" native="false" synchronized="false"
  2480. static="false" final="false" visibility="public"
  2481. deprecated="not deprecated">
  2482. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2483. <doc>
  2484. <![CDATA[Set the <code>ApplicationId</code> of an application
  2485. @param applicationId
  2486. <code>ApplicationId</code> of an application]]>
  2487. </doc>
  2488. </method>
  2489. <doc>
  2490. <![CDATA[<p>
  2491. The request from clients to get a list of application attempt reports of an
  2492. application from the <code>ResourceManager</code>.
  2493. </p>
  2494. @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
  2495. </doc>
  2496. </class>
  2497. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
  2498. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
  2499. <class name="GetApplicationAttemptsResponse" extends="java.lang.Object"
  2500. abstract="true"
  2501. static="false" final="false" visibility="public"
  2502. deprecated="not deprecated">
  2503. <constructor name="GetApplicationAttemptsResponse"
  2504. static="false" final="false" visibility="public"
  2505. deprecated="not deprecated">
  2506. </constructor>
  2507. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
  2508. abstract="false" native="false" synchronized="false"
  2509. static="true" final="false" visibility="public"
  2510. deprecated="not deprecated">
  2511. <param name="applicationAttempts" type="java.util.List"/>
  2512. </method>
  2513. <method name="getApplicationAttemptList" return="java.util.List"
  2514. abstract="true" native="false" synchronized="false"
  2515. static="false" final="false" visibility="public"
  2516. deprecated="not deprecated">
  2517. <doc>
  2518. <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
  2519. @return a list of <code>ApplicationReport</code> of an application]]>
  2520. </doc>
  2521. </method>
  2522. <method name="setApplicationAttemptList"
  2523. abstract="true" native="false" synchronized="false"
  2524. static="false" final="false" visibility="public"
  2525. deprecated="not deprecated">
  2526. <param name="applicationAttempts" type="java.util.List"/>
  2527. <doc>
  2528. <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
  2529. @param applicationAttempts
  2530. a list of <code>ApplicationReport</code> of an application]]>
  2531. </doc>
  2532. </method>
  2533. <doc>
  2534. <![CDATA[<p>
  2535. The response sent by the <code>ResourceManager</code> to a client requesting
  2536. a list of {@link ApplicationAttemptReport} for application attempts.
  2537. </p>
  2538. <p>
  2539. The <code>ApplicationAttemptReport</code> for each application includes the
  2540. details of an application attempt.
  2541. </p>
  2542. @see ApplicationAttemptReport
  2543. @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
  2544. </doc>
  2545. </class>
  2546. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
  2547. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
  2548. <class name="GetApplicationReportRequest" extends="java.lang.Object"
  2549. abstract="true"
  2550. static="false" final="false" visibility="public"
  2551. deprecated="not deprecated">
  2552. <constructor name="GetApplicationReportRequest"
  2553. static="false" final="false" visibility="public"
  2554. deprecated="not deprecated">
  2555. </constructor>
  2556. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"
  2557. abstract="false" native="false" synchronized="false"
  2558. static="true" final="false" visibility="public"
  2559. deprecated="not deprecated">
  2560. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2561. </method>
  2562. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2563. abstract="true" native="false" synchronized="false"
  2564. static="false" final="false" visibility="public"
  2565. deprecated="not deprecated">
  2566. <doc>
  2567. <![CDATA[Get the <code>ApplicationId</code> of the application.
  2568. @return <code>ApplicationId</code> of the application]]>
  2569. </doc>
  2570. </method>
  2571. <method name="setApplicationId"
  2572. abstract="true" native="false" synchronized="false"
  2573. static="false" final="false" visibility="public"
  2574. deprecated="not deprecated">
  2575. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2576. <doc>
  2577. <![CDATA[Set the <code>ApplicationId</code> of the application
  2578. @param applicationId <code>ApplicationId</code> of the application]]>
  2579. </doc>
  2580. </method>
  2581. <doc>
  2582. <![CDATA[<p>The request sent by a client to the <code>ResourceManager</code> to
  2583. get an {@link ApplicationReport} for an application.</p>
  2584. <p>The request should include the {@link ApplicationId} of the
  2585. application.</p>
  2586. @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)
  2587. @see ApplicationReport]]>
  2588. </doc>
  2589. </class>
  2590. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
  2591. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
  2592. <class name="GetApplicationReportResponse" extends="java.lang.Object"
  2593. abstract="true"
  2594. static="false" final="false" visibility="public"
  2595. deprecated="not deprecated">
  2596. <constructor name="GetApplicationReportResponse"
  2597. static="false" final="false" visibility="public"
  2598. deprecated="not deprecated">
  2599. </constructor>
  2600. <method name="getApplicationReport" return="org.apache.hadoop.yarn.api.records.ApplicationReport"
  2601. abstract="true" native="false" synchronized="false"
  2602. static="false" final="false" visibility="public"
  2603. deprecated="not deprecated">
  2604. <doc>
  2605. <![CDATA[Get the <code>ApplicationReport</code> for the application.
  2606. @return <code>ApplicationReport</code> for the application]]>
  2607. </doc>
  2608. </method>
  2609. <doc>
  2610. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  2611. requesting an application report.</p>
  2612. <p>The response includes an {@link ApplicationReport} which has details such
  2613. as user, queue, name, host on which the <code>ApplicationMaster</code> is
  2614. running, RPC port, tracking URL, diagnostics, start time etc.</p>
  2615. @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)]]>
  2616. </doc>
  2617. </class>
  2618. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
  2619. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
  2620. <class name="GetApplicationsRequest" extends="java.lang.Object"
  2621. abstract="true"
  2622. static="false" final="false" visibility="public"
  2623. deprecated="not deprecated">
  2624. <constructor name="GetApplicationsRequest"
  2625. static="false" final="false" visibility="public"
  2626. deprecated="not deprecated">
  2627. </constructor>
  2628. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2629. abstract="false" native="false" synchronized="false"
  2630. static="true" final="false" visibility="public"
  2631. deprecated="not deprecated">
  2632. </method>
  2633. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2634. abstract="false" native="false" synchronized="false"
  2635. static="true" final="false" visibility="public"
  2636. deprecated="not deprecated">
  2637. <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
  2638. <param name="users" type="java.util.Set"/>
  2639. <param name="queues" type="java.util.Set"/>
  2640. <param name="applicationTypes" type="java.util.Set"/>
  2641. <param name="applicationTags" type="java.util.Set"/>
  2642. <param name="applicationStates" type="java.util.EnumSet"/>
  2643. <param name="startRange" type="org.apache.commons.lang3.Range"/>
  2644. <param name="finishRange" type="org.apache.commons.lang3.Range"/>
  2645. <param name="limit" type="java.lang.Long"/>
  2646. <doc>
  2647. <![CDATA[<p>
  2648. The request from clients to get a report of Applications matching the
  2649. giving application types in the cluster from the
  2650. <code>ResourceManager</code>.
  2651. </p>
  2652. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2653. <p>Setting any of the parameters to null, would just disable that
  2654. filter</p>
  2655. @param scope {@link ApplicationsRequestScope} to filter by
  2656. @param users list of users to filter by
  2657. @param queues list of scheduler queues to filter by
  2658. @param applicationTypes types of applications
  2659. @param applicationTags application tags to filter by
  2660. @param applicationStates application states to filter by
  2661. @param startRange range of application start times to filter by
  2662. @param finishRange range of application finish times to filter by
  2663. @param limit number of applications to limit to
  2664. @return {@link GetApplicationsRequest} to be used with
  2665. {@link ApplicationClientProtocol#getApplications(GetApplicationsRequest)}]]>
  2666. </doc>
  2667. </method>
  2668. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2669. abstract="false" native="false" synchronized="false"
  2670. static="true" final="false" visibility="public"
  2671. deprecated="not deprecated">
  2672. <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
  2673. <doc>
  2674. <![CDATA[<p>
  2675. The request from clients to get a report of Applications matching the
  2676. giving application types in the cluster from the
  2677. <code>ResourceManager</code>.
  2678. </p>
  2679. @param scope {@link ApplicationsRequestScope} to filter by
  2680. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2681. @return a report of Applications in {@link GetApplicationsRequest}]]>
  2682. </doc>
  2683. </method>
  2684. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2685. abstract="false" native="false" synchronized="false"
  2686. static="true" final="false" visibility="public"
  2687. deprecated="not deprecated">
  2688. <param name="applicationTypes" type="java.util.Set"/>
  2689. <doc>
  2690. <![CDATA[<p>
  2691. The request from clients to get a report of Applications matching the
  2692. giving application types in the cluster from the
  2693. <code>ResourceManager</code>.
  2694. </p>
  2695. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2696. @return a report of Applications in {@link GetApplicationsRequest}]]>
  2697. </doc>
  2698. </method>
  2699. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2700. abstract="false" native="false" synchronized="false"
  2701. static="true" final="false" visibility="public"
  2702. deprecated="not deprecated">
  2703. <param name="applicationStates" type="java.util.EnumSet"/>
  2704. <doc>
  2705. <![CDATA[<p>
  2706. The request from clients to get a report of Applications matching the
  2707. giving application states in the cluster from the
  2708. <code>ResourceManager</code>.
  2709. </p>
  2710. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2711. @return a report of Applications in {@link GetApplicationsRequest}]]>
  2712. </doc>
  2713. </method>
  2714. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2715. abstract="false" native="false" synchronized="false"
  2716. static="true" final="false" visibility="public"
  2717. deprecated="not deprecated">
  2718. <param name="applicationTypes" type="java.util.Set"/>
  2719. <param name="applicationStates" type="java.util.EnumSet"/>
  2720. <doc>
  2721. <![CDATA[<p>
  2722. The request from clients to get a report of Applications matching the
  2723. giving and application types and application types in the cluster from the
  2724. <code>ResourceManager</code>.
  2725. </p>
  2726. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2727. @return a report of Applications in <code>GetApplicationsRequest</code>]]>
  2728. </doc>
  2729. </method>
  2730. <method name="getApplicationTypes" return="java.util.Set"
  2731. abstract="true" native="false" synchronized="false"
  2732. static="false" final="false" visibility="public"
  2733. deprecated="not deprecated">
  2734. <doc>
  2735. <![CDATA[Get the application types to filter applications on
  2736. @return Set of Application Types to filter on]]>
  2737. </doc>
  2738. </method>
  2739. <method name="getApplicationStates" return="java.util.EnumSet"
  2740. abstract="true" native="false" synchronized="false"
  2741. static="false" final="false" visibility="public"
  2742. deprecated="not deprecated">
  2743. <doc>
  2744. <![CDATA[Get the application states to filter applications on
  2745. @return Set of Application states to filter on]]>
  2746. </doc>
  2747. </method>
  2748. <doc>
  2749. <![CDATA[<p>The request from clients to get a report of Applications
  2750. in the cluster from the <code>ResourceManager</code>.</p>
  2751. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2752. </doc>
  2753. </class>
  2754. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
  2755. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
  2756. <class name="GetApplicationsResponse" extends="java.lang.Object"
  2757. abstract="true"
  2758. static="false" final="false" visibility="public"
  2759. deprecated="not deprecated">
  2760. <constructor name="GetApplicationsResponse"
  2761. static="false" final="false" visibility="public"
  2762. deprecated="not deprecated">
  2763. </constructor>
  2764. <method name="getApplicationList" return="java.util.List"
  2765. abstract="true" native="false" synchronized="false"
  2766. static="false" final="false" visibility="public"
  2767. deprecated="not deprecated">
  2768. <doc>
  2769. <![CDATA[Get <code>ApplicationReport</code> for applications.
  2770. @return <code>ApplicationReport</code> for applications]]>
  2771. </doc>
  2772. </method>
  2773. <doc>
  2774. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  2775. requesting an {@link ApplicationReport} for applications.</p>
  2776. <p>The <code>ApplicationReport</code> for each application includes details
  2777. such as user, queue, name, host on which the <code>ApplicationMaster</code>
  2778. is running, RPC port, tracking URL, diagnostics, start time etc.</p>
  2779. @see ApplicationReport
  2780. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2781. </doc>
  2782. </class>
  2783. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
  2784. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesRequest -->
  2785. <class name="GetAttributesToNodesRequest" extends="java.lang.Object"
  2786. abstract="true"
  2787. static="false" final="false" visibility="public"
  2788. deprecated="not deprecated">
  2789. <constructor name="GetAttributesToNodesRequest"
  2790. static="false" final="false" visibility="public"
  2791. deprecated="not deprecated">
  2792. </constructor>
  2793. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesRequest"
  2794. abstract="false" native="false" synchronized="false"
  2795. static="true" final="false" visibility="public"
  2796. deprecated="not deprecated">
  2797. </method>
  2798. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesRequest"
  2799. abstract="false" native="false" synchronized="false"
  2800. static="true" final="false" visibility="public"
  2801. deprecated="not deprecated">
  2802. <param name="attributes" type="java.util.Set"/>
  2803. </method>
  2804. <method name="setNodeAttributes"
  2805. abstract="true" native="false" synchronized="false"
  2806. static="false" final="false" visibility="public"
  2807. deprecated="not deprecated">
  2808. <param name="attributes" type="java.util.Set"/>
  2809. <doc>
  2810. <![CDATA[Set node attributeKeys for which the mapping of hostname to attribute value
  2811. is required.
  2812. @param attributes Set of NodeAttributeKey provided.]]>
  2813. </doc>
  2814. </method>
  2815. <method name="getNodeAttributes" return="java.util.Set"
  2816. abstract="true" native="false" synchronized="false"
  2817. static="false" final="false" visibility="public"
  2818. deprecated="not deprecated">
  2819. <doc>
  2820. <![CDATA[Get node attributeKeys for which mapping of hostname to attribute value is
  2821. required.
  2822. @return Set of NodeAttributeKey]]>
  2823. </doc>
  2824. </method>
  2825. <doc>
  2826. <![CDATA[<p>
  2827. The request from clients to get node to attribute value mapping for all or
  2828. given set of Node AttributeKey's in the cluster from the
  2829. <code>ResourceManager</code>.
  2830. </p>
  2831. @see ApplicationClientProtocol#getAttributesToNodes
  2832. (GetAttributesToNodesRequest)]]>
  2833. </doc>
  2834. </class>
  2835. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesRequest -->
  2836. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesResponse -->
  2837. <class name="GetAttributesToNodesResponse" extends="java.lang.Object"
  2838. abstract="true"
  2839. static="false" final="false" visibility="public"
  2840. deprecated="not deprecated">
  2841. <constructor name="GetAttributesToNodesResponse"
  2842. static="false" final="false" visibility="public"
  2843. deprecated="not deprecated">
  2844. </constructor>
  2845. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesResponse"
  2846. abstract="false" native="false" synchronized="false"
  2847. static="true" final="false" visibility="public"
  2848. deprecated="not deprecated">
  2849. <param name="map" type="java.util.Map"/>
  2850. </method>
  2851. <method name="setAttributeToNodes"
  2852. abstract="true" native="false" synchronized="false"
  2853. static="false" final="false" visibility="public"
  2854. deprecated="not deprecated">
  2855. <param name="map" type="java.util.Map"/>
  2856. </method>
  2857. <method name="getAttributesToNodes" return="java.util.Map"
  2858. abstract="true" native="false" synchronized="false"
  2859. static="false" final="false" visibility="public"
  2860. deprecated="not deprecated">
  2861. <doc>
  2862. <![CDATA[Get mapping of NodeAttributeKey to its associated mapping of list of
  2863. NodeToAttributeValue associated with attribute.
  2864. @return Map of node attributes to list of NodeToAttributeValue.]]>
  2865. </doc>
  2866. </method>
  2867. <doc>
  2868. <![CDATA[<p>
  2869. The response sent by the <code>ResourceManager</code> to a client requesting
  2870. node to attribute value mapping for all or given set of Node AttributeKey's.
  2871. </p>
  2872. @see ApplicationClientProtocol#getAttributesToNodes
  2873. (GetAttributesToNodesRequest)]]>
  2874. </doc>
  2875. </class>
  2876. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesResponse -->
  2877. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
  2878. <class name="GetClusterMetricsRequest" extends="java.lang.Object"
  2879. abstract="true"
  2880. static="false" final="false" visibility="public"
  2881. deprecated="not deprecated">
  2882. <constructor name="GetClusterMetricsRequest"
  2883. static="false" final="false" visibility="public"
  2884. deprecated="not deprecated">
  2885. </constructor>
  2886. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"
  2887. abstract="false" native="false" synchronized="false"
  2888. static="true" final="false" visibility="public"
  2889. deprecated="not deprecated">
  2890. </method>
  2891. <doc>
  2892. <![CDATA[<p>The request sent by clients to get cluster metrics from the
  2893. <code>ResourceManager</code>.</p>
  2894. <p>Currently, this is empty.</p>
  2895. @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
  2896. </doc>
  2897. </class>
  2898. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
  2899. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
  2900. <class name="GetClusterMetricsResponse" extends="java.lang.Object"
  2901. abstract="true"
  2902. static="false" final="false" visibility="public"
  2903. deprecated="not deprecated">
  2904. <constructor name="GetClusterMetricsResponse"
  2905. static="false" final="false" visibility="public"
  2906. deprecated="not deprecated">
  2907. </constructor>
  2908. <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.records.YarnClusterMetrics"
  2909. abstract="true" native="false" synchronized="false"
  2910. static="false" final="false" visibility="public"
  2911. deprecated="not deprecated">
  2912. <doc>
  2913. <![CDATA[Get the <code>YarnClusterMetrics</code> for the cluster.
  2914. @return <code>YarnClusterMetrics</code> for the cluster]]>
  2915. </doc>
  2916. </method>
  2917. <doc>
  2918. <![CDATA[The response sent by the <code>ResourceManager</code> to a client
  2919. requesting cluster metrics.
  2920. @see YarnClusterMetrics
  2921. @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
  2922. </doc>
  2923. </class>
  2924. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
  2925. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesRequest -->
  2926. <class name="GetClusterNodeAttributesRequest" extends="java.lang.Object"
  2927. abstract="true"
  2928. static="false" final="false" visibility="public"
  2929. deprecated="not deprecated">
  2930. <constructor name="GetClusterNodeAttributesRequest"
  2931. static="false" final="false" visibility="public"
  2932. deprecated="not deprecated">
  2933. </constructor>
  2934. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesRequest"
  2935. abstract="false" native="false" synchronized="false"
  2936. static="true" final="false" visibility="public"
  2937. deprecated="not deprecated">
  2938. <doc>
  2939. <![CDATA[Create new instance of GetClusterNodeAttributesRequest.
  2940. @return GetClusterNodeAttributesRequest is returned.]]>
  2941. </doc>
  2942. </method>
  2943. <doc>
  2944. <![CDATA[<p>
  2945. The request from clients to get node attributes in the cluster from the
  2946. <code>ResourceManager</code>.
  2947. </p>
  2948. @see ApplicationClientProtocol#getClusterNodeAttributes
  2949. (GetClusterNodeAttributesRequest)]]>
  2950. </doc>
  2951. </class>
  2952. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesRequest -->
  2953. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesResponse -->
  2954. <class name="GetClusterNodeAttributesResponse" extends="java.lang.Object"
  2955. abstract="true"
  2956. static="false" final="false" visibility="public"
  2957. deprecated="not deprecated">
  2958. <constructor name="GetClusterNodeAttributesResponse"
  2959. static="false" final="false" visibility="public"
  2960. deprecated="not deprecated">
  2961. </constructor>
  2962. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesResponse"
  2963. abstract="false" native="false" synchronized="false"
  2964. static="true" final="false" visibility="public"
  2965. deprecated="not deprecated">
  2966. <param name="attributes" type="java.util.Set"/>
  2967. <doc>
  2968. <![CDATA[Create instance of GetClusterNodeAttributesResponse.
  2969. @param attributes
  2970. @return GetClusterNodeAttributesResponse.]]>
  2971. </doc>
  2972. </method>
  2973. <method name="setNodeAttributes"
  2974. abstract="true" native="false" synchronized="false"
  2975. static="false" final="false" visibility="public"
  2976. deprecated="not deprecated">
  2977. <param name="attributes" type="java.util.Set"/>
  2978. <doc>
  2979. <![CDATA[Set node attributes to the response.
  2980. @param attributes Map of Node attributeKey to Type.]]>
  2981. </doc>
  2982. </method>
  2983. <method name="getNodeAttributes" return="java.util.Set"
  2984. abstract="true" native="false" synchronized="false"
  2985. static="false" final="false" visibility="public"
  2986. deprecated="not deprecated">
  2987. <doc>
  2988. <![CDATA[Get node attributes from the response.
  2989. @return Node attributes.]]>
  2990. </doc>
  2991. </method>
  2992. <doc>
  2993. <![CDATA[<p>
  2994. The response sent by the <code>ResourceManager</code> to a client requesting
  2995. a node attributes in cluster.
  2996. </p>
  2997. @see ApplicationClientProtocol#getClusterNodeAttributes
  2998. (GetClusterNodeAttributesRequest)]]>
  2999. </doc>
  3000. </class>
  3001. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesResponse -->
  3002. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
  3003. <class name="GetClusterNodeLabelsRequest" extends="java.lang.Object"
  3004. abstract="true"
  3005. static="false" final="false" visibility="public"
  3006. deprecated="not deprecated">
  3007. <constructor name="GetClusterNodeLabelsRequest"
  3008. static="false" final="false" visibility="public"
  3009. deprecated="not deprecated">
  3010. </constructor>
  3011. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"
  3012. abstract="false" native="false" synchronized="false"
  3013. static="true" final="false" visibility="public"
  3014. deprecated="not deprecated">
  3015. </method>
  3016. </class>
  3017. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
  3018. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
  3019. <class name="GetClusterNodeLabelsResponse" extends="java.lang.Object"
  3020. abstract="true"
  3021. static="false" final="false" visibility="public"
  3022. deprecated="not deprecated">
  3023. <constructor name="GetClusterNodeLabelsResponse"
  3024. static="false" final="false" visibility="public"
  3025. deprecated="not deprecated">
  3026. </constructor>
  3027. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  3028. abstract="false" native="false" synchronized="false"
  3029. static="true" final="false" visibility="public"
  3030. deprecated="Use {@link #newInstance(List)} instead.">
  3031. <param name="labels" type="java.util.Set"/>
  3032. <doc>
  3033. <![CDATA[Creates a new instance.
  3034. @param labels Node labels
  3035. @return response
  3036. @deprecated Use {@link #newInstance(List)} instead.]]>
  3037. </doc>
  3038. </method>
  3039. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  3040. abstract="false" native="false" synchronized="false"
  3041. static="true" final="false" visibility="public"
  3042. deprecated="not deprecated">
  3043. <param name="labels" type="java.util.List"/>
  3044. </method>
  3045. <method name="setNodeLabelList"
  3046. abstract="true" native="false" synchronized="false"
  3047. static="false" final="false" visibility="public"
  3048. deprecated="not deprecated">
  3049. <param name="labels" type="java.util.List"/>
  3050. </method>
  3051. <method name="getNodeLabelList" return="java.util.List"
  3052. abstract="true" native="false" synchronized="false"
  3053. static="false" final="false" visibility="public"
  3054. deprecated="not deprecated">
  3055. </method>
  3056. <method name="setNodeLabels"
  3057. abstract="true" native="false" synchronized="false"
  3058. static="false" final="false" visibility="public"
  3059. deprecated="Use {@link #setNodeLabelList(List)} instead.">
  3060. <param name="labels" type="java.util.Set"/>
  3061. <doc>
  3062. <![CDATA[Set node labels to the response.
  3063. @param labels Node labels
  3064. @deprecated Use {@link #setNodeLabelList(List)} instead.]]>
  3065. </doc>
  3066. </method>
  3067. <method name="getNodeLabels" return="java.util.Set"
  3068. abstract="true" native="false" synchronized="false"
  3069. static="false" final="false" visibility="public"
  3070. deprecated="Use {@link #getNodeLabelList()} instead.">
  3071. <doc>
  3072. <![CDATA[Get node labels of the response.
  3073. @return Node labels
  3074. @deprecated Use {@link #getNodeLabelList()} instead.]]>
  3075. </doc>
  3076. </method>
  3077. </class>
  3078. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
  3079. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
  3080. <class name="GetClusterNodesRequest" extends="java.lang.Object"
  3081. abstract="true"
  3082. static="false" final="false" visibility="public"
  3083. deprecated="not deprecated">
  3084. <constructor name="GetClusterNodesRequest"
  3085. static="false" final="false" visibility="public"
  3086. deprecated="not deprecated">
  3087. </constructor>
  3088. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
  3089. abstract="false" native="false" synchronized="false"
  3090. static="true" final="false" visibility="public"
  3091. deprecated="not deprecated">
  3092. <param name="states" type="java.util.EnumSet"/>
  3093. </method>
  3094. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
  3095. abstract="false" native="false" synchronized="false"
  3096. static="true" final="false" visibility="public"
  3097. deprecated="not deprecated">
  3098. </method>
  3099. <method name="getNodeStates" return="java.util.EnumSet"
  3100. abstract="true" native="false" synchronized="false"
  3101. static="false" final="false" visibility="public"
  3102. deprecated="not deprecated">
  3103. <doc>
  3104. <![CDATA[The state to filter the cluster nodes with.
  3105. @return the set of {@link NodeState}]]>
  3106. </doc>
  3107. </method>
  3108. <method name="setNodeStates"
  3109. abstract="true" native="false" synchronized="false"
  3110. static="false" final="false" visibility="public"
  3111. deprecated="not deprecated">
  3112. <param name="states" type="java.util.EnumSet"/>
  3113. <doc>
  3114. <![CDATA[The state to filter the cluster nodes with.
  3115. @param states the set of {@link NodeState}]]>
  3116. </doc>
  3117. </method>
  3118. <doc>
  3119. <![CDATA[<p>The request from clients to get a report of all nodes
  3120. in the cluster from the <code>ResourceManager</code>.</p>
  3121. The request will ask for all nodes in the given {@link NodeState}s.
  3122. @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
  3123. </doc>
  3124. </class>
  3125. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
  3126. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
  3127. <class name="GetClusterNodesResponse" extends="java.lang.Object"
  3128. abstract="true"
  3129. static="false" final="false" visibility="public"
  3130. deprecated="not deprecated">
  3131. <constructor name="GetClusterNodesResponse"
  3132. static="false" final="false" visibility="public"
  3133. deprecated="not deprecated">
  3134. </constructor>
  3135. <method name="getNodeReports" return="java.util.List"
  3136. abstract="true" native="false" synchronized="false"
  3137. static="false" final="false" visibility="public"
  3138. deprecated="not deprecated">
  3139. <doc>
  3140. <![CDATA[Get <code>NodeReport</code> for all nodes in the cluster.
  3141. @return <code>NodeReport</code> for all nodes in the cluster]]>
  3142. </doc>
  3143. </method>
  3144. <doc>
  3145. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  3146. requesting a {@link NodeReport} for all nodes.</p>
  3147. <p>The <code>NodeReport</code> contains per-node information such as
  3148. available resources, number of containers, tracking url, rack name, health
  3149. status etc.
  3150. @see NodeReport
  3151. @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
  3152. </doc>
  3153. </class>
  3154. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
  3155. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
  3156. <class name="GetContainerReportRequest" extends="java.lang.Object"
  3157. abstract="true"
  3158. static="false" final="false" visibility="public"
  3159. deprecated="not deprecated">
  3160. <constructor name="GetContainerReportRequest"
  3161. static="false" final="false" visibility="public"
  3162. deprecated="not deprecated">
  3163. </constructor>
  3164. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"
  3165. abstract="false" native="false" synchronized="false"
  3166. static="true" final="false" visibility="public"
  3167. deprecated="not deprecated">
  3168. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  3169. </method>
  3170. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  3171. abstract="true" native="false" synchronized="false"
  3172. static="false" final="false" visibility="public"
  3173. deprecated="not deprecated">
  3174. <doc>
  3175. <![CDATA[Get the <code>ContainerId</code> of the Container.
  3176. @return <code>ContainerId</code> of the Container]]>
  3177. </doc>
  3178. </method>
  3179. <method name="setContainerId"
  3180. abstract="true" native="false" synchronized="false"
  3181. static="false" final="false" visibility="public"
  3182. deprecated="not deprecated">
  3183. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  3184. <doc>
  3185. <![CDATA[Set the <code>ContainerId</code> of the container
  3186. @param containerId
  3187. <code>ContainerId</code> of the container]]>
  3188. </doc>
  3189. </method>
  3190. <doc>
  3191. <![CDATA[<p>
  3192. The request sent by a client to the <code>ResourceManager</code> to get an
  3193. {@link ContainerReport} for a container.
  3194. </p>]]>
  3195. </doc>
  3196. </class>
  3197. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
  3198. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
  3199. <class name="GetContainerReportResponse" extends="java.lang.Object"
  3200. abstract="true"
  3201. static="false" final="false" visibility="public"
  3202. deprecated="not deprecated">
  3203. <constructor name="GetContainerReportResponse"
  3204. static="false" final="false" visibility="public"
  3205. deprecated="not deprecated">
  3206. </constructor>
  3207. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
  3208. abstract="false" native="false" synchronized="false"
  3209. static="true" final="false" visibility="public"
  3210. deprecated="not deprecated">
  3211. <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
  3212. </method>
  3213. <method name="getContainerReport" return="org.apache.hadoop.yarn.api.records.ContainerReport"
  3214. abstract="true" native="false" synchronized="false"
  3215. static="false" final="false" visibility="public"
  3216. deprecated="not deprecated">
  3217. <doc>
  3218. <![CDATA[Get the <code>ContainerReport</code> for the container.
  3219. @return <code>ContainerReport</code> for the container]]>
  3220. </doc>
  3221. </method>
  3222. <method name="setContainerReport"
  3223. abstract="true" native="false" synchronized="false"
  3224. static="false" final="false" visibility="public"
  3225. deprecated="not deprecated">
  3226. <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
  3227. </method>
  3228. <doc>
  3229. <![CDATA[<p>
  3230. The response sent by the <code>ResourceManager</code> to a client requesting
  3231. a container report.
  3232. </p>
  3233. <p>
  3234. The response includes a {@link ContainerReport} which has details of a
  3235. container.
  3236. </p>]]>
  3237. </doc>
  3238. </class>
  3239. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
  3240. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
  3241. <class name="GetContainersRequest" extends="java.lang.Object"
  3242. abstract="true"
  3243. static="false" final="false" visibility="public"
  3244. deprecated="not deprecated">
  3245. <constructor name="GetContainersRequest"
  3246. static="false" final="false" visibility="public"
  3247. deprecated="not deprecated">
  3248. </constructor>
  3249. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"
  3250. abstract="false" native="false" synchronized="false"
  3251. static="true" final="false" visibility="public"
  3252. deprecated="not deprecated">
  3253. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  3254. </method>
  3255. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  3256. abstract="true" native="false" synchronized="false"
  3257. static="false" final="false" visibility="public"
  3258. deprecated="not deprecated">
  3259. <doc>
  3260. <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
  3261. @return <code>ApplicationAttemptId</code> of an application attempt]]>
  3262. </doc>
  3263. </method>
  3264. <method name="setApplicationAttemptId"
  3265. abstract="true" native="false" synchronized="false"
  3266. static="false" final="false" visibility="public"
  3267. deprecated="not deprecated">
  3268. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  3269. <doc>
  3270. <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
  3271. @param applicationAttemptId
  3272. <code>ApplicationAttemptId</code> of an application attempt]]>
  3273. </doc>
  3274. </method>
  3275. <doc>
  3276. <![CDATA[<p>
  3277. The request from clients to get a list of container reports, which belong to
  3278. an application attempt from the <code>ResourceManager</code>.
  3279. </p>
  3280. @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
  3281. </doc>
  3282. </class>
  3283. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
  3284. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
  3285. <class name="GetContainersResponse" extends="java.lang.Object"
  3286. abstract="true"
  3287. static="false" final="false" visibility="public"
  3288. deprecated="not deprecated">
  3289. <constructor name="GetContainersResponse"
  3290. static="false" final="false" visibility="public"
  3291. deprecated="not deprecated">
  3292. </constructor>
  3293. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
  3294. abstract="false" native="false" synchronized="false"
  3295. static="true" final="false" visibility="public"
  3296. deprecated="not deprecated">
  3297. <param name="containers" type="java.util.List"/>
  3298. </method>
  3299. <method name="getContainerList" 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 a list of <code>ContainerReport</code> for all the containers of an
  3305. application attempt.
  3306. @return a list of <code>ContainerReport</code> for all the containers of an
  3307. application attempt]]>
  3308. </doc>
  3309. </method>
  3310. <method name="setContainerList"
  3311. abstract="true" native="false" synchronized="false"
  3312. static="false" final="false" visibility="public"
  3313. deprecated="not deprecated">
  3314. <param name="containers" type="java.util.List"/>
  3315. <doc>
  3316. <![CDATA[Set a list of <code>ContainerReport</code> for all the containers of an
  3317. application attempt.
  3318. @param containers
  3319. a list of <code>ContainerReport</code> for all the containers of
  3320. an application attempt]]>
  3321. </doc>
  3322. </method>
  3323. <doc>
  3324. <![CDATA[<p>
  3325. The response sent by the <code>ResourceManager</code> to a client requesting
  3326. a list of {@link ContainerReport} for containers.
  3327. </p>
  3328. <p>
  3329. The <code>ContainerReport</code> for each container includes the container
  3330. details.
  3331. </p>
  3332. @see ContainerReport
  3333. @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
  3334. </doc>
  3335. </class>
  3336. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
  3337. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
  3338. <class name="GetContainerStatusesRequest" extends="java.lang.Object"
  3339. abstract="true"
  3340. static="false" final="false" visibility="public"
  3341. deprecated="not deprecated">
  3342. <constructor name="GetContainerStatusesRequest"
  3343. static="false" final="false" visibility="public"
  3344. deprecated="not deprecated">
  3345. </constructor>
  3346. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"
  3347. abstract="false" native="false" synchronized="false"
  3348. static="true" final="false" visibility="public"
  3349. deprecated="not deprecated">
  3350. <param name="containerIds" type="java.util.List"/>
  3351. </method>
  3352. <method name="getContainerIds" return="java.util.List"
  3353. abstract="true" native="false" synchronized="false"
  3354. static="false" final="false" visibility="public"
  3355. deprecated="not deprecated">
  3356. <doc>
  3357. <![CDATA[Get the list of <code>ContainerId</code>s of containers for which to obtain
  3358. the <code>ContainerStatus</code>.
  3359. @return the list of <code>ContainerId</code>s of containers for which to
  3360. obtain the <code>ContainerStatus</code>.]]>
  3361. </doc>
  3362. </method>
  3363. <method name="setContainerIds"
  3364. abstract="true" native="false" synchronized="false"
  3365. static="false" final="false" visibility="public"
  3366. deprecated="not deprecated">
  3367. <param name="containerIds" type="java.util.List"/>
  3368. <doc>
  3369. <![CDATA[Set a list of <code>ContainerId</code>s of containers for which to obtain
  3370. the <code>ContainerStatus</code>
  3371. @param containerIds
  3372. a list of <code>ContainerId</code>s of containers for which to
  3373. obtain the <code>ContainerStatus</code>]]>
  3374. </doc>
  3375. </method>
  3376. <doc>
  3377. <![CDATA[The request sent by the <code>ApplicationMaster</code> to the
  3378. <code>NodeManager</code> to get {@link ContainerStatus} of requested
  3379. containers.
  3380. @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
  3381. </doc>
  3382. </class>
  3383. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
  3384. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
  3385. <class name="GetContainerStatusesResponse" extends="java.lang.Object"
  3386. abstract="true"
  3387. static="false" final="false" visibility="public"
  3388. deprecated="not deprecated">
  3389. <constructor name="GetContainerStatusesResponse"
  3390. static="false" final="false" visibility="public"
  3391. deprecated="not deprecated">
  3392. </constructor>
  3393. <method name="getContainerStatuses" return="java.util.List"
  3394. abstract="true" native="false" synchronized="false"
  3395. static="false" final="false" visibility="public"
  3396. deprecated="not deprecated">
  3397. <doc>
  3398. <![CDATA[Get the <code>ContainerStatus</code>es of the requested containers.
  3399. @return <code>ContainerStatus</code>es of the requested containers.]]>
  3400. </doc>
  3401. </method>
  3402. <method name="getFailedRequests" return="java.util.Map"
  3403. abstract="true" native="false" synchronized="false"
  3404. static="false" final="false" visibility="public"
  3405. deprecated="not deprecated">
  3406. <doc>
  3407. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  3408. from per container for failed requests
  3409. @return map of containerId-to-exception]]>
  3410. </doc>
  3411. </method>
  3412. <doc>
  3413. <![CDATA[The response sent by the <code>NodeManager</code> to the
  3414. <code>ApplicationMaster</code> when asked to obtain the
  3415. <code>ContainerStatus</code> of requested containers.
  3416. @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
  3417. </doc>
  3418. </class>
  3419. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
  3420. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
  3421. <class name="GetDelegationTokenRequest" extends="java.lang.Object"
  3422. abstract="true"
  3423. static="false" final="false" visibility="public"
  3424. deprecated="not deprecated">
  3425. <constructor name="GetDelegationTokenRequest"
  3426. static="false" final="false" visibility="public"
  3427. deprecated="not deprecated">
  3428. </constructor>
  3429. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"
  3430. abstract="false" native="false" synchronized="false"
  3431. static="true" final="false" visibility="public"
  3432. deprecated="not deprecated">
  3433. <param name="renewer" type="java.lang.String"/>
  3434. </method>
  3435. <method name="getRenewer" return="java.lang.String"
  3436. abstract="true" native="false" synchronized="false"
  3437. static="false" final="false" visibility="public"
  3438. deprecated="not deprecated">
  3439. </method>
  3440. <method name="setRenewer"
  3441. abstract="true" native="false" synchronized="false"
  3442. static="false" final="false" visibility="public"
  3443. deprecated="not deprecated">
  3444. <param name="renewer" type="java.lang.String"/>
  3445. </method>
  3446. <doc>
  3447. <![CDATA[The request issued by the client to get a delegation token from
  3448. the {@code ResourceManager}.
  3449. for more information.]]>
  3450. </doc>
  3451. </class>
  3452. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
  3453. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
  3454. <class name="GetDelegationTokenResponse" extends="java.lang.Object"
  3455. abstract="true"
  3456. static="false" final="false" visibility="public"
  3457. deprecated="not deprecated">
  3458. <constructor name="GetDelegationTokenResponse"
  3459. static="false" final="false" visibility="public"
  3460. deprecated="not deprecated">
  3461. </constructor>
  3462. <method name="getRMDelegationToken" return="org.apache.hadoop.yarn.api.records.Token"
  3463. abstract="true" native="false" synchronized="false"
  3464. static="false" final="false" visibility="public"
  3465. deprecated="not deprecated">
  3466. <doc>
  3467. <![CDATA[The Delegation tokens have a identifier which maps to
  3468. {@link AbstractDelegationTokenIdentifier}.
  3469. @return the delegation tokens]]>
  3470. </doc>
  3471. </method>
  3472. <doc>
  3473. <![CDATA[Response to a {@link GetDelegationTokenRequest} request
  3474. from the client. The response contains the token that
  3475. can be used by the containers to talk to ClientRMService.]]>
  3476. </doc>
  3477. </class>
  3478. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
  3479. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesRequest -->
  3480. <class name="GetLocalizationStatusesRequest" extends="java.lang.Object"
  3481. abstract="true"
  3482. static="false" final="false" visibility="public"
  3483. deprecated="not deprecated">
  3484. <constructor name="GetLocalizationStatusesRequest"
  3485. static="false" final="false" visibility="public"
  3486. deprecated="not deprecated">
  3487. </constructor>
  3488. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesRequest"
  3489. abstract="false" native="false" synchronized="false"
  3490. static="true" final="false" visibility="public"
  3491. deprecated="not deprecated">
  3492. <param name="containerIds" type="java.util.List"/>
  3493. </method>
  3494. <method name="getContainerIds" return="java.util.List"
  3495. abstract="true" native="false" synchronized="false"
  3496. static="false" final="false" visibility="public"
  3497. deprecated="not deprecated">
  3498. <doc>
  3499. <![CDATA[Get the list of container IDs of the containers for which the localization
  3500. statuses are needed.
  3501. @return the list of container IDs.]]>
  3502. </doc>
  3503. </method>
  3504. <method name="setContainerIds"
  3505. abstract="true" native="false" synchronized="false"
  3506. static="false" final="false" visibility="public"
  3507. deprecated="not deprecated">
  3508. <param name="containerIds" type="java.util.List"/>
  3509. <doc>
  3510. <![CDATA[Sets the list of container IDs of containers for which the localization
  3511. statuses are needed.
  3512. @param containerIds the list of container IDs.]]>
  3513. </doc>
  3514. </method>
  3515. <doc>
  3516. <![CDATA[The request sent by an application master to the node manager to get
  3517. {@link LocalizationStatus}es of containers.
  3518. @see ContainerManagementProtocol#getLocalizationStatuses(
  3519. GetLocalizationStatusesRequest)]]>
  3520. </doc>
  3521. </class>
  3522. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesRequest -->
  3523. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesResponse -->
  3524. <class name="GetLocalizationStatusesResponse" extends="java.lang.Object"
  3525. abstract="true"
  3526. static="false" final="false" visibility="public"
  3527. deprecated="not deprecated">
  3528. <constructor name="GetLocalizationStatusesResponse"
  3529. static="false" final="false" visibility="public"
  3530. deprecated="not deprecated">
  3531. </constructor>
  3532. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesResponse"
  3533. abstract="false" native="false" synchronized="false"
  3534. static="true" final="false" visibility="public"
  3535. deprecated="not deprecated">
  3536. <param name="statuses" type="java.util.Map"/>
  3537. <param name="failedRequests" type="java.util.Map"/>
  3538. </method>
  3539. <method name="getLocalizationStatuses" return="java.util.Map"
  3540. abstract="true" native="false" synchronized="false"
  3541. static="false" final="false" visibility="public"
  3542. deprecated="not deprecated">
  3543. <doc>
  3544. <![CDATA[Get all the container localization statuses.
  3545. @return container localization statuses.]]>
  3546. </doc>
  3547. </method>
  3548. <doc>
  3549. <![CDATA[The response sent by the node manager to an application master when
  3550. localization statuses are requested.
  3551. @see ContainerManagementProtocol#getLocalizationStatuses(
  3552. GetLocalizationStatusesRequest)]]>
  3553. </doc>
  3554. </class>
  3555. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesResponse -->
  3556. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
  3557. <class name="GetNewApplicationRequest" extends="java.lang.Object"
  3558. abstract="true"
  3559. static="false" final="false" visibility="public"
  3560. deprecated="not deprecated">
  3561. <constructor name="GetNewApplicationRequest"
  3562. static="false" final="false" visibility="public"
  3563. deprecated="not deprecated">
  3564. </constructor>
  3565. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"
  3566. abstract="false" native="false" synchronized="false"
  3567. static="true" final="false" visibility="public"
  3568. deprecated="not deprecated">
  3569. </method>
  3570. <doc>
  3571. <![CDATA[<p>The request sent by clients to get a new {@link ApplicationId} for
  3572. submitting an application.</p>
  3573. <p>Currently, this is empty.</p>
  3574. @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
  3575. </doc>
  3576. </class>
  3577. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
  3578. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
  3579. <class name="GetNewApplicationResponse" extends="java.lang.Object"
  3580. abstract="true"
  3581. static="false" final="false" visibility="public"
  3582. deprecated="not deprecated">
  3583. <constructor name="GetNewApplicationResponse"
  3584. static="false" final="false" visibility="public"
  3585. deprecated="not deprecated">
  3586. </constructor>
  3587. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3588. abstract="true" native="false" synchronized="false"
  3589. static="false" final="false" visibility="public"
  3590. deprecated="not deprecated">
  3591. <doc>
  3592. <![CDATA[Get the <em>new</em> <code>ApplicationId</code> allocated by the
  3593. <code>ResourceManager</code>.
  3594. @return <em>new</em> <code>ApplicationId</code> allocated by the
  3595. <code>ResourceManager</code>]]>
  3596. </doc>
  3597. </method>
  3598. <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  3599. abstract="true" native="false" synchronized="false"
  3600. static="false" final="false" visibility="public"
  3601. deprecated="not deprecated">
  3602. <doc>
  3603. <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
  3604. <code>ResourceManager</code> in the cluster.
  3605. @return maximum capability of allocated resources in the cluster]]>
  3606. </doc>
  3607. </method>
  3608. <doc>
  3609. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client for
  3610. a request to get a new {@link ApplicationId} for submitting applications.</p>
  3611. <p>Clients can submit an application with the returned
  3612. {@link ApplicationId}.</p>
  3613. @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
  3614. </doc>
  3615. </class>
  3616. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
  3617. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest -->
  3618. <class name="GetNewReservationRequest" extends="java.lang.Object"
  3619. abstract="true"
  3620. static="false" final="false" visibility="public"
  3621. deprecated="not deprecated">
  3622. <constructor name="GetNewReservationRequest"
  3623. static="false" final="false" visibility="public"
  3624. deprecated="not deprecated">
  3625. </constructor>
  3626. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest"
  3627. abstract="false" native="false" synchronized="false"
  3628. static="true" final="false" visibility="public"
  3629. deprecated="not deprecated">
  3630. </method>
  3631. <doc>
  3632. <![CDATA[<p>The request sent by clients to get a new {@code ReservationId} for
  3633. submitting an reservation.</p>
  3634. {@code ApplicationClientProtocol#getNewReservation(GetNewReservationRequest)}]]>
  3635. </doc>
  3636. </class>
  3637. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest -->
  3638. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse -->
  3639. <class name="GetNewReservationResponse" extends="java.lang.Object"
  3640. abstract="true"
  3641. static="false" final="false" visibility="public"
  3642. deprecated="not deprecated">
  3643. <constructor name="GetNewReservationResponse"
  3644. static="false" final="false" visibility="public"
  3645. deprecated="not deprecated">
  3646. </constructor>
  3647. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  3648. abstract="true" native="false" synchronized="false"
  3649. static="false" final="false" visibility="public"
  3650. deprecated="not deprecated">
  3651. <doc>
  3652. <![CDATA[Get a new {@link ReservationId} to be used to submit a reservation.
  3653. @return a {@link ReservationId} representing the unique id to identify
  3654. a reservation with which it was submitted.]]>
  3655. </doc>
  3656. </method>
  3657. <doc>
  3658. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client for
  3659. a request to get a new {@link ReservationId} for submitting reservations.</p>
  3660. <p>Clients can submit an reservation with the returned
  3661. {@link ReservationId}.</p>
  3662. {@code ApplicationClientProtocol#getNewReservation(GetNewReservationRequest)}]]>
  3663. </doc>
  3664. </class>
  3665. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse -->
  3666. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesRequest -->
  3667. <class name="GetNodesToAttributesRequest" extends="java.lang.Object"
  3668. abstract="true"
  3669. static="false" final="false" visibility="public"
  3670. deprecated="not deprecated">
  3671. <constructor name="GetNodesToAttributesRequest"
  3672. static="false" final="false" visibility="public"
  3673. deprecated="not deprecated">
  3674. </constructor>
  3675. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesRequest"
  3676. abstract="false" native="false" synchronized="false"
  3677. static="true" final="false" visibility="public"
  3678. deprecated="not deprecated">
  3679. <param name="hostNames" type="java.util.Set"/>
  3680. </method>
  3681. <method name="setHostNames"
  3682. abstract="true" native="false" synchronized="false"
  3683. static="false" final="false" visibility="public"
  3684. deprecated="not deprecated">
  3685. <param name="hostnames" type="java.util.Set"/>
  3686. <doc>
  3687. <![CDATA[Set hostnames for which mapping is required.
  3688. @param hostnames]]>
  3689. </doc>
  3690. </method>
  3691. <method name="getHostNames" return="java.util.Set"
  3692. abstract="true" native="false" synchronized="false"
  3693. static="false" final="false" visibility="public"
  3694. deprecated="not deprecated">
  3695. <doc>
  3696. <![CDATA[Get hostnames for which mapping is required.
  3697. @return Set of hostnames.]]>
  3698. </doc>
  3699. </method>
  3700. <doc>
  3701. <![CDATA[<p>
  3702. The request from clients to get nodes to attributes mapping
  3703. in the cluster from the <code>ResourceManager</code>.
  3704. </p>
  3705. @see ApplicationClientProtocol#getNodesToAttributes
  3706. (GetNodesToAttributesRequest)]]>
  3707. </doc>
  3708. </class>
  3709. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesRequest -->
  3710. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesResponse -->
  3711. <class name="GetNodesToAttributesResponse" extends="java.lang.Object"
  3712. abstract="true"
  3713. static="false" final="false" visibility="public"
  3714. deprecated="not deprecated">
  3715. <constructor name="GetNodesToAttributesResponse"
  3716. static="false" final="false" visibility="public"
  3717. deprecated="not deprecated">
  3718. </constructor>
  3719. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesResponse"
  3720. abstract="false" native="false" synchronized="false"
  3721. static="true" final="false" visibility="public"
  3722. deprecated="not deprecated">
  3723. <param name="map" type="java.util.Map"/>
  3724. </method>
  3725. <method name="setNodeToAttributes"
  3726. abstract="true" native="false" synchronized="false"
  3727. static="false" final="false" visibility="public"
  3728. deprecated="not deprecated">
  3729. <param name="map" type="java.util.Map"/>
  3730. </method>
  3731. <method name="getNodeToAttributes" return="java.util.Map"
  3732. abstract="true" native="false" synchronized="false"
  3733. static="false" final="false" visibility="public"
  3734. deprecated="not deprecated">
  3735. <doc>
  3736. <![CDATA[Get hostnames to NodeAttributes mapping.
  3737. @return Map of host to attributes.]]>
  3738. </doc>
  3739. </method>
  3740. <doc>
  3741. <![CDATA[<p>
  3742. The response sent by the <code>ResourceManager</code> to a client requesting
  3743. nodes to attributes mapping.
  3744. </p>
  3745. @see ApplicationClientProtocol#getNodesToAttributes
  3746. (GetNodesToAttributesRequest)]]>
  3747. </doc>
  3748. </class>
  3749. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesResponse -->
  3750. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
  3751. <class name="GetQueueInfoRequest" extends="java.lang.Object"
  3752. abstract="true"
  3753. static="false" final="false" visibility="public"
  3754. deprecated="not deprecated">
  3755. <constructor name="GetQueueInfoRequest"
  3756. static="false" final="false" visibility="public"
  3757. deprecated="not deprecated">
  3758. </constructor>
  3759. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"
  3760. abstract="false" native="false" synchronized="false"
  3761. static="true" final="false" visibility="public"
  3762. deprecated="not deprecated">
  3763. <param name="queueName" type="java.lang.String"/>
  3764. <param name="includeApplications" type="boolean"/>
  3765. <param name="includeChildQueues" type="boolean"/>
  3766. <param name="recursive" type="boolean"/>
  3767. </method>
  3768. <method name="getQueueName" return="java.lang.String"
  3769. abstract="true" native="false" synchronized="false"
  3770. static="false" final="false" visibility="public"
  3771. deprecated="not deprecated">
  3772. <doc>
  3773. <![CDATA[Get the <em>queue name</em> for which to get queue information.
  3774. @return <em>queue name</em> for which to get queue information]]>
  3775. </doc>
  3776. </method>
  3777. <method name="setQueueName"
  3778. abstract="true" native="false" synchronized="false"
  3779. static="false" final="false" visibility="public"
  3780. deprecated="not deprecated">
  3781. <param name="queueName" type="java.lang.String"/>
  3782. <doc>
  3783. <![CDATA[Set the <em>queue name</em> for which to get queue information
  3784. @param queueName <em>queue name</em> for which to get queue information]]>
  3785. </doc>
  3786. </method>
  3787. <method name="getIncludeApplications" return="boolean"
  3788. abstract="true" native="false" synchronized="false"
  3789. static="false" final="false" visibility="public"
  3790. deprecated="not deprecated">
  3791. <doc>
  3792. <![CDATA[Is information about <em>active applications</em> required?
  3793. @return <code>true</code> if applications' information is to be included,
  3794. else <code>false</code>]]>
  3795. </doc>
  3796. </method>
  3797. <method name="setIncludeApplications"
  3798. abstract="true" native="false" synchronized="false"
  3799. static="false" final="false" visibility="public"
  3800. deprecated="not deprecated">
  3801. <param name="includeApplications" type="boolean"/>
  3802. <doc>
  3803. <![CDATA[Should we get fetch information about <em>active applications</em>?
  3804. @param includeApplications fetch information about <em>active
  3805. applications</em>?]]>
  3806. </doc>
  3807. </method>
  3808. <method name="getIncludeChildQueues" return="boolean"
  3809. abstract="true" native="false" synchronized="false"
  3810. static="false" final="false" visibility="public"
  3811. deprecated="not deprecated">
  3812. <doc>
  3813. <![CDATA[Is information about <em>child queues</em> required?
  3814. @return <code>true</code> if information about child queues is required,
  3815. else <code>false</code>]]>
  3816. </doc>
  3817. </method>
  3818. <method name="setIncludeChildQueues"
  3819. abstract="true" native="false" synchronized="false"
  3820. static="false" final="false" visibility="public"
  3821. deprecated="not deprecated">
  3822. <param name="includeChildQueues" type="boolean"/>
  3823. <doc>
  3824. <![CDATA[Should we fetch information about <em>child queues</em>?
  3825. @param includeChildQueues fetch information about <em>child queues</em>?]]>
  3826. </doc>
  3827. </method>
  3828. <method name="getRecursive" return="boolean"
  3829. abstract="true" native="false" synchronized="false"
  3830. static="false" final="false" visibility="public"
  3831. deprecated="not deprecated">
  3832. <doc>
  3833. <![CDATA[Is information on the entire <em>child queue hierarchy</em> required?
  3834. @return <code>true</code> if information about entire hierarchy is
  3835. required, <code>false</code> otherwise]]>
  3836. </doc>
  3837. </method>
  3838. <method name="setRecursive"
  3839. abstract="true" native="false" synchronized="false"
  3840. static="false" final="false" visibility="public"
  3841. deprecated="not deprecated">
  3842. <param name="recursive" type="boolean"/>
  3843. <doc>
  3844. <![CDATA[Should we fetch information on the entire <em>child queue hierarchy</em>?
  3845. @param recursive fetch information on the entire <em>child queue
  3846. hierarchy</em>?]]>
  3847. </doc>
  3848. </method>
  3849. <doc>
  3850. <![CDATA[<p>The request sent by clients to get <em>queue information</em>
  3851. from the <code>ResourceManager</code>.</p>
  3852. @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
  3853. </doc>
  3854. </class>
  3855. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
  3856. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
  3857. <class name="GetQueueInfoResponse" extends="java.lang.Object"
  3858. abstract="true"
  3859. static="false" final="false" visibility="public"
  3860. deprecated="not deprecated">
  3861. <constructor name="GetQueueInfoResponse"
  3862. static="false" final="false" visibility="public"
  3863. deprecated="not deprecated">
  3864. </constructor>
  3865. <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.records.QueueInfo"
  3866. abstract="true" native="false" synchronized="false"
  3867. static="false" final="false" visibility="public"
  3868. deprecated="not deprecated">
  3869. <doc>
  3870. <![CDATA[Get the <code>QueueInfo</code> for the specified queue.
  3871. @return <code>QueueInfo</code> for the specified queue]]>
  3872. </doc>
  3873. </method>
  3874. <doc>
  3875. <![CDATA[The response sent by the {@code ResourceManager} to a client
  3876. requesting information about queues in the system.
  3877. <p>
  3878. The response includes a {@link QueueInfo} which has details such as
  3879. queue name, used/total capacities, running applications, child queues etc.
  3880. @see QueueInfo
  3881. @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
  3882. </doc>
  3883. </class>
  3884. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
  3885. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
  3886. <class name="GetQueueUserAclsInfoRequest" extends="java.lang.Object"
  3887. abstract="true"
  3888. static="false" final="false" visibility="public"
  3889. deprecated="not deprecated">
  3890. <constructor name="GetQueueUserAclsInfoRequest"
  3891. static="false" final="false" visibility="public"
  3892. deprecated="not deprecated">
  3893. </constructor>
  3894. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"
  3895. abstract="false" native="false" synchronized="false"
  3896. static="true" final="false" visibility="public"
  3897. deprecated="not deprecated">
  3898. </method>
  3899. <doc>
  3900. <![CDATA[<p>The request sent by clients to the <code>ResourceManager</code> to
  3901. get queue acls for the <em>current user</em>.</p>
  3902. <p>Currently, this is empty.</p>
  3903. @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  3904. </doc>
  3905. </class>
  3906. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
  3907. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
  3908. <class name="GetQueueUserAclsInfoResponse" extends="java.lang.Object"
  3909. abstract="true"
  3910. static="false" final="false" visibility="public"
  3911. deprecated="not deprecated">
  3912. <constructor name="GetQueueUserAclsInfoResponse"
  3913. static="false" final="false" visibility="public"
  3914. deprecated="not deprecated">
  3915. </constructor>
  3916. <method name="getUserAclsInfoList" return="java.util.List"
  3917. abstract="true" native="false" synchronized="false"
  3918. static="false" final="false" visibility="public"
  3919. deprecated="not deprecated">
  3920. <doc>
  3921. <![CDATA[Get the <code>QueueUserACLInfo</code> per queue for the user.
  3922. @return <code>QueueUserACLInfo</code> per queue for the user]]>
  3923. </doc>
  3924. </method>
  3925. <doc>
  3926. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to clients
  3927. seeking queue acls for the user.</p>
  3928. <p>The response contains a list of {@link QueueUserACLInfo} which
  3929. provides information about {@link QueueACL} per queue.</p>
  3930. @see QueueACL
  3931. @see QueueUserACLInfo
  3932. @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  3933. </doc>
  3934. </class>
  3935. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
  3936. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileRequest -->
  3937. <class name="GetResourceProfileRequest" extends="java.lang.Object"
  3938. abstract="true"
  3939. static="false" final="false" visibility="public"
  3940. deprecated="not deprecated">
  3941. <constructor name="GetResourceProfileRequest"
  3942. static="false" final="false" visibility="public"
  3943. deprecated="not deprecated">
  3944. </constructor>
  3945. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileRequest"
  3946. abstract="false" native="false" synchronized="false"
  3947. static="true" final="false" visibility="public"
  3948. deprecated="not deprecated">
  3949. <param name="profile" type="java.lang.String"/>
  3950. </method>
  3951. <method name="setProfileName"
  3952. abstract="true" native="false" synchronized="false"
  3953. static="false" final="false" visibility="public"
  3954. deprecated="not deprecated">
  3955. <param name="profileName" type="java.lang.String"/>
  3956. </method>
  3957. <method name="getProfileName" return="java.lang.String"
  3958. abstract="true" native="false" synchronized="false"
  3959. static="false" final="false" visibility="public"
  3960. deprecated="not deprecated">
  3961. </method>
  3962. <method name="equals" return="boolean"
  3963. abstract="false" native="false" synchronized="false"
  3964. static="false" final="false" visibility="public"
  3965. deprecated="not deprecated">
  3966. <param name="other" type="java.lang.Object"/>
  3967. </method>
  3968. <method name="hashCode" return="int"
  3969. abstract="false" native="false" synchronized="false"
  3970. static="false" final="false" visibility="public"
  3971. deprecated="not deprecated">
  3972. </method>
  3973. <doc>
  3974. <![CDATA[Request class for getting the details for a particular resource profile.]]>
  3975. </doc>
  3976. </class>
  3977. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileRequest -->
  3978. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileResponse -->
  3979. <class name="GetResourceProfileResponse" extends="java.lang.Object"
  3980. abstract="true"
  3981. static="false" final="false" visibility="public"
  3982. deprecated="not deprecated">
  3983. <constructor name="GetResourceProfileResponse"
  3984. static="false" final="false" visibility="public"
  3985. deprecated="not deprecated">
  3986. </constructor>
  3987. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileResponse"
  3988. abstract="false" native="false" synchronized="false"
  3989. static="true" final="false" visibility="public"
  3990. deprecated="not deprecated">
  3991. </method>
  3992. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  3993. abstract="true" native="false" synchronized="false"
  3994. static="false" final="false" visibility="public"
  3995. deprecated="not deprecated">
  3996. <doc>
  3997. <![CDATA[Get the resources that will be allocated if the profile was used.
  3998. @return the resources that will be allocated if the profile was used.]]>
  3999. </doc>
  4000. </method>
  4001. <method name="setResource"
  4002. abstract="true" native="false" synchronized="false"
  4003. static="false" final="false" visibility="public"
  4004. deprecated="not deprecated">
  4005. <param name="r" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4006. <doc>
  4007. <![CDATA[Set the resources that will be allocated if the profile is used.
  4008. @param r Set the resources that will be allocated if the profile is used.]]>
  4009. </doc>
  4010. </method>
  4011. <method name="equals" return="boolean"
  4012. abstract="false" native="false" synchronized="false"
  4013. static="false" final="false" visibility="public"
  4014. deprecated="not deprecated">
  4015. <param name="other" type="java.lang.Object"/>
  4016. </method>
  4017. <method name="hashCode" return="int"
  4018. abstract="false" native="false" synchronized="false"
  4019. static="false" final="false" visibility="public"
  4020. deprecated="not deprecated">
  4021. </method>
  4022. <doc>
  4023. <![CDATA[Response class for getting the details for a particular resource profile.]]>
  4024. </doc>
  4025. </class>
  4026. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileResponse -->
  4027. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest -->
  4028. <class name="IncreaseContainersResourceRequest" extends="java.lang.Object"
  4029. abstract="true"
  4030. static="false" final="false" visibility="public"
  4031. deprecated="not deprecated">
  4032. <constructor name="IncreaseContainersResourceRequest"
  4033. static="false" final="false" visibility="public"
  4034. deprecated="not deprecated">
  4035. </constructor>
  4036. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest"
  4037. abstract="false" native="false" synchronized="false"
  4038. static="true" final="false" visibility="public"
  4039. deprecated="not deprecated">
  4040. <param name="containersToIncrease" type="java.util.List"/>
  4041. </method>
  4042. <method name="getContainersToIncrease" return="java.util.List"
  4043. abstract="true" native="false" synchronized="false"
  4044. static="false" final="false" visibility="public"
  4045. deprecated="not deprecated">
  4046. <doc>
  4047. <![CDATA[Get a list of container tokens to be used for authorization during
  4048. container resource increase.
  4049. <p>
  4050. Note: {@link NMToken} will be used for authenticating communication with
  4051. {@code NodeManager}.
  4052. @return the list of container tokens to be used for authorization during
  4053. container resource increase.
  4054. @see NMToken]]>
  4055. </doc>
  4056. </method>
  4057. <method name="setContainersToIncrease"
  4058. abstract="true" native="false" synchronized="false"
  4059. static="false" final="false" visibility="public"
  4060. deprecated="not deprecated">
  4061. <param name="containersToIncrease" type="java.util.List"/>
  4062. <doc>
  4063. <![CDATA[Set container tokens to be used during container resource increase.
  4064. The token is acquired from
  4065. <code>AllocateResponse.getIncreasedContainers</code>.
  4066. The token contains the container id and resource capability required for
  4067. container resource increase.
  4068. @param containersToIncrease the list of container tokens to be used
  4069. for container resource increase.]]>
  4070. </doc>
  4071. </method>
  4072. <doc>
  4073. <![CDATA[<p>The request sent by <code>Application Master</code> to the
  4074. <code>Node Manager</code> to change the resource quota of a container.</p>
  4075. @see ContainerManagementProtocol#increaseContainersResource(IncreaseContainersResourceRequest)]]>
  4076. </doc>
  4077. </class>
  4078. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest -->
  4079. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse -->
  4080. <class name="IncreaseContainersResourceResponse" extends="java.lang.Object"
  4081. abstract="true"
  4082. static="false" final="false" visibility="public"
  4083. deprecated="not deprecated">
  4084. <constructor name="IncreaseContainersResourceResponse"
  4085. static="false" final="false" visibility="public"
  4086. deprecated="not deprecated">
  4087. </constructor>
  4088. <method name="getSuccessfullyIncreasedContainers" return="java.util.List"
  4089. abstract="true" native="false" synchronized="false"
  4090. static="false" final="false" visibility="public"
  4091. deprecated="not deprecated">
  4092. <doc>
  4093. <![CDATA[Get the list of containerIds of containers whose resource
  4094. have been successfully increased.
  4095. @return the list of containerIds of containers whose resource have
  4096. been successfully increased.]]>
  4097. </doc>
  4098. </method>
  4099. <method name="getFailedRequests" return="java.util.Map"
  4100. abstract="true" native="false" synchronized="false"
  4101. static="false" final="false" visibility="public"
  4102. deprecated="not deprecated">
  4103. <doc>
  4104. <![CDATA[Get the containerId-to-exception map in which the exception indicates
  4105. error from each container for failed requests.
  4106. @return map of containerId-to-exception]]>
  4107. </doc>
  4108. </method>
  4109. <doc>
  4110. <![CDATA[<p>
  4111. The response sent by the <code>NodeManager</code> to the
  4112. <code>ApplicationMaster</code> when asked to increase container resource.
  4113. </p>
  4114. @see ContainerManagementProtocol#increaseContainersResource(IncreaseContainersResourceRequest)]]>
  4115. </doc>
  4116. </class>
  4117. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse -->
  4118. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
  4119. <class name="KillApplicationRequest" extends="java.lang.Object"
  4120. abstract="true"
  4121. static="false" final="false" visibility="public"
  4122. deprecated="not deprecated">
  4123. <constructor name="KillApplicationRequest"
  4124. static="false" final="false" visibility="public"
  4125. deprecated="not deprecated">
  4126. </constructor>
  4127. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"
  4128. abstract="false" native="false" synchronized="false"
  4129. static="true" final="false" visibility="public"
  4130. deprecated="not deprecated">
  4131. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4132. </method>
  4133. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4134. abstract="true" native="false" synchronized="false"
  4135. static="false" final="false" visibility="public"
  4136. deprecated="not deprecated">
  4137. <doc>
  4138. <![CDATA[Get the <code>ApplicationId</code> of the application to be aborted.
  4139. @return <code>ApplicationId</code> of the application to be aborted]]>
  4140. </doc>
  4141. </method>
  4142. <method name="setApplicationId"
  4143. abstract="true" native="false" synchronized="false"
  4144. static="false" final="false" visibility="public"
  4145. deprecated="not deprecated">
  4146. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4147. </method>
  4148. <method name="getDiagnostics" return="java.lang.String"
  4149. abstract="true" native="false" synchronized="false"
  4150. static="false" final="false" visibility="public"
  4151. deprecated="not deprecated">
  4152. <doc>
  4153. <![CDATA[Get the <em>diagnostics</em> to which the application is being killed.
  4154. @return <em>diagnostics</em> to which the application is being killed]]>
  4155. </doc>
  4156. </method>
  4157. <method name="setDiagnostics"
  4158. abstract="true" native="false" synchronized="false"
  4159. static="false" final="false" visibility="public"
  4160. deprecated="not deprecated">
  4161. <param name="diagnostics" type="java.lang.String"/>
  4162. <doc>
  4163. <![CDATA[Set the <em>diagnostics</em> to which the application is being killed.
  4164. @param diagnostics <em>diagnostics</em> to which the application is being
  4165. killed]]>
  4166. </doc>
  4167. </method>
  4168. <doc>
  4169. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  4170. to abort a submitted application.</p>
  4171. <p>The request includes the {@link ApplicationId} of the application to be
  4172. aborted.</p>
  4173. @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
  4174. </doc>
  4175. </class>
  4176. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
  4177. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
  4178. <class name="KillApplicationResponse" extends="java.lang.Object"
  4179. abstract="true"
  4180. static="false" final="false" visibility="public"
  4181. deprecated="not deprecated">
  4182. <constructor name="KillApplicationResponse"
  4183. static="false" final="false" visibility="public"
  4184. deprecated="not deprecated">
  4185. </constructor>
  4186. <method name="getIsKillCompleted" return="boolean"
  4187. abstract="true" native="false" synchronized="false"
  4188. static="false" final="false" visibility="public"
  4189. deprecated="not deprecated">
  4190. <doc>
  4191. <![CDATA[Get the flag which indicates that the process of killing application is completed or not.
  4192. @return true if the process of killing application has completed,
  4193. false otherwise]]>
  4194. </doc>
  4195. </method>
  4196. <doc>
  4197. <![CDATA[The response sent by the <code>ResourceManager</code> to the client aborting
  4198. a submitted application.
  4199. <p>
  4200. The response, includes:
  4201. <ul>
  4202. <li>
  4203. A flag which indicates that the process of killing the application is
  4204. completed or not.
  4205. </li>
  4206. </ul>
  4207. Note: user is recommended to wait until this flag becomes true, otherwise if
  4208. the <code>ResourceManager</code> crashes before the process of killing the
  4209. application is completed, the <code>ResourceManager</code> may retry this
  4210. application on recovery.
  4211. @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
  4212. </doc>
  4213. </class>
  4214. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
  4215. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
  4216. <class name="MoveApplicationAcrossQueuesRequest" extends="java.lang.Object"
  4217. abstract="true"
  4218. static="false" final="false" visibility="public"
  4219. deprecated="not deprecated">
  4220. <constructor name="MoveApplicationAcrossQueuesRequest"
  4221. static="false" final="false" visibility="public"
  4222. deprecated="not deprecated">
  4223. </constructor>
  4224. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"
  4225. abstract="false" native="false" synchronized="false"
  4226. static="true" final="false" visibility="public"
  4227. deprecated="not deprecated">
  4228. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4229. <param name="queue" type="java.lang.String"/>
  4230. </method>
  4231. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4232. abstract="true" native="false" synchronized="false"
  4233. static="false" final="false" visibility="public"
  4234. deprecated="not deprecated">
  4235. <doc>
  4236. <![CDATA[Get the <code>ApplicationId</code> of the application to be moved.
  4237. @return <code>ApplicationId</code> of the application to be moved]]>
  4238. </doc>
  4239. </method>
  4240. <method name="setApplicationId"
  4241. abstract="true" native="false" synchronized="false"
  4242. static="false" final="false" visibility="public"
  4243. deprecated="not deprecated">
  4244. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4245. <doc>
  4246. <![CDATA[Set the <code>ApplicationId</code> of the application to be moved.
  4247. @param appId <code>ApplicationId</code> of the application to be moved]]>
  4248. </doc>
  4249. </method>
  4250. <method name="getTargetQueue" return="java.lang.String"
  4251. abstract="true" native="false" synchronized="false"
  4252. static="false" final="false" visibility="public"
  4253. deprecated="not deprecated">
  4254. <doc>
  4255. <![CDATA[Get the queue to place the application in.
  4256. @return the name of the queue to place the application in]]>
  4257. </doc>
  4258. </method>
  4259. <method name="setTargetQueue"
  4260. abstract="true" native="false" synchronized="false"
  4261. static="false" final="false" visibility="public"
  4262. deprecated="not deprecated">
  4263. <param name="queue" type="java.lang.String"/>
  4264. <doc>
  4265. <![CDATA[Get the queue to place the application in.
  4266. @param queue the name of the queue to place the application in]]>
  4267. </doc>
  4268. </method>
  4269. <doc>
  4270. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  4271. to move a submitted application to a different queue.</p>
  4272. <p>The request includes the {@link ApplicationId} of the application to be
  4273. moved and the queue to place it in.</p>
  4274. @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
  4275. </doc>
  4276. </class>
  4277. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
  4278. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
  4279. <class name="MoveApplicationAcrossQueuesResponse" extends="java.lang.Object"
  4280. abstract="true"
  4281. static="false" final="false" visibility="public"
  4282. deprecated="not deprecated">
  4283. <constructor name="MoveApplicationAcrossQueuesResponse"
  4284. static="false" final="false" visibility="public"
  4285. deprecated="not deprecated">
  4286. </constructor>
  4287. <doc>
  4288. <![CDATA[<p>
  4289. The response sent by the <code>ResourceManager</code> to the client moving
  4290. a submitted application to a different queue.
  4291. </p>
  4292. <p>
  4293. A response without exception means that the move has completed successfully.
  4294. </p>
  4295. @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
  4296. </doc>
  4297. </class>
  4298. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
  4299. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
  4300. <class name="RegisterApplicationMasterRequest" extends="java.lang.Object"
  4301. abstract="true"
  4302. static="false" final="false" visibility="public"
  4303. deprecated="not deprecated">
  4304. <constructor name="RegisterApplicationMasterRequest"
  4305. static="false" final="false" visibility="public"
  4306. deprecated="not deprecated">
  4307. </constructor>
  4308. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"
  4309. abstract="false" native="false" synchronized="false"
  4310. static="true" final="false" visibility="public"
  4311. deprecated="not deprecated">
  4312. <param name="host" type="java.lang.String"/>
  4313. <param name="port" type="int"/>
  4314. <param name="trackingUrl" type="java.lang.String"/>
  4315. <doc>
  4316. <![CDATA[Create a new instance of <code>RegisterApplicationMasterRequest</code>.
  4317. If <em>port, trackingUrl</em> is not used, use the following default value:
  4318. <ul>
  4319. <li>port: -1</li>
  4320. <li>trackingUrl: null</li>
  4321. </ul>
  4322. The port is allowed to be any integer larger than or equal to -1.
  4323. @return the new instance of <code>RegisterApplicationMasterRequest</code>]]>
  4324. </doc>
  4325. </method>
  4326. <method name="getHost" return="java.lang.String"
  4327. abstract="true" native="false" synchronized="false"
  4328. static="false" final="false" visibility="public"
  4329. deprecated="not deprecated">
  4330. <doc>
  4331. <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code> is
  4332. running.
  4333. @return <em>host</em> on which the <code>ApplicationMaster</code> is running]]>
  4334. </doc>
  4335. </method>
  4336. <method name="setHost"
  4337. abstract="true" native="false" synchronized="false"
  4338. static="false" final="false" visibility="public"
  4339. deprecated="not deprecated">
  4340. <param name="host" type="java.lang.String"/>
  4341. <doc>
  4342. <![CDATA[Set the <em>host</em> on which the <code>ApplicationMaster</code> is
  4343. running.
  4344. @param host <em>host</em> on which the <code>ApplicationMaster</code>
  4345. is running]]>
  4346. </doc>
  4347. </method>
  4348. <method name="getRpcPort" return="int"
  4349. abstract="true" native="false" synchronized="false"
  4350. static="false" final="false" visibility="public"
  4351. deprecated="not deprecated">
  4352. <doc>
  4353. <![CDATA[Get the <em>RPC port</em> on which the {@code ApplicationMaster} is
  4354. responding.
  4355. @return the <em>RPC port</em> on which the {@code ApplicationMaster}
  4356. is responding]]>
  4357. </doc>
  4358. </method>
  4359. <method name="setRpcPort"
  4360. abstract="true" native="false" synchronized="false"
  4361. static="false" final="false" visibility="public"
  4362. deprecated="not deprecated">
  4363. <param name="port" type="int"/>
  4364. <doc>
  4365. <![CDATA[Set the <em>RPC port</em> on which the {@code ApplicationMaster} is
  4366. responding.
  4367. @param port <em>RPC port</em> on which the {@code ApplicationMaster}
  4368. is responding]]>
  4369. </doc>
  4370. </method>
  4371. <method name="getTrackingUrl" 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[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
  4377. This url if contains scheme then that will be used by resource manager
  4378. web application proxy otherwise it will default to http.
  4379. @return <em>tracking URL</em> for the <code>ApplicationMaster</code>]]>
  4380. </doc>
  4381. </method>
  4382. <method name="setTrackingUrl"
  4383. abstract="true" native="false" synchronized="false"
  4384. static="false" final="false" visibility="public"
  4385. deprecated="not deprecated">
  4386. <param name="trackingUrl" type="java.lang.String"/>
  4387. <doc>
  4388. <![CDATA[Set the <em>tracking URL</em>for the <code>ApplicationMaster</code> while
  4389. it is running. This is the web-URL to which ResourceManager or
  4390. web-application proxy will redirect client/users while the application and
  4391. the <code>ApplicationMaster</code> are still running.
  4392. <p>
  4393. If the passed url has a scheme then that will be used by the
  4394. ResourceManager and web-application proxy, otherwise the scheme will
  4395. default to http.
  4396. </p>
  4397. <p>
  4398. Empty, null, "N/A" strings are all valid besides a real URL. In case an url
  4399. isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
  4400. <p>
  4401. @param trackingUrl
  4402. <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  4403. </doc>
  4404. </method>
  4405. <method name="getPlacementConstraints" return="java.util.Map"
  4406. abstract="false" native="false" synchronized="false"
  4407. static="false" final="false" visibility="public"
  4408. deprecated="not deprecated">
  4409. <doc>
  4410. <![CDATA[Return all Placement Constraints specified at the Application level. The
  4411. mapping is from a set of allocation tags to a
  4412. <code>PlacementConstraint</code> associated with the tags, i.e., each
  4413. {@link org.apache.hadoop.yarn.api.records.SchedulingRequest} that has those
  4414. tags will be placed taking into account the corresponding constraint.
  4415. @return A map of Placement Constraints.]]>
  4416. </doc>
  4417. </method>
  4418. <method name="setPlacementConstraints"
  4419. abstract="false" native="false" synchronized="false"
  4420. static="false" final="false" visibility="public"
  4421. deprecated="not deprecated">
  4422. <param name="placementConstraints" type="java.util.Map"/>
  4423. <doc>
  4424. <![CDATA[Set Placement Constraints applicable to the
  4425. {@link org.apache.hadoop.yarn.api.records.SchedulingRequest}s
  4426. of this application.
  4427. The mapping is from a set of allocation tags to a
  4428. <code>PlacementConstraint</code> associated with the tags.
  4429. For example:
  4430. Map &lt;
  4431. &lt;hb_regionserver&gt; -&gt; node_anti_affinity,
  4432. &lt;hb_regionserver, hb_master&gt; -&gt; rack_affinity,
  4433. ...
  4434. &gt;
  4435. @param placementConstraints Placement Constraint Mapping.]]>
  4436. </doc>
  4437. </method>
  4438. <doc>
  4439. <![CDATA[The request sent by the {@code ApplicationMaster} to {@code ResourceManager}
  4440. on registration.
  4441. <p>
  4442. The registration includes details such as:
  4443. <ul>
  4444. <li>Hostname on which the AM is running.</li>
  4445. <li>RPC Port</li>
  4446. <li>Tracking URL</li>
  4447. </ul>
  4448. @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
  4449. </doc>
  4450. </class>
  4451. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
  4452. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
  4453. <class name="RegisterApplicationMasterResponse" extends="java.lang.Object"
  4454. abstract="true"
  4455. static="false" final="false" visibility="public"
  4456. deprecated="not deprecated">
  4457. <constructor name="RegisterApplicationMasterResponse"
  4458. static="false" final="false" visibility="public"
  4459. deprecated="not deprecated">
  4460. </constructor>
  4461. <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  4462. abstract="true" native="false" synchronized="false"
  4463. static="false" final="false" visibility="public"
  4464. deprecated="not deprecated">
  4465. <doc>
  4466. <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
  4467. <code>ResourceManager</code> in the cluster.
  4468. @return maximum capability of allocated resources in the cluster]]>
  4469. </doc>
  4470. </method>
  4471. <method name="getApplicationACLs" return="java.util.Map"
  4472. abstract="true" native="false" synchronized="false"
  4473. static="false" final="false" visibility="public"
  4474. deprecated="not deprecated">
  4475. <doc>
  4476. <![CDATA[Get the <code>ApplicationACL</code>s for the application.
  4477. @return all the <code>ApplicationACL</code>s]]>
  4478. </doc>
  4479. </method>
  4480. <method name="getClientToAMTokenMasterKey" return="java.nio.ByteBuffer"
  4481. abstract="true" native="false" synchronized="false"
  4482. static="false" final="false" visibility="public"
  4483. deprecated="not deprecated">
  4484. <doc>
  4485. <![CDATA[<p>Get ClientToAMToken master key.</p>
  4486. <p>The ClientToAMToken master key is sent to <code>ApplicationMaster</code>
  4487. by <code>ResourceManager</code> via {@link RegisterApplicationMasterResponse}
  4488. , used to verify corresponding ClientToAMToken.</p>
  4489. @return ClientToAMToken master key]]>
  4490. </doc>
  4491. </method>
  4492. <method name="setClientToAMTokenMasterKey"
  4493. abstract="true" native="false" synchronized="false"
  4494. static="false" final="false" visibility="public"
  4495. deprecated="not deprecated">
  4496. <param name="key" type="java.nio.ByteBuffer"/>
  4497. <doc>
  4498. <![CDATA[Set ClientToAMToken master key.]]>
  4499. </doc>
  4500. </method>
  4501. <method name="getQueue" return="java.lang.String"
  4502. abstract="true" native="false" synchronized="false"
  4503. static="false" final="false" visibility="public"
  4504. deprecated="not deprecated">
  4505. <doc>
  4506. <![CDATA[<p>Get the queue that the application was placed in.<p>
  4507. @return the queue that the application was placed in.]]>
  4508. </doc>
  4509. </method>
  4510. <method name="setQueue"
  4511. abstract="true" native="false" synchronized="false"
  4512. static="false" final="false" visibility="public"
  4513. deprecated="not deprecated">
  4514. <param name="queue" type="java.lang.String"/>
  4515. <doc>
  4516. <![CDATA[<p>Set the queue that the application was placed in.<p>]]>
  4517. </doc>
  4518. </method>
  4519. <method name="getContainersFromPreviousAttempts" return="java.util.List"
  4520. abstract="true" native="false" synchronized="false"
  4521. static="false" final="false" visibility="public"
  4522. deprecated="not deprecated">
  4523. <doc>
  4524. <![CDATA[<p>
  4525. Get the list of running containers as viewed by
  4526. <code>ResourceManager</code> from previous application attempts.
  4527. </p>
  4528. @return the list of running containers as viewed by
  4529. <code>ResourceManager</code> from previous application attempts
  4530. @see RegisterApplicationMasterResponse#getNMTokensFromPreviousAttempts()]]>
  4531. </doc>
  4532. </method>
  4533. <method name="getNMTokensFromPreviousAttempts" return="java.util.List"
  4534. abstract="true" native="false" synchronized="false"
  4535. static="false" final="false" visibility="public"
  4536. deprecated="not deprecated">
  4537. <doc>
  4538. <![CDATA[Get the list of NMTokens for communicating with the NMs where the
  4539. containers of previous application attempts are running.
  4540. @return the list of NMTokens for communicating with the NMs where the
  4541. containers of previous application attempts are running.
  4542. @see RegisterApplicationMasterResponse#getContainersFromPreviousAttempts()]]>
  4543. </doc>
  4544. </method>
  4545. <method name="getSchedulerResourceTypes" return="java.util.EnumSet"
  4546. abstract="true" native="false" synchronized="false"
  4547. static="false" final="false" visibility="public"
  4548. deprecated="not deprecated">
  4549. <doc>
  4550. <![CDATA[Get a set of the resource types considered by the scheduler.
  4551. @return a Map of RM settings]]>
  4552. </doc>
  4553. </method>
  4554. <method name="getResourceProfiles" return="java.util.Map"
  4555. abstract="true" native="false" synchronized="false"
  4556. static="false" final="false" visibility="public"
  4557. deprecated="not deprecated">
  4558. <doc>
  4559. <![CDATA[Get list of supported resource profiles from RM.
  4560. @return a map of resource profiles and its capabilities.]]>
  4561. </doc>
  4562. </method>
  4563. <method name="getResourceTypes" return="java.util.List"
  4564. abstract="true" native="false" synchronized="false"
  4565. static="false" final="false" visibility="public"
  4566. deprecated="not deprecated">
  4567. <doc>
  4568. <![CDATA[Get available resource types supported by RM.
  4569. @return a Map of RM settings]]>
  4570. </doc>
  4571. </method>
  4572. <doc>
  4573. <![CDATA[The response sent by the {@code ResourceManager} to a new
  4574. {@code ApplicationMaster} on registration.
  4575. <p>
  4576. The response contains critical details such as:
  4577. <ul>
  4578. <li>Maximum capability for allocated resources in the cluster.</li>
  4579. <li>{@code ApplicationACL}s for the application.</li>
  4580. <li>ClientToAMToken master key.</li>
  4581. </ul>
  4582. @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
  4583. </doc>
  4584. </class>
  4585. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
  4586. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest -->
  4587. <class name="ReInitializeContainerRequest" extends="java.lang.Object"
  4588. abstract="true"
  4589. static="false" final="false" visibility="public"
  4590. deprecated="not deprecated">
  4591. <constructor name="ReInitializeContainerRequest"
  4592. static="false" final="false" visibility="public"
  4593. deprecated="not deprecated">
  4594. </constructor>
  4595. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest"
  4596. abstract="false" native="false" synchronized="false"
  4597. static="true" final="false" visibility="public"
  4598. deprecated="not deprecated">
  4599. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  4600. <param name="containerLaunchContext" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4601. <param name="autoCommit" type="boolean"/>
  4602. <doc>
  4603. <![CDATA[Creates a new instance of the ReInitializationContainerRequest.
  4604. @param containerId Container Id.
  4605. @param containerLaunchContext Container Launch Context.
  4606. @param autoCommit AutoCommit.
  4607. @return ReInitializationContainerRequest.]]>
  4608. </doc>
  4609. </method>
  4610. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  4611. abstract="true" native="false" synchronized="false"
  4612. static="false" final="false" visibility="public"
  4613. deprecated="not deprecated">
  4614. <doc>
  4615. <![CDATA[Get the <code>ContainerId</code> of the container to re-initialize.
  4616. @return <code>ContainerId</code> of the container to re-initialize.]]>
  4617. </doc>
  4618. </method>
  4619. <method name="getContainerLaunchContext" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  4620. abstract="true" native="false" synchronized="false"
  4621. static="false" final="false" visibility="public"
  4622. deprecated="not deprecated">
  4623. <doc>
  4624. <![CDATA[Get the <code>ContainerLaunchContext</code> to re-initialize the container
  4625. with.
  4626. @return <code>ContainerLaunchContext</code> of to re-initialize the
  4627. container with.]]>
  4628. </doc>
  4629. </method>
  4630. <method name="getAutoCommit" return="boolean"
  4631. abstract="true" native="false" synchronized="false"
  4632. static="false" final="false" visibility="public"
  4633. deprecated="not deprecated">
  4634. <doc>
  4635. <![CDATA[Check if AutoCommit is set for this ReInitialization.
  4636. @return If AutoCommit is set for this ReInitialization.]]>
  4637. </doc>
  4638. </method>
  4639. <doc>
  4640. <![CDATA[This encapsulates all the required fields needed for a Container
  4641. ReInitialization.]]>
  4642. </doc>
  4643. </class>
  4644. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest -->
  4645. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerResponse -->
  4646. <class name="ReInitializeContainerResponse" extends="java.lang.Object"
  4647. abstract="true"
  4648. static="false" final="false" visibility="public"
  4649. deprecated="not deprecated">
  4650. <constructor name="ReInitializeContainerResponse"
  4651. static="false" final="false" visibility="public"
  4652. deprecated="not deprecated">
  4653. </constructor>
  4654. <doc>
  4655. <![CDATA[The response to the {@link ReInitializeContainerRequest}.]]>
  4656. </doc>
  4657. </class>
  4658. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerResponse -->
  4659. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
  4660. <class name="ReleaseSharedCacheResourceRequest" extends="java.lang.Object"
  4661. abstract="true"
  4662. static="false" final="false" visibility="public"
  4663. deprecated="not deprecated">
  4664. <constructor name="ReleaseSharedCacheResourceRequest"
  4665. static="false" final="false" visibility="public"
  4666. deprecated="not deprecated">
  4667. </constructor>
  4668. <method name="getAppId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4669. abstract="true" native="false" synchronized="false"
  4670. static="false" final="false" visibility="public"
  4671. deprecated="not deprecated">
  4672. <doc>
  4673. <![CDATA[Get the <code>ApplicationId</code> of the resource to be released.
  4674. @return <code>ApplicationId</code>]]>
  4675. </doc>
  4676. </method>
  4677. <method name="setAppId"
  4678. abstract="true" native="false" synchronized="false"
  4679. static="false" final="false" visibility="public"
  4680. deprecated="not deprecated">
  4681. <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4682. <doc>
  4683. <![CDATA[Set the <code>ApplicationId</code> of the resource to be released.
  4684. @param id <code>ApplicationId</code>]]>
  4685. </doc>
  4686. </method>
  4687. <method name="getResourceKey" return="java.lang.String"
  4688. abstract="true" native="false" synchronized="false"
  4689. static="false" final="false" visibility="public"
  4690. deprecated="not deprecated">
  4691. <doc>
  4692. <![CDATA[Get the <code>key</code> of the resource to be released.
  4693. @return <code>key</code>]]>
  4694. </doc>
  4695. </method>
  4696. <method name="setResourceKey"
  4697. abstract="true" native="false" synchronized="false"
  4698. static="false" final="false" visibility="public"
  4699. deprecated="not deprecated">
  4700. <param name="key" type="java.lang.String"/>
  4701. <doc>
  4702. <![CDATA[Set the <code>key</code> of the resource to be released.
  4703. @param key unique identifier for the resource]]>
  4704. </doc>
  4705. </method>
  4706. <doc>
  4707. <![CDATA[<p>The request from clients to release a resource in the shared cache.</p>]]>
  4708. </doc>
  4709. </class>
  4710. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
  4711. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
  4712. <class name="ReleaseSharedCacheResourceResponse" extends="java.lang.Object"
  4713. abstract="true"
  4714. static="false" final="false" visibility="public"
  4715. deprecated="not deprecated">
  4716. <constructor name="ReleaseSharedCacheResourceResponse"
  4717. static="false" final="false" visibility="public"
  4718. deprecated="not deprecated">
  4719. </constructor>
  4720. <doc>
  4721. <![CDATA[<p>
  4722. The response to clients from the <code>SharedCacheManager</code> when
  4723. releasing a resource in the shared cache.
  4724. </p>
  4725. <p>
  4726. Currently, this is empty.
  4727. </p>]]>
  4728. </doc>
  4729. </class>
  4730. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
  4731. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
  4732. <class name="ReservationDeleteRequest" extends="java.lang.Object"
  4733. abstract="true"
  4734. static="false" final="false" visibility="public"
  4735. deprecated="not deprecated">
  4736. <constructor name="ReservationDeleteRequest"
  4737. static="false" final="false" visibility="public"
  4738. deprecated="not deprecated">
  4739. </constructor>
  4740. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"
  4741. abstract="false" native="false" synchronized="false"
  4742. static="true" final="false" visibility="public"
  4743. deprecated="not deprecated">
  4744. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  4745. </method>
  4746. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  4747. abstract="true" native="false" synchronized="false"
  4748. static="false" final="false" visibility="public"
  4749. deprecated="not deprecated">
  4750. <doc>
  4751. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  4752. allocation in the scheduler (between start and end time of this
  4753. reservation)
  4754. @return the {@link ReservationId} representing the unique id of the
  4755. corresponding reserved resource allocation in the scheduler]]>
  4756. </doc>
  4757. </method>
  4758. <method name="setReservationId"
  4759. abstract="true" native="false" synchronized="false"
  4760. static="false" final="false" visibility="public"
  4761. deprecated="not deprecated">
  4762. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  4763. <doc>
  4764. <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
  4765. allocation in the scheduler (between start and end time of this
  4766. reservation)
  4767. @param reservationId the {@link ReservationId} representing the the unique
  4768. id of the corresponding reserved resource allocation in the
  4769. scheduler]]>
  4770. </doc>
  4771. </method>
  4772. <doc>
  4773. <![CDATA[{@link ReservationDeleteRequest} captures the set of requirements the user
  4774. has to delete an existing reservation.
  4775. @see ReservationDefinition]]>
  4776. </doc>
  4777. </class>
  4778. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
  4779. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
  4780. <class name="ReservationDeleteResponse" extends="java.lang.Object"
  4781. abstract="true"
  4782. static="false" final="false" visibility="public"
  4783. deprecated="not deprecated">
  4784. <constructor name="ReservationDeleteResponse"
  4785. static="false" final="false" visibility="public"
  4786. deprecated="not deprecated">
  4787. </constructor>
  4788. <doc>
  4789. <![CDATA[{@link ReservationDeleteResponse} contains the answer of the admission
  4790. control system in the {@code ResourceManager} to a reservation delete
  4791. operation. Currently response is empty if the operation was successful, if
  4792. not an exception reporting reason for a failure.
  4793. @see ReservationDefinition]]>
  4794. </doc>
  4795. </class>
  4796. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
  4797. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest -->
  4798. <class name="ReservationListRequest" extends="java.lang.Object"
  4799. abstract="true"
  4800. static="false" final="false" visibility="public"
  4801. deprecated="not deprecated">
  4802. <constructor name="ReservationListRequest"
  4803. static="false" final="false" visibility="public"
  4804. deprecated="not deprecated">
  4805. </constructor>
  4806. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
  4807. abstract="false" native="false" synchronized="false"
  4808. static="true" final="false" visibility="public"
  4809. deprecated="not deprecated">
  4810. <param name="queue" type="java.lang.String"/>
  4811. <param name="reservationId" type="java.lang.String"/>
  4812. <param name="startTime" type="long"/>
  4813. <param name="endTime" type="long"/>
  4814. <param name="includeReservationAllocations" type="boolean"/>
  4815. <doc>
  4816. <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
  4817. reservations to list if it is provided. Otherwise, it will select active
  4818. reservations within the startTime and endTime (inclusive).
  4819. @param queue Required. Cannot be null or empty. Refers to the reservable
  4820. queue in the scheduler that was selected when creating a
  4821. reservation submission {@link ReservationSubmissionRequest}.
  4822. @param reservationId Optional. String representation of
  4823. {@code ReservationId} If provided, other fields will
  4824. be ignored.
  4825. @param startTime Optional. If provided, only reservations that
  4826. end after the startTime will be selected. This defaults
  4827. to 0 if an invalid number is used.
  4828. @param endTime Optional. If provided, only reservations that
  4829. start on or before endTime will be selected. This defaults
  4830. to Long.MAX_VALUE if an invalid number is used.
  4831. @param includeReservationAllocations Optional. Flag that
  4832. determines whether the entire reservation allocations are
  4833. to be returned. Reservation allocations are subject to
  4834. change in the event of re-planning as described by
  4835. {@code ReservationDefinition}.
  4836. @return the list of reservations via {@link ReservationListRequest}]]>
  4837. </doc>
  4838. </method>
  4839. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
  4840. abstract="false" native="false" synchronized="false"
  4841. static="true" final="false" visibility="public"
  4842. deprecated="not deprecated">
  4843. <param name="queue" type="java.lang.String"/>
  4844. <param name="reservationId" type="java.lang.String"/>
  4845. <param name="includeReservationAllocations" type="boolean"/>
  4846. <doc>
  4847. <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
  4848. reservations to list if it is provided. Otherwise, it will select active
  4849. reservations within the startTime and endTime (inclusive).
  4850. @param queue Required. Cannot be null or empty. Refers to the reservable
  4851. queue in the scheduler that was selected when creating a
  4852. reservation submission {@link ReservationSubmissionRequest}.
  4853. @param reservationId Optional. String representation of
  4854. {@code ReservationId} If provided, other fields will
  4855. be ignored.
  4856. @param includeReservationAllocations Optional. Flag that
  4857. determines whether the entire reservation allocations are
  4858. to be returned. Reservation allocations are subject to
  4859. change in the event of re-planning as described by
  4860. {@code ReservationDefinition}.
  4861. @return the list of reservations via {@link ReservationListRequest}]]>
  4862. </doc>
  4863. </method>
  4864. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
  4865. abstract="false" native="false" synchronized="false"
  4866. static="true" final="false" visibility="public"
  4867. deprecated="not deprecated">
  4868. <param name="queue" type="java.lang.String"/>
  4869. <param name="reservationId" type="java.lang.String"/>
  4870. <doc>
  4871. <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
  4872. reservations to list if it is provided. Otherwise, it will select active
  4873. reservations within the startTime and endTime (inclusive).
  4874. @param queue Required. Cannot be null or empty. Refers to the reservable
  4875. queue in the scheduler that was selected when creating a
  4876. reservation submission {@link ReservationSubmissionRequest}.
  4877. @param reservationId Optional. String representation of
  4878. {@code ReservationId} If provided, other fields will
  4879. be ignored.
  4880. @return the list of reservations via {@link ReservationListRequest}]]>
  4881. </doc>
  4882. </method>
  4883. <method name="getQueue" return="java.lang.String"
  4884. abstract="true" native="false" synchronized="false"
  4885. static="false" final="false" visibility="public"
  4886. deprecated="not deprecated">
  4887. <doc>
  4888. <![CDATA[Get queue name to use to find reservations.
  4889. @return the queue name to use to find reservations.]]>
  4890. </doc>
  4891. </method>
  4892. <method name="setQueue"
  4893. abstract="true" native="false" synchronized="false"
  4894. static="false" final="false" visibility="public"
  4895. deprecated="not deprecated">
  4896. <param name="queue" type="java.lang.String"/>
  4897. <doc>
  4898. <![CDATA[Set queue name to use to find resource allocations.
  4899. @param queue Required. Cannot be null or empty.]]>
  4900. </doc>
  4901. </method>
  4902. <method name="getReservationId" return="java.lang.String"
  4903. abstract="true" native="false" synchronized="false"
  4904. static="false" final="false" visibility="public"
  4905. deprecated="not deprecated">
  4906. <doc>
  4907. <![CDATA[Get the reservation id to use to find a reservation.
  4908. @return the reservation id of the reservation.]]>
  4909. </doc>
  4910. </method>
  4911. <method name="setReservationId"
  4912. abstract="true" native="false" synchronized="false"
  4913. static="false" final="false" visibility="public"
  4914. deprecated="not deprecated">
  4915. <param name="reservationId" type="java.lang.String"/>
  4916. <doc>
  4917. <![CDATA[Set the reservation id to use to find a reservation.
  4918. @param reservationId Optional. String representation of
  4919. {@code ReservationId} If provided, other fields will
  4920. be ignored.]]>
  4921. </doc>
  4922. </method>
  4923. <method name="getStartTime" return="long"
  4924. abstract="true" native="false" synchronized="false"
  4925. static="false" final="false" visibility="public"
  4926. deprecated="not deprecated">
  4927. <doc>
  4928. <![CDATA[Get the start time to use to search for reservations.
  4929. When this is set, reservations that start before this start
  4930. time are ignored.
  4931. @return the start time to use to search for reservations.]]>
  4932. </doc>
  4933. </method>
  4934. <method name="setStartTime"
  4935. abstract="true" native="false" synchronized="false"
  4936. static="false" final="false" visibility="public"
  4937. deprecated="not deprecated">
  4938. <param name="startTime" type="long"/>
  4939. <doc>
  4940. <![CDATA[Set the start time to use to search for reservations.
  4941. When this is set, reservations that start before this start
  4942. time are ignored.
  4943. @param startTime Optional. If provided, only reservations that
  4944. end after the startTime will be selected. This defaults
  4945. to 0 if an invalid number is used.]]>
  4946. </doc>
  4947. </method>
  4948. <method name="getEndTime" return="long"
  4949. abstract="true" native="false" synchronized="false"
  4950. static="false" final="false" visibility="public"
  4951. deprecated="not deprecated">
  4952. <doc>
  4953. <![CDATA[Get the end time to use to search for reservations.
  4954. When this is set, reservations that start after this end
  4955. time are ignored.
  4956. @return the end time to use to search for reservations.]]>
  4957. </doc>
  4958. </method>
  4959. <method name="setEndTime"
  4960. abstract="true" native="false" synchronized="false"
  4961. static="false" final="false" visibility="public"
  4962. deprecated="not deprecated">
  4963. <param name="endTime" type="long"/>
  4964. <doc>
  4965. <![CDATA[Set the end time to use to search for reservations.
  4966. When this is set, reservations that start after this end
  4967. time are ignored.
  4968. @param endTime Optional. If provided, only reservations that
  4969. start before endTime will be selected. This defaults
  4970. to Long.MAX_VALUE if an invalid number is used.]]>
  4971. </doc>
  4972. </method>
  4973. <method name="getIncludeResourceAllocations" return="boolean"
  4974. abstract="true" native="false" synchronized="false"
  4975. static="false" final="false" visibility="public"
  4976. deprecated="not deprecated">
  4977. <doc>
  4978. <![CDATA[Get the boolean representing whether or not the user
  4979. is requesting the full resource allocation.
  4980. If this is true, the full resource allocation will
  4981. be included in the response.
  4982. @return the end time to use to search for reservations.]]>
  4983. </doc>
  4984. </method>
  4985. <method name="setIncludeResourceAllocations"
  4986. abstract="true" native="false" synchronized="false"
  4987. static="false" final="false" visibility="public"
  4988. deprecated="not deprecated">
  4989. <param name="includeReservationAllocations" type="boolean"/>
  4990. <doc>
  4991. <![CDATA[Set the boolean representing whether or not the user
  4992. is requesting the full resource allocation.
  4993. If this is true, the full resource allocation will
  4994. be included in the response.
  4995. @param includeReservationAllocations Optional. Flag that
  4996. determines whether the entire list of
  4997. {@code ResourceAllocationRequest} will be returned.]]>
  4998. </doc>
  4999. </method>
  5000. <doc>
  5001. <![CDATA[{@link ReservationListRequest} captures the set of requirements the
  5002. user has to list reservations.]]>
  5003. </doc>
  5004. </class>
  5005. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest -->
  5006. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse -->
  5007. <class name="ReservationListResponse" extends="java.lang.Object"
  5008. abstract="true"
  5009. static="false" final="false" visibility="public"
  5010. deprecated="not deprecated">
  5011. <constructor name="ReservationListResponse"
  5012. static="false" final="false" visibility="public"
  5013. deprecated="not deprecated">
  5014. </constructor>
  5015. <method name="getReservationAllocationState" return="java.util.List"
  5016. abstract="true" native="false" synchronized="false"
  5017. static="false" final="false" visibility="public"
  5018. deprecated="not deprecated">
  5019. <doc>
  5020. <![CDATA[Get the list of {@link ReservationAllocationState}, that corresponds
  5021. to a reservation in the scheduler.
  5022. @return the list of {@link ReservationAllocationState} which holds
  5023. information of a particular reservation]]>
  5024. </doc>
  5025. </method>
  5026. <doc>
  5027. <![CDATA[{@link ReservationListResponse} captures the list of reservations that the
  5028. user has queried.
  5029. The resulting list of {@link ReservationAllocationState} contains a list of
  5030. {@code ResourceAllocationRequest} representing the current state of the
  5031. reservation resource allocations will be returned. This is subject to change
  5032. in the event of re-planning a described by {@code ReservationDefinition}
  5033. @see ReservationAllocationState]]>
  5034. </doc>
  5035. </class>
  5036. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse -->
  5037. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
  5038. <class name="ReservationSubmissionRequest" extends="java.lang.Object"
  5039. abstract="true"
  5040. static="false" final="false" visibility="public"
  5041. deprecated="not deprecated">
  5042. <constructor name="ReservationSubmissionRequest"
  5043. static="false" final="false" visibility="public"
  5044. deprecated="not deprecated">
  5045. </constructor>
  5046. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"
  5047. abstract="false" native="false" synchronized="false"
  5048. static="true" final="false" visibility="public"
  5049. deprecated="not deprecated">
  5050. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  5051. <param name="queueName" type="java.lang.String"/>
  5052. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  5053. </method>
  5054. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  5055. abstract="true" native="false" synchronized="false"
  5056. static="false" final="false" visibility="public"
  5057. deprecated="not deprecated">
  5058. <doc>
  5059. <![CDATA[Get the {@link ReservationDefinition} representing the user constraints for
  5060. this reservation
  5061. @return the reservation definition representing user constraints]]>
  5062. </doc>
  5063. </method>
  5064. <method name="setReservationDefinition"
  5065. abstract="true" native="false" synchronized="false"
  5066. static="false" final="false" visibility="public"
  5067. deprecated="not deprecated">
  5068. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  5069. <doc>
  5070. <![CDATA[Set the {@link ReservationDefinition} representing the user constraints for
  5071. this reservation
  5072. @param reservationDefinition the reservation request representing the
  5073. reservation]]>
  5074. </doc>
  5075. </method>
  5076. <method name="getQueue" return="java.lang.String"
  5077. abstract="true" native="false" synchronized="false"
  5078. static="false" final="false" visibility="public"
  5079. deprecated="not deprecated">
  5080. <doc>
  5081. <![CDATA[Get the name of the {@code Plan} that corresponds to the name of the
  5082. {@link QueueInfo} in the scheduler to which the reservation will be
  5083. submitted to.
  5084. @return the name of the {@code Plan} that corresponds to the name of the
  5085. {@link QueueInfo} in the scheduler to which the reservation will be
  5086. submitted to]]>
  5087. </doc>
  5088. </method>
  5089. <method name="setQueue"
  5090. abstract="true" native="false" synchronized="false"
  5091. static="false" final="false" visibility="public"
  5092. deprecated="not deprecated">
  5093. <param name="queueName" type="java.lang.String"/>
  5094. <doc>
  5095. <![CDATA[Set the name of the {@code Plan} that corresponds to the name of the
  5096. {@link QueueInfo} in the scheduler to which the reservation will be
  5097. submitted to
  5098. @param queueName the name of the parent {@code Plan} that corresponds to
  5099. the name of the {@link QueueInfo} in the scheduler to which the
  5100. reservation will be submitted to]]>
  5101. </doc>
  5102. </method>
  5103. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  5104. abstract="true" native="false" synchronized="false"
  5105. static="false" final="false" visibility="public"
  5106. deprecated="not deprecated">
  5107. <doc>
  5108. <![CDATA[Get the reservation id that corresponds to the reservation submission.
  5109. @return reservation id that will be used to identify the reservation
  5110. submission.]]>
  5111. </doc>
  5112. </method>
  5113. <method name="setReservationId"
  5114. abstract="true" native="false" synchronized="false"
  5115. static="false" final="false" visibility="public"
  5116. deprecated="not deprecated">
  5117. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  5118. <doc>
  5119. <![CDATA[Set the reservation id that corresponds to the reservation submission.
  5120. @param reservationId reservation id that will be used to identify the
  5121. reservation submission.]]>
  5122. </doc>
  5123. </method>
  5124. <doc>
  5125. <![CDATA[{@link ReservationSubmissionRequest} captures the set of requirements the
  5126. user has to create a reservation.
  5127. @see ReservationDefinition]]>
  5128. </doc>
  5129. </class>
  5130. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
  5131. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
  5132. <class name="ReservationSubmissionResponse" extends="java.lang.Object"
  5133. abstract="true"
  5134. static="false" final="false" visibility="public"
  5135. deprecated="not deprecated">
  5136. <constructor name="ReservationSubmissionResponse"
  5137. static="false" final="false" visibility="public"
  5138. deprecated="not deprecated">
  5139. </constructor>
  5140. <doc>
  5141. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client on
  5142. reservation submission.</p>
  5143. <p>Currently, this is empty.</p>
  5144. {@code ApplicationClientProtocol#submitReservation(
  5145. ReservationSubmissionRequest)}]]>
  5146. </doc>
  5147. </class>
  5148. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
  5149. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
  5150. <class name="ReservationUpdateRequest" extends="java.lang.Object"
  5151. abstract="true"
  5152. static="false" final="false" visibility="public"
  5153. deprecated="not deprecated">
  5154. <constructor name="ReservationUpdateRequest"
  5155. static="false" final="false" visibility="public"
  5156. deprecated="not deprecated">
  5157. </constructor>
  5158. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"
  5159. abstract="false" native="false" synchronized="false"
  5160. static="true" final="false" visibility="public"
  5161. deprecated="not deprecated">
  5162. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  5163. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  5164. </method>
  5165. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  5166. abstract="true" native="false" synchronized="false"
  5167. static="false" final="false" visibility="public"
  5168. deprecated="not deprecated">
  5169. <doc>
  5170. <![CDATA[Get the {@link ReservationDefinition} representing the updated user
  5171. constraints for this reservation
  5172. @return the reservation definition representing user constraints]]>
  5173. </doc>
  5174. </method>
  5175. <method name="setReservationDefinition"
  5176. abstract="true" native="false" synchronized="false"
  5177. static="false" final="false" visibility="public"
  5178. deprecated="not deprecated">
  5179. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  5180. <doc>
  5181. <![CDATA[Set the {@link ReservationDefinition} representing the updated user
  5182. constraints for this reservation
  5183. @param reservationDefinition the reservation request representing the
  5184. reservation]]>
  5185. </doc>
  5186. </method>
  5187. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  5188. abstract="true" native="false" synchronized="false"
  5189. static="false" final="false" visibility="public"
  5190. deprecated="not deprecated">
  5191. <doc>
  5192. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  5193. allocation in the scheduler (between start and end time of this
  5194. reservation)
  5195. @return the {@link ReservationId} representing the unique id of the
  5196. corresponding reserved resource allocation in the scheduler]]>
  5197. </doc>
  5198. </method>
  5199. <method name="setReservationId"
  5200. abstract="true" native="false" synchronized="false"
  5201. static="false" final="false" visibility="public"
  5202. deprecated="not deprecated">
  5203. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  5204. <doc>
  5205. <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
  5206. allocation in the scheduler (between start and end time of this
  5207. reservation)
  5208. @param reservationId the {@link ReservationId} representing the the unique
  5209. id of the corresponding reserved resource allocation in the
  5210. scheduler]]>
  5211. </doc>
  5212. </method>
  5213. <doc>
  5214. <![CDATA[{@link ReservationUpdateRequest} captures the set of requirements the user
  5215. has to update an existing reservation.
  5216. @see ReservationDefinition]]>
  5217. </doc>
  5218. </class>
  5219. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
  5220. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
  5221. <class name="ReservationUpdateResponse" extends="java.lang.Object"
  5222. abstract="true"
  5223. static="false" final="false" visibility="public"
  5224. deprecated="not deprecated">
  5225. <constructor name="ReservationUpdateResponse"
  5226. static="false" final="false" visibility="public"
  5227. deprecated="not deprecated">
  5228. </constructor>
  5229. <doc>
  5230. <![CDATA[{@link ReservationUpdateResponse} contains the answer of the admission
  5231. control system in the {@code ResourceManager} to a reservation update
  5232. operation. Currently response is empty if the operation was successful, if
  5233. not an exception reporting reason for a failure.
  5234. @see ReservationDefinition]]>
  5235. </doc>
  5236. </class>
  5237. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
  5238. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest -->
  5239. <class name="ResourceLocalizationRequest" extends="java.lang.Object"
  5240. abstract="true"
  5241. static="false" final="false" visibility="public"
  5242. deprecated="not deprecated">
  5243. <constructor name="ResourceLocalizationRequest"
  5244. static="false" final="false" visibility="public"
  5245. deprecated="not deprecated">
  5246. </constructor>
  5247. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest"
  5248. abstract="false" native="false" synchronized="false"
  5249. static="true" final="false" visibility="public"
  5250. deprecated="not deprecated">
  5251. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5252. <param name="localResources" type="java.util.Map"/>
  5253. </method>
  5254. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5255. abstract="true" native="false" synchronized="false"
  5256. static="false" final="false" visibility="public"
  5257. deprecated="not deprecated">
  5258. <doc>
  5259. <![CDATA[Get the <code>ContainerId</code> of the container to localize resources.
  5260. @return <code>ContainerId</code> of the container to localize resources.]]>
  5261. </doc>
  5262. </method>
  5263. <method name="getLocalResources" return="java.util.Map"
  5264. abstract="true" native="false" synchronized="false"
  5265. static="false" final="false" visibility="public"
  5266. deprecated="not deprecated">
  5267. <doc>
  5268. <![CDATA[Get <code>LocalResource</code> required by the container.
  5269. @return all <code>LocalResource</code> required by the container]]>
  5270. </doc>
  5271. </method>
  5272. <doc>
  5273. <![CDATA[The request sent by the ApplicationMaster to ask for localizing resources.]]>
  5274. </doc>
  5275. </class>
  5276. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest -->
  5277. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationResponse -->
  5278. <class name="ResourceLocalizationResponse" extends="java.lang.Object"
  5279. abstract="true"
  5280. static="false" final="false" visibility="public"
  5281. deprecated="not deprecated">
  5282. <constructor name="ResourceLocalizationResponse"
  5283. static="false" final="false" visibility="public"
  5284. deprecated="not deprecated">
  5285. </constructor>
  5286. <doc>
  5287. <![CDATA[The response to the {@link ResourceLocalizationRequest}]]>
  5288. </doc>
  5289. </class>
  5290. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationResponse -->
  5291. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RestartContainerResponse -->
  5292. <class name="RestartContainerResponse" extends="java.lang.Object"
  5293. abstract="true"
  5294. static="false" final="false" visibility="public"
  5295. deprecated="not deprecated">
  5296. <constructor name="RestartContainerResponse"
  5297. static="false" final="false" visibility="public"
  5298. deprecated="not deprecated">
  5299. </constructor>
  5300. <doc>
  5301. <![CDATA[The response to a restart Container request.]]>
  5302. </doc>
  5303. </class>
  5304. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RestartContainerResponse -->
  5305. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RollbackResponse -->
  5306. <class name="RollbackResponse" extends="java.lang.Object"
  5307. abstract="true"
  5308. static="false" final="false" visibility="public"
  5309. deprecated="not deprecated">
  5310. <constructor name="RollbackResponse"
  5311. static="false" final="false" visibility="public"
  5312. deprecated="not deprecated">
  5313. </constructor>
  5314. <doc>
  5315. <![CDATA[Response to a Rollback request.]]>
  5316. </doc>
  5317. </class>
  5318. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RollbackResponse -->
  5319. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest -->
  5320. <class name="SignalContainerRequest" extends="java.lang.Object"
  5321. abstract="true"
  5322. static="false" final="false" visibility="public"
  5323. deprecated="not deprecated">
  5324. <constructor name="SignalContainerRequest"
  5325. static="false" final="false" visibility="public"
  5326. deprecated="not deprecated">
  5327. </constructor>
  5328. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest"
  5329. abstract="false" native="false" synchronized="false"
  5330. static="true" final="false" visibility="public"
  5331. deprecated="not deprecated">
  5332. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5333. <param name="signalContainerCommand" type="org.apache.hadoop.yarn.api.records.SignalContainerCommand"/>
  5334. </method>
  5335. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5336. abstract="true" native="false" synchronized="false"
  5337. static="false" final="false" visibility="public"
  5338. deprecated="not deprecated">
  5339. <doc>
  5340. <![CDATA[Get the <code>ContainerId</code> of the container to signal.
  5341. @return <code>ContainerId</code> of the container to signal.]]>
  5342. </doc>
  5343. </method>
  5344. <method name="setContainerId"
  5345. abstract="true" native="false" synchronized="false"
  5346. static="false" final="false" visibility="public"
  5347. deprecated="not deprecated">
  5348. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5349. <doc>
  5350. <![CDATA[Set the <code>ContainerId</code> of the container to signal.]]>
  5351. </doc>
  5352. </method>
  5353. <method name="getCommand" return="org.apache.hadoop.yarn.api.records.SignalContainerCommand"
  5354. abstract="true" native="false" synchronized="false"
  5355. static="false" final="false" visibility="public"
  5356. deprecated="not deprecated">
  5357. <doc>
  5358. <![CDATA[Get the <code>SignalContainerCommand</code> of the signal request.
  5359. @return <code>SignalContainerCommand</code> of the signal request.]]>
  5360. </doc>
  5361. </method>
  5362. <method name="setCommand"
  5363. abstract="true" native="false" synchronized="false"
  5364. static="false" final="false" visibility="public"
  5365. deprecated="not deprecated">
  5366. <param name="command" type="org.apache.hadoop.yarn.api.records.SignalContainerCommand"/>
  5367. <doc>
  5368. <![CDATA[Set the <code>SignalContainerCommand</code> of the signal request.]]>
  5369. </doc>
  5370. </method>
  5371. <doc>
  5372. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  5373. or by the <code>ApplicationMaster</code> to the <code>NodeManager</code>
  5374. to signal a container.
  5375. @see SignalContainerCommand </p>]]>
  5376. </doc>
  5377. </class>
  5378. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest -->
  5379. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse -->
  5380. <class name="SignalContainerResponse" extends="java.lang.Object"
  5381. abstract="true"
  5382. static="false" final="false" visibility="public"
  5383. deprecated="not deprecated">
  5384. <constructor name="SignalContainerResponse"
  5385. static="false" final="false" visibility="public"
  5386. deprecated="not deprecated">
  5387. </constructor>
  5388. <doc>
  5389. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client
  5390. signalling a container.</p>
  5391. <p>Currently it's empty.</p>
  5392. @see ApplicationClientProtocol#signalToContainer(SignalContainerRequest)]]>
  5393. </doc>
  5394. </class>
  5395. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse -->
  5396. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
  5397. <class name="StartContainerRequest" extends="java.lang.Object"
  5398. abstract="true"
  5399. static="false" final="false" visibility="public"
  5400. deprecated="not deprecated">
  5401. <constructor name="StartContainerRequest"
  5402. static="false" final="false" visibility="public"
  5403. deprecated="not deprecated">
  5404. </constructor>
  5405. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest"
  5406. abstract="false" native="false" synchronized="false"
  5407. static="true" final="false" visibility="public"
  5408. deprecated="not deprecated">
  5409. <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  5410. <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
  5411. </method>
  5412. <method name="getContainerLaunchContext" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  5413. abstract="true" native="false" synchronized="false"
  5414. static="false" final="false" visibility="public"
  5415. deprecated="not deprecated">
  5416. <doc>
  5417. <![CDATA[Get the <code>ContainerLaunchContext</code> for the container to be started
  5418. by the <code>NodeManager</code>.
  5419. @return <code>ContainerLaunchContext</code> for the container to be started
  5420. by the <code>NodeManager</code>]]>
  5421. </doc>
  5422. </method>
  5423. <method name="setContainerLaunchContext"
  5424. abstract="true" native="false" synchronized="false"
  5425. static="false" final="false" visibility="public"
  5426. deprecated="not deprecated">
  5427. <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  5428. <doc>
  5429. <![CDATA[Set the <code>ContainerLaunchContext</code> for the container to be started
  5430. by the <code>NodeManager</code>
  5431. @param context <code>ContainerLaunchContext</code> for the container to be
  5432. started by the <code>NodeManager</code>]]>
  5433. </doc>
  5434. </method>
  5435. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  5436. abstract="true" native="false" synchronized="false"
  5437. static="false" final="false" visibility="public"
  5438. deprecated="not deprecated">
  5439. <doc>
  5440. <![CDATA[Get the container token to be used for authorization during starting
  5441. container.
  5442. <p>
  5443. Note: {@link NMToken} will be used for authenticating communication with
  5444. {@code NodeManager}.
  5445. @return the container token to be used for authorization during starting
  5446. container.
  5447. @see NMToken
  5448. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  5449. </doc>
  5450. </method>
  5451. <method name="setContainerToken"
  5452. abstract="true" native="false" synchronized="false"
  5453. static="false" final="false" visibility="public"
  5454. deprecated="not deprecated">
  5455. <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
  5456. </method>
  5457. <doc>
  5458. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
  5459. <code>NodeManager</code> to <em>start</em> a container.</p>
  5460. <p>The <code>ApplicationMaster</code> has to provide details such as
  5461. allocated resource capability, security tokens (if enabled), command
  5462. to be executed to start the container, environment for the process,
  5463. necessary binaries/jar/shared-objects etc. via the
  5464. {@link ContainerLaunchContext}.</p>
  5465. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  5466. </doc>
  5467. </class>
  5468. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
  5469. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
  5470. <class name="StartContainersRequest" extends="java.lang.Object"
  5471. abstract="true"
  5472. static="false" final="false" visibility="public"
  5473. deprecated="not deprecated">
  5474. <constructor name="StartContainersRequest"
  5475. static="false" final="false" visibility="public"
  5476. deprecated="not deprecated">
  5477. </constructor>
  5478. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"
  5479. abstract="false" native="false" synchronized="false"
  5480. static="true" final="false" visibility="public"
  5481. deprecated="not deprecated">
  5482. <param name="requests" type="java.util.List"/>
  5483. </method>
  5484. <method name="getStartContainerRequests" return="java.util.List"
  5485. abstract="true" native="false" synchronized="false"
  5486. static="false" final="false" visibility="public"
  5487. deprecated="not deprecated">
  5488. <doc>
  5489. <![CDATA[Get a list of {@link StartContainerRequest} to start containers.
  5490. @return a list of {@link StartContainerRequest} to start containers.]]>
  5491. </doc>
  5492. </method>
  5493. <method name="setStartContainerRequests"
  5494. abstract="true" native="false" synchronized="false"
  5495. static="false" final="false" visibility="public"
  5496. deprecated="not deprecated">
  5497. <param name="request" type="java.util.List"/>
  5498. <doc>
  5499. <![CDATA[Set a list of {@link StartContainerRequest} to start containers.
  5500. @param request a list of {@link StartContainerRequest} to start containers]]>
  5501. </doc>
  5502. </method>
  5503. <doc>
  5504. <![CDATA[<p>
  5505. The request which contains a list of {@link StartContainerRequest} sent by
  5506. the <code>ApplicationMaster</code> to the <code>NodeManager</code> to
  5507. <em>start</em> containers.
  5508. </p>
  5509. <p>
  5510. In each {@link StartContainerRequest}, the <code>ApplicationMaster</code> has
  5511. to provide details such as allocated resource capability, security tokens (if
  5512. enabled), command to be executed to start the container, environment for the
  5513. process, necessary binaries/jar/shared-objects etc. via the
  5514. {@link ContainerLaunchContext}.
  5515. </p>
  5516. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  5517. </doc>
  5518. </class>
  5519. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
  5520. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
  5521. <class name="StartContainersResponse" extends="java.lang.Object"
  5522. abstract="true"
  5523. static="false" final="false" visibility="public"
  5524. deprecated="not deprecated">
  5525. <constructor name="StartContainersResponse"
  5526. static="false" final="false" visibility="public"
  5527. deprecated="not deprecated">
  5528. </constructor>
  5529. <method name="getSuccessfullyStartedContainers" return="java.util.List"
  5530. abstract="true" native="false" synchronized="false"
  5531. static="false" final="false" visibility="public"
  5532. deprecated="not deprecated">
  5533. <doc>
  5534. <![CDATA[Get the list of <code>ContainerId</code> s of the containers that are
  5535. started successfully.
  5536. @return the list of <code>ContainerId</code> s of the containers that are
  5537. started successfully.
  5538. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  5539. </doc>
  5540. </method>
  5541. <method name="getFailedRequests" return="java.util.Map"
  5542. abstract="true" native="false" synchronized="false"
  5543. static="false" final="false" visibility="public"
  5544. deprecated="not deprecated">
  5545. <doc>
  5546. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  5547. from per container for failed requests
  5548. @return map of containerId-to-exception]]>
  5549. </doc>
  5550. </method>
  5551. <method name="getAllServicesMetaData" return="java.util.Map"
  5552. abstract="true" native="false" synchronized="false"
  5553. static="false" final="false" visibility="public"
  5554. deprecated="not deprecated">
  5555. <doc>
  5556. <![CDATA[<p>
  5557. Get the meta-data from all auxiliary services running on the
  5558. <code>NodeManager</code>.
  5559. </p>
  5560. <p>
  5561. The meta-data is returned as a Map between the auxiliary service names and
  5562. their corresponding per service meta-data as an opaque blob
  5563. <code>ByteBuffer</code>
  5564. </p>
  5565. <p>
  5566. To be able to interpret the per-service meta-data, you should consult the
  5567. documentation for the Auxiliary-service configured on the NodeManager
  5568. </p>
  5569. @return a Map between the names of auxiliary services and their
  5570. corresponding meta-data]]>
  5571. </doc>
  5572. </method>
  5573. <doc>
  5574. <![CDATA[<p>
  5575. The response sent by the <code>NodeManager</code> to the
  5576. <code>ApplicationMaster</code> when asked to <em>start</em> an allocated
  5577. container.
  5578. </p>
  5579. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  5580. </doc>
  5581. </class>
  5582. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
  5583. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
  5584. <class name="StopContainersRequest" extends="java.lang.Object"
  5585. abstract="true"
  5586. static="false" final="false" visibility="public"
  5587. deprecated="not deprecated">
  5588. <constructor name="StopContainersRequest"
  5589. static="false" final="false" visibility="public"
  5590. deprecated="not deprecated">
  5591. </constructor>
  5592. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"
  5593. abstract="false" native="false" synchronized="false"
  5594. static="true" final="false" visibility="public"
  5595. deprecated="not deprecated">
  5596. <param name="containerIds" type="java.util.List"/>
  5597. </method>
  5598. <method name="getContainerIds" return="java.util.List"
  5599. abstract="true" native="false" synchronized="false"
  5600. static="false" final="false" visibility="public"
  5601. deprecated="not deprecated">
  5602. <doc>
  5603. <![CDATA[Get the <code>ContainerId</code>s of the containers to be stopped.
  5604. @return <code>ContainerId</code>s of containers to be stopped]]>
  5605. </doc>
  5606. </method>
  5607. <method name="setContainerIds"
  5608. abstract="true" native="false" synchronized="false"
  5609. static="false" final="false" visibility="public"
  5610. deprecated="not deprecated">
  5611. <param name="containerIds" type="java.util.List"/>
  5612. <doc>
  5613. <![CDATA[Set the <code>ContainerId</code>s of the containers to be stopped.
  5614. @param containerIds <code>ContainerId</code>s of the containers to be stopped]]>
  5615. </doc>
  5616. </method>
  5617. <doc>
  5618. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
  5619. <code>NodeManager</code> to <em>stop</em> containers.</p>
  5620. @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
  5621. </doc>
  5622. </class>
  5623. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
  5624. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
  5625. <class name="StopContainersResponse" extends="java.lang.Object"
  5626. abstract="true"
  5627. static="false" final="false" visibility="public"
  5628. deprecated="not deprecated">
  5629. <constructor name="StopContainersResponse"
  5630. static="false" final="false" visibility="public"
  5631. deprecated="not deprecated">
  5632. </constructor>
  5633. <method name="getSuccessfullyStoppedContainers" return="java.util.List"
  5634. abstract="true" native="false" synchronized="false"
  5635. static="false" final="false" visibility="public"
  5636. deprecated="not deprecated">
  5637. <doc>
  5638. <![CDATA[Get the list of containerIds of successfully stopped containers.
  5639. @return the list of containerIds of successfully stopped containers.]]>
  5640. </doc>
  5641. </method>
  5642. <method name="getFailedRequests" return="java.util.Map"
  5643. abstract="true" native="false" synchronized="false"
  5644. static="false" final="false" visibility="public"
  5645. deprecated="not deprecated">
  5646. <doc>
  5647. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  5648. from per container for failed requests
  5649. @return map of containerId-to-exception]]>
  5650. </doc>
  5651. </method>
  5652. <doc>
  5653. <![CDATA[<p>
  5654. The response sent by the <code>NodeManager</code> to the
  5655. <code>ApplicationMaster</code> when asked to <em>stop</em> allocated
  5656. containers.
  5657. </p>
  5658. @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
  5659. </doc>
  5660. </class>
  5661. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
  5662. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
  5663. <class name="SubmitApplicationRequest" extends="java.lang.Object"
  5664. abstract="true"
  5665. static="false" final="false" visibility="public"
  5666. deprecated="not deprecated">
  5667. <constructor name="SubmitApplicationRequest"
  5668. static="false" final="false" visibility="public"
  5669. deprecated="not deprecated">
  5670. </constructor>
  5671. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"
  5672. abstract="false" native="false" synchronized="false"
  5673. static="true" final="false" visibility="public"
  5674. deprecated="not deprecated">
  5675. <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
  5676. </method>
  5677. <method name="getApplicationSubmissionContext" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  5678. abstract="true" native="false" synchronized="false"
  5679. static="false" final="false" visibility="public"
  5680. deprecated="not deprecated">
  5681. <doc>
  5682. <![CDATA[Get the <code>ApplicationSubmissionContext</code> for the application.
  5683. @return <code>ApplicationSubmissionContext</code> for the application]]>
  5684. </doc>
  5685. </method>
  5686. <method name="setApplicationSubmissionContext"
  5687. abstract="true" native="false" synchronized="false"
  5688. static="false" final="false" visibility="public"
  5689. deprecated="not deprecated">
  5690. <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
  5691. <doc>
  5692. <![CDATA[Set the <code>ApplicationSubmissionContext</code> for the application.
  5693. @param context <code>ApplicationSubmissionContext</code> for the
  5694. application]]>
  5695. </doc>
  5696. </method>
  5697. <doc>
  5698. <![CDATA[<p>The request sent by a client to <em>submit an application</em> to the
  5699. <code>ResourceManager</code>.</p>
  5700. <p>The request, via {@link ApplicationSubmissionContext}, contains
  5701. details such as queue, {@link Resource} required to run the
  5702. <code>ApplicationMaster</code>, the equivalent of
  5703. {@link ContainerLaunchContext} for launching the
  5704. <code>ApplicationMaster</code> etc.
  5705. @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
  5706. </doc>
  5707. </class>
  5708. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
  5709. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
  5710. <class name="SubmitApplicationResponse" extends="java.lang.Object"
  5711. abstract="true"
  5712. static="false" final="false" visibility="public"
  5713. deprecated="not deprecated">
  5714. <constructor name="SubmitApplicationResponse"
  5715. static="false" final="false" visibility="public"
  5716. deprecated="not deprecated">
  5717. </constructor>
  5718. <doc>
  5719. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client on
  5720. application submission.</p>
  5721. <p>Currently, this is empty.</p>
  5722. @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
  5723. </doc>
  5724. </class>
  5725. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
  5726. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest -->
  5727. <class name="UpdateApplicationPriorityRequest" extends="java.lang.Object"
  5728. abstract="true"
  5729. static="false" final="false" visibility="public"
  5730. deprecated="not deprecated">
  5731. <constructor name="UpdateApplicationPriorityRequest"
  5732. static="false" final="false" visibility="public"
  5733. deprecated="not deprecated">
  5734. </constructor>
  5735. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest"
  5736. abstract="false" native="false" synchronized="false"
  5737. static="true" final="false" visibility="public"
  5738. deprecated="not deprecated">
  5739. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5740. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5741. </method>
  5742. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5743. abstract="true" native="false" synchronized="false"
  5744. static="false" final="false" visibility="public"
  5745. deprecated="not deprecated">
  5746. <doc>
  5747. <![CDATA[Get the <code>ApplicationId</code> of the application.
  5748. @return <code>ApplicationId</code> of the application]]>
  5749. </doc>
  5750. </method>
  5751. <method name="setApplicationId"
  5752. abstract="true" native="false" synchronized="false"
  5753. static="false" final="false" visibility="public"
  5754. deprecated="not deprecated">
  5755. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5756. <doc>
  5757. <![CDATA[Set the <code>ApplicationId</code> of the application.
  5758. @param applicationId <code>ApplicationId</code> of the application]]>
  5759. </doc>
  5760. </method>
  5761. <method name="getApplicationPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  5762. abstract="true" native="false" synchronized="false"
  5763. static="false" final="false" visibility="public"
  5764. deprecated="not deprecated">
  5765. <doc>
  5766. <![CDATA[Get the <code>Priority</code> of the application to be set.
  5767. @return <code>Priority</code> of the application to be set.]]>
  5768. </doc>
  5769. </method>
  5770. <method name="setApplicationPriority"
  5771. abstract="true" native="false" synchronized="false"
  5772. static="false" final="false" visibility="public"
  5773. deprecated="not deprecated">
  5774. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5775. <doc>
  5776. <![CDATA[Set the <code>Priority</code> of the application.
  5777. @param priority <code>Priority</code> of the application]]>
  5778. </doc>
  5779. </method>
  5780. <doc>
  5781. <![CDATA[<p>
  5782. The request sent by the client to the <code>ResourceManager</code> to set or
  5783. update the application priority.
  5784. </p>
  5785. <p>
  5786. The request includes the {@link ApplicationId} of the application and
  5787. {@link Priority} to be set for an application
  5788. </p>
  5789. @see ApplicationClientProtocol#updateApplicationPriority(UpdateApplicationPriorityRequest)]]>
  5790. </doc>
  5791. </class>
  5792. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest -->
  5793. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse -->
  5794. <class name="UpdateApplicationPriorityResponse" extends="java.lang.Object"
  5795. abstract="true"
  5796. static="false" final="false" visibility="public"
  5797. deprecated="not deprecated">
  5798. <constructor name="UpdateApplicationPriorityResponse"
  5799. static="false" final="false" visibility="public"
  5800. deprecated="not deprecated">
  5801. </constructor>
  5802. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse"
  5803. abstract="false" native="false" synchronized="false"
  5804. static="true" final="false" visibility="public"
  5805. deprecated="not deprecated">
  5806. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5807. </method>
  5808. <method name="getApplicationPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  5809. abstract="true" native="false" synchronized="false"
  5810. static="false" final="false" visibility="public"
  5811. deprecated="not deprecated">
  5812. <doc>
  5813. <![CDATA[Get the <code>Priority</code> of the application to be set.
  5814. @return Updated <code>Priority</code> of the application.]]>
  5815. </doc>
  5816. </method>
  5817. <method name="setApplicationPriority"
  5818. abstract="true" native="false" synchronized="false"
  5819. static="false" final="false" visibility="public"
  5820. deprecated="not deprecated">
  5821. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5822. <doc>
  5823. <![CDATA[Set the <code>Priority</code> of the application.
  5824. @param priority <code>Priority</code> of the application]]>
  5825. </doc>
  5826. </method>
  5827. <doc>
  5828. <![CDATA[<p>
  5829. The response sent by the <code>ResourceManager</code> to the client on update
  5830. the application priority.
  5831. </p>
  5832. <p>
  5833. A response without exception means that the move has completed successfully.
  5834. </p>
  5835. @see ApplicationClientProtocol#updateApplicationPriority(UpdateApplicationPriorityRequest)]]>
  5836. </doc>
  5837. </class>
  5838. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse -->
  5839. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest -->
  5840. <class name="UpdateApplicationTimeoutsRequest" extends="java.lang.Object"
  5841. abstract="true"
  5842. static="false" final="false" visibility="public"
  5843. deprecated="not deprecated">
  5844. <constructor name="UpdateApplicationTimeoutsRequest"
  5845. static="false" final="false" visibility="public"
  5846. deprecated="not deprecated">
  5847. </constructor>
  5848. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest"
  5849. abstract="false" native="false" synchronized="false"
  5850. static="true" final="false" visibility="public"
  5851. deprecated="not deprecated">
  5852. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5853. <param name="applicationTimeouts" type="java.util.Map"/>
  5854. </method>
  5855. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5856. abstract="true" native="false" synchronized="false"
  5857. static="false" final="false" visibility="public"
  5858. deprecated="not deprecated">
  5859. <doc>
  5860. <![CDATA[Get the <code>ApplicationId</code> of the application.
  5861. @return <code>ApplicationId</code> of the application]]>
  5862. </doc>
  5863. </method>
  5864. <method name="setApplicationId"
  5865. abstract="true" native="false" synchronized="false"
  5866. static="false" final="false" visibility="public"
  5867. deprecated="not deprecated">
  5868. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5869. <doc>
  5870. <![CDATA[Set the <code>ApplicationId</code> of the application.
  5871. @param applicationId <code>ApplicationId</code> of the application]]>
  5872. </doc>
  5873. </method>
  5874. <method name="getApplicationTimeouts" return="java.util.Map"
  5875. abstract="true" native="false" synchronized="false"
  5876. static="false" final="false" visibility="public"
  5877. deprecated="not deprecated">
  5878. <doc>
  5879. <![CDATA[Get <code>ApplicationTimeouts</code> of the application. Timeout value is
  5880. in ISO8601 standard with format <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.
  5881. @return all <code>ApplicationTimeouts</code> of the application.]]>
  5882. </doc>
  5883. </method>
  5884. <method name="setApplicationTimeouts"
  5885. abstract="true" native="false" synchronized="false"
  5886. static="false" final="false" visibility="public"
  5887. deprecated="not deprecated">
  5888. <param name="applicationTimeouts" type="java.util.Map"/>
  5889. <doc>
  5890. <![CDATA[Set the <code>ApplicationTimeouts</code> for the application. Timeout value
  5891. is absolute. Timeout value should meet ISO8601 format. Support ISO8601
  5892. format is <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>. All pre-existing Map entries
  5893. are cleared before adding the new Map.
  5894. @param applicationTimeouts <code>ApplicationTimeouts</code>s for the
  5895. application]]>
  5896. </doc>
  5897. </method>
  5898. <doc>
  5899. <![CDATA[<p>
  5900. The request sent by the client to the <code>ResourceManager</code> to set or
  5901. update the application timeout.
  5902. </p>
  5903. <p>
  5904. The request includes the {@link ApplicationId} of the application and timeout
  5905. to be set for an application
  5906. </p>]]>
  5907. </doc>
  5908. </class>
  5909. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest -->
  5910. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse -->
  5911. <class name="UpdateApplicationTimeoutsResponse" extends="java.lang.Object"
  5912. abstract="true"
  5913. static="false" final="false" visibility="public"
  5914. deprecated="not deprecated">
  5915. <constructor name="UpdateApplicationTimeoutsResponse"
  5916. static="false" final="false" visibility="public"
  5917. deprecated="not deprecated">
  5918. </constructor>
  5919. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse"
  5920. abstract="false" native="false" synchronized="false"
  5921. static="true" final="false" visibility="public"
  5922. deprecated="not deprecated">
  5923. </method>
  5924. <method name="getApplicationTimeouts" return="java.util.Map"
  5925. abstract="true" native="false" synchronized="false"
  5926. static="false" final="false" visibility="public"
  5927. deprecated="not deprecated">
  5928. <doc>
  5929. <![CDATA[Get <code>ApplicationTimeouts</code> of the application. Timeout value is
  5930. in ISO8601 standard with format <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.
  5931. @return all <code>ApplicationTimeouts</code> of the application.]]>
  5932. </doc>
  5933. </method>
  5934. <method name="setApplicationTimeouts"
  5935. abstract="true" native="false" synchronized="false"
  5936. static="false" final="false" visibility="public"
  5937. deprecated="not deprecated">
  5938. <param name="applicationTimeouts" type="java.util.Map"/>
  5939. <doc>
  5940. <![CDATA[Set the <code>ApplicationTimeouts</code> for the application. Timeout value
  5941. is absolute. Timeout value should meet ISO8601 format. Support ISO8601
  5942. format is <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>. All pre-existing Map entries
  5943. are cleared before adding the new Map.
  5944. @param applicationTimeouts <code>ApplicationTimeouts</code>s for the
  5945. application]]>
  5946. </doc>
  5947. </method>
  5948. <doc>
  5949. <![CDATA[<p>
  5950. The response sent by the <code>ResourceManager</code> to the client on update
  5951. application timeout.
  5952. </p>
  5953. <p>
  5954. A response without exception means that the update has completed
  5955. successfully.
  5956. </p>]]>
  5957. </doc>
  5958. </class>
  5959. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse -->
  5960. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
  5961. <class name="UseSharedCacheResourceRequest" extends="java.lang.Object"
  5962. abstract="true"
  5963. static="false" final="false" visibility="public"
  5964. deprecated="not deprecated">
  5965. <constructor name="UseSharedCacheResourceRequest"
  5966. static="false" final="false" visibility="public"
  5967. deprecated="not deprecated">
  5968. </constructor>
  5969. <method name="getAppId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5970. abstract="true" native="false" synchronized="false"
  5971. static="false" final="false" visibility="public"
  5972. deprecated="not deprecated">
  5973. <doc>
  5974. <![CDATA[Get the <code>ApplicationId</code> of the resource to be used.
  5975. @return <code>ApplicationId</code>]]>
  5976. </doc>
  5977. </method>
  5978. <method name="setAppId"
  5979. abstract="true" native="false" synchronized="false"
  5980. static="false" final="false" visibility="public"
  5981. deprecated="not deprecated">
  5982. <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5983. <doc>
  5984. <![CDATA[Set the <code>ApplicationId</code> of the resource to be used.
  5985. @param id <code>ApplicationId</code>]]>
  5986. </doc>
  5987. </method>
  5988. <method name="getResourceKey" return="java.lang.String"
  5989. abstract="true" native="false" synchronized="false"
  5990. static="false" final="false" visibility="public"
  5991. deprecated="not deprecated">
  5992. <doc>
  5993. <![CDATA[Get the <code>key</code> of the resource to be used.
  5994. @return <code>key</code>]]>
  5995. </doc>
  5996. </method>
  5997. <method name="setResourceKey"
  5998. abstract="true" native="false" synchronized="false"
  5999. static="false" final="false" visibility="public"
  6000. deprecated="not deprecated">
  6001. <param name="key" type="java.lang.String"/>
  6002. <doc>
  6003. <![CDATA[Set the <code>key</code> of the resource to be used.
  6004. @param key unique identifier for the resource]]>
  6005. </doc>
  6006. </method>
  6007. <doc>
  6008. <![CDATA[<p>
  6009. The request from clients to the <code>SharedCacheManager</code> that claims a
  6010. resource in the shared cache.
  6011. </p>]]>
  6012. </doc>
  6013. </class>
  6014. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
  6015. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
  6016. <class name="UseSharedCacheResourceResponse" extends="java.lang.Object"
  6017. abstract="true"
  6018. static="false" final="false" visibility="public"
  6019. deprecated="not deprecated">
  6020. <constructor name="UseSharedCacheResourceResponse"
  6021. static="false" final="false" visibility="public"
  6022. deprecated="not deprecated">
  6023. </constructor>
  6024. <method name="getPath" return="java.lang.String"
  6025. abstract="true" native="false" synchronized="false"
  6026. static="false" final="false" visibility="public"
  6027. deprecated="not deprecated">
  6028. <doc>
  6029. <![CDATA[Get the <code>Path</code> corresponding to the requested resource in the
  6030. shared cache.
  6031. @return String A <code>Path</code> if the resource exists in the shared
  6032. cache, <code>null</code> otherwise]]>
  6033. </doc>
  6034. </method>
  6035. <method name="setPath"
  6036. abstract="true" native="false" synchronized="false"
  6037. static="false" final="false" visibility="public"
  6038. deprecated="not deprecated">
  6039. <param name="p" type="java.lang.String"/>
  6040. <doc>
  6041. <![CDATA[Set the <code>Path</code> corresponding to a resource in the shared cache.
  6042. @param p A <code>Path</code> corresponding to a resource in the shared
  6043. cache]]>
  6044. </doc>
  6045. </method>
  6046. <doc>
  6047. <![CDATA[<p>
  6048. The response from the SharedCacheManager to the client that indicates whether
  6049. a requested resource exists in the cache.
  6050. </p>]]>
  6051. </doc>
  6052. </class>
  6053. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
  6054. </package>
  6055. <package name="org.apache.hadoop.yarn.api.records">
  6056. <!-- start class org.apache.hadoop.yarn.api.records.AMCommand -->
  6057. <class name="AMCommand" extends="java.lang.Enum"
  6058. abstract="false"
  6059. static="false" final="true" visibility="public"
  6060. deprecated="not deprecated">
  6061. <method name="values" return="org.apache.hadoop.yarn.api.records.AMCommand[]"
  6062. abstract="false" native="false" synchronized="false"
  6063. static="true" final="false" visibility="public"
  6064. deprecated="not deprecated">
  6065. </method>
  6066. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.AMCommand"
  6067. abstract="false" native="false" synchronized="false"
  6068. static="true" final="false" visibility="public"
  6069. deprecated="not deprecated">
  6070. <param name="name" type="java.lang.String"/>
  6071. </method>
  6072. <doc>
  6073. <![CDATA[Command sent by the Resource Manager to the Application Master in the
  6074. AllocateResponse
  6075. @see AllocateResponse]]>
  6076. </doc>
  6077. </class>
  6078. <!-- end class org.apache.hadoop.yarn.api.records.AMCommand -->
  6079. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
  6080. <class name="ApplicationAccessType" extends="java.lang.Enum"
  6081. abstract="false"
  6082. static="false" final="true" visibility="public"
  6083. deprecated="not deprecated">
  6084. <method name="values" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType[]"
  6085. abstract="false" native="false" synchronized="false"
  6086. static="true" final="false" visibility="public"
  6087. deprecated="not deprecated">
  6088. </method>
  6089. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType"
  6090. abstract="false" native="false" synchronized="false"
  6091. static="true" final="false" visibility="public"
  6092. deprecated="not deprecated">
  6093. <param name="name" type="java.lang.String"/>
  6094. </method>
  6095. <doc>
  6096. <![CDATA[Application access types.]]>
  6097. </doc>
  6098. </class>
  6099. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
  6100. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
  6101. <class name="ApplicationAttemptId" extends="java.lang.Object"
  6102. abstract="true"
  6103. static="false" final="false" visibility="public"
  6104. deprecated="not deprecated">
  6105. <implements name="java.lang.Comparable"/>
  6106. <constructor name="ApplicationAttemptId"
  6107. static="false" final="false" visibility="public"
  6108. deprecated="not deprecated">
  6109. </constructor>
  6110. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  6111. abstract="false" native="false" synchronized="false"
  6112. static="true" final="false" visibility="public"
  6113. deprecated="not deprecated">
  6114. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6115. <param name="attemptId" type="int"/>
  6116. </method>
  6117. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  6118. abstract="true" native="false" synchronized="false"
  6119. static="false" final="false" visibility="public"
  6120. deprecated="not deprecated">
  6121. <doc>
  6122. <![CDATA[Get the <code>ApplicationId</code> of the <code>ApplicationAttempId</code>.
  6123. @return <code>ApplicationId</code> of the <code>ApplicationAttempId</code>]]>
  6124. </doc>
  6125. </method>
  6126. <method name="getAttemptId" return="int"
  6127. abstract="true" native="false" synchronized="false"
  6128. static="false" final="false" visibility="public"
  6129. deprecated="not deprecated">
  6130. <doc>
  6131. <![CDATA[Get the <code>attempt id</code> of the <code>Application</code>.
  6132. @return <code>attempt id</code> of the <code>Application</code>]]>
  6133. </doc>
  6134. </method>
  6135. <method name="hashCode" return="int"
  6136. abstract="false" native="false" synchronized="false"
  6137. static="false" final="false" visibility="public"
  6138. deprecated="not deprecated">
  6139. </method>
  6140. <method name="equals" return="boolean"
  6141. abstract="false" native="false" synchronized="false"
  6142. static="false" final="false" visibility="public"
  6143. deprecated="not deprecated">
  6144. <param name="obj" type="java.lang.Object"/>
  6145. </method>
  6146. <method name="compareTo" return="int"
  6147. abstract="false" native="false" synchronized="false"
  6148. static="false" final="false" visibility="public"
  6149. deprecated="not deprecated">
  6150. <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  6151. </method>
  6152. <method name="toString" return="java.lang.String"
  6153. abstract="false" native="false" synchronized="false"
  6154. static="false" final="false" visibility="public"
  6155. deprecated="not deprecated">
  6156. </method>
  6157. <method name="build"
  6158. abstract="true" native="false" synchronized="false"
  6159. static="false" final="false" visibility="protected"
  6160. deprecated="not deprecated">
  6161. </method>
  6162. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  6163. abstract="false" native="false" synchronized="false"
  6164. static="true" final="false" visibility="public"
  6165. deprecated="not deprecated">
  6166. <param name="appAttemptIdStr" type="java.lang.String"/>
  6167. </method>
  6168. <field name="appAttemptIdStrPrefix" type="java.lang.String"
  6169. transient="false" volatile="false"
  6170. static="true" final="true" visibility="public"
  6171. deprecated="not deprecated">
  6172. </field>
  6173. <doc>
  6174. <![CDATA[<p><code>ApplicationAttemptId</code> denotes the particular <em>attempt</em>
  6175. of an <code>ApplicationMaster</code> for a given {@link ApplicationId}.</p>
  6176. <p>Multiple attempts might be needed to run an application to completion due
  6177. to temporal failures of the <code>ApplicationMaster</code> such as hardware
  6178. failures, connectivity issues etc. on the node on which it was scheduled.</p>]]>
  6179. </doc>
  6180. </class>
  6181. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
  6182. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
  6183. <class name="ApplicationAttemptReport" extends="java.lang.Object"
  6184. abstract="true"
  6185. static="false" final="false" visibility="public"
  6186. deprecated="not deprecated">
  6187. <constructor name="ApplicationAttemptReport"
  6188. static="false" final="false" visibility="public"
  6189. deprecated="not deprecated">
  6190. </constructor>
  6191. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
  6192. abstract="false" native="false" synchronized="false"
  6193. static="true" final="false" visibility="public"
  6194. deprecated="not deprecated">
  6195. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  6196. <param name="host" type="java.lang.String"/>
  6197. <param name="rpcPort" type="int"/>
  6198. <param name="url" type="java.lang.String"/>
  6199. <param name="oUrl" type="java.lang.String"/>
  6200. <param name="diagnostics" type="java.lang.String"/>
  6201. <param name="state" type="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"/>
  6202. <param name="amContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  6203. </method>
  6204. <method name="getYarnApplicationAttemptState" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
  6205. abstract="true" native="false" synchronized="false"
  6206. static="false" final="false" visibility="public"
  6207. deprecated="not deprecated">
  6208. <doc>
  6209. <![CDATA[Get the <em>YarnApplicationAttemptState</em> of the application attempt.
  6210. @return <em>YarnApplicationAttemptState</em> of the application attempt]]>
  6211. </doc>
  6212. </method>
  6213. <method name="getRpcPort" return="int"
  6214. abstract="true" native="false" synchronized="false"
  6215. static="false" final="false" visibility="public"
  6216. deprecated="not deprecated">
  6217. <doc>
  6218. <![CDATA[Get the <em>RPC port</em> of this attempt <code>ApplicationMaster</code>.
  6219. @return <em>RPC port</em> of this attempt <code>ApplicationMaster</code>]]>
  6220. </doc>
  6221. </method>
  6222. <method name="getHost" return="java.lang.String"
  6223. abstract="true" native="false" synchronized="false"
  6224. static="false" final="false" visibility="public"
  6225. deprecated="not deprecated">
  6226. <doc>
  6227. <![CDATA[Get the <em>host</em> on which this attempt of
  6228. <code>ApplicationMaster</code> is running.
  6229. @return <em>host</em> on which this attempt of
  6230. <code>ApplicationMaster</code> is running]]>
  6231. </doc>
  6232. </method>
  6233. <method name="getDiagnostics" return="java.lang.String"
  6234. abstract="true" native="false" synchronized="false"
  6235. static="false" final="false" visibility="public"
  6236. deprecated="not deprecated">
  6237. <doc>
  6238. <![CDATA[Get the <em>diagnositic information</em> of the application attempt in case
  6239. of errors.
  6240. @return <em>diagnositic information</em> of the application attempt in case
  6241. of errors]]>
  6242. </doc>
  6243. </method>
  6244. <method name="getTrackingUrl" return="java.lang.String"
  6245. abstract="true" native="false" synchronized="false"
  6246. static="false" final="false" visibility="public"
  6247. deprecated="not deprecated">
  6248. <doc>
  6249. <![CDATA[Get the <em>tracking url</em> for the application attempt.
  6250. @return <em>tracking url</em> for the application attempt]]>
  6251. </doc>
  6252. </method>
  6253. <method name="getOriginalTrackingUrl" return="java.lang.String"
  6254. abstract="true" native="false" synchronized="false"
  6255. static="false" final="false" visibility="public"
  6256. deprecated="not deprecated">
  6257. <doc>
  6258. <![CDATA[Get the <em>original tracking url</em> for the application attempt.
  6259. @return <em>original tracking url</em> for the application attempt]]>
  6260. </doc>
  6261. </method>
  6262. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  6263. abstract="true" native="false" synchronized="false"
  6264. static="false" final="false" visibility="public"
  6265. deprecated="not deprecated">
  6266. <doc>
  6267. <![CDATA[Get the <code>ApplicationAttemptId</code> of this attempt of the
  6268. application
  6269. @return <code>ApplicationAttemptId</code> of the attempt]]>
  6270. </doc>
  6271. </method>
  6272. <method name="getAMContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  6273. abstract="true" native="false" synchronized="false"
  6274. static="false" final="false" visibility="public"
  6275. deprecated="not deprecated">
  6276. <doc>
  6277. <![CDATA[Get the <code>ContainerId</code> of AMContainer for this attempt
  6278. @return <code>ContainerId</code> of the attempt]]>
  6279. </doc>
  6280. </method>
  6281. <method name="getStartTime" return="long"
  6282. abstract="true" native="false" synchronized="false"
  6283. static="false" final="false" visibility="public"
  6284. deprecated="not deprecated">
  6285. </method>
  6286. <method name="getFinishTime" return="long"
  6287. abstract="true" native="false" synchronized="false"
  6288. static="false" final="false" visibility="public"
  6289. deprecated="not deprecated">
  6290. <doc>
  6291. <![CDATA[Get the <em>finish time</em> of the application.
  6292. @return <em>finish time</em> of the application]]>
  6293. </doc>
  6294. </method>
  6295. <doc>
  6296. <![CDATA[{@code ApplicationAttemptReport} is a report of an application attempt.
  6297. <p>
  6298. It includes details such as:
  6299. <ul>
  6300. <li>{@link ApplicationAttemptId} of the application.</li>
  6301. <li>Host on which the <code>ApplicationMaster</code> of this attempt is
  6302. running.</li>
  6303. <li>RPC port of the <code>ApplicationMaster</code> of this attempt.</li>
  6304. <li>Tracking URL.</li>
  6305. <li>Diagnostic information in case of errors.</li>
  6306. <li>{@link YarnApplicationAttemptState} of the application attempt.</li>
  6307. <li>{@link ContainerId} of the master Container.</li>
  6308. </ul>]]>
  6309. </doc>
  6310. </class>
  6311. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
  6312. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationId -->
  6313. <class name="ApplicationId" extends="java.lang.Object"
  6314. abstract="true"
  6315. static="false" final="false" visibility="public"
  6316. deprecated="not deprecated">
  6317. <implements name="java.lang.Comparable"/>
  6318. <constructor name="ApplicationId"
  6319. static="false" final="false" visibility="public"
  6320. deprecated="not deprecated">
  6321. </constructor>
  6322. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  6323. abstract="false" native="false" synchronized="false"
  6324. static="true" final="false" visibility="public"
  6325. deprecated="not deprecated">
  6326. <param name="clusterTimestamp" type="long"/>
  6327. <param name="id" type="int"/>
  6328. </method>
  6329. <method name="getId" return="int"
  6330. abstract="true" native="false" synchronized="false"
  6331. static="false" final="false" visibility="public"
  6332. deprecated="not deprecated">
  6333. <doc>
  6334. <![CDATA[Get the short integer identifier of the <code>ApplicationId</code>
  6335. which is unique for all applications started by a particular instance
  6336. of the <code>ResourceManager</code>.
  6337. @return short integer identifier of the <code>ApplicationId</code>]]>
  6338. </doc>
  6339. </method>
  6340. <method name="getClusterTimestamp" return="long"
  6341. abstract="true" native="false" synchronized="false"
  6342. static="false" final="false" visibility="public"
  6343. deprecated="not deprecated">
  6344. <doc>
  6345. <![CDATA[Get the <em>start time</em> of the <code>ResourceManager</code> which is
  6346. used to generate globally unique <code>ApplicationId</code>.
  6347. @return <em>start time</em> of the <code>ResourceManager</code>]]>
  6348. </doc>
  6349. </method>
  6350. <method name="build"
  6351. abstract="true" native="false" synchronized="false"
  6352. static="false" final="false" visibility="protected"
  6353. deprecated="not deprecated">
  6354. </method>
  6355. <method name="compareTo" return="int"
  6356. abstract="false" native="false" synchronized="false"
  6357. static="false" final="false" visibility="public"
  6358. deprecated="not deprecated">
  6359. <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6360. </method>
  6361. <method name="toString" return="java.lang.String"
  6362. abstract="false" native="false" synchronized="false"
  6363. static="false" final="false" visibility="public"
  6364. deprecated="not deprecated">
  6365. </method>
  6366. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  6367. abstract="false" native="false" synchronized="false"
  6368. static="true" final="false" visibility="public"
  6369. deprecated="not deprecated">
  6370. <param name="appIdStr" type="java.lang.String"/>
  6371. </method>
  6372. <method name="hashCode" return="int"
  6373. abstract="false" native="false" synchronized="false"
  6374. static="false" final="false" visibility="public"
  6375. deprecated="not deprecated">
  6376. </method>
  6377. <method name="equals" return="boolean"
  6378. abstract="false" native="false" synchronized="false"
  6379. static="false" final="false" visibility="public"
  6380. deprecated="not deprecated">
  6381. <param name="obj" type="java.lang.Object"/>
  6382. </method>
  6383. <field name="appIdStrPrefix" type="java.lang.String"
  6384. transient="false" volatile="false"
  6385. static="true" final="true" visibility="public"
  6386. deprecated="not deprecated">
  6387. </field>
  6388. <doc>
  6389. <![CDATA[<p><code>ApplicationId</code> represents the <em>globally unique</em>
  6390. identifier for an application.</p>
  6391. <p>The globally unique nature of the identifier is achieved by using the
  6392. <em>cluster timestamp</em> i.e. start-time of the
  6393. <code>ResourceManager</code> along with a monotonically increasing counter
  6394. for the application.</p>]]>
  6395. </doc>
  6396. </class>
  6397. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationId -->
  6398. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationReport -->
  6399. <class name="ApplicationReport" extends="java.lang.Object"
  6400. abstract="true"
  6401. static="false" final="false" visibility="public"
  6402. deprecated="not deprecated">
  6403. <constructor name="ApplicationReport"
  6404. static="false" final="false" visibility="public"
  6405. deprecated="not deprecated">
  6406. </constructor>
  6407. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  6408. abstract="true" native="false" synchronized="false"
  6409. static="false" final="false" visibility="public"
  6410. deprecated="not deprecated">
  6411. <doc>
  6412. <![CDATA[Get the <code>ApplicationId</code> of the application.
  6413. @return <code>ApplicationId</code> of the application]]>
  6414. </doc>
  6415. </method>
  6416. <method name="getCurrentApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  6417. abstract="true" native="false" synchronized="false"
  6418. static="false" final="false" visibility="public"
  6419. deprecated="not deprecated">
  6420. <doc>
  6421. <![CDATA[Get the <code>ApplicationAttemptId</code> of the current
  6422. attempt of the application
  6423. @return <code>ApplicationAttemptId</code> of the attempt]]>
  6424. </doc>
  6425. </method>
  6426. <method name="getUser" return="java.lang.String"
  6427. abstract="true" native="false" synchronized="false"
  6428. static="false" final="false" visibility="public"
  6429. deprecated="not deprecated">
  6430. <doc>
  6431. <![CDATA[Get the <em>user</em> who submitted the application.
  6432. @return <em>user</em> who submitted the application]]>
  6433. </doc>
  6434. </method>
  6435. <method name="getQueue" return="java.lang.String"
  6436. abstract="true" native="false" synchronized="false"
  6437. static="false" final="false" visibility="public"
  6438. deprecated="not deprecated">
  6439. <doc>
  6440. <![CDATA[Get the <em>queue</em> to which the application was submitted.
  6441. @return <em>queue</em> to which the application was submitted]]>
  6442. </doc>
  6443. </method>
  6444. <method name="getName" return="java.lang.String"
  6445. abstract="true" native="false" synchronized="false"
  6446. static="false" final="false" visibility="public"
  6447. deprecated="not deprecated">
  6448. <doc>
  6449. <![CDATA[Get the user-defined <em>name</em> of the application.
  6450. @return <em>name</em> of the application]]>
  6451. </doc>
  6452. </method>
  6453. <method name="getHost" return="java.lang.String"
  6454. abstract="true" native="false" synchronized="false"
  6455. static="false" final="false" visibility="public"
  6456. deprecated="not deprecated">
  6457. <doc>
  6458. <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code>
  6459. is running.
  6460. @return <em>host</em> on which the <code>ApplicationMaster</code>
  6461. is running]]>
  6462. </doc>
  6463. </method>
  6464. <method name="getRpcPort" return="int"
  6465. abstract="true" native="false" synchronized="false"
  6466. static="false" final="false" visibility="public"
  6467. deprecated="not deprecated">
  6468. <doc>
  6469. <![CDATA[Get the <em>RPC port</em> of the <code>ApplicationMaster</code>.
  6470. @return <em>RPC port</em> of the <code>ApplicationMaster</code>]]>
  6471. </doc>
  6472. </method>
  6473. <method name="getClientToAMToken" return="org.apache.hadoop.yarn.api.records.Token"
  6474. abstract="true" native="false" synchronized="false"
  6475. static="false" final="false" visibility="public"
  6476. deprecated="not deprecated">
  6477. <doc>
  6478. <![CDATA[Get the <em>client token</em> for communicating with the
  6479. <code>ApplicationMaster</code>.
  6480. <p>
  6481. <em>ClientToAMToken</em> is the security token used by the AMs to verify
  6482. authenticity of any <code>client</code>.
  6483. </p>
  6484. <p>
  6485. The <code>ResourceManager</code>, provides a secure token (via
  6486. {@link ApplicationReport#getClientToAMToken()}) which is verified by the
  6487. ApplicationMaster when the client directly talks to an AM.
  6488. </p>
  6489. @return <em>client token</em> for communicating with the
  6490. <code>ApplicationMaster</code>]]>
  6491. </doc>
  6492. </method>
  6493. <method name="getYarnApplicationState" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
  6494. abstract="true" native="false" synchronized="false"
  6495. static="false" final="false" visibility="public"
  6496. deprecated="not deprecated">
  6497. <doc>
  6498. <![CDATA[Get the <code>YarnApplicationState</code> of the application.
  6499. @return <code>YarnApplicationState</code> of the application]]>
  6500. </doc>
  6501. </method>
  6502. <method name="getDiagnostics" return="java.lang.String"
  6503. abstract="true" native="false" synchronized="false"
  6504. static="false" final="false" visibility="public"
  6505. deprecated="not deprecated">
  6506. <doc>
  6507. <![CDATA[Get the <em>diagnositic information</em> of the application in case of
  6508. errors.
  6509. @return <em>diagnositic information</em> of the application in case
  6510. of errors]]>
  6511. </doc>
  6512. </method>
  6513. <method name="getTrackingUrl" return="java.lang.String"
  6514. abstract="true" native="false" synchronized="false"
  6515. static="false" final="false" visibility="public"
  6516. deprecated="not deprecated">
  6517. <doc>
  6518. <![CDATA[Get the <em>tracking url</em> for the application.
  6519. @return <em>tracking url</em> for the application]]>
  6520. </doc>
  6521. </method>
  6522. <method name="getStartTime" return="long"
  6523. abstract="true" native="false" synchronized="false"
  6524. static="false" final="false" visibility="public"
  6525. deprecated="not deprecated">
  6526. <doc>
  6527. <![CDATA[Get the <em>start time</em> of the application.
  6528. @return <em>start time</em> of the application]]>
  6529. </doc>
  6530. </method>
  6531. <method name="getSubmitTime" return="long"
  6532. abstract="true" native="false" synchronized="false"
  6533. static="false" final="false" visibility="public"
  6534. deprecated="not deprecated">
  6535. </method>
  6536. <method name="getLaunchTime" return="long"
  6537. abstract="true" native="false" synchronized="false"
  6538. static="false" final="false" visibility="public"
  6539. deprecated="not deprecated">
  6540. </method>
  6541. <method name="getFinishTime" return="long"
  6542. abstract="true" native="false" synchronized="false"
  6543. static="false" final="false" visibility="public"
  6544. deprecated="not deprecated">
  6545. <doc>
  6546. <![CDATA[Get the <em>finish time</em> of the application.
  6547. @return <em>finish time</em> of the application]]>
  6548. </doc>
  6549. </method>
  6550. <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  6551. abstract="true" native="false" synchronized="false"
  6552. static="false" final="false" visibility="public"
  6553. deprecated="not deprecated">
  6554. <doc>
  6555. <![CDATA[Get the <em>final finish status</em> of the application.
  6556. @return <em>final finish status</em> of the application]]>
  6557. </doc>
  6558. </method>
  6559. <method name="getApplicationResourceUsageReport" return="org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport"
  6560. abstract="true" native="false" synchronized="false"
  6561. static="false" final="false" visibility="public"
  6562. deprecated="not deprecated">
  6563. <doc>
  6564. <![CDATA[Retrieve the structure containing the job resources for this application
  6565. @return the job resources structure for this application]]>
  6566. </doc>
  6567. </method>
  6568. <method name="getProgress" return="float"
  6569. abstract="true" native="false" synchronized="false"
  6570. static="false" final="false" visibility="public"
  6571. deprecated="not deprecated">
  6572. <doc>
  6573. <![CDATA[Get the application's progress ( range 0.0 to 1.0 )
  6574. @return application's progress]]>
  6575. </doc>
  6576. </method>
  6577. <method name="getApplicationType" return="java.lang.String"
  6578. abstract="true" native="false" synchronized="false"
  6579. static="false" final="false" visibility="public"
  6580. deprecated="not deprecated">
  6581. <doc>
  6582. <![CDATA[Get the application's Type
  6583. @return application's Type]]>
  6584. </doc>
  6585. </method>
  6586. <method name="getApplicationTags" return="java.util.Set"
  6587. abstract="true" native="false" synchronized="false"
  6588. static="false" final="false" visibility="public"
  6589. deprecated="not deprecated">
  6590. <doc>
  6591. <![CDATA[Get all tags corresponding to the application
  6592. @return Application's tags]]>
  6593. </doc>
  6594. </method>
  6595. <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
  6596. abstract="true" native="false" synchronized="false"
  6597. static="false" final="false" visibility="public"
  6598. deprecated="not deprecated">
  6599. <doc>
  6600. <![CDATA[Get the AMRM token of the application.
  6601. <p>
  6602. The AMRM token is required for AM to RM scheduling operations. For
  6603. managed Application Masters YARN takes care of injecting it. For unmanaged
  6604. Applications Masters, the token must be obtained via this method and set
  6605. in the {@link org.apache.hadoop.security.UserGroupInformation} of the
  6606. current user.
  6607. <p>
  6608. The AMRM token will be returned only if all the following conditions are
  6609. met:
  6610. <ul>
  6611. <li>the requester is the owner of the ApplicationMaster</li>
  6612. <li>the application master is an unmanaged ApplicationMaster</li>
  6613. <li>the application master is in ACCEPTED state</li>
  6614. </ul>
  6615. Else this method returns NULL.
  6616. @return the AM to RM token if available.]]>
  6617. </doc>
  6618. </method>
  6619. <method name="getLogAggregationStatus" return="org.apache.hadoop.yarn.api.records.LogAggregationStatus"
  6620. abstract="true" native="false" synchronized="false"
  6621. static="false" final="false" visibility="public"
  6622. deprecated="not deprecated">
  6623. <doc>
  6624. <![CDATA[Get log aggregation status for the application
  6625. @return Application's log aggregation status]]>
  6626. </doc>
  6627. </method>
  6628. <method name="isUnmanagedApp" return="boolean"
  6629. abstract="true" native="false" synchronized="false"
  6630. static="false" final="false" visibility="public"
  6631. deprecated="not deprecated">
  6632. <doc>
  6633. <![CDATA[@return true if the AM is not managed by the RM]]>
  6634. </doc>
  6635. </method>
  6636. <method name="setUnmanagedApp"
  6637. abstract="true" native="false" synchronized="false"
  6638. static="false" final="false" visibility="public"
  6639. deprecated="not deprecated">
  6640. <param name="unmanagedApplication" type="boolean"/>
  6641. <doc>
  6642. <![CDATA[@param unmanagedApplication true if RM should not manage the AM]]>
  6643. </doc>
  6644. </method>
  6645. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  6646. abstract="true" native="false" synchronized="false"
  6647. static="false" final="false" visibility="public"
  6648. deprecated="not deprecated">
  6649. <doc>
  6650. <![CDATA[Get priority of the application
  6651. @return Application's priority]]>
  6652. </doc>
  6653. </method>
  6654. <method name="getAppNodeLabelExpression" return="java.lang.String"
  6655. abstract="true" native="false" synchronized="false"
  6656. static="false" final="false" visibility="public"
  6657. deprecated="not deprecated">
  6658. <doc>
  6659. <![CDATA[Get the default Node Label expression for all the application's containers
  6660. @return Application's NodeLabelExpression]]>
  6661. </doc>
  6662. </method>
  6663. <method name="setAppNodeLabelExpression"
  6664. abstract="true" native="false" synchronized="false"
  6665. static="false" final="false" visibility="public"
  6666. deprecated="not deprecated">
  6667. <param name="appNodeLabelExpression" type="java.lang.String"/>
  6668. </method>
  6669. <method name="getAmNodeLabelExpression" return="java.lang.String"
  6670. abstract="true" native="false" synchronized="false"
  6671. static="false" final="false" visibility="public"
  6672. deprecated="not deprecated">
  6673. <doc>
  6674. <![CDATA[Get the default Node Label expression for all the application's containers
  6675. @return Application's NodeLabelExpression]]>
  6676. </doc>
  6677. </method>
  6678. <method name="setAmNodeLabelExpression"
  6679. abstract="true" native="false" synchronized="false"
  6680. static="false" final="false" visibility="public"
  6681. deprecated="not deprecated">
  6682. <param name="amNodeLabelExpression" type="java.lang.String"/>
  6683. </method>
  6684. <method name="getApplicationTimeouts" return="java.util.Map"
  6685. abstract="true" native="false" synchronized="false"
  6686. static="false" final="false" visibility="public"
  6687. deprecated="not deprecated">
  6688. </method>
  6689. <doc>
  6690. <![CDATA[{@code ApplicationReport} is a report of an application.
  6691. <p>
  6692. It includes details such as:
  6693. <ul>
  6694. <li>{@link ApplicationId} of the application.</li>
  6695. <li>Applications user.</li>
  6696. <li>Application queue.</li>
  6697. <li>Application name.</li>
  6698. <li>Host on which the <code>ApplicationMaster</code> is running.</li>
  6699. <li>RPC port of the <code>ApplicationMaster</code>.</li>
  6700. <li>Tracking URL.</li>
  6701. <li>{@link YarnApplicationState} of the application.</li>
  6702. <li>Diagnostic information in case of errors.</li>
  6703. <li>Start time of the application.</li>
  6704. <li>Client {@link Token} of the application (if security is enabled).</li>
  6705. </ul>
  6706. @see ApplicationClientProtocol#getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest)]]>
  6707. </doc>
  6708. </class>
  6709. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationReport -->
  6710. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
  6711. <class name="ApplicationResourceUsageReport" extends="java.lang.Object"
  6712. abstract="true"
  6713. static="false" final="false" visibility="public"
  6714. deprecated="not deprecated">
  6715. <constructor name="ApplicationResourceUsageReport"
  6716. static="false" final="false" visibility="public"
  6717. deprecated="not deprecated">
  6718. </constructor>
  6719. <method name="getNumUsedContainers" return="int"
  6720. abstract="true" native="false" synchronized="false"
  6721. static="false" final="false" visibility="public"
  6722. deprecated="not deprecated">
  6723. <doc>
  6724. <![CDATA[Get the number of used containers. -1 for invalid/inaccessible reports.
  6725. @return the number of used containers]]>
  6726. </doc>
  6727. </method>
  6728. <method name="getUsedResources" return="org.apache.hadoop.yarn.api.records.Resource"
  6729. abstract="true" native="false" synchronized="false"
  6730. static="false" final="false" visibility="public"
  6731. deprecated="not deprecated">
  6732. <doc>
  6733. <![CDATA[Get the used <code>Resource</code>. -1 for invalid/inaccessible reports.
  6734. @return the used <code>Resource</code>]]>
  6735. </doc>
  6736. </method>
  6737. <method name="getReservedResources" return="org.apache.hadoop.yarn.api.records.Resource"
  6738. abstract="true" native="false" synchronized="false"
  6739. static="false" final="false" visibility="public"
  6740. deprecated="not deprecated">
  6741. <doc>
  6742. <![CDATA[Get the reserved <code>Resource</code>. -1 for invalid/inaccessible reports.
  6743. @return the reserved <code>Resource</code>]]>
  6744. </doc>
  6745. </method>
  6746. <method name="getNeededResources" return="org.apache.hadoop.yarn.api.records.Resource"
  6747. abstract="true" native="false" synchronized="false"
  6748. static="false" final="false" visibility="public"
  6749. deprecated="not deprecated">
  6750. <doc>
  6751. <![CDATA[Get the needed <code>Resource</code>. -1 for invalid/inaccessible reports.
  6752. @return the needed <code>Resource</code>]]>
  6753. </doc>
  6754. </method>
  6755. <method name="getMemorySeconds" return="long"
  6756. abstract="true" native="false" synchronized="false"
  6757. static="false" final="false" visibility="public"
  6758. deprecated="not deprecated">
  6759. <doc>
  6760. <![CDATA[Get the aggregated amount of memory (in megabytes) the application has
  6761. allocated times the number of seconds the application has been running.
  6762. @return the aggregated amount of memory seconds]]>
  6763. </doc>
  6764. </method>
  6765. <method name="getVcoreSeconds" return="long"
  6766. abstract="true" native="false" synchronized="false"
  6767. static="false" final="false" visibility="public"
  6768. deprecated="not deprecated">
  6769. <doc>
  6770. <![CDATA[Get the aggregated number of vcores that the application has allocated
  6771. times the number of seconds the application has been running.
  6772. @return the aggregated number of vcore seconds]]>
  6773. </doc>
  6774. </method>
  6775. <method name="getQueueUsagePercentage" return="float"
  6776. abstract="true" native="false" synchronized="false"
  6777. static="false" final="false" visibility="public"
  6778. deprecated="not deprecated">
  6779. <doc>
  6780. <![CDATA[Get the percentage of resources of the queue that the app is using.
  6781. @return the percentage of resources of the queue that the app is using.]]>
  6782. </doc>
  6783. </method>
  6784. <method name="getClusterUsagePercentage" return="float"
  6785. abstract="true" native="false" synchronized="false"
  6786. static="false" final="false" visibility="public"
  6787. deprecated="not deprecated">
  6788. <doc>
  6789. <![CDATA[Get the percentage of resources of the cluster that the app is using.
  6790. @return the percentage of resources of the cluster that the app is using.]]>
  6791. </doc>
  6792. </method>
  6793. <method name="getPreemptedMemorySeconds" return="long"
  6794. abstract="true" native="false" synchronized="false"
  6795. static="false" final="false" visibility="public"
  6796. deprecated="not deprecated">
  6797. <doc>
  6798. <![CDATA[Get the aggregated amount of memory preempted(in megabytes)
  6799. the application has allocated times the number of
  6800. seconds the application has been running.
  6801. @return the aggregated amount of memory seconds]]>
  6802. </doc>
  6803. </method>
  6804. <method name="getPreemptedVcoreSeconds" return="long"
  6805. abstract="true" native="false" synchronized="false"
  6806. static="false" final="false" visibility="public"
  6807. deprecated="not deprecated">
  6808. <doc>
  6809. <![CDATA[Get the aggregated number of vcores preempted that the application has
  6810. allocated times the number of seconds the application has been running.
  6811. @return the aggregated number of vcore seconds]]>
  6812. </doc>
  6813. </method>
  6814. <method name="getResourceSecondsMap" return="java.util.Map"
  6815. abstract="true" native="false" synchronized="false"
  6816. static="false" final="false" visibility="public"
  6817. deprecated="not deprecated">
  6818. <doc>
  6819. <![CDATA[Get the aggregated number of resources that the application has
  6820. allocated times the number of seconds the application has been running.
  6821. @return map containing the resource name and aggregated resource-seconds]]>
  6822. </doc>
  6823. </method>
  6824. <method name="getPreemptedResourceSecondsMap" return="java.util.Map"
  6825. abstract="true" native="false" synchronized="false"
  6826. static="false" final="false" visibility="public"
  6827. deprecated="not deprecated">
  6828. <doc>
  6829. <![CDATA[Get the aggregated number of resources preempted that the application has
  6830. allocated times the number of seconds the application has been running.
  6831. @return map containing the resource name and aggregated preempted
  6832. resource-seconds]]>
  6833. </doc>
  6834. </method>
  6835. <doc>
  6836. <![CDATA[Contains various scheduling metrics to be reported by UI and CLI.]]>
  6837. </doc>
  6838. </class>
  6839. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
  6840. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
  6841. <class name="ApplicationSubmissionContext" extends="java.lang.Object"
  6842. abstract="true"
  6843. static="false" final="false" visibility="public"
  6844. deprecated="not deprecated">
  6845. <constructor name="ApplicationSubmissionContext"
  6846. static="false" final="false" visibility="public"
  6847. deprecated="not deprecated">
  6848. </constructor>
  6849. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6850. abstract="false" native="false" synchronized="false"
  6851. static="true" final="false" visibility="public"
  6852. deprecated="not deprecated">
  6853. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6854. <param name="applicationName" type="java.lang.String"/>
  6855. <param name="queue" type="java.lang.String"/>
  6856. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6857. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6858. <param name="isUnmanagedAM" type="boolean"/>
  6859. <param name="cancelTokensWhenComplete" type="boolean"/>
  6860. <param name="maxAppAttempts" type="int"/>
  6861. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6862. <param name="applicationType" type="java.lang.String"/>
  6863. <param name="keepContainers" type="boolean"/>
  6864. <param name="appLabelExpression" type="java.lang.String"/>
  6865. <param name="amContainerLabelExpression" type="java.lang.String"/>
  6866. </method>
  6867. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6868. abstract="false" native="false" synchronized="false"
  6869. static="true" final="false" visibility="public"
  6870. deprecated="not deprecated">
  6871. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6872. <param name="applicationName" type="java.lang.String"/>
  6873. <param name="queue" type="java.lang.String"/>
  6874. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6875. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6876. <param name="isUnmanagedAM" type="boolean"/>
  6877. <param name="cancelTokensWhenComplete" type="boolean"/>
  6878. <param name="maxAppAttempts" type="int"/>
  6879. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6880. <param name="applicationType" type="java.lang.String"/>
  6881. <param name="keepContainers" type="boolean"/>
  6882. </method>
  6883. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6884. abstract="false" native="false" synchronized="false"
  6885. static="true" final="false" visibility="public"
  6886. deprecated="not deprecated">
  6887. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6888. <param name="applicationName" type="java.lang.String"/>
  6889. <param name="queue" type="java.lang.String"/>
  6890. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6891. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6892. <param name="isUnmanagedAM" type="boolean"/>
  6893. <param name="cancelTokensWhenComplete" type="boolean"/>
  6894. <param name="maxAppAttempts" type="int"/>
  6895. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6896. <param name="applicationType" type="java.lang.String"/>
  6897. </method>
  6898. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6899. abstract="false" native="false" synchronized="false"
  6900. static="true" final="false" visibility="public"
  6901. deprecated="not deprecated">
  6902. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6903. <param name="applicationName" type="java.lang.String"/>
  6904. <param name="queue" type="java.lang.String"/>
  6905. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6906. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6907. <param name="isUnmanagedAM" type="boolean"/>
  6908. <param name="cancelTokensWhenComplete" type="boolean"/>
  6909. <param name="maxAppAttempts" type="int"/>
  6910. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6911. </method>
  6912. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6913. abstract="false" native="false" synchronized="false"
  6914. static="true" final="false" visibility="public"
  6915. deprecated="not deprecated">
  6916. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6917. <param name="applicationName" type="java.lang.String"/>
  6918. <param name="queue" type="java.lang.String"/>
  6919. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6920. <param name="isUnmanagedAM" type="boolean"/>
  6921. <param name="cancelTokensWhenComplete" type="boolean"/>
  6922. <param name="maxAppAttempts" type="int"/>
  6923. <param name="applicationType" type="java.lang.String"/>
  6924. <param name="keepContainers" type="boolean"/>
  6925. <param name="appLabelExpression" type="java.lang.String"/>
  6926. <param name="resourceRequest" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  6927. </method>
  6928. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6929. abstract="false" native="false" synchronized="false"
  6930. static="true" final="false" visibility="public"
  6931. deprecated="not deprecated">
  6932. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6933. <param name="applicationName" type="java.lang.String"/>
  6934. <param name="queue" type="java.lang.String"/>
  6935. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6936. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6937. <param name="isUnmanagedAM" type="boolean"/>
  6938. <param name="cancelTokensWhenComplete" type="boolean"/>
  6939. <param name="maxAppAttempts" type="int"/>
  6940. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6941. <param name="applicationType" type="java.lang.String"/>
  6942. <param name="keepContainers" type="boolean"/>
  6943. <param name="attemptFailuresValidityInterval" type="long"/>
  6944. </method>
  6945. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6946. abstract="false" native="false" synchronized="false"
  6947. static="true" final="false" visibility="public"
  6948. deprecated="not deprecated">
  6949. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6950. <param name="applicationName" type="java.lang.String"/>
  6951. <param name="queue" type="java.lang.String"/>
  6952. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6953. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6954. <param name="isUnmanagedAM" type="boolean"/>
  6955. <param name="cancelTokensWhenComplete" type="boolean"/>
  6956. <param name="maxAppAttempts" type="int"/>
  6957. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6958. <param name="applicationType" type="java.lang.String"/>
  6959. <param name="keepContainers" type="boolean"/>
  6960. <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
  6961. </method>
  6962. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  6963. abstract="true" native="false" synchronized="false"
  6964. static="false" final="false" visibility="public"
  6965. deprecated="not deprecated">
  6966. <doc>
  6967. <![CDATA[Get the <code>ApplicationId</code> of the submitted application.
  6968. @return <code>ApplicationId</code> of the submitted application]]>
  6969. </doc>
  6970. </method>
  6971. <method name="setApplicationId"
  6972. abstract="true" native="false" synchronized="false"
  6973. static="false" final="false" visibility="public"
  6974. deprecated="not deprecated">
  6975. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6976. <doc>
  6977. <![CDATA[Set the <code>ApplicationId</code> of the submitted application.
  6978. @param applicationId <code>ApplicationId</code> of the submitted
  6979. application]]>
  6980. </doc>
  6981. </method>
  6982. <method name="getApplicationName" return="java.lang.String"
  6983. abstract="true" native="false" synchronized="false"
  6984. static="false" final="false" visibility="public"
  6985. deprecated="not deprecated">
  6986. <doc>
  6987. <![CDATA[Get the application <em>name</em>.
  6988. @return application name]]>
  6989. </doc>
  6990. </method>
  6991. <method name="setApplicationName"
  6992. abstract="true" native="false" synchronized="false"
  6993. static="false" final="false" visibility="public"
  6994. deprecated="not deprecated">
  6995. <param name="applicationName" type="java.lang.String"/>
  6996. <doc>
  6997. <![CDATA[Set the application <em>name</em>.
  6998. @param applicationName application name]]>
  6999. </doc>
  7000. </method>
  7001. <method name="getQueue" return="java.lang.String"
  7002. abstract="true" native="false" synchronized="false"
  7003. static="false" final="false" visibility="public"
  7004. deprecated="not deprecated">
  7005. <doc>
  7006. <![CDATA[Get the <em>queue</em> to which the application is being submitted.
  7007. @return <em>queue</em> to which the application is being submitted]]>
  7008. </doc>
  7009. </method>
  7010. <method name="setQueue"
  7011. abstract="true" native="false" synchronized="false"
  7012. static="false" final="false" visibility="public"
  7013. deprecated="not deprecated">
  7014. <param name="queue" type="java.lang.String"/>
  7015. <doc>
  7016. <![CDATA[Set the <em>queue</em> to which the application is being submitted
  7017. @param queue <em>queue</em> to which the application is being submitted]]>
  7018. </doc>
  7019. </method>
  7020. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  7021. abstract="true" native="false" synchronized="false"
  7022. static="false" final="false" visibility="public"
  7023. deprecated="not deprecated">
  7024. <doc>
  7025. <![CDATA[Get the <code>Priority</code> of the application.
  7026. @return <code>Priority</code> of the application]]>
  7027. </doc>
  7028. </method>
  7029. <method name="getAMContainerSpec" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  7030. abstract="true" native="false" synchronized="false"
  7031. static="false" final="false" visibility="public"
  7032. deprecated="not deprecated">
  7033. <doc>
  7034. <![CDATA[Get the <code>ContainerLaunchContext</code> to describe the
  7035. <code>Container</code> with which the <code>ApplicationMaster</code> is
  7036. launched.
  7037. @return <code>ContainerLaunchContext</code> for the
  7038. <code>ApplicationMaster</code> container]]>
  7039. </doc>
  7040. </method>
  7041. <method name="setAMContainerSpec"
  7042. abstract="true" native="false" synchronized="false"
  7043. static="false" final="false" visibility="public"
  7044. deprecated="not deprecated">
  7045. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  7046. <doc>
  7047. <![CDATA[Set the <code>ContainerLaunchContext</code> to describe the
  7048. <code>Container</code> with which the <code>ApplicationMaster</code> is
  7049. launched.
  7050. @param amContainer <code>ContainerLaunchContext</code> for the
  7051. <code>ApplicationMaster</code> container]]>
  7052. </doc>
  7053. </method>
  7054. <method name="getUnmanagedAM" return="boolean"
  7055. abstract="true" native="false" synchronized="false"
  7056. static="false" final="false" visibility="public"
  7057. deprecated="not deprecated">
  7058. <doc>
  7059. <![CDATA[Get if the RM should manage the execution of the AM.
  7060. If true, then the RM
  7061. will not allocate a container for the AM and start it. It will expect the
  7062. AM to be launched and connect to the RM within the AM liveliness period and
  7063. fail the app otherwise. The client should launch the AM only after the RM
  7064. has ACCEPTED the application and changed the <code>YarnApplicationState</code>.
  7065. Such apps will not be retried by the RM on app attempt failure.
  7066. The default value is false.
  7067. @return true if the AM is not managed by the RM]]>
  7068. </doc>
  7069. </method>
  7070. <method name="setUnmanagedAM"
  7071. abstract="true" native="false" synchronized="false"
  7072. static="false" final="false" visibility="public"
  7073. deprecated="not deprecated">
  7074. <param name="value" type="boolean"/>
  7075. <doc>
  7076. <![CDATA[@param value true if RM should not manage the AM]]>
  7077. </doc>
  7078. </method>
  7079. <method name="getMaxAppAttempts" return="int"
  7080. abstract="true" native="false" synchronized="false"
  7081. static="false" final="false" visibility="public"
  7082. deprecated="not deprecated">
  7083. <doc>
  7084. <![CDATA[@return the number of max attempts of the application to be submitted]]>
  7085. </doc>
  7086. </method>
  7087. <method name="setMaxAppAttempts"
  7088. abstract="true" native="false" synchronized="false"
  7089. static="false" final="false" visibility="public"
  7090. deprecated="not deprecated">
  7091. <param name="maxAppAttempts" type="int"/>
  7092. <doc>
  7093. <![CDATA[Set the number of max attempts of the application to be submitted. WARNING:
  7094. it should be no larger than the global number of max attempts in the Yarn
  7095. configuration.
  7096. @param maxAppAttempts the number of max attempts of the application
  7097. to be submitted.]]>
  7098. </doc>
  7099. </method>
  7100. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  7101. abstract="true" native="false" synchronized="false"
  7102. static="false" final="false" visibility="public"
  7103. deprecated="not deprecated">
  7104. <doc>
  7105. <![CDATA[Get the resource required by the <code>ApplicationMaster</code> for this
  7106. application. Please note this will be DEPRECATED, use <em>getResource</em>
  7107. in <em>getAMContainerResourceRequest</em> instead.
  7108. @return the resource required by the <code>ApplicationMaster</code> for
  7109. this application.]]>
  7110. </doc>
  7111. </method>
  7112. <method name="setResource"
  7113. abstract="true" native="false" synchronized="false"
  7114. static="false" final="false" visibility="public"
  7115. deprecated="not deprecated">
  7116. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7117. <doc>
  7118. <![CDATA[Set the resource required by the <code>ApplicationMaster</code> for this
  7119. application.
  7120. @param resource the resource required by the <code>ApplicationMaster</code>
  7121. for this application.]]>
  7122. </doc>
  7123. </method>
  7124. <method name="getApplicationType" return="java.lang.String"
  7125. abstract="true" native="false" synchronized="false"
  7126. static="false" final="false" visibility="public"
  7127. deprecated="not deprecated">
  7128. <doc>
  7129. <![CDATA[Get the application type
  7130. @return the application type]]>
  7131. </doc>
  7132. </method>
  7133. <method name="setApplicationType"
  7134. abstract="true" native="false" synchronized="false"
  7135. static="false" final="false" visibility="public"
  7136. deprecated="not deprecated">
  7137. <param name="applicationType" type="java.lang.String"/>
  7138. <doc>
  7139. <![CDATA[Set the application type
  7140. @param applicationType the application type]]>
  7141. </doc>
  7142. </method>
  7143. <method name="getKeepContainersAcrossApplicationAttempts" return="boolean"
  7144. abstract="true" native="false" synchronized="false"
  7145. static="false" final="false" visibility="public"
  7146. deprecated="not deprecated">
  7147. <doc>
  7148. <![CDATA[Get the flag which indicates whether to keep containers across application
  7149. attempts or not.
  7150. @return the flag which indicates whether to keep containers across
  7151. application attempts or not.]]>
  7152. </doc>
  7153. </method>
  7154. <method name="setKeepContainersAcrossApplicationAttempts"
  7155. abstract="true" native="false" synchronized="false"
  7156. static="false" final="false" visibility="public"
  7157. deprecated="not deprecated">
  7158. <param name="keepContainers" type="boolean"/>
  7159. <doc>
  7160. <![CDATA[Set the flag which indicates whether to keep containers across application
  7161. attempts.
  7162. <p>
  7163. For managed AM, if the flag is true, running containers will not be killed
  7164. when application attempt fails and these containers will be retrieved by
  7165. the new application attempt on registration via
  7166. {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}.
  7167. </p>
  7168. <p>
  7169. For unmanaged AM, if the flag is true, RM allows re-register and returns
  7170. the running containers in the same attempt back to the UAM for HA.
  7171. </p>
  7172. @param keepContainers the flag which indicates whether to keep containers
  7173. across application attempts.]]>
  7174. </doc>
  7175. </method>
  7176. <method name="getApplicationTags" return="java.util.Set"
  7177. abstract="true" native="false" synchronized="false"
  7178. static="false" final="false" visibility="public"
  7179. deprecated="not deprecated">
  7180. <doc>
  7181. <![CDATA[Get tags for the application
  7182. @return the application tags]]>
  7183. </doc>
  7184. </method>
  7185. <method name="setApplicationTags"
  7186. abstract="true" native="false" synchronized="false"
  7187. static="false" final="false" visibility="public"
  7188. deprecated="not deprecated">
  7189. <param name="tags" type="java.util.Set"/>
  7190. <doc>
  7191. <![CDATA[Set tags for the application. A maximum of
  7192. {@link YarnConfiguration#RM_APPLICATION_MAX_TAGS} are allowed
  7193. per application. Each tag can be at most
  7194. {@link YarnConfiguration#RM_APPLICATION_MAX_TAG_LENGTH}
  7195. characters, and can contain only ASCII characters.
  7196. @param tags tags to set]]>
  7197. </doc>
  7198. </method>
  7199. <method name="getNodeLabelExpression" return="java.lang.String"
  7200. abstract="true" native="false" synchronized="false"
  7201. static="false" final="false" visibility="public"
  7202. deprecated="not deprecated">
  7203. <doc>
  7204. <![CDATA[Get node-label-expression for this app. If this is set, all containers of
  7205. this application without setting node-label-expression in ResurceRequest
  7206. will get allocated resources on only those nodes that satisfy this
  7207. node-label-expression.
  7208. If different node-label-expression of this app and ResourceRequest are set
  7209. at the same time, the one set in ResourceRequest will be used when
  7210. allocating container
  7211. @return node-label-expression for this app]]>
  7212. </doc>
  7213. </method>
  7214. <method name="setNodeLabelExpression"
  7215. abstract="true" native="false" synchronized="false"
  7216. static="false" final="false" visibility="public"
  7217. deprecated="not deprecated">
  7218. <param name="nodeLabelExpression" type="java.lang.String"/>
  7219. <doc>
  7220. <![CDATA[Set node-label-expression for this app
  7221. @param nodeLabelExpression node-label-expression of this app]]>
  7222. </doc>
  7223. </method>
  7224. <method name="getAMContainerResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  7225. abstract="true" native="false" synchronized="false"
  7226. static="false" final="false" visibility="public"
  7227. deprecated="See {@link #getAMContainerResourceRequests()}">
  7228. <doc>
  7229. <![CDATA[Get the ResourceRequest of the AM container.
  7230. If this is not null, scheduler will use this to acquire resource for AM
  7231. container.
  7232. If this is null, scheduler will assemble a ResourceRequest by using
  7233. <em>getResource</em> and <em>getPriority</em> of
  7234. <em>ApplicationSubmissionContext</em>.
  7235. Number of containers and Priority will be ignored.
  7236. @return ResourceRequest of the AM container
  7237. @deprecated See {@link #getAMContainerResourceRequests()}]]>
  7238. </doc>
  7239. </method>
  7240. <method name="setAMContainerResourceRequest"
  7241. abstract="true" native="false" synchronized="false"
  7242. static="false" final="false" visibility="public"
  7243. deprecated="See {@link #setAMContainerResourceRequests(List)}">
  7244. <param name="request" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  7245. <doc>
  7246. <![CDATA[Set ResourceRequest of the AM container
  7247. @param request of the AM container
  7248. @deprecated See {@link #setAMContainerResourceRequests(List)}]]>
  7249. </doc>
  7250. </method>
  7251. <method name="getAMContainerResourceRequests" return="java.util.List"
  7252. abstract="true" native="false" synchronized="false"
  7253. static="false" final="false" visibility="public"
  7254. deprecated="not deprecated">
  7255. <doc>
  7256. <![CDATA[Get the ResourceRequests of the AM container.
  7257. If this is not null, scheduler will use this to acquire resource for AM
  7258. container.
  7259. If this is null, scheduler will use the ResourceRequest as determined by
  7260. <em>getAMContainerResourceRequest</em> and its behavior.
  7261. Number of containers and Priority will be ignored.
  7262. @return List of ResourceRequests of the AM container]]>
  7263. </doc>
  7264. </method>
  7265. <method name="setAMContainerResourceRequests"
  7266. abstract="true" native="false" synchronized="false"
  7267. static="false" final="false" visibility="public"
  7268. deprecated="not deprecated">
  7269. <param name="requests" type="java.util.List"/>
  7270. <doc>
  7271. <![CDATA[Set ResourceRequests of the AM container.
  7272. @param requests of the AM container]]>
  7273. </doc>
  7274. </method>
  7275. <method name="getAttemptFailuresValidityInterval" return="long"
  7276. abstract="true" native="false" synchronized="false"
  7277. static="false" final="false" visibility="public"
  7278. deprecated="not deprecated">
  7279. <doc>
  7280. <![CDATA[Get the attemptFailuresValidityInterval in milliseconds for the application
  7281. @return the attemptFailuresValidityInterval]]>
  7282. </doc>
  7283. </method>
  7284. <method name="setAttemptFailuresValidityInterval"
  7285. abstract="true" native="false" synchronized="false"
  7286. static="false" final="false" visibility="public"
  7287. deprecated="not deprecated">
  7288. <param name="attemptFailuresValidityInterval" type="long"/>
  7289. <doc>
  7290. <![CDATA[Set the attemptFailuresValidityInterval in milliseconds for the application
  7291. @param attemptFailuresValidityInterval]]>
  7292. </doc>
  7293. </method>
  7294. <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  7295. abstract="true" native="false" synchronized="false"
  7296. static="false" final="false" visibility="public"
  7297. deprecated="not deprecated">
  7298. <doc>
  7299. <![CDATA[Get <code>LogAggregationContext</code> of the application
  7300. @return <code>LogAggregationContext</code> of the application]]>
  7301. </doc>
  7302. </method>
  7303. <method name="setLogAggregationContext"
  7304. abstract="true" native="false" synchronized="false"
  7305. static="false" final="false" visibility="public"
  7306. deprecated="not deprecated">
  7307. <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
  7308. <doc>
  7309. <![CDATA[Set <code>LogAggregationContext</code> for the application
  7310. @param logAggregationContext
  7311. for the application]]>
  7312. </doc>
  7313. </method>
  7314. <method name="getReservationID" return="org.apache.hadoop.yarn.api.records.ReservationId"
  7315. abstract="true" native="false" synchronized="false"
  7316. static="false" final="false" visibility="public"
  7317. deprecated="not deprecated">
  7318. <doc>
  7319. <![CDATA[Get the reservation id, that corresponds to a valid resource allocation in
  7320. the scheduler (between start and end time of the corresponding reservation)
  7321. @return the reservation id representing the unique id of the corresponding
  7322. reserved resource allocation in the scheduler]]>
  7323. </doc>
  7324. </method>
  7325. <method name="setReservationID"
  7326. abstract="true" native="false" synchronized="false"
  7327. static="false" final="false" visibility="public"
  7328. deprecated="not deprecated">
  7329. <param name="reservationID" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  7330. <doc>
  7331. <![CDATA[Set the reservation id, that correspond to a valid resource allocation in
  7332. the scheduler (between start and end time of the corresponding reservation)
  7333. @param reservationID representing the unique id of the
  7334. corresponding reserved resource allocation in the scheduler]]>
  7335. </doc>
  7336. </method>
  7337. <method name="getApplicationTimeouts" return="java.util.Map"
  7338. abstract="true" native="false" synchronized="false"
  7339. static="false" final="false" visibility="public"
  7340. deprecated="not deprecated">
  7341. <doc>
  7342. <![CDATA[Get <code>ApplicationTimeouts</code> of the application. Timeout value is
  7343. in seconds.
  7344. @return all <code>ApplicationTimeouts</code> of the application.]]>
  7345. </doc>
  7346. </method>
  7347. <method name="setApplicationTimeouts"
  7348. abstract="true" native="false" synchronized="false"
  7349. static="false" final="false" visibility="public"
  7350. deprecated="not deprecated">
  7351. <param name="applicationTimeouts" type="java.util.Map"/>
  7352. <doc>
  7353. <![CDATA[Set the <code>ApplicationTimeouts</code> for the application in seconds.
  7354. All pre-existing Map entries are cleared before adding the new Map.
  7355. <p>
  7356. <b>Note:</b> If application timeout value is less than or equal to zero
  7357. then application submission will throw an exception.
  7358. </p>
  7359. @param applicationTimeouts <code>ApplicationTimeouts</code>s for the
  7360. application]]>
  7361. </doc>
  7362. </method>
  7363. <method name="getApplicationSchedulingPropertiesMap" return="java.util.Map"
  7364. abstract="true" native="false" synchronized="false"
  7365. static="false" final="false" visibility="public"
  7366. deprecated="not deprecated">
  7367. <doc>
  7368. <![CDATA[Get application scheduling environment variables stored as a key value
  7369. pair map for application.
  7370. @return placement envs for application.]]>
  7371. </doc>
  7372. </method>
  7373. <method name="setApplicationSchedulingPropertiesMap"
  7374. abstract="true" native="false" synchronized="false"
  7375. static="false" final="false" visibility="public"
  7376. deprecated="not deprecated">
  7377. <param name="schedulingEnvMap" type="java.util.Map"/>
  7378. <doc>
  7379. <![CDATA[Set the scheduling envs for the application.
  7380. @param schedulingEnvMap
  7381. A map of env's for the application scheduling preferences.]]>
  7382. </doc>
  7383. </method>
  7384. <doc>
  7385. <![CDATA[{@code ApplicationSubmissionContext} represents all of the
  7386. information needed by the {@code ResourceManager} to launch
  7387. the {@code ApplicationMaster} for an application.
  7388. <p>
  7389. It includes details such as:
  7390. <ul>
  7391. <li>{@link ApplicationId} of the application.</li>
  7392. <li>Application user.</li>
  7393. <li>Application name.</li>
  7394. <li>{@link Priority} of the application.</li>
  7395. <li>
  7396. {@link ContainerLaunchContext} of the container in which the
  7397. <code>ApplicationMaster</code> is executed.
  7398. </li>
  7399. <li>
  7400. maxAppAttempts. The maximum number of application attempts.
  7401. It should be no larger than the global number of max attempts in the
  7402. YARN configuration.
  7403. </li>
  7404. <li>
  7405. attemptFailuresValidityInterval. The default value is -1.
  7406. when attemptFailuresValidityInterval in milliseconds is set to
  7407. {@literal >} 0, the failure number will no take failures which happen
  7408. out of the validityInterval into failure count. If failure count
  7409. reaches to maxAppAttempts, the application will be failed.
  7410. </li>
  7411. <li>Optional, application-specific {@link LogAggregationContext}</li>
  7412. </ul>
  7413. @see ContainerLaunchContext
  7414. @see ApplicationClientProtocol#submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest)]]>
  7415. </doc>
  7416. </class>
  7417. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
  7418. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationTimeout -->
  7419. <class name="ApplicationTimeout" extends="java.lang.Object"
  7420. abstract="true"
  7421. static="false" final="false" visibility="public"
  7422. deprecated="not deprecated">
  7423. <constructor name="ApplicationTimeout"
  7424. static="false" final="false" visibility="public"
  7425. deprecated="not deprecated">
  7426. </constructor>
  7427. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationTimeout"
  7428. abstract="false" native="false" synchronized="false"
  7429. static="true" final="false" visibility="public"
  7430. deprecated="not deprecated">
  7431. <param name="type" type="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"/>
  7432. <param name="expiryTime" type="java.lang.String"/>
  7433. <param name="remainingTime" type="long"/>
  7434. </method>
  7435. <method name="getTimeoutType" return="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"
  7436. abstract="true" native="false" synchronized="false"
  7437. static="false" final="false" visibility="public"
  7438. deprecated="not deprecated">
  7439. <doc>
  7440. <![CDATA[Get the application timeout type.
  7441. @return timeoutType of an application timeout.]]>
  7442. </doc>
  7443. </method>
  7444. <method name="setTimeoutType"
  7445. abstract="true" native="false" synchronized="false"
  7446. static="false" final="false" visibility="public"
  7447. deprecated="not deprecated">
  7448. <param name="timeoutType" type="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"/>
  7449. <doc>
  7450. <![CDATA[Set the application timeout type.
  7451. @param timeoutType of an application timeout.]]>
  7452. </doc>
  7453. </method>
  7454. <method name="getExpiryTime" return="java.lang.String"
  7455. abstract="true" native="false" synchronized="false"
  7456. static="false" final="false" visibility="public"
  7457. deprecated="not deprecated">
  7458. <doc>
  7459. <![CDATA[Get <code>expiryTime</code> for given timeout type.
  7460. @return expiryTime in ISO8601 standard with format
  7461. <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.]]>
  7462. </doc>
  7463. </method>
  7464. <method name="setExpiryTime"
  7465. abstract="true" native="false" synchronized="false"
  7466. static="false" final="false" visibility="public"
  7467. deprecated="not deprecated">
  7468. <param name="expiryTime" type="java.lang.String"/>
  7469. <doc>
  7470. <![CDATA[Set <code>expiryTime</code> for given timeout type.
  7471. @param expiryTime in ISO8601 standard with format
  7472. <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.]]>
  7473. </doc>
  7474. </method>
  7475. <method name="getRemainingTime" return="long"
  7476. abstract="true" native="false" synchronized="false"
  7477. static="false" final="false" visibility="public"
  7478. deprecated="not deprecated">
  7479. <doc>
  7480. <![CDATA[Get <code>Remaining Time</code> of an application for given timeout type.
  7481. @return Remaining Time in seconds.]]>
  7482. </doc>
  7483. </method>
  7484. <method name="setRemainingTime"
  7485. abstract="true" native="false" synchronized="false"
  7486. static="false" final="false" visibility="public"
  7487. deprecated="not deprecated">
  7488. <param name="remainingTime" type="long"/>
  7489. <doc>
  7490. <![CDATA[Set <code>Remaining Time</code> of an application for given timeout type.
  7491. @param remainingTime in seconds.]]>
  7492. </doc>
  7493. </method>
  7494. <doc>
  7495. <![CDATA[{@code ApplicationTimeout} is a report for configured application timeouts.
  7496. It includes details such as:
  7497. <ul>
  7498. <li>{@link ApplicationTimeoutType} of the timeout type.</li>
  7499. <li>Expiry time in ISO8601 standard with format
  7500. <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b> or "UNLIMITED".</li>
  7501. <li>Remaining time in seconds.</li>
  7502. </ul>
  7503. The possible values for {ExpiryTime, RemainingTimeInSeconds} are
  7504. <ul>
  7505. <li>{UNLIMITED,-1} : Timeout is not configured for given timeout type
  7506. (LIFETIME).</li>
  7507. <li>{ISO8601 date string, 0} : Timeout is configured and application has
  7508. completed.</li>
  7509. <li>{ISO8601 date string, greater than zero} : Timeout is configured and
  7510. application is RUNNING. Application will be timed out after configured
  7511. value.</li>
  7512. </ul>]]>
  7513. </doc>
  7514. </class>
  7515. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationTimeout -->
  7516. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationTimeoutType -->
  7517. <class name="ApplicationTimeoutType" extends="java.lang.Enum"
  7518. abstract="false"
  7519. static="false" final="true" visibility="public"
  7520. deprecated="not deprecated">
  7521. <method name="values" return="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType[]"
  7522. abstract="false" native="false" synchronized="false"
  7523. static="true" final="false" visibility="public"
  7524. deprecated="not deprecated">
  7525. </method>
  7526. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"
  7527. abstract="false" native="false" synchronized="false"
  7528. static="true" final="false" visibility="public"
  7529. deprecated="not deprecated">
  7530. <param name="name" type="java.lang.String"/>
  7531. </method>
  7532. <doc>
  7533. <![CDATA[Application timeout type.]]>
  7534. </doc>
  7535. </class>
  7536. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationTimeoutType -->
  7537. <!-- start class org.apache.hadoop.yarn.api.records.CollectorInfo -->
  7538. <class name="CollectorInfo" extends="java.lang.Object"
  7539. abstract="true"
  7540. static="false" final="false" visibility="public"
  7541. deprecated="not deprecated">
  7542. <constructor name="CollectorInfo"
  7543. static="false" final="false" visibility="public"
  7544. deprecated="not deprecated">
  7545. </constructor>
  7546. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.CollectorInfo"
  7547. abstract="false" native="false" synchronized="false"
  7548. static="true" final="false" visibility="public"
  7549. deprecated="not deprecated">
  7550. <param name="collectorAddr" type="java.lang.String"/>
  7551. </method>
  7552. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.CollectorInfo"
  7553. abstract="false" native="false" synchronized="false"
  7554. static="true" final="false" visibility="public"
  7555. deprecated="not deprecated">
  7556. <param name="collectorAddr" type="java.lang.String"/>
  7557. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  7558. </method>
  7559. <method name="getCollectorAddr" return="java.lang.String"
  7560. abstract="true" native="false" synchronized="false"
  7561. static="false" final="false" visibility="public"
  7562. deprecated="not deprecated">
  7563. </method>
  7564. <method name="setCollectorAddr"
  7565. abstract="true" native="false" synchronized="false"
  7566. static="false" final="false" visibility="public"
  7567. deprecated="not deprecated">
  7568. <param name="addr" type="java.lang.String"/>
  7569. </method>
  7570. <method name="getCollectorToken" return="org.apache.hadoop.yarn.api.records.Token"
  7571. abstract="true" native="false" synchronized="false"
  7572. static="false" final="false" visibility="public"
  7573. deprecated="not deprecated">
  7574. <doc>
  7575. <![CDATA[Get delegation token for app collector which AM will use to publish
  7576. entities.
  7577. @return the delegation token for app collector.]]>
  7578. </doc>
  7579. </method>
  7580. <method name="setCollectorToken"
  7581. abstract="true" native="false" synchronized="false"
  7582. static="false" final="false" visibility="public"
  7583. deprecated="not deprecated">
  7584. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  7585. </method>
  7586. <field name="DEFAULT_TIMESTAMP_VALUE" type="long"
  7587. transient="false" volatile="false"
  7588. static="true" final="true" visibility="protected"
  7589. deprecated="not deprecated">
  7590. </field>
  7591. <doc>
  7592. <![CDATA[Collector info containing collector address and collector token passed from
  7593. RM to AM in Allocate Response.]]>
  7594. </doc>
  7595. </class>
  7596. <!-- end class org.apache.hadoop.yarn.api.records.CollectorInfo -->
  7597. <!-- start class org.apache.hadoop.yarn.api.records.Container -->
  7598. <class name="Container" extends="java.lang.Object"
  7599. abstract="true"
  7600. static="false" final="false" visibility="public"
  7601. deprecated="not deprecated">
  7602. <implements name="java.lang.Comparable"/>
  7603. <constructor name="Container"
  7604. static="false" final="false" visibility="public"
  7605. deprecated="not deprecated">
  7606. </constructor>
  7607. <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  7608. abstract="true" native="false" synchronized="false"
  7609. static="false" final="false" visibility="public"
  7610. deprecated="not deprecated">
  7611. <doc>
  7612. <![CDATA[Get the globally unique identifier for the container.
  7613. @return globally unique identifier for the container]]>
  7614. </doc>
  7615. </method>
  7616. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  7617. abstract="true" native="false" synchronized="false"
  7618. static="false" final="false" visibility="public"
  7619. deprecated="not deprecated">
  7620. <doc>
  7621. <![CDATA[Get the identifier of the node on which the container is allocated.
  7622. @return identifier of the node on which the container is allocated]]>
  7623. </doc>
  7624. </method>
  7625. <method name="getNodeHttpAddress" return="java.lang.String"
  7626. abstract="true" native="false" synchronized="false"
  7627. static="false" final="false" visibility="public"
  7628. deprecated="not deprecated">
  7629. <doc>
  7630. <![CDATA[Get the http uri of the node on which the container is allocated.
  7631. @return http uri of the node on which the container is allocated]]>
  7632. </doc>
  7633. </method>
  7634. <method name="getExposedPorts" return="java.util.Map"
  7635. abstract="true" native="false" synchronized="false"
  7636. static="false" final="false" visibility="public"
  7637. deprecated="not deprecated">
  7638. <doc>
  7639. <![CDATA[Get the exposed ports of the node on which the container is allocated.
  7640. @return exposed ports of the node on which the container is allocated]]>
  7641. </doc>
  7642. </method>
  7643. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  7644. abstract="true" native="false" synchronized="false"
  7645. static="false" final="false" visibility="public"
  7646. deprecated="not deprecated">
  7647. <doc>
  7648. <![CDATA[Get the <code>Resource</code> allocated to the container.
  7649. @return <code>Resource</code> allocated to the container]]>
  7650. </doc>
  7651. </method>
  7652. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  7653. abstract="true" native="false" synchronized="false"
  7654. static="false" final="false" visibility="public"
  7655. deprecated="not deprecated">
  7656. <doc>
  7657. <![CDATA[Get the <code>Priority</code> at which the <code>Container</code> was
  7658. allocated.
  7659. @return <code>Priority</code> at which the <code>Container</code> was
  7660. allocated]]>
  7661. </doc>
  7662. </method>
  7663. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  7664. abstract="true" native="false" synchronized="false"
  7665. static="false" final="false" visibility="public"
  7666. deprecated="not deprecated">
  7667. <doc>
  7668. <![CDATA[Get the <code>ContainerToken</code> for the container.
  7669. <p><code>ContainerToken</code> is the security token used by the framework
  7670. to verify authenticity of any <code>Container</code>.</p>
  7671. <p>The <code>ResourceManager</code>, on container allocation provides a
  7672. secure token which is verified by the <code>NodeManager</code> on
  7673. container launch.</p>
  7674. <p>Applications do not need to care about <code>ContainerToken</code>, they
  7675. are transparently handled by the framework - the allocated
  7676. <code>Container</code> includes the <code>ContainerToken</code>.</p>
  7677. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
  7678. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
  7679. @return <code>ContainerToken</code> for the container]]>
  7680. </doc>
  7681. </method>
  7682. <method name="getAllocationRequestId" return="long"
  7683. abstract="false" native="false" synchronized="false"
  7684. static="false" final="false" visibility="public"
  7685. deprecated="not deprecated">
  7686. <doc>
  7687. <![CDATA[Get the optional <em>ID</em> corresponding to the original {@code
  7688. ResourceRequest{@link #getAllocationRequestId()}}s which is satisfied by
  7689. this allocated {@code Container}.
  7690. <p>
  7691. The scheduler may return multiple {@code AllocateResponse}s corresponding
  7692. to the same ID as and when scheduler allocates {@code Container}s.
  7693. <b>Applications</b> can continue to completely ignore the returned ID in
  7694. the response and use the allocation for any of their outstanding requests.
  7695. <p>
  7696. @return the <em>ID</em> corresponding to the original allocation request
  7697. which is satisfied by this allocation.]]>
  7698. </doc>
  7699. </method>
  7700. <doc>
  7701. <![CDATA[{@code Container} represents an allocated resource in the cluster.
  7702. <p>
  7703. The {@code ResourceManager} is the sole authority to allocate any
  7704. {@code Container} to applications. The allocated {@code Container}
  7705. is always on a single node and has a unique {@link ContainerId}. It has
  7706. a specific amount of {@link Resource} allocated.
  7707. <p>
  7708. It includes details such as:
  7709. <ul>
  7710. <li>{@link ContainerId} for the container, which is globally unique.</li>
  7711. <li>
  7712. {@link NodeId} of the node on which it is allocated.
  7713. </li>
  7714. <li>HTTP uri of the node.</li>
  7715. <li>{@link Resource} allocated to the container.</li>
  7716. <li>{@link Priority} at which the container was allocated.</li>
  7717. <li>
  7718. Container {@link Token} of the container, used to securely verify
  7719. authenticity of the allocation.
  7720. </li>
  7721. </ul>
  7722. Typically, an {@code ApplicationMaster} receives the {@code Container}
  7723. from the {@code ResourceManager} during resource-negotiation and then
  7724. talks to the {@code NodeManager} to start/stop containers.
  7725. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
  7726. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
  7727. @see ContainerManagementProtocol#stopContainers(org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest)]]>
  7728. </doc>
  7729. </class>
  7730. <!-- end class org.apache.hadoop.yarn.api.records.Container -->
  7731. <!-- start class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
  7732. <class name="ContainerExitStatus" extends="java.lang.Object"
  7733. abstract="false"
  7734. static="false" final="false" visibility="public"
  7735. deprecated="not deprecated">
  7736. <constructor name="ContainerExitStatus"
  7737. static="false" final="false" visibility="public"
  7738. deprecated="not deprecated">
  7739. </constructor>
  7740. <field name="SUCCESS" type="int"
  7741. transient="false" volatile="false"
  7742. static="true" final="true" visibility="public"
  7743. deprecated="not deprecated">
  7744. </field>
  7745. <field name="INVALID" type="int"
  7746. transient="false" volatile="false"
  7747. static="true" final="true" visibility="public"
  7748. deprecated="not deprecated">
  7749. </field>
  7750. <field name="ABORTED" type="int"
  7751. transient="false" volatile="false"
  7752. static="true" final="true" visibility="public"
  7753. deprecated="not deprecated">
  7754. <doc>
  7755. <![CDATA[Containers killed by the framework, either due to being released by
  7756. the application or being 'lost' due to node failures etc.]]>
  7757. </doc>
  7758. </field>
  7759. <field name="DISKS_FAILED" type="int"
  7760. transient="false" volatile="false"
  7761. static="true" final="true" visibility="public"
  7762. deprecated="not deprecated">
  7763. <doc>
  7764. <![CDATA[When threshold number of the nodemanager-local-directories or
  7765. threshold number of the nodemanager-log-directories become bad.]]>
  7766. </doc>
  7767. </field>
  7768. <field name="PREEMPTED" type="int"
  7769. transient="false" volatile="false"
  7770. static="true" final="true" visibility="public"
  7771. deprecated="not deprecated">
  7772. <doc>
  7773. <![CDATA[Containers preempted by the framework.]]>
  7774. </doc>
  7775. </field>
  7776. <field name="KILLED_EXCEEDED_VMEM" type="int"
  7777. transient="false" volatile="false"
  7778. static="true" final="true" visibility="public"
  7779. deprecated="not deprecated">
  7780. <doc>
  7781. <![CDATA[Container terminated because of exceeding allocated virtual memory.]]>
  7782. </doc>
  7783. </field>
  7784. <field name="KILLED_EXCEEDED_PMEM" type="int"
  7785. transient="false" volatile="false"
  7786. static="true" final="true" visibility="public"
  7787. deprecated="not deprecated">
  7788. <doc>
  7789. <![CDATA[Container terminated because of exceeding allocated physical memory.]]>
  7790. </doc>
  7791. </field>
  7792. <field name="KILLED_BY_APPMASTER" type="int"
  7793. transient="false" volatile="false"
  7794. static="true" final="true" visibility="public"
  7795. deprecated="not deprecated">
  7796. <doc>
  7797. <![CDATA[Container was terminated by stop request by the app master.]]>
  7798. </doc>
  7799. </field>
  7800. <field name="KILLED_BY_RESOURCEMANAGER" type="int"
  7801. transient="false" volatile="false"
  7802. static="true" final="true" visibility="public"
  7803. deprecated="not deprecated">
  7804. <doc>
  7805. <![CDATA[Container was terminated by the resource manager.]]>
  7806. </doc>
  7807. </field>
  7808. <field name="KILLED_AFTER_APP_COMPLETION" type="int"
  7809. transient="false" volatile="false"
  7810. static="true" final="true" visibility="public"
  7811. deprecated="not deprecated">
  7812. <doc>
  7813. <![CDATA[Container was terminated after the application finished.]]>
  7814. </doc>
  7815. </field>
  7816. <field name="KILLED_BY_CONTAINER_SCHEDULER" type="int"
  7817. transient="false" volatile="false"
  7818. static="true" final="true" visibility="public"
  7819. deprecated="not deprecated">
  7820. <doc>
  7821. <![CDATA[Container was terminated by the ContainerScheduler to make room
  7822. for another container...]]>
  7823. </doc>
  7824. </field>
  7825. <field name="KILLED_FOR_EXCESS_LOGS" type="int"
  7826. transient="false" volatile="false"
  7827. static="true" final="true" visibility="public"
  7828. deprecated="not deprecated">
  7829. <doc>
  7830. <![CDATA[Container was terminated for generating excess log data.]]>
  7831. </doc>
  7832. </field>
  7833. <doc>
  7834. <![CDATA[Container exit statuses indicating special exit circumstances.]]>
  7835. </doc>
  7836. </class>
  7837. <!-- end class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
  7838. <!-- start class org.apache.hadoop.yarn.api.records.ContainerId -->
  7839. <class name="ContainerId" extends="java.lang.Object"
  7840. abstract="true"
  7841. static="false" final="false" visibility="public"
  7842. deprecated="not deprecated">
  7843. <implements name="java.lang.Comparable"/>
  7844. <constructor name="ContainerId"
  7845. static="false" final="false" visibility="public"
  7846. deprecated="not deprecated">
  7847. </constructor>
  7848. <method name="newContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  7849. abstract="false" native="false" synchronized="false"
  7850. static="true" final="false" visibility="public"
  7851. deprecated="not deprecated">
  7852. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  7853. <param name="containerId" type="long"/>
  7854. </method>
  7855. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  7856. abstract="true" native="false" synchronized="false"
  7857. static="false" final="false" visibility="public"
  7858. deprecated="not deprecated">
  7859. <doc>
  7860. <![CDATA[Get the <code>ApplicationAttemptId</code> of the application to which the
  7861. <code>Container</code> was assigned.
  7862. <p>
  7863. Note: If containers are kept alive across application attempts via
  7864. {@link ApplicationSubmissionContext#setKeepContainersAcrossApplicationAttempts(boolean)}
  7865. the <code>ContainerId</code> does not necessarily contain the current
  7866. running application attempt's <code>ApplicationAttemptId</code> This
  7867. container can be allocated by previously exited application attempt and
  7868. managed by the current running attempt thus have the previous application
  7869. attempt's <code>ApplicationAttemptId</code>.
  7870. </p>
  7871. @return <code>ApplicationAttemptId</code> of the application to which the
  7872. <code>Container</code> was assigned]]>
  7873. </doc>
  7874. </method>
  7875. <method name="getId" return="int"
  7876. abstract="true" native="false" synchronized="false"
  7877. static="false" final="false" visibility="public"
  7878. deprecated="not deprecated">
  7879. <doc>
  7880. <![CDATA[Get the lower 32 bits of identifier of the <code>ContainerId</code>,
  7881. which doesn't include epoch. Note that this method will be marked as
  7882. deprecated, so please use <code>getContainerId</code> instead.
  7883. @return lower 32 bits of identifier of the <code>ContainerId</code>]]>
  7884. </doc>
  7885. </method>
  7886. <method name="getContainerId" return="long"
  7887. abstract="true" native="false" synchronized="false"
  7888. static="false" final="false" visibility="public"
  7889. deprecated="not deprecated">
  7890. <doc>
  7891. <![CDATA[Get the identifier of the <code>ContainerId</code>. Upper 24 bits are
  7892. reserved as epoch of cluster, and lower 40 bits are reserved as
  7893. sequential number of containers.
  7894. @return identifier of the <code>ContainerId</code>]]>
  7895. </doc>
  7896. </method>
  7897. <method name="hashCode" return="int"
  7898. abstract="false" native="false" synchronized="false"
  7899. static="false" final="false" visibility="public"
  7900. deprecated="not deprecated">
  7901. </method>
  7902. <method name="equals" return="boolean"
  7903. abstract="false" native="false" synchronized="false"
  7904. static="false" final="false" visibility="public"
  7905. deprecated="not deprecated">
  7906. <param name="obj" type="java.lang.Object"/>
  7907. </method>
  7908. <method name="compareTo" return="int"
  7909. abstract="false" native="false" synchronized="false"
  7910. static="false" final="false" visibility="public"
  7911. deprecated="not deprecated">
  7912. <param name="other" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  7913. </method>
  7914. <method name="toString" return="java.lang.String"
  7915. abstract="false" native="false" synchronized="false"
  7916. static="false" final="false" visibility="public"
  7917. deprecated="not deprecated">
  7918. <doc>
  7919. <![CDATA[@return A string representation of containerId. The format is
  7920. container_e*epoch*_*clusterTimestamp*_*appId*_*attemptId*_*containerId*
  7921. when epoch is larger than 0
  7922. (e.g. container_e17_1410901177871_0001_01_000005).
  7923. *epoch* is increased when RM restarts or fails over.
  7924. When epoch is 0, epoch is omitted
  7925. (e.g. container_1410901177871_0001_01_000005).]]>
  7926. </doc>
  7927. </method>
  7928. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ContainerId"
  7929. abstract="false" native="false" synchronized="false"
  7930. static="true" final="false" visibility="public"
  7931. deprecated="not deprecated">
  7932. <param name="containerIdStr" type="java.lang.String"/>
  7933. </method>
  7934. <method name="build"
  7935. abstract="true" native="false" synchronized="false"
  7936. static="false" final="false" visibility="protected"
  7937. deprecated="not deprecated">
  7938. </method>
  7939. <field name="CONTAINER_ID_BITMASK" type="long"
  7940. transient="false" volatile="false"
  7941. static="true" final="true" visibility="public"
  7942. deprecated="not deprecated">
  7943. </field>
  7944. <doc>
  7945. <![CDATA[<p><code>ContainerId</code> represents a globally unique identifier
  7946. for a {@link Container} in the cluster.</p>]]>
  7947. </doc>
  7948. </class>
  7949. <!-- end class org.apache.hadoop.yarn.api.records.ContainerId -->
  7950. <!-- start class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
  7951. <class name="ContainerLaunchContext" extends="java.lang.Object"
  7952. abstract="true"
  7953. static="false" final="false" visibility="public"
  7954. deprecated="not deprecated">
  7955. <constructor name="ContainerLaunchContext"
  7956. static="false" final="false" visibility="public"
  7957. deprecated="not deprecated">
  7958. </constructor>
  7959. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  7960. abstract="false" native="false" synchronized="false"
  7961. static="true" final="false" visibility="public"
  7962. deprecated="not deprecated">
  7963. <param name="localResources" type="java.util.Map"/>
  7964. <param name="environment" type="java.util.Map"/>
  7965. <param name="commands" type="java.util.List"/>
  7966. <param name="serviceData" type="java.util.Map"/>
  7967. <param name="tokens" type="java.nio.ByteBuffer"/>
  7968. <param name="acls" type="java.util.Map"/>
  7969. </method>
  7970. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  7971. abstract="false" native="false" synchronized="false"
  7972. static="true" final="false" visibility="public"
  7973. deprecated="not deprecated">
  7974. <param name="localResources" type="java.util.Map"/>
  7975. <param name="environment" type="java.util.Map"/>
  7976. <param name="commands" type="java.util.List"/>
  7977. <param name="serviceData" type="java.util.Map"/>
  7978. <param name="tokens" type="java.nio.ByteBuffer"/>
  7979. <param name="acls" type="java.util.Map"/>
  7980. <param name="containerRetryContext" type="org.apache.hadoop.yarn.api.records.ContainerRetryContext"/>
  7981. </method>
  7982. <method name="getTokens" return="java.nio.ByteBuffer"
  7983. abstract="true" native="false" synchronized="false"
  7984. static="false" final="false" visibility="public"
  7985. deprecated="not deprecated">
  7986. <doc>
  7987. <![CDATA[Get all the tokens needed by this container. It may include file-system
  7988. tokens, ApplicationMaster related tokens if this container is an
  7989. ApplicationMaster or framework level tokens needed by this container to
  7990. communicate to various services in a secure manner.
  7991. @return tokens needed by this container.]]>
  7992. </doc>
  7993. </method>
  7994. <method name="setTokens"
  7995. abstract="true" native="false" synchronized="false"
  7996. static="false" final="false" visibility="public"
  7997. deprecated="not deprecated">
  7998. <param name="tokens" type="java.nio.ByteBuffer"/>
  7999. <doc>
  8000. <![CDATA[Set security tokens needed by this container.
  8001. @param tokens security tokens]]>
  8002. </doc>
  8003. </method>
  8004. <method name="getTokensConf" return="java.nio.ByteBuffer"
  8005. abstract="true" native="false" synchronized="false"
  8006. static="false" final="false" visibility="public"
  8007. deprecated="not deprecated">
  8008. <doc>
  8009. <![CDATA[Get the configuration used by RM to renew tokens.
  8010. @return The configuration used by RM to renew the tokens.]]>
  8011. </doc>
  8012. </method>
  8013. <method name="setTokensConf"
  8014. abstract="true" native="false" synchronized="false"
  8015. static="false" final="false" visibility="public"
  8016. deprecated="not deprecated">
  8017. <param name="tokensConf" type="java.nio.ByteBuffer"/>
  8018. <doc>
  8019. <![CDATA[Set the configuration used by RM to renew the tokens.
  8020. @param tokensConf The configuration used by RM to renew the tokens]]>
  8021. </doc>
  8022. </method>
  8023. <method name="getLocalResources" return="java.util.Map"
  8024. abstract="true" native="false" synchronized="false"
  8025. static="false" final="false" visibility="public"
  8026. deprecated="not deprecated">
  8027. <doc>
  8028. <![CDATA[Get <code>LocalResource</code> required by the container.
  8029. @return all <code>LocalResource</code> required by the container]]>
  8030. </doc>
  8031. </method>
  8032. <method name="setLocalResources"
  8033. abstract="true" native="false" synchronized="false"
  8034. static="false" final="false" visibility="public"
  8035. deprecated="not deprecated">
  8036. <param name="localResources" type="java.util.Map"/>
  8037. <doc>
  8038. <![CDATA[Set <code>LocalResource</code> required by the container. All pre-existing
  8039. Map entries are cleared before adding the new Map
  8040. @param localResources <code>LocalResource</code> required by the container]]>
  8041. </doc>
  8042. </method>
  8043. <method name="getServiceData" return="java.util.Map"
  8044. abstract="true" native="false" synchronized="false"
  8045. static="false" final="false" visibility="public"
  8046. deprecated="not deprecated">
  8047. <doc>
  8048. <![CDATA[<p>
  8049. Get application-specific binary <em>service data</em>. This is a map keyed
  8050. by the name of each {@link AuxiliaryService} that is configured on a
  8051. NodeManager and value correspond to the application specific data targeted
  8052. for the keyed {@link AuxiliaryService}.
  8053. </p>
  8054. <p>
  8055. This will be used to initialize this application on the specific
  8056. {@link AuxiliaryService} running on the NodeManager by calling
  8057. {@link AuxiliaryService#initializeApplication(ApplicationInitializationContext)}
  8058. </p>
  8059. @return application-specific binary <em>service data</em>]]>
  8060. </doc>
  8061. </method>
  8062. <method name="setServiceData"
  8063. abstract="true" native="false" synchronized="false"
  8064. static="false" final="false" visibility="public"
  8065. deprecated="not deprecated">
  8066. <param name="serviceData" type="java.util.Map"/>
  8067. <doc>
  8068. <![CDATA[<p>
  8069. Set application-specific binary <em>service data</em>. This is a map keyed
  8070. by the name of each {@link AuxiliaryService} that is configured on a
  8071. NodeManager and value correspond to the application specific data targeted
  8072. for the keyed {@link AuxiliaryService}. All pre-existing Map entries are
  8073. preserved.
  8074. </p>
  8075. @param serviceData
  8076. application-specific binary <em>service data</em>]]>
  8077. </doc>
  8078. </method>
  8079. <method name="getEnvironment" return="java.util.Map"
  8080. abstract="true" native="false" synchronized="false"
  8081. static="false" final="false" visibility="public"
  8082. deprecated="not deprecated">
  8083. <doc>
  8084. <![CDATA[Get <em>environment variables</em> for the container.
  8085. @return <em>environment variables</em> for the container]]>
  8086. </doc>
  8087. </method>
  8088. <method name="setEnvironment"
  8089. abstract="true" native="false" synchronized="false"
  8090. static="false" final="false" visibility="public"
  8091. deprecated="not deprecated">
  8092. <param name="environment" type="java.util.Map"/>
  8093. <doc>
  8094. <![CDATA[Add <em>environment variables</em> for the container. All pre-existing Map
  8095. entries are cleared before adding the new Map
  8096. @param environment <em>environment variables</em> for the container]]>
  8097. </doc>
  8098. </method>
  8099. <method name="getCommands" return="java.util.List"
  8100. abstract="true" native="false" synchronized="false"
  8101. static="false" final="false" visibility="public"
  8102. deprecated="not deprecated">
  8103. <doc>
  8104. <![CDATA[Get the list of <em>commands</em> for launching the container.
  8105. @return the list of <em>commands</em> for launching the container]]>
  8106. </doc>
  8107. </method>
  8108. <method name="setCommands"
  8109. abstract="true" native="false" synchronized="false"
  8110. static="false" final="false" visibility="public"
  8111. deprecated="not deprecated">
  8112. <param name="commands" type="java.util.List"/>
  8113. <doc>
  8114. <![CDATA[Add the list of <em>commands</em> for launching the container. All
  8115. pre-existing List entries are cleared before adding the new List
  8116. @param commands the list of <em>commands</em> for launching the container]]>
  8117. </doc>
  8118. </method>
  8119. <method name="getApplicationACLs" return="java.util.Map"
  8120. abstract="true" native="false" synchronized="false"
  8121. static="false" final="false" visibility="public"
  8122. deprecated="not deprecated">
  8123. <doc>
  8124. <![CDATA[Get the <code>ApplicationACL</code>s for the application.
  8125. @return all the <code>ApplicationACL</code>s]]>
  8126. </doc>
  8127. </method>
  8128. <method name="setApplicationACLs"
  8129. abstract="true" native="false" synchronized="false"
  8130. static="false" final="false" visibility="public"
  8131. deprecated="not deprecated">
  8132. <param name="acls" type="java.util.Map"/>
  8133. <doc>
  8134. <![CDATA[Set the <code>ApplicationACL</code>s for the application. All pre-existing
  8135. Map entries are cleared before adding the new Map
  8136. @param acls <code>ApplicationACL</code>s for the application]]>
  8137. </doc>
  8138. </method>
  8139. <method name="getContainerRetryContext" return="org.apache.hadoop.yarn.api.records.ContainerRetryContext"
  8140. abstract="true" native="false" synchronized="false"
  8141. static="false" final="false" visibility="public"
  8142. deprecated="not deprecated">
  8143. <doc>
  8144. <![CDATA[Get the <code>ContainerRetryContext</code> to relaunch container.
  8145. @return <code>ContainerRetryContext</code> to relaunch container.]]>
  8146. </doc>
  8147. </method>
  8148. <method name="setContainerRetryContext"
  8149. abstract="true" native="false" synchronized="false"
  8150. static="false" final="false" visibility="public"
  8151. deprecated="not deprecated">
  8152. <param name="containerRetryContext" type="org.apache.hadoop.yarn.api.records.ContainerRetryContext"/>
  8153. <doc>
  8154. <![CDATA[Set the <code>ContainerRetryContext</code> to relaunch container.
  8155. @param containerRetryContext <code>ContainerRetryContext</code> to
  8156. relaunch container.]]>
  8157. </doc>
  8158. </method>
  8159. <doc>
  8160. <![CDATA[{@code ContainerLaunchContext} represents all of the information
  8161. needed by the {@code NodeManager} to launch a container.
  8162. <p>
  8163. It includes details such as:
  8164. <ul>
  8165. <li>{@link ContainerId} of the container.</li>
  8166. <li>{@link Resource} allocated to the container.</li>
  8167. <li>User to whom the container is allocated.</li>
  8168. <li>Security tokens (if security is enabled).</li>
  8169. <li>
  8170. {@link LocalResource} necessary for running the container such
  8171. as binaries, jar, shared-objects, side-files etc.
  8172. </li>
  8173. <li>Optional, application-specific binary service data.</li>
  8174. <li>Environment variables for the launched process.</li>
  8175. <li>Command to launch the container.</li>
  8176. <li>Retry strategy when container exits with failure.</li>
  8177. </ul>
  8178. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  8179. </doc>
  8180. </class>
  8181. <!-- end class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
  8182. <!-- start class org.apache.hadoop.yarn.api.records.ContainerReport -->
  8183. <class name="ContainerReport" extends="java.lang.Object"
  8184. abstract="true"
  8185. static="false" final="false" visibility="public"
  8186. deprecated="not deprecated">
  8187. <constructor name="ContainerReport"
  8188. static="false" final="false" visibility="public"
  8189. deprecated="not deprecated">
  8190. </constructor>
  8191. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  8192. abstract="true" native="false" synchronized="false"
  8193. static="false" final="false" visibility="public"
  8194. deprecated="not deprecated">
  8195. <doc>
  8196. <![CDATA[Get the <code>ContainerId</code> of the container.
  8197. @return <code>ContainerId</code> of the container.]]>
  8198. </doc>
  8199. </method>
  8200. <method name="setContainerId"
  8201. abstract="true" native="false" synchronized="false"
  8202. static="false" final="false" visibility="public"
  8203. deprecated="not deprecated">
  8204. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  8205. </method>
  8206. <method name="getAllocatedResource" return="org.apache.hadoop.yarn.api.records.Resource"
  8207. abstract="true" native="false" synchronized="false"
  8208. static="false" final="false" visibility="public"
  8209. deprecated="not deprecated">
  8210. <doc>
  8211. <![CDATA[Get the allocated <code>Resource</code> of the container.
  8212. @return allocated <code>Resource</code> of the container.]]>
  8213. </doc>
  8214. </method>
  8215. <method name="setAllocatedResource"
  8216. abstract="true" native="false" synchronized="false"
  8217. static="false" final="false" visibility="public"
  8218. deprecated="not deprecated">
  8219. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  8220. </method>
  8221. <method name="getAssignedNode" return="org.apache.hadoop.yarn.api.records.NodeId"
  8222. abstract="true" native="false" synchronized="false"
  8223. static="false" final="false" visibility="public"
  8224. deprecated="not deprecated">
  8225. <doc>
  8226. <![CDATA[Get the allocated <code>NodeId</code> where container is running.
  8227. @return allocated <code>NodeId</code> where container is running.]]>
  8228. </doc>
  8229. </method>
  8230. <method name="setAssignedNode"
  8231. abstract="true" native="false" synchronized="false"
  8232. static="false" final="false" visibility="public"
  8233. deprecated="not deprecated">
  8234. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  8235. </method>
  8236. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  8237. abstract="true" native="false" synchronized="false"
  8238. static="false" final="false" visibility="public"
  8239. deprecated="not deprecated">
  8240. <doc>
  8241. <![CDATA[Get the allocated <code>Priority</code> of the container.
  8242. @return allocated <code>Priority</code> of the container.]]>
  8243. </doc>
  8244. </method>
  8245. <method name="setPriority"
  8246. abstract="true" native="false" synchronized="false"
  8247. static="false" final="false" visibility="public"
  8248. deprecated="not deprecated">
  8249. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  8250. </method>
  8251. <method name="getCreationTime" return="long"
  8252. abstract="true" native="false" synchronized="false"
  8253. static="false" final="false" visibility="public"
  8254. deprecated="not deprecated">
  8255. <doc>
  8256. <![CDATA[Get the creation time of the container.
  8257. @return creation time of the container]]>
  8258. </doc>
  8259. </method>
  8260. <method name="setCreationTime"
  8261. abstract="true" native="false" synchronized="false"
  8262. static="false" final="false" visibility="public"
  8263. deprecated="not deprecated">
  8264. <param name="creationTime" type="long"/>
  8265. </method>
  8266. <method name="getFinishTime" return="long"
  8267. abstract="true" native="false" synchronized="false"
  8268. static="false" final="false" visibility="public"
  8269. deprecated="not deprecated">
  8270. <doc>
  8271. <![CDATA[Get the Finish time of the container.
  8272. @return Finish time of the container]]>
  8273. </doc>
  8274. </method>
  8275. <method name="setFinishTime"
  8276. abstract="true" native="false" synchronized="false"
  8277. static="false" final="false" visibility="public"
  8278. deprecated="not deprecated">
  8279. <param name="finishTime" type="long"/>
  8280. </method>
  8281. <method name="getDiagnosticsInfo" return="java.lang.String"
  8282. abstract="true" native="false" synchronized="false"
  8283. static="false" final="false" visibility="public"
  8284. deprecated="not deprecated">
  8285. <doc>
  8286. <![CDATA[Get the DiagnosticsInfo of the container.
  8287. @return DiagnosticsInfo of the container]]>
  8288. </doc>
  8289. </method>
  8290. <method name="setDiagnosticsInfo"
  8291. abstract="true" native="false" synchronized="false"
  8292. static="false" final="false" visibility="public"
  8293. deprecated="not deprecated">
  8294. <param name="diagnosticsInfo" type="java.lang.String"/>
  8295. </method>
  8296. <method name="getLogUrl" return="java.lang.String"
  8297. abstract="true" native="false" synchronized="false"
  8298. static="false" final="false" visibility="public"
  8299. deprecated="not deprecated">
  8300. <doc>
  8301. <![CDATA[Get the LogURL of the container.
  8302. @return LogURL of the container]]>
  8303. </doc>
  8304. </method>
  8305. <method name="setLogUrl"
  8306. abstract="true" native="false" synchronized="false"
  8307. static="false" final="false" visibility="public"
  8308. deprecated="not deprecated">
  8309. <param name="logUrl" type="java.lang.String"/>
  8310. </method>
  8311. <method name="getContainerState" return="org.apache.hadoop.yarn.api.records.ContainerState"
  8312. abstract="true" native="false" synchronized="false"
  8313. static="false" final="false" visibility="public"
  8314. deprecated="not deprecated">
  8315. <doc>
  8316. <![CDATA[Get the final <code>ContainerState</code> of the container.
  8317. @return final <code>ContainerState</code> of the container.]]>
  8318. </doc>
  8319. </method>
  8320. <method name="setContainerState"
  8321. abstract="true" native="false" synchronized="false"
  8322. static="false" final="false" visibility="public"
  8323. deprecated="not deprecated">
  8324. <param name="containerState" type="org.apache.hadoop.yarn.api.records.ContainerState"/>
  8325. </method>
  8326. <method name="getContainerExitStatus" return="int"
  8327. abstract="true" native="false" synchronized="false"
  8328. static="false" final="false" visibility="public"
  8329. deprecated="not deprecated">
  8330. <doc>
  8331. <![CDATA[Get the final <code>exit status</code> of the container.
  8332. @return final <code>exit status</code> of the container.]]>
  8333. </doc>
  8334. </method>
  8335. <method name="setContainerExitStatus"
  8336. abstract="true" native="false" synchronized="false"
  8337. static="false" final="false" visibility="public"
  8338. deprecated="not deprecated">
  8339. <param name="containerExitStatus" type="int"/>
  8340. </method>
  8341. <method name="getExposedPorts" return="java.lang.String"
  8342. abstract="true" native="false" synchronized="false"
  8343. static="false" final="false" visibility="public"
  8344. deprecated="not deprecated">
  8345. <doc>
  8346. <![CDATA[Get exposed ports of the container.
  8347. @return the node exposed ports of the container]]>
  8348. </doc>
  8349. </method>
  8350. <method name="getNodeHttpAddress" return="java.lang.String"
  8351. abstract="true" native="false" synchronized="false"
  8352. static="false" final="false" visibility="public"
  8353. deprecated="not deprecated">
  8354. <doc>
  8355. <![CDATA[Get the Node Http address of the container.
  8356. @return the node http address of the container]]>
  8357. </doc>
  8358. </method>
  8359. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  8360. abstract="true" native="false" synchronized="false"
  8361. static="false" final="false" visibility="public"
  8362. deprecated="not deprecated">
  8363. <doc>
  8364. <![CDATA[Get the execution type of the container.
  8365. @return the execution type of the container]]>
  8366. </doc>
  8367. </method>
  8368. <doc>
  8369. <![CDATA[{@code ContainerReport} is a report of an container.
  8370. <p>
  8371. It includes details such as:
  8372. <ul>
  8373. <li>{@link ContainerId} of the container.</li>
  8374. <li>Allocated Resources to the container.</li>
  8375. <li>Assigned Node id.</li>
  8376. <li>Assigned Priority.</li>
  8377. <li>Creation Time.</li>
  8378. <li>Finish Time.</li>
  8379. <li>Container Exit Status.</li>
  8380. <li>{@link ContainerState} of the container.</li>
  8381. <li>Diagnostic information in case of errors.</li>
  8382. <li>Log URL.</li>
  8383. <li>nodeHttpAddress</li>
  8384. </ul>]]>
  8385. </doc>
  8386. </class>
  8387. <!-- end class org.apache.hadoop.yarn.api.records.ContainerReport -->
  8388. <!-- start class org.apache.hadoop.yarn.api.records.ContainerRetryContext -->
  8389. <class name="ContainerRetryContext" extends="java.lang.Object"
  8390. abstract="true"
  8391. static="false" final="false" visibility="public"
  8392. deprecated="not deprecated">
  8393. <constructor name="ContainerRetryContext"
  8394. static="false" final="false" visibility="public"
  8395. deprecated="not deprecated">
  8396. </constructor>
  8397. <method name="getRetryPolicy" return="org.apache.hadoop.yarn.api.records.ContainerRetryPolicy"
  8398. abstract="true" native="false" synchronized="false"
  8399. static="false" final="false" visibility="public"
  8400. deprecated="not deprecated">
  8401. </method>
  8402. <method name="setRetryPolicy"
  8403. abstract="true" native="false" synchronized="false"
  8404. static="false" final="false" visibility="public"
  8405. deprecated="not deprecated">
  8406. <param name="retryPolicy" type="org.apache.hadoop.yarn.api.records.ContainerRetryPolicy"/>
  8407. </method>
  8408. <method name="getErrorCodes" return="java.util.Set"
  8409. abstract="true" native="false" synchronized="false"
  8410. static="false" final="false" visibility="public"
  8411. deprecated="not deprecated">
  8412. </method>
  8413. <method name="setErrorCodes"
  8414. abstract="true" native="false" synchronized="false"
  8415. static="false" final="false" visibility="public"
  8416. deprecated="not deprecated">
  8417. <param name="errorCodes" type="java.util.Set"/>
  8418. </method>
  8419. <method name="getMaxRetries" return="int"
  8420. abstract="true" native="false" synchronized="false"
  8421. static="false" final="false" visibility="public"
  8422. deprecated="not deprecated">
  8423. </method>
  8424. <method name="setMaxRetries"
  8425. abstract="true" native="false" synchronized="false"
  8426. static="false" final="false" visibility="public"
  8427. deprecated="not deprecated">
  8428. <param name="maxRetries" type="int"/>
  8429. </method>
  8430. <method name="getRetryInterval" return="int"
  8431. abstract="true" native="false" synchronized="false"
  8432. static="false" final="false" visibility="public"
  8433. deprecated="not deprecated">
  8434. </method>
  8435. <method name="setRetryInterval"
  8436. abstract="true" native="false" synchronized="false"
  8437. static="false" final="false" visibility="public"
  8438. deprecated="not deprecated">
  8439. <param name="retryInterval" type="int"/>
  8440. </method>
  8441. <method name="getFailuresValidityInterval" return="long"
  8442. abstract="true" native="false" synchronized="false"
  8443. static="false" final="false" visibility="public"
  8444. deprecated="not deprecated">
  8445. </method>
  8446. <method name="setFailuresValidityInterval"
  8447. abstract="true" native="false" synchronized="false"
  8448. static="false" final="false" visibility="public"
  8449. deprecated="not deprecated">
  8450. <param name="failuresValidityInterval" type="long"/>
  8451. </method>
  8452. <field name="RETRY_FOREVER" type="int"
  8453. transient="false" volatile="false"
  8454. static="true" final="true" visibility="public"
  8455. deprecated="not deprecated">
  8456. </field>
  8457. <field name="RETRY_INVALID" type="int"
  8458. transient="false" volatile="false"
  8459. static="true" final="true" visibility="public"
  8460. deprecated="not deprecated">
  8461. </field>
  8462. <field name="NEVER_RETRY_CONTEXT" type="org.apache.hadoop.yarn.api.records.ContainerRetryContext"
  8463. transient="false" volatile="false"
  8464. static="true" final="true" visibility="public"
  8465. deprecated="not deprecated">
  8466. </field>
  8467. <doc>
  8468. <![CDATA[{@code ContainerRetryContext} indicates how container retry after it fails
  8469. to run.
  8470. <p>
  8471. It provides details such as:
  8472. <ul>
  8473. <li>
  8474. {@link ContainerRetryPolicy} :
  8475. - NEVER_RETRY(DEFAULT value): no matter what error code is when container
  8476. fails to run, just do not retry.
  8477. - RETRY_ON_ALL_ERRORS: no matter what error code is, when container fails
  8478. to run, just retry.
  8479. - RETRY_ON_SPECIFIC_ERROR_CODES: when container fails to run, do retry if
  8480. the error code is one of <em>errorCodes</em>, otherwise do not retry.
  8481. Note: if error code is 137(SIGKILL) or 143(SIGTERM), it will not retry
  8482. because it is usually killed on purpose.
  8483. </li>
  8484. <li>
  8485. <em>maxRetries</em> specifies how many times to retry if need to retry.
  8486. If the value is -1, it means retry forever.
  8487. </li>
  8488. <li><em>retryInterval</em> specifies delaying some time before relaunch
  8489. container, the unit is millisecond.</li>
  8490. <li>
  8491. <em>failuresValidityInterval</em>: default value is -1.
  8492. When failuresValidityInterval in milliseconds is set to {@literal >} 0,
  8493. the failure number will not take failures which happen out of the
  8494. failuresValidityInterval into failure count. If failure count
  8495. reaches to <em>maxRetries</em>, the container will be failed.
  8496. </li>
  8497. </ul>]]>
  8498. </doc>
  8499. </class>
  8500. <!-- end class org.apache.hadoop.yarn.api.records.ContainerRetryContext -->
  8501. <!-- start class org.apache.hadoop.yarn.api.records.ContainerRetryPolicy -->
  8502. <class name="ContainerRetryPolicy" extends="java.lang.Enum"
  8503. abstract="false"
  8504. static="false" final="true" visibility="public"
  8505. deprecated="not deprecated">
  8506. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerRetryPolicy[]"
  8507. abstract="false" native="false" synchronized="false"
  8508. static="true" final="false" visibility="public"
  8509. deprecated="not deprecated">
  8510. </method>
  8511. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerRetryPolicy"
  8512. abstract="false" native="false" synchronized="false"
  8513. static="true" final="false" visibility="public"
  8514. deprecated="not deprecated">
  8515. <param name="name" type="java.lang.String"/>
  8516. </method>
  8517. <doc>
  8518. <![CDATA[<p>Retry policy for relaunching a <code>Container</code>.</p>]]>
  8519. </doc>
  8520. </class>
  8521. <!-- end class org.apache.hadoop.yarn.api.records.ContainerRetryPolicy -->
  8522. <!-- start class org.apache.hadoop.yarn.api.records.ContainerState -->
  8523. <class name="ContainerState" extends="java.lang.Enum"
  8524. abstract="false"
  8525. static="false" final="true" visibility="public"
  8526. deprecated="not deprecated">
  8527. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerState[]"
  8528. abstract="false" native="false" synchronized="false"
  8529. static="true" final="false" visibility="public"
  8530. deprecated="not deprecated">
  8531. </method>
  8532. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerState"
  8533. abstract="false" native="false" synchronized="false"
  8534. static="true" final="false" visibility="public"
  8535. deprecated="not deprecated">
  8536. <param name="name" type="java.lang.String"/>
  8537. </method>
  8538. <doc>
  8539. <![CDATA[<p>State of a <code>Container</code>.</p>]]>
  8540. </doc>
  8541. </class>
  8542. <!-- end class org.apache.hadoop.yarn.api.records.ContainerState -->
  8543. <!-- start class org.apache.hadoop.yarn.api.records.ContainerStatus -->
  8544. <class name="ContainerStatus" extends="java.lang.Object"
  8545. abstract="true"
  8546. static="false" final="false" visibility="public"
  8547. deprecated="not deprecated">
  8548. <constructor name="ContainerStatus"
  8549. static="false" final="false" visibility="public"
  8550. deprecated="not deprecated">
  8551. </constructor>
  8552. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  8553. abstract="true" native="false" synchronized="false"
  8554. static="false" final="false" visibility="public"
  8555. deprecated="not deprecated">
  8556. <doc>
  8557. <![CDATA[Get the <code>ContainerId</code> of the container.
  8558. @return <code>ContainerId</code> of the container]]>
  8559. </doc>
  8560. </method>
  8561. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  8562. abstract="false" native="false" synchronized="false"
  8563. static="false" final="false" visibility="public"
  8564. deprecated="not deprecated">
  8565. <doc>
  8566. <![CDATA[Get the <code>ExecutionType</code> of the container.
  8567. @return <code>ExecutionType</code> of the container]]>
  8568. </doc>
  8569. </method>
  8570. <method name="getState" return="org.apache.hadoop.yarn.api.records.ContainerState"
  8571. abstract="true" native="false" synchronized="false"
  8572. static="false" final="false" visibility="public"
  8573. deprecated="not deprecated">
  8574. <doc>
  8575. <![CDATA[Get the <code>ContainerState</code> of the container.
  8576. @return <code>ContainerState</code> of the container]]>
  8577. </doc>
  8578. </method>
  8579. <method name="getExitStatus" return="int"
  8580. abstract="true" native="false" synchronized="false"
  8581. static="false" final="false" visibility="public"
  8582. deprecated="not deprecated">
  8583. <doc>
  8584. <![CDATA[<p>Get the <em>exit status</em> for the container.</p>
  8585. <p>Note: This is valid only for completed containers i.e. containers
  8586. with state {@link ContainerState#COMPLETE}.
  8587. Otherwise, it returns an ContainerExitStatus.INVALID.
  8588. </p>
  8589. <p>Containers killed by the framework, either due to being released by
  8590. the application or being 'lost' due to node failures etc. have a special
  8591. exit code of ContainerExitStatus.ABORTED.</p>
  8592. <p>When threshold number of the nodemanager-local-directories or
  8593. threshold number of the nodemanager-log-directories become bad, then
  8594. container is not launched and is exited with ContainersExitStatus.DISKS_FAILED.
  8595. </p>
  8596. @return <em>exit status</em> for the container]]>
  8597. </doc>
  8598. </method>
  8599. <method name="getDiagnostics" return="java.lang.String"
  8600. abstract="true" native="false" synchronized="false"
  8601. static="false" final="false" visibility="public"
  8602. deprecated="not deprecated">
  8603. <doc>
  8604. <![CDATA[Get <em>diagnostic messages</em> for failed containers.
  8605. @return <em>diagnostic messages</em> for failed containers]]>
  8606. </doc>
  8607. </method>
  8608. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  8609. abstract="false" native="false" synchronized="false"
  8610. static="false" final="false" visibility="public"
  8611. deprecated="not deprecated">
  8612. <doc>
  8613. <![CDATA[Get the <code>Resource</code> allocated to the container.
  8614. @return <code>Resource</code> allocated to the container]]>
  8615. </doc>
  8616. </method>
  8617. <method name="getIPs" return="java.util.List"
  8618. abstract="false" native="false" synchronized="false"
  8619. static="false" final="false" visibility="public"
  8620. deprecated="not deprecated">
  8621. <doc>
  8622. <![CDATA[Get all the IP addresses with which the container run.
  8623. @return The IP address where the container runs.]]>
  8624. </doc>
  8625. </method>
  8626. <method name="getHost" return="java.lang.String"
  8627. abstract="false" native="false" synchronized="false"
  8628. static="false" final="false" visibility="public"
  8629. deprecated="not deprecated">
  8630. <doc>
  8631. <![CDATA[Get the hostname where the container runs.
  8632. @return The hostname where the container runs.]]>
  8633. </doc>
  8634. </method>
  8635. <method name="getExposedPorts" return="java.lang.String"
  8636. abstract="false" native="false" synchronized="false"
  8637. static="false" final="false" visibility="public"
  8638. deprecated="not deprecated">
  8639. <doc>
  8640. <![CDATA[Get exposed ports of the container.
  8641. @return List of exposed ports]]>
  8642. </doc>
  8643. </method>
  8644. <doc>
  8645. <![CDATA[{@code ContainerStatus} represents the current status of a
  8646. {@code Container}.
  8647. <p>
  8648. It provides details such as:
  8649. <ul>
  8650. <li>{@code ContainerId} of the container.</li>
  8651. <li>{@code ExecutionType} of the container.</li>
  8652. <li>{@code ContainerState} of the container.</li>
  8653. <li><em>Exit status</em> of a completed container.</li>
  8654. <li><em>Diagnostic</em> message for a failed container.</li>
  8655. <li>{@link Resource} allocated to the container.</li>
  8656. </ul>]]>
  8657. </doc>
  8658. </class>
  8659. <!-- end class org.apache.hadoop.yarn.api.records.ContainerStatus -->
  8660. <!-- start class org.apache.hadoop.yarn.api.records.ContainerSubState -->
  8661. <class name="ContainerSubState" extends="java.lang.Enum"
  8662. abstract="false"
  8663. static="false" final="true" visibility="public"
  8664. deprecated="not deprecated">
  8665. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerSubState[]"
  8666. abstract="false" native="false" synchronized="false"
  8667. static="true" final="false" visibility="public"
  8668. deprecated="not deprecated">
  8669. </method>
  8670. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerSubState"
  8671. abstract="false" native="false" synchronized="false"
  8672. static="true" final="false" visibility="public"
  8673. deprecated="not deprecated">
  8674. <param name="name" type="java.lang.String"/>
  8675. </method>
  8676. <doc>
  8677. <![CDATA[Container Sub-State.]]>
  8678. </doc>
  8679. </class>
  8680. <!-- end class org.apache.hadoop.yarn.api.records.ContainerSubState -->
  8681. <!-- start class org.apache.hadoop.yarn.api.records.ContainerUpdateType -->
  8682. <class name="ContainerUpdateType" extends="java.lang.Enum"
  8683. abstract="false"
  8684. static="false" final="true" visibility="public"
  8685. deprecated="not deprecated">
  8686. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType[]"
  8687. abstract="false" native="false" synchronized="false"
  8688. static="true" final="false" visibility="public"
  8689. deprecated="not deprecated">
  8690. </method>
  8691. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType"
  8692. abstract="false" native="false" synchronized="false"
  8693. static="true" final="false" visibility="public"
  8694. deprecated="not deprecated">
  8695. <param name="name" type="java.lang.String"/>
  8696. </method>
  8697. <doc>
  8698. <![CDATA[Encodes the type of Container Update.]]>
  8699. </doc>
  8700. </class>
  8701. <!-- end class org.apache.hadoop.yarn.api.records.ContainerUpdateType -->
  8702. <!-- start class org.apache.hadoop.yarn.api.records.ExecutionType -->
  8703. <class name="ExecutionType" extends="java.lang.Enum"
  8704. abstract="false"
  8705. static="false" final="true" visibility="public"
  8706. deprecated="not deprecated">
  8707. <method name="values" return="org.apache.hadoop.yarn.api.records.ExecutionType[]"
  8708. abstract="false" native="false" synchronized="false"
  8709. static="true" final="false" visibility="public"
  8710. deprecated="not deprecated">
  8711. </method>
  8712. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  8713. abstract="false" native="false" synchronized="false"
  8714. static="true" final="false" visibility="public"
  8715. deprecated="not deprecated">
  8716. <param name="name" type="java.lang.String"/>
  8717. </method>
  8718. <doc>
  8719. <![CDATA[Container property encoding execution semantics.
  8720. <p>
  8721. The execution types are the following:
  8722. <ul>
  8723. <li>{@link #GUARANTEED} - this container is guaranteed to start its
  8724. execution, once the corresponding start container request is received by
  8725. an NM.
  8726. <li>{@link #OPPORTUNISTIC} - the execution of this container may not start
  8727. immediately at the NM that receives the corresponding start container
  8728. request (depending on the NM's available resources). Moreover, it may be
  8729. preempted if it blocks a GUARANTEED container from being executed.
  8730. </ul>]]>
  8731. </doc>
  8732. </class>
  8733. <!-- end class org.apache.hadoop.yarn.api.records.ExecutionType -->
  8734. <!-- start class org.apache.hadoop.yarn.api.records.ExecutionTypeRequest -->
  8735. <class name="ExecutionTypeRequest" extends="java.lang.Object"
  8736. abstract="true"
  8737. static="false" final="false" visibility="public"
  8738. deprecated="not deprecated">
  8739. <implements name="java.lang.Comparable"/>
  8740. <constructor name="ExecutionTypeRequest"
  8741. static="false" final="false" visibility="public"
  8742. deprecated="not deprecated">
  8743. </constructor>
  8744. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
  8745. abstract="false" native="false" synchronized="false"
  8746. static="true" final="false" visibility="public"
  8747. deprecated="not deprecated">
  8748. </method>
  8749. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
  8750. abstract="false" native="false" synchronized="false"
  8751. static="true" final="false" visibility="public"
  8752. deprecated="not deprecated">
  8753. <param name="execType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  8754. </method>
  8755. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
  8756. abstract="false" native="false" synchronized="false"
  8757. static="true" final="false" visibility="public"
  8758. deprecated="not deprecated">
  8759. <param name="execType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  8760. <param name="ensureExecutionType" type="boolean"/>
  8761. </method>
  8762. <method name="setExecutionType"
  8763. abstract="true" native="false" synchronized="false"
  8764. static="false" final="false" visibility="public"
  8765. deprecated="not deprecated">
  8766. <param name="execType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  8767. <doc>
  8768. <![CDATA[Set the <code>ExecutionType</code> of the requested container.
  8769. @param execType
  8770. ExecutionType of the requested container]]>
  8771. </doc>
  8772. </method>
  8773. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  8774. abstract="true" native="false" synchronized="false"
  8775. static="false" final="false" visibility="public"
  8776. deprecated="not deprecated">
  8777. <doc>
  8778. <![CDATA[Get <code>ExecutionType</code>.
  8779. @return <code>ExecutionType</code>.]]>
  8780. </doc>
  8781. </method>
  8782. <method name="setEnforceExecutionType"
  8783. abstract="true" native="false" synchronized="false"
  8784. static="false" final="false" visibility="public"
  8785. deprecated="not deprecated">
  8786. <param name="enforceExecutionType" type="boolean"/>
  8787. <doc>
  8788. <![CDATA[Set to true to explicitly ask that the Scheduling Authority return
  8789. Containers of exactly the Execution Type requested.
  8790. @param enforceExecutionType whether ExecutionType request should be
  8791. strictly honored.]]>
  8792. </doc>
  8793. </method>
  8794. <method name="getEnforceExecutionType" return="boolean"
  8795. abstract="true" native="false" synchronized="false"
  8796. static="false" final="false" visibility="public"
  8797. deprecated="not deprecated">
  8798. <doc>
  8799. <![CDATA[Get whether Scheduling Authority should return Containers of exactly the
  8800. Execution Type requested for this <code>ResourceRequest</code>.
  8801. Defaults to false.
  8802. @return whether ExecutionType request should be strictly honored]]>
  8803. </doc>
  8804. </method>
  8805. <method name="hashCode" return="int"
  8806. abstract="false" native="false" synchronized="false"
  8807. static="false" final="false" visibility="public"
  8808. deprecated="not deprecated">
  8809. </method>
  8810. <method name="equals" return="boolean"
  8811. abstract="false" native="false" synchronized="false"
  8812. static="false" final="false" visibility="public"
  8813. deprecated="not deprecated">
  8814. <param name="obj" type="java.lang.Object"/>
  8815. </method>
  8816. <doc>
  8817. <![CDATA[An object of this class represents a specification of the execution
  8818. guarantee of the Containers associated with a ResourceRequest. It consists
  8819. of an <code>ExecutionType</code> as well as flag that explicitly asks the
  8820. configuredScheduler to return Containers of exactly the Execution Type
  8821. requested.]]>
  8822. </doc>
  8823. </class>
  8824. <!-- end class org.apache.hadoop.yarn.api.records.ExecutionTypeRequest -->
  8825. <!-- start class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
  8826. <class name="FinalApplicationStatus" extends="java.lang.Enum"
  8827. abstract="false"
  8828. static="false" final="true" visibility="public"
  8829. deprecated="not deprecated">
  8830. <method name="values" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus[]"
  8831. abstract="false" native="false" synchronized="false"
  8832. static="true" final="false" visibility="public"
  8833. deprecated="not deprecated">
  8834. </method>
  8835. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  8836. abstract="false" native="false" synchronized="false"
  8837. static="true" final="false" visibility="public"
  8838. deprecated="not deprecated">
  8839. <param name="name" type="java.lang.String"/>
  8840. </method>
  8841. <doc>
  8842. <![CDATA[Enumeration of various final states of an <code>Application</code>.]]>
  8843. </doc>
  8844. </class>
  8845. <!-- end class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
  8846. <!-- start class org.apache.hadoop.yarn.api.records.LocalizationState -->
  8847. <class name="LocalizationState" extends="java.lang.Enum"
  8848. abstract="false"
  8849. static="false" final="true" visibility="public"
  8850. deprecated="not deprecated">
  8851. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalizationState[]"
  8852. abstract="false" native="false" synchronized="false"
  8853. static="true" final="false" visibility="public"
  8854. deprecated="not deprecated">
  8855. </method>
  8856. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalizationState"
  8857. abstract="false" native="false" synchronized="false"
  8858. static="true" final="false" visibility="public"
  8859. deprecated="not deprecated">
  8860. <param name="name" type="java.lang.String"/>
  8861. </method>
  8862. <doc>
  8863. <![CDATA[State of localization.]]>
  8864. </doc>
  8865. </class>
  8866. <!-- end class org.apache.hadoop.yarn.api.records.LocalizationState -->
  8867. <!-- start class org.apache.hadoop.yarn.api.records.LocalizationStatus -->
  8868. <class name="LocalizationStatus" extends="java.lang.Object"
  8869. abstract="true"
  8870. static="false" final="false" visibility="public"
  8871. deprecated="not deprecated">
  8872. <constructor name="LocalizationStatus"
  8873. static="false" final="false" visibility="public"
  8874. deprecated="not deprecated">
  8875. </constructor>
  8876. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalizationStatus"
  8877. abstract="false" native="false" synchronized="false"
  8878. static="true" final="false" visibility="public"
  8879. deprecated="not deprecated">
  8880. <param name="resourceKey" type="java.lang.String"/>
  8881. <param name="localizationState" type="org.apache.hadoop.yarn.api.records.LocalizationState"/>
  8882. </method>
  8883. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalizationStatus"
  8884. abstract="false" native="false" synchronized="false"
  8885. static="true" final="false" visibility="public"
  8886. deprecated="not deprecated">
  8887. <param name="resourceKey" type="java.lang.String"/>
  8888. <param name="localizationState" type="org.apache.hadoop.yarn.api.records.LocalizationState"/>
  8889. <param name="diagnostics" type="java.lang.String"/>
  8890. </method>
  8891. <method name="getResourceKey" return="java.lang.String"
  8892. abstract="true" native="false" synchronized="false"
  8893. static="false" final="false" visibility="public"
  8894. deprecated="not deprecated">
  8895. <doc>
  8896. <![CDATA[Get the resource key.
  8897. @return resource key.]]>
  8898. </doc>
  8899. </method>
  8900. <method name="getLocalizationState" return="org.apache.hadoop.yarn.api.records.LocalizationState"
  8901. abstract="true" native="false" synchronized="false"
  8902. static="false" final="false" visibility="public"
  8903. deprecated="not deprecated">
  8904. <doc>
  8905. <![CDATA[Get the localization sate.
  8906. @return localization state.]]>
  8907. </doc>
  8908. </method>
  8909. <method name="getDiagnostics" return="java.lang.String"
  8910. abstract="true" native="false" synchronized="false"
  8911. static="false" final="false" visibility="public"
  8912. deprecated="not deprecated">
  8913. <doc>
  8914. <![CDATA[Get the diagnostics.
  8915. @return diagnostics.]]>
  8916. </doc>
  8917. </method>
  8918. <doc>
  8919. <![CDATA[Represents the localization status of a resource.
  8920. The status of the localization includes:
  8921. <ul>
  8922. <li>resource key</li>
  8923. <li>{@link LocalizationState} of the resource</li>
  8924. </ul>]]>
  8925. </doc>
  8926. </class>
  8927. <!-- end class org.apache.hadoop.yarn.api.records.LocalizationStatus -->
  8928. <!-- start class org.apache.hadoop.yarn.api.records.LocalResource -->
  8929. <class name="LocalResource" extends="java.lang.Object"
  8930. abstract="true"
  8931. static="false" final="false" visibility="public"
  8932. deprecated="not deprecated">
  8933. <constructor name="LocalResource"
  8934. static="false" final="false" visibility="public"
  8935. deprecated="not deprecated">
  8936. </constructor>
  8937. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  8938. abstract="false" native="false" synchronized="false"
  8939. static="true" final="false" visibility="public"
  8940. deprecated="not deprecated">
  8941. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  8942. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  8943. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  8944. <param name="size" type="long"/>
  8945. <param name="timestamp" type="long"/>
  8946. <param name="pattern" type="java.lang.String"/>
  8947. </method>
  8948. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  8949. abstract="false" native="false" synchronized="false"
  8950. static="true" final="false" visibility="public"
  8951. deprecated="not deprecated">
  8952. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  8953. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  8954. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  8955. <param name="size" type="long"/>
  8956. <param name="timestamp" type="long"/>
  8957. <param name="pattern" type="java.lang.String"/>
  8958. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  8959. </method>
  8960. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  8961. abstract="false" native="false" synchronized="false"
  8962. static="true" final="false" visibility="public"
  8963. deprecated="not deprecated">
  8964. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  8965. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  8966. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  8967. <param name="size" type="long"/>
  8968. <param name="timestamp" type="long"/>
  8969. </method>
  8970. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  8971. abstract="false" native="false" synchronized="false"
  8972. static="true" final="false" visibility="public"
  8973. deprecated="not deprecated">
  8974. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  8975. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  8976. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  8977. <param name="size" type="long"/>
  8978. <param name="timestamp" type="long"/>
  8979. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  8980. </method>
  8981. <method name="getResource" return="org.apache.hadoop.yarn.api.records.URL"
  8982. abstract="true" native="false" synchronized="false"
  8983. static="false" final="false" visibility="public"
  8984. deprecated="not deprecated">
  8985. <doc>
  8986. <![CDATA[Get the <em>location</em> of the resource to be localized.
  8987. @return <em>location</em> of the resource to be localized]]>
  8988. </doc>
  8989. </method>
  8990. <method name="setResource"
  8991. abstract="true" native="false" synchronized="false"
  8992. static="false" final="false" visibility="public"
  8993. deprecated="not deprecated">
  8994. <param name="resource" type="org.apache.hadoop.yarn.api.records.URL"/>
  8995. <doc>
  8996. <![CDATA[Set <em>location</em> of the resource to be localized.
  8997. @param resource <em>location</em> of the resource to be localized]]>
  8998. </doc>
  8999. </method>
  9000. <method name="getSize" return="long"
  9001. abstract="true" native="false" synchronized="false"
  9002. static="false" final="false" visibility="public"
  9003. deprecated="not deprecated">
  9004. <doc>
  9005. <![CDATA[Get the <em>size</em> of the resource to be localized.
  9006. @return <em>size</em> of the resource to be localized]]>
  9007. </doc>
  9008. </method>
  9009. <method name="setSize"
  9010. abstract="true" native="false" synchronized="false"
  9011. static="false" final="false" visibility="public"
  9012. deprecated="not deprecated">
  9013. <param name="size" type="long"/>
  9014. <doc>
  9015. <![CDATA[Set the <em>size</em> of the resource to be localized.
  9016. @param size <em>size</em> of the resource to be localized]]>
  9017. </doc>
  9018. </method>
  9019. <method name="getTimestamp" return="long"
  9020. abstract="true" native="false" synchronized="false"
  9021. static="false" final="false" visibility="public"
  9022. deprecated="not deprecated">
  9023. <doc>
  9024. <![CDATA[Get the original <em>timestamp</em> of the resource to be localized, used
  9025. for verification.
  9026. @return <em>timestamp</em> of the resource to be localized]]>
  9027. </doc>
  9028. </method>
  9029. <method name="setTimestamp"
  9030. abstract="true" native="false" synchronized="false"
  9031. static="false" final="false" visibility="public"
  9032. deprecated="not deprecated">
  9033. <param name="timestamp" type="long"/>
  9034. <doc>
  9035. <![CDATA[Set the <em>timestamp</em> of the resource to be localized, used
  9036. for verification.
  9037. @param timestamp <em>timestamp</em> of the resource to be localized]]>
  9038. </doc>
  9039. </method>
  9040. <method name="getType" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
  9041. abstract="true" native="false" synchronized="false"
  9042. static="false" final="false" visibility="public"
  9043. deprecated="not deprecated">
  9044. <doc>
  9045. <![CDATA[Get the <code>LocalResourceType</code> of the resource to be localized.
  9046. @return <code>LocalResourceType</code> of the resource to be localized]]>
  9047. </doc>
  9048. </method>
  9049. <method name="setType"
  9050. abstract="true" native="false" synchronized="false"
  9051. static="false" final="false" visibility="public"
  9052. deprecated="not deprecated">
  9053. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  9054. <doc>
  9055. <![CDATA[Set the <code>LocalResourceType</code> of the resource to be localized.
  9056. @param type <code>LocalResourceType</code> of the resource to be localized]]>
  9057. </doc>
  9058. </method>
  9059. <method name="getVisibility" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
  9060. abstract="true" native="false" synchronized="false"
  9061. static="false" final="false" visibility="public"
  9062. deprecated="not deprecated">
  9063. <doc>
  9064. <![CDATA[Get the <code>LocalResourceVisibility</code> of the resource to be
  9065. localized.
  9066. @return <code>LocalResourceVisibility</code> of the resource to be
  9067. localized]]>
  9068. </doc>
  9069. </method>
  9070. <method name="setVisibility"
  9071. abstract="true" native="false" synchronized="false"
  9072. static="false" final="false" visibility="public"
  9073. deprecated="not deprecated">
  9074. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  9075. <doc>
  9076. <![CDATA[Set the <code>LocalResourceVisibility</code> of the resource to be
  9077. localized.
  9078. @param visibility <code>LocalResourceVisibility</code> of the resource to be
  9079. localized]]>
  9080. </doc>
  9081. </method>
  9082. <method name="getPattern" return="java.lang.String"
  9083. abstract="true" native="false" synchronized="false"
  9084. static="false" final="false" visibility="public"
  9085. deprecated="not deprecated">
  9086. <doc>
  9087. <![CDATA[Get the <em>pattern</em> that should be used to extract entries from the
  9088. archive (only used when type is <code>PATTERN</code>).
  9089. @return <em>pattern</em> that should be used to extract entries from the
  9090. archive.]]>
  9091. </doc>
  9092. </method>
  9093. <method name="setPattern"
  9094. abstract="true" native="false" synchronized="false"
  9095. static="false" final="false" visibility="public"
  9096. deprecated="not deprecated">
  9097. <param name="pattern" type="java.lang.String"/>
  9098. <doc>
  9099. <![CDATA[Set the <em>pattern</em> that should be used to extract entries from the
  9100. archive (only used when type is <code>PATTERN</code>).
  9101. @param pattern <em>pattern</em> that should be used to extract entries
  9102. from the archive.]]>
  9103. </doc>
  9104. </method>
  9105. <method name="getShouldBeUploadedToSharedCache" return="boolean"
  9106. abstract="true" native="false" synchronized="false"
  9107. static="false" final="false" visibility="public"
  9108. deprecated="not deprecated">
  9109. <doc>
  9110. <![CDATA[NM uses it to decide whether if it is necessary to upload the resource to
  9111. the shared cache
  9112. @return true if it is necessary to upload the resource
  9113. to the shared cache,
  9114. false otherwise]]>
  9115. </doc>
  9116. </method>
  9117. <method name="setShouldBeUploadedToSharedCache"
  9118. abstract="true" native="false" synchronized="false"
  9119. static="false" final="false" visibility="public"
  9120. deprecated="not deprecated">
  9121. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  9122. <doc>
  9123. <![CDATA[Inform NM whether upload to SCM is needed.
  9124. @param shouldBeUploadedToSharedCache <em>shouldBeUploadedToSharedCache</em>
  9125. of this request]]>
  9126. </doc>
  9127. </method>
  9128. <doc>
  9129. <![CDATA[<p><code>LocalResource</code> represents a local resource required to
  9130. run a container.</p>
  9131. <p>The <code>NodeManager</code> is responsible for localizing the resource
  9132. prior to launching the container.</p>
  9133. <p>Applications can specify {@link LocalResourceType} and
  9134. {@link LocalResourceVisibility}.</p>
  9135. @see LocalResourceType
  9136. @see LocalResourceVisibility
  9137. @see ContainerLaunchContext
  9138. @see ApplicationSubmissionContext
  9139. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  9140. </doc>
  9141. </class>
  9142. <!-- end class org.apache.hadoop.yarn.api.records.LocalResource -->
  9143. <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceType -->
  9144. <class name="LocalResourceType" extends="java.lang.Enum"
  9145. abstract="false"
  9146. static="false" final="true" visibility="public"
  9147. deprecated="not deprecated">
  9148. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceType[]"
  9149. abstract="false" native="false" synchronized="false"
  9150. static="true" final="false" visibility="public"
  9151. deprecated="not deprecated">
  9152. </method>
  9153. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
  9154. abstract="false" native="false" synchronized="false"
  9155. static="true" final="false" visibility="public"
  9156. deprecated="not deprecated">
  9157. <param name="name" type="java.lang.String"/>
  9158. </method>
  9159. <doc>
  9160. <![CDATA[{@code LocalResourceType} specifies the <em>type</em>
  9161. of a resource localized by the {@code NodeManager}.
  9162. <p>
  9163. The <em>type</em> can be one of:
  9164. <ul>
  9165. <li>
  9166. {@link #FILE} - Regular file i.e. uninterpreted bytes.
  9167. </li>
  9168. <li>
  9169. {@link #ARCHIVE} - Archive, which is automatically unarchived by the
  9170. <code>NodeManager</code>.
  9171. </li>
  9172. <li>
  9173. {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}.
  9174. </li>
  9175. </ul>
  9176. @see LocalResource
  9177. @see ContainerLaunchContext
  9178. @see ApplicationSubmissionContext
  9179. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  9180. </doc>
  9181. </class>
  9182. <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceType -->
  9183. <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
  9184. <class name="LocalResourceVisibility" extends="java.lang.Enum"
  9185. abstract="false"
  9186. static="false" final="true" visibility="public"
  9187. deprecated="not deprecated">
  9188. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility[]"
  9189. abstract="false" native="false" synchronized="false"
  9190. static="true" final="false" visibility="public"
  9191. deprecated="not deprecated">
  9192. </method>
  9193. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
  9194. abstract="false" native="false" synchronized="false"
  9195. static="true" final="false" visibility="public"
  9196. deprecated="not deprecated">
  9197. <param name="name" type="java.lang.String"/>
  9198. </method>
  9199. <doc>
  9200. <![CDATA[{@code LocalResourceVisibility} specifies the <em>visibility</em>
  9201. of a resource localized by the {@code NodeManager}.
  9202. <p>
  9203. The <em>visibility</em> can be one of:
  9204. <ul>
  9205. <li>{@link #PUBLIC} - Shared by all users on the node.</li>
  9206. <li>
  9207. {@link #PRIVATE} - Shared among all applications of the
  9208. <em>same user</em> on the node.
  9209. </li>
  9210. <li>
  9211. {@link #APPLICATION} - Shared only among containers of the
  9212. <em>same application</em> on the node.
  9213. </li>
  9214. </ul>
  9215. @see LocalResource
  9216. @see ContainerLaunchContext
  9217. @see ApplicationSubmissionContext
  9218. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  9219. </doc>
  9220. </class>
  9221. <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
  9222. <!-- start class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
  9223. <class name="LogAggregationContext" extends="java.lang.Object"
  9224. abstract="true"
  9225. static="false" final="false" visibility="public"
  9226. deprecated="not deprecated">
  9227. <constructor name="LogAggregationContext"
  9228. static="false" final="false" visibility="public"
  9229. deprecated="not deprecated">
  9230. </constructor>
  9231. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  9232. abstract="false" native="false" synchronized="false"
  9233. static="true" final="false" visibility="public"
  9234. deprecated="not deprecated">
  9235. <param name="includePattern" type="java.lang.String"/>
  9236. <param name="excludePattern" type="java.lang.String"/>
  9237. </method>
  9238. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  9239. abstract="false" native="false" synchronized="false"
  9240. static="true" final="false" visibility="public"
  9241. deprecated="not deprecated">
  9242. <param name="includePattern" type="java.lang.String"/>
  9243. <param name="excludePattern" type="java.lang.String"/>
  9244. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  9245. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  9246. </method>
  9247. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  9248. abstract="false" native="false" synchronized="false"
  9249. static="true" final="false" visibility="public"
  9250. deprecated="not deprecated">
  9251. <param name="includePattern" type="java.lang.String"/>
  9252. <param name="excludePattern" type="java.lang.String"/>
  9253. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  9254. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  9255. <param name="policyClassName" type="java.lang.String"/>
  9256. <param name="policyParameters" type="java.lang.String"/>
  9257. </method>
  9258. <method name="getIncludePattern" return="java.lang.String"
  9259. abstract="true" native="false" synchronized="false"
  9260. static="false" final="false" visibility="public"
  9261. deprecated="not deprecated">
  9262. <doc>
  9263. <![CDATA[Get include pattern. This includePattern only takes affect
  9264. on logs that exist at the time of application finish.
  9265. @return include pattern]]>
  9266. </doc>
  9267. </method>
  9268. <method name="setIncludePattern"
  9269. abstract="true" native="false" synchronized="false"
  9270. static="false" final="false" visibility="public"
  9271. deprecated="not deprecated">
  9272. <param name="includePattern" type="java.lang.String"/>
  9273. <doc>
  9274. <![CDATA[Set include pattern. This includePattern only takes affect
  9275. on logs that exist at the time of application finish.
  9276. @param includePattern]]>
  9277. </doc>
  9278. </method>
  9279. <method name="getExcludePattern" return="java.lang.String"
  9280. abstract="true" native="false" synchronized="false"
  9281. static="false" final="false" visibility="public"
  9282. deprecated="not deprecated">
  9283. <doc>
  9284. <![CDATA[Get exclude pattern. This excludePattern only takes affect
  9285. on logs that exist at the time of application finish.
  9286. @return exclude pattern]]>
  9287. </doc>
  9288. </method>
  9289. <method name="setExcludePattern"
  9290. abstract="true" native="false" synchronized="false"
  9291. static="false" final="false" visibility="public"
  9292. deprecated="not deprecated">
  9293. <param name="excludePattern" type="java.lang.String"/>
  9294. <doc>
  9295. <![CDATA[Set exclude pattern. This excludePattern only takes affect
  9296. on logs that exist at the time of application finish.
  9297. @param excludePattern]]>
  9298. </doc>
  9299. </method>
  9300. <method name="getRolledLogsIncludePattern" return="java.lang.String"
  9301. abstract="true" native="false" synchronized="false"
  9302. static="false" final="false" visibility="public"
  9303. deprecated="not deprecated">
  9304. <doc>
  9305. <![CDATA[Get include pattern in a rolling fashion.
  9306. @return include pattern]]>
  9307. </doc>
  9308. </method>
  9309. <method name="setRolledLogsIncludePattern"
  9310. abstract="true" native="false" synchronized="false"
  9311. static="false" final="false" visibility="public"
  9312. deprecated="not deprecated">
  9313. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  9314. <doc>
  9315. <![CDATA[Set include pattern in a rolling fashion.
  9316. @param rolledLogsIncludePattern]]>
  9317. </doc>
  9318. </method>
  9319. <method name="getRolledLogsExcludePattern" return="java.lang.String"
  9320. abstract="true" native="false" synchronized="false"
  9321. static="false" final="false" visibility="public"
  9322. deprecated="not deprecated">
  9323. <doc>
  9324. <![CDATA[Get exclude pattern for aggregation in a rolling fashion.
  9325. @return exclude pattern]]>
  9326. </doc>
  9327. </method>
  9328. <method name="setRolledLogsExcludePattern"
  9329. abstract="true" native="false" synchronized="false"
  9330. static="false" final="false" visibility="public"
  9331. deprecated="not deprecated">
  9332. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  9333. <doc>
  9334. <![CDATA[Set exclude pattern for in a rolling fashion.
  9335. @param rolledLogsExcludePattern]]>
  9336. </doc>
  9337. </method>
  9338. <method name="getLogAggregationPolicyClassName" return="java.lang.String"
  9339. abstract="true" native="false" synchronized="false"
  9340. static="false" final="false" visibility="public"
  9341. deprecated="not deprecated">
  9342. <doc>
  9343. <![CDATA[Get the log aggregation policy class.
  9344. @return log aggregation policy class]]>
  9345. </doc>
  9346. </method>
  9347. <method name="setLogAggregationPolicyClassName"
  9348. abstract="true" native="false" synchronized="false"
  9349. static="false" final="false" visibility="public"
  9350. deprecated="not deprecated">
  9351. <param name="className" type="java.lang.String"/>
  9352. <doc>
  9353. <![CDATA[Set the log aggregation policy class.
  9354. @param className]]>
  9355. </doc>
  9356. </method>
  9357. <method name="getLogAggregationPolicyParameters" return="java.lang.String"
  9358. abstract="true" native="false" synchronized="false"
  9359. static="false" final="false" visibility="public"
  9360. deprecated="not deprecated">
  9361. <doc>
  9362. <![CDATA[Get the log aggregation policy parameters.
  9363. @return log aggregation policy parameters]]>
  9364. </doc>
  9365. </method>
  9366. <method name="setLogAggregationPolicyParameters"
  9367. abstract="true" native="false" synchronized="false"
  9368. static="false" final="false" visibility="public"
  9369. deprecated="not deprecated">
  9370. <param name="parameters" type="java.lang.String"/>
  9371. <doc>
  9372. <![CDATA[Set the log aggregation policy parameters.
  9373. There is no schema defined for the parameters string.
  9374. It is up to the log aggregation policy class to decide how to parse
  9375. the parameters string.
  9376. @param parameters]]>
  9377. </doc>
  9378. </method>
  9379. <doc>
  9380. <![CDATA[{@code LogAggregationContext} represents all of the
  9381. information needed by the {@code NodeManager} to handle
  9382. the logs for an application.
  9383. <p>
  9384. It includes details such as:
  9385. <ul>
  9386. <li>
  9387. includePattern. It uses Java Regex to filter the log files
  9388. which match the defined include pattern and those log files
  9389. will be uploaded when the application finishes.
  9390. </li>
  9391. <li>
  9392. excludePattern. It uses Java Regex to filter the log files
  9393. which match the defined exclude pattern and those log files
  9394. will not be uploaded when application finishes. If the log file
  9395. name matches both the include and the exclude pattern, this file
  9396. will be excluded eventually.
  9397. </li>
  9398. <li>
  9399. rolledLogsIncludePattern. It uses Java Regex to filter the log files
  9400. which match the defined include pattern and those log files
  9401. will be aggregated in a rolling fashion.
  9402. </li>
  9403. <li>
  9404. rolledLogsExcludePattern. It uses Java Regex to filter the log files
  9405. which match the defined exclude pattern and those log files
  9406. will not be aggregated in a rolling fashion. If the log file
  9407. name matches both the include and the exclude pattern, this file
  9408. will be excluded eventually.
  9409. </li>
  9410. <li>
  9411. policyClassName. The policy class name that implements
  9412. ContainerLogAggregationPolicy. At runtime, nodemanager will the policy
  9413. if a given container's log should be aggregated based on the
  9414. ContainerType and other runtime state such as exit code by calling
  9415. ContainerLogAggregationPolicy#shouldDoLogAggregation.
  9416. This is useful when the app only wants to aggregate logs of a subset of
  9417. containers. Here are the available policies. Please make sure to specify
  9418. the canonical name by prefixing org.apache.hadoop.yarn.server.
  9419. nodemanager.containermanager.logaggregation.
  9420. to the class simple name below.
  9421. NoneContainerLogAggregationPolicy: skip aggregation for all containers.
  9422. AllContainerLogAggregationPolicy: aggregate all containers.
  9423. AMOrFailedContainerLogAggregationPolicy: aggregate application master
  9424. or failed containers.
  9425. FailedOrKilledContainerLogAggregationPolicy: aggregate failed or killed
  9426. containers
  9427. FailedContainerLogAggregationPolicy: aggregate failed containers
  9428. AMOnlyLogAggregationPolicy: aggregate application master containers
  9429. SampleContainerLogAggregationPolicy: sample logs of successful worker
  9430. containers, in addition to application master and failed/killed
  9431. containers.
  9432. LimitSizeContainerLogAggregationPolicy: skip aggregation for killed
  9433. containers whose log size exceeds the limit of container log size.
  9434. If it isn't specified, it will use the cluster-wide default policy
  9435. defined by configuration yarn.nodemanager.log-aggregation.policy.class.
  9436. The default value of yarn.nodemanager.log-aggregation.policy.class is
  9437. AllContainerLogAggregationPolicy.
  9438. </li>
  9439. <li>
  9440. policyParameters. The parameters passed to the policy class via
  9441. ContainerLogAggregationPolicy#parseParameters during the policy object
  9442. initialization. This is optional. Some policy class might use parameters
  9443. to adjust its settings. It is up to policy class to define the scheme of
  9444. parameters.
  9445. For example, SampleContainerLogAggregationPolicy supports the format of
  9446. "SR:0.5,MIN:50", which means sample rate of 50% beyond the first 50
  9447. successful worker containers.
  9448. </li>
  9449. </ul>
  9450. @see ApplicationSubmissionContext]]>
  9451. </doc>
  9452. </class>
  9453. <!-- end class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
  9454. <!-- start class org.apache.hadoop.yarn.api.records.NMToken -->
  9455. <class name="NMToken" extends="java.lang.Object"
  9456. abstract="true"
  9457. static="false" final="false" visibility="public"
  9458. deprecated="not deprecated">
  9459. <constructor name="NMToken"
  9460. static="false" final="false" visibility="public"
  9461. deprecated="not deprecated">
  9462. </constructor>
  9463. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  9464. abstract="true" native="false" synchronized="false"
  9465. static="false" final="false" visibility="public"
  9466. deprecated="not deprecated">
  9467. <doc>
  9468. <![CDATA[Get the {@link NodeId} of the <code>NodeManager</code> for which the NMToken
  9469. is used to authenticate.
  9470. @return the {@link NodeId} of the <code>NodeManager</code> for which the
  9471. NMToken is used to authenticate.]]>
  9472. </doc>
  9473. </method>
  9474. <method name="setNodeId"
  9475. abstract="true" native="false" synchronized="false"
  9476. static="false" final="false" visibility="public"
  9477. deprecated="not deprecated">
  9478. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  9479. </method>
  9480. <method name="getToken" return="org.apache.hadoop.yarn.api.records.Token"
  9481. abstract="true" native="false" synchronized="false"
  9482. static="false" final="false" visibility="public"
  9483. deprecated="not deprecated">
  9484. <doc>
  9485. <![CDATA[Get the {@link Token} used for authenticating with <code>NodeManager</code>
  9486. @return the {@link Token} used for authenticating with <code>NodeManager</code>]]>
  9487. </doc>
  9488. </method>
  9489. <method name="setToken"
  9490. abstract="true" native="false" synchronized="false"
  9491. static="false" final="false" visibility="public"
  9492. deprecated="not deprecated">
  9493. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  9494. </method>
  9495. <method name="hashCode" return="int"
  9496. abstract="false" native="false" synchronized="false"
  9497. static="false" final="false" visibility="public"
  9498. deprecated="not deprecated">
  9499. </method>
  9500. <method name="equals" return="boolean"
  9501. abstract="false" native="false" synchronized="false"
  9502. static="false" final="false" visibility="public"
  9503. deprecated="not deprecated">
  9504. <param name="obj" type="java.lang.Object"/>
  9505. </method>
  9506. <doc>
  9507. <![CDATA[<p>The NMToken is used for authenticating communication with
  9508. <code>NodeManager</code></p>
  9509. <p>It is issued by <code>ResourceMananger</code> when <code>ApplicationMaster</code>
  9510. negotiates resource with <code>ResourceManager</code> and
  9511. validated on <code>NodeManager</code> side.</p>
  9512. @see AllocateResponse#getNMTokens()]]>
  9513. </doc>
  9514. </class>
  9515. <!-- end class org.apache.hadoop.yarn.api.records.NMToken -->
  9516. <!-- start class org.apache.hadoop.yarn.api.records.NodeAttribute -->
  9517. <class name="NodeAttribute" extends="java.lang.Object"
  9518. abstract="true"
  9519. static="false" final="false" visibility="public"
  9520. deprecated="not deprecated">
  9521. <constructor name="NodeAttribute"
  9522. static="false" final="false" visibility="public"
  9523. deprecated="not deprecated">
  9524. </constructor>
  9525. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttribute"
  9526. abstract="false" native="false" synchronized="false"
  9527. static="true" final="false" visibility="public"
  9528. deprecated="not deprecated">
  9529. <param name="attributeName" type="java.lang.String"/>
  9530. <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
  9531. <param name="attributeValue" type="java.lang.String"/>
  9532. </method>
  9533. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttribute"
  9534. abstract="false" native="false" synchronized="false"
  9535. static="true" final="false" visibility="public"
  9536. deprecated="not deprecated">
  9537. <param name="attributePrefix" type="java.lang.String"/>
  9538. <param name="attributeName" type="java.lang.String"/>
  9539. <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
  9540. <param name="attributeValue" type="java.lang.String"/>
  9541. </method>
  9542. <method name="getAttributeKey" return="org.apache.hadoop.yarn.api.records.NodeAttributeKey"
  9543. abstract="true" native="false" synchronized="false"
  9544. static="false" final="false" visibility="public"
  9545. deprecated="not deprecated">
  9546. </method>
  9547. <method name="setAttributeKey"
  9548. abstract="true" native="false" synchronized="false"
  9549. static="false" final="false" visibility="public"
  9550. deprecated="not deprecated">
  9551. <param name="attributeKey" type="org.apache.hadoop.yarn.api.records.NodeAttributeKey"/>
  9552. </method>
  9553. <method name="getAttributeValue" return="java.lang.String"
  9554. abstract="true" native="false" synchronized="false"
  9555. static="false" final="false" visibility="public"
  9556. deprecated="not deprecated">
  9557. </method>
  9558. <method name="setAttributeValue"
  9559. abstract="true" native="false" synchronized="false"
  9560. static="false" final="false" visibility="public"
  9561. deprecated="not deprecated">
  9562. <param name="attributeValue" type="java.lang.String"/>
  9563. </method>
  9564. <method name="getAttributeType" return="org.apache.hadoop.yarn.api.records.NodeAttributeType"
  9565. abstract="true" native="false" synchronized="false"
  9566. static="false" final="false" visibility="public"
  9567. deprecated="not deprecated">
  9568. </method>
  9569. <method name="setAttributeType"
  9570. abstract="true" native="false" synchronized="false"
  9571. static="false" final="false" visibility="public"
  9572. deprecated="not deprecated">
  9573. <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
  9574. </method>
  9575. <field name="PREFIX_DISTRIBUTED" type="java.lang.String"
  9576. transient="false" volatile="false"
  9577. static="true" final="true" visibility="public"
  9578. deprecated="not deprecated">
  9579. </field>
  9580. <field name="PREFIX_CENTRALIZED" type="java.lang.String"
  9581. transient="false" volatile="false"
  9582. static="true" final="true" visibility="public"
  9583. deprecated="not deprecated">
  9584. </field>
  9585. <doc>
  9586. <![CDATA[<p>
  9587. Node Attribute is a kind of a label which represents one of the
  9588. attribute/feature of a Node. Its different from node partition label as
  9589. resource guarantees across the queues will not be maintained for these type
  9590. of labels.
  9591. </p>
  9592. <p>
  9593. A given Node can be mapped with any kind of attribute, few examples are
  9594. HAS_SSD=true, JAVA_VERSION=JDK1.8, OS_TYPE=WINDOWS.
  9595. </p>
  9596. <p>
  9597. Its not compulsory for all the attributes to have value, empty string is the
  9598. default value of the <code>NodeAttributeType.STRING</code>
  9599. </p>
  9600. <p>
  9601. Node Attribute Prefix is used as namespace to segregate the attributes.
  9602. </p>]]>
  9603. </doc>
  9604. </class>
  9605. <!-- end class org.apache.hadoop.yarn.api.records.NodeAttribute -->
  9606. <!-- start class org.apache.hadoop.yarn.api.records.NodeAttributeInfo -->
  9607. <class name="NodeAttributeInfo" extends="java.lang.Object"
  9608. abstract="true"
  9609. static="false" final="false" visibility="public"
  9610. deprecated="not deprecated">
  9611. <constructor name="NodeAttributeInfo"
  9612. static="false" final="false" visibility="public"
  9613. deprecated="not deprecated">
  9614. </constructor>
  9615. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttributeInfo"
  9616. abstract="false" native="false" synchronized="false"
  9617. static="true" final="false" visibility="public"
  9618. deprecated="not deprecated">
  9619. <param name="nodeAttribute" type="org.apache.hadoop.yarn.api.records.NodeAttribute"/>
  9620. </method>
  9621. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttributeInfo"
  9622. abstract="false" native="false" synchronized="false"
  9623. static="true" final="false" visibility="public"
  9624. deprecated="not deprecated">
  9625. <param name="nodeAttributeKey" type="org.apache.hadoop.yarn.api.records.NodeAttributeKey"/>
  9626. <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
  9627. </method>
  9628. <method name="getAttributeKey" return="org.apache.hadoop.yarn.api.records.NodeAttributeKey"
  9629. abstract="true" native="false" synchronized="false"
  9630. static="false" final="false" visibility="public"
  9631. deprecated="not deprecated">
  9632. </method>
  9633. <method name="setAttributeKey"
  9634. abstract="true" native="false" synchronized="false"
  9635. static="false" final="false" visibility="public"
  9636. deprecated="not deprecated">
  9637. <param name="attributeKey" type="org.apache.hadoop.yarn.api.records.NodeAttributeKey"/>
  9638. </method>
  9639. <method name="getAttributeType" return="org.apache.hadoop.yarn.api.records.NodeAttributeType"
  9640. abstract="true" native="false" synchronized="false"
  9641. static="false" final="false" visibility="public"
  9642. deprecated="not deprecated">
  9643. </method>
  9644. <method name="setAttributeType"
  9645. abstract="true" native="false" synchronized="false"
  9646. static="false" final="false" visibility="public"
  9647. deprecated="not deprecated">
  9648. <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
  9649. </method>
  9650. <doc>
  9651. <![CDATA[<p>
  9652. Node Attribute Info describes a NodeAttribute.
  9653. </p>]]>
  9654. </doc>
  9655. </class>
  9656. <!-- end class org.apache.hadoop.yarn.api.records.NodeAttributeInfo -->
  9657. <!-- start class org.apache.hadoop.yarn.api.records.NodeAttributeKey -->
  9658. <class name="NodeAttributeKey" extends="java.lang.Object"
  9659. abstract="true"
  9660. static="false" final="false" visibility="public"
  9661. deprecated="not deprecated">
  9662. <constructor name="NodeAttributeKey"
  9663. static="false" final="false" visibility="public"
  9664. deprecated="not deprecated">
  9665. </constructor>
  9666. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttributeKey"
  9667. abstract="false" native="false" synchronized="false"
  9668. static="true" final="false" visibility="public"
  9669. deprecated="not deprecated">
  9670. <param name="attributeName" type="java.lang.String"/>
  9671. </method>
  9672. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttributeKey"
  9673. abstract="false" native="false" synchronized="false"
  9674. static="true" final="false" visibility="public"
  9675. deprecated="not deprecated">
  9676. <param name="attributePrefix" type="java.lang.String"/>
  9677. <param name="attributeName" type="java.lang.String"/>
  9678. </method>
  9679. <method name="getAttributePrefix" return="java.lang.String"
  9680. abstract="true" native="false" synchronized="false"
  9681. static="false" final="false" visibility="public"
  9682. deprecated="not deprecated">
  9683. </method>
  9684. <method name="setAttributePrefix"
  9685. abstract="true" native="false" synchronized="false"
  9686. static="false" final="false" visibility="public"
  9687. deprecated="not deprecated">
  9688. <param name="attributePrefix" type="java.lang.String"/>
  9689. </method>
  9690. <method name="getAttributeName" return="java.lang.String"
  9691. abstract="true" native="false" synchronized="false"
  9692. static="false" final="false" visibility="public"
  9693. deprecated="not deprecated">
  9694. </method>
  9695. <method name="setAttributeName"
  9696. abstract="true" native="false" synchronized="false"
  9697. static="false" final="false" visibility="public"
  9698. deprecated="not deprecated">
  9699. <param name="attributeName" type="java.lang.String"/>
  9700. </method>
  9701. <doc>
  9702. <![CDATA[<p>
  9703. Node AttributeKey uniquely identifies a given Node Attribute. Node Attribute
  9704. is identified based on attribute prefix and name.
  9705. </p>
  9706. <p>
  9707. Node Attribute Prefix is used as namespace to segregate the attributes.
  9708. </p>]]>
  9709. </doc>
  9710. </class>
  9711. <!-- end class org.apache.hadoop.yarn.api.records.NodeAttributeKey -->
  9712. <!-- start class org.apache.hadoop.yarn.api.records.NodeAttributeOpCode -->
  9713. <class name="NodeAttributeOpCode" extends="java.lang.Enum"
  9714. abstract="false"
  9715. static="false" final="true" visibility="public"
  9716. deprecated="not deprecated">
  9717. <method name="values" return="org.apache.hadoop.yarn.api.records.NodeAttributeOpCode[]"
  9718. abstract="false" native="false" synchronized="false"
  9719. static="true" final="false" visibility="public"
  9720. deprecated="not deprecated">
  9721. </method>
  9722. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.NodeAttributeOpCode"
  9723. abstract="false" native="false" synchronized="false"
  9724. static="true" final="false" visibility="public"
  9725. deprecated="not deprecated">
  9726. <param name="name" type="java.lang.String"/>
  9727. </method>
  9728. <doc>
  9729. <![CDATA[Enumeration of various node attribute op codes.]]>
  9730. </doc>
  9731. </class>
  9732. <!-- end class org.apache.hadoop.yarn.api.records.NodeAttributeOpCode -->
  9733. <!-- start class org.apache.hadoop.yarn.api.records.NodeAttributeType -->
  9734. <class name="NodeAttributeType" extends="java.lang.Enum"
  9735. abstract="false"
  9736. static="false" final="true" visibility="public"
  9737. deprecated="not deprecated">
  9738. <method name="values" return="org.apache.hadoop.yarn.api.records.NodeAttributeType[]"
  9739. abstract="false" native="false" synchronized="false"
  9740. static="true" final="false" visibility="public"
  9741. deprecated="not deprecated">
  9742. </method>
  9743. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.NodeAttributeType"
  9744. abstract="false" native="false" synchronized="false"
  9745. static="true" final="false" visibility="public"
  9746. deprecated="not deprecated">
  9747. <param name="name" type="java.lang.String"/>
  9748. </method>
  9749. <doc>
  9750. <![CDATA[<p>
  9751. Type of a <code>node Attribute</code>.
  9752. </p>
  9753. Based on this attribute expressions and values will be evaluated.]]>
  9754. </doc>
  9755. </class>
  9756. <!-- end class org.apache.hadoop.yarn.api.records.NodeAttributeType -->
  9757. <!-- start class org.apache.hadoop.yarn.api.records.NodeId -->
  9758. <class name="NodeId" extends="java.lang.Object"
  9759. abstract="true"
  9760. static="false" final="false" visibility="public"
  9761. deprecated="not deprecated">
  9762. <implements name="java.lang.Comparable"/>
  9763. <constructor name="NodeId"
  9764. static="false" final="false" visibility="public"
  9765. deprecated="not deprecated">
  9766. </constructor>
  9767. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeId"
  9768. abstract="false" native="false" synchronized="false"
  9769. static="true" final="false" visibility="public"
  9770. deprecated="not deprecated">
  9771. <param name="host" type="java.lang.String"/>
  9772. <param name="port" type="int"/>
  9773. </method>
  9774. <method name="getHost" return="java.lang.String"
  9775. abstract="true" native="false" synchronized="false"
  9776. static="false" final="false" visibility="public"
  9777. deprecated="not deprecated">
  9778. <doc>
  9779. <![CDATA[Get the <em>hostname</em> of the node.
  9780. @return <em>hostname</em> of the node]]>
  9781. </doc>
  9782. </method>
  9783. <method name="getPort" return="int"
  9784. abstract="true" native="false" synchronized="false"
  9785. static="false" final="false" visibility="public"
  9786. deprecated="not deprecated">
  9787. <doc>
  9788. <![CDATA[Get the <em>port</em> for communicating with the node.
  9789. @return <em>port</em> for communicating with the node]]>
  9790. </doc>
  9791. </method>
  9792. <method name="toString" return="java.lang.String"
  9793. abstract="false" native="false" synchronized="false"
  9794. static="false" final="false" visibility="public"
  9795. deprecated="not deprecated">
  9796. </method>
  9797. <method name="hashCode" return="int"
  9798. abstract="false" native="false" synchronized="false"
  9799. static="false" final="false" visibility="public"
  9800. deprecated="not deprecated">
  9801. </method>
  9802. <method name="equals" return="boolean"
  9803. abstract="false" native="false" synchronized="false"
  9804. static="false" final="false" visibility="public"
  9805. deprecated="not deprecated">
  9806. <param name="obj" type="java.lang.Object"/>
  9807. </method>
  9808. <method name="compareTo" return="int"
  9809. abstract="false" native="false" synchronized="false"
  9810. static="false" final="false" visibility="public"
  9811. deprecated="not deprecated">
  9812. <param name="other" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  9813. </method>
  9814. <method name="fromString" return="org.apache.hadoop.yarn.api.records.NodeId"
  9815. abstract="false" native="false" synchronized="false"
  9816. static="true" final="false" visibility="public"
  9817. deprecated="not deprecated">
  9818. <param name="nodeIdStr" type="java.lang.String"/>
  9819. </method>
  9820. <method name="build"
  9821. abstract="true" native="false" synchronized="false"
  9822. static="false" final="false" visibility="protected"
  9823. deprecated="not deprecated">
  9824. </method>
  9825. <doc>
  9826. <![CDATA[<p><code>NodeId</code> is the unique identifier for a node.</p>
  9827. <p>It includes the <em>hostname</em> and <em>port</em> to uniquely
  9828. identify the node. Thus, it is unique across restarts of any
  9829. <code>NodeManager</code>.</p>]]>
  9830. </doc>
  9831. </class>
  9832. <!-- end class org.apache.hadoop.yarn.api.records.NodeId -->
  9833. <!-- start class org.apache.hadoop.yarn.api.records.NodeLabel -->
  9834. <class name="NodeLabel" extends="java.lang.Object"
  9835. abstract="true"
  9836. static="false" final="false" visibility="public"
  9837. deprecated="not deprecated">
  9838. <implements name="java.lang.Comparable"/>
  9839. <constructor name="NodeLabel"
  9840. static="false" final="false" visibility="public"
  9841. deprecated="not deprecated">
  9842. </constructor>
  9843. <method name="getName" return="java.lang.String"
  9844. abstract="true" native="false" synchronized="false"
  9845. static="false" final="false" visibility="public"
  9846. deprecated="not deprecated">
  9847. </method>
  9848. <method name="isExclusive" return="boolean"
  9849. abstract="true" native="false" synchronized="false"
  9850. static="false" final="false" visibility="public"
  9851. deprecated="not deprecated">
  9852. </method>
  9853. <method name="compareTo" return="int"
  9854. abstract="false" native="false" synchronized="false"
  9855. static="false" final="false" visibility="public"
  9856. deprecated="not deprecated">
  9857. <param name="other" type="org.apache.hadoop.yarn.api.records.NodeLabel"/>
  9858. </method>
  9859. <method name="equals" return="boolean"
  9860. abstract="false" native="false" synchronized="false"
  9861. static="false" final="false" visibility="public"
  9862. deprecated="not deprecated">
  9863. <param name="obj" type="java.lang.Object"/>
  9864. </method>
  9865. <method name="toString" return="java.lang.String"
  9866. abstract="false" native="false" synchronized="false"
  9867. static="false" final="false" visibility="public"
  9868. deprecated="not deprecated">
  9869. </method>
  9870. <method name="hashCode" return="int"
  9871. abstract="false" native="false" synchronized="false"
  9872. static="false" final="false" visibility="public"
  9873. deprecated="not deprecated">
  9874. </method>
  9875. <field name="DEFAULT_NODE_LABEL_PARTITION" type="java.lang.String"
  9876. transient="false" volatile="false"
  9877. static="true" final="true" visibility="public"
  9878. deprecated="not deprecated">
  9879. <doc>
  9880. <![CDATA[Default node label partition used for displaying.]]>
  9881. </doc>
  9882. </field>
  9883. <field name="NODE_LABEL_EXPRESSION_NOT_SET" type="java.lang.String"
  9884. transient="false" volatile="false"
  9885. static="true" final="true" visibility="public"
  9886. deprecated="not deprecated">
  9887. <doc>
  9888. <![CDATA[Node Label expression not set .]]>
  9889. </doc>
  9890. </field>
  9891. <field name="DEFAULT_NODE_LABEL_EXCLUSIVITY" type="boolean"
  9892. transient="false" volatile="false"
  9893. static="true" final="true" visibility="public"
  9894. deprecated="not deprecated">
  9895. <doc>
  9896. <![CDATA[By default, node label is exclusive or not]]>
  9897. </doc>
  9898. </field>
  9899. </class>
  9900. <!-- end class org.apache.hadoop.yarn.api.records.NodeLabel -->
  9901. <!-- start class org.apache.hadoop.yarn.api.records.NodeReport -->
  9902. <class name="NodeReport" extends="java.lang.Object"
  9903. abstract="true"
  9904. static="false" final="false" visibility="public"
  9905. deprecated="not deprecated">
  9906. <constructor name="NodeReport"
  9907. static="false" final="false" visibility="public"
  9908. deprecated="not deprecated">
  9909. </constructor>
  9910. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  9911. abstract="true" native="false" synchronized="false"
  9912. static="false" final="false" visibility="public"
  9913. deprecated="not deprecated">
  9914. <doc>
  9915. <![CDATA[Get the <code>NodeId</code> of the node.
  9916. @return <code>NodeId</code> of the node]]>
  9917. </doc>
  9918. </method>
  9919. <method name="getNodeState" return="org.apache.hadoop.yarn.api.records.NodeState"
  9920. abstract="true" native="false" synchronized="false"
  9921. static="false" final="false" visibility="public"
  9922. deprecated="not deprecated">
  9923. <doc>
  9924. <![CDATA[Get the <code>NodeState</code> of the node.
  9925. @return <code>NodeState</code> of the node]]>
  9926. </doc>
  9927. </method>
  9928. <method name="getHttpAddress" return="java.lang.String"
  9929. abstract="true" native="false" synchronized="false"
  9930. static="false" final="false" visibility="public"
  9931. deprecated="not deprecated">
  9932. <doc>
  9933. <![CDATA[Get the <em>http address</em> of the node.
  9934. @return <em>http address</em> of the node]]>
  9935. </doc>
  9936. </method>
  9937. <method name="getRackName" return="java.lang.String"
  9938. abstract="true" native="false" synchronized="false"
  9939. static="false" final="false" visibility="public"
  9940. deprecated="not deprecated">
  9941. <doc>
  9942. <![CDATA[Get the <em>rack name</em> for the node.
  9943. @return <em>rack name</em> for the node]]>
  9944. </doc>
  9945. </method>
  9946. <method name="getUsed" return="org.apache.hadoop.yarn.api.records.Resource"
  9947. abstract="true" native="false" synchronized="false"
  9948. static="false" final="false" visibility="public"
  9949. deprecated="not deprecated">
  9950. <doc>
  9951. <![CDATA[Get <em>used</em> <code>Resource</code> on the node.
  9952. @return <em>used</em> <code>Resource</code> on the node]]>
  9953. </doc>
  9954. </method>
  9955. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  9956. abstract="true" native="false" synchronized="false"
  9957. static="false" final="false" visibility="public"
  9958. deprecated="not deprecated">
  9959. <doc>
  9960. <![CDATA[Get the <em>total</em> <code>Resource</code> on the node.
  9961. @return <em>total</em> <code>Resource</code> on the node]]>
  9962. </doc>
  9963. </method>
  9964. <method name="getHealthReport" return="java.lang.String"
  9965. abstract="true" native="false" synchronized="false"
  9966. static="false" final="false" visibility="public"
  9967. deprecated="not deprecated">
  9968. <doc>
  9969. <![CDATA[Get the <em>diagnostic health report</em> of the node.
  9970. @return <em>diagnostic health report</em> of the node]]>
  9971. </doc>
  9972. </method>
  9973. <method name="getLastHealthReportTime" return="long"
  9974. abstract="true" native="false" synchronized="false"
  9975. static="false" final="false" visibility="public"
  9976. deprecated="not deprecated">
  9977. <doc>
  9978. <![CDATA[Get the <em>last timestamp</em> at which the health report was received.
  9979. @return <em>last timestamp</em> at which the health report was received]]>
  9980. </doc>
  9981. </method>
  9982. <method name="getNodeLabels" return="java.util.Set"
  9983. abstract="true" native="false" synchronized="false"
  9984. static="false" final="false" visibility="public"
  9985. deprecated="not deprecated">
  9986. <doc>
  9987. <![CDATA[Get labels of this node.
  9988. @return labels of this node.]]>
  9989. </doc>
  9990. </method>
  9991. <method name="getAggregatedContainersUtilization" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  9992. abstract="false" native="false" synchronized="false"
  9993. static="false" final="false" visibility="public"
  9994. deprecated="not deprecated">
  9995. <doc>
  9996. <![CDATA[Get containers aggregated resource utilization in a node.
  9997. @return containers resource utilization.]]>
  9998. </doc>
  9999. </method>
  10000. <method name="getNodeUtilization" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  10001. abstract="true" native="false" synchronized="false"
  10002. static="false" final="false" visibility="public"
  10003. deprecated="not deprecated">
  10004. <doc>
  10005. <![CDATA[Get node resource utilization.
  10006. @return node resource utilization.]]>
  10007. </doc>
  10008. </method>
  10009. <method name="getDecommissioningTimeout" return="java.lang.Integer"
  10010. abstract="false" native="false" synchronized="false"
  10011. static="false" final="false" visibility="public"
  10012. deprecated="not deprecated">
  10013. <doc>
  10014. <![CDATA[Optional decommissioning timeout in seconds (null indicates absent
  10015. timeout).
  10016. @return the decommissioning timeout in second.]]>
  10017. </doc>
  10018. </method>
  10019. <method name="setDecommissioningTimeout"
  10020. abstract="false" native="false" synchronized="false"
  10021. static="false" final="false" visibility="public"
  10022. deprecated="not deprecated">
  10023. <param name="decommissioningTimeout" type="java.lang.Integer"/>
  10024. <doc>
  10025. <![CDATA[Set the decommissioning timeout in seconds (null indicates absent timeout).]]>
  10026. </doc>
  10027. </method>
  10028. <method name="getNodeUpdateType" return="org.apache.hadoop.yarn.api.records.NodeUpdateType"
  10029. abstract="false" native="false" synchronized="false"
  10030. static="false" final="false" visibility="public"
  10031. deprecated="not deprecated">
  10032. <doc>
  10033. <![CDATA[Optional node update type (null indicates absent update type).
  10034. @return the node update.]]>
  10035. </doc>
  10036. </method>
  10037. <method name="setNodeUpdateType"
  10038. abstract="false" native="false" synchronized="false"
  10039. static="false" final="false" visibility="public"
  10040. deprecated="not deprecated">
  10041. <param name="nodeUpdateType" type="org.apache.hadoop.yarn.api.records.NodeUpdateType"/>
  10042. <doc>
  10043. <![CDATA[Set the node update type (null indicates absent node update type).]]>
  10044. </doc>
  10045. </method>
  10046. <method name="setNodeAttributes"
  10047. abstract="true" native="false" synchronized="false"
  10048. static="false" final="false" visibility="public"
  10049. deprecated="not deprecated">
  10050. <param name="nodeAttributes" type="java.util.Set"/>
  10051. <doc>
  10052. <![CDATA[Set the node attributes of node.
  10053. @param nodeAttributes set of node attributes.]]>
  10054. </doc>
  10055. </method>
  10056. <method name="getNodeAttributes" return="java.util.Set"
  10057. abstract="true" native="false" synchronized="false"
  10058. static="false" final="false" visibility="public"
  10059. deprecated="not deprecated">
  10060. <doc>
  10061. <![CDATA[Get node attributes of node.
  10062. @return the set of node attributes.]]>
  10063. </doc>
  10064. </method>
  10065. <doc>
  10066. <![CDATA[{@code NodeReport} is a summary of runtime information of a node
  10067. in the cluster.
  10068. <p>
  10069. It includes details such as:
  10070. <ul>
  10071. <li>{@link NodeId} of the node.</li>
  10072. <li>HTTP Tracking URL of the node.</li>
  10073. <li>Rack name for the node.</li>
  10074. <li>Used {@link Resource} on the node.</li>
  10075. <li>Total available {@link Resource} of the node.</li>
  10076. <li>Number of running containers on the node.</li>
  10077. </ul>
  10078. @see ApplicationClientProtocol#getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)]]>
  10079. </doc>
  10080. </class>
  10081. <!-- end class org.apache.hadoop.yarn.api.records.NodeReport -->
  10082. <!-- start class org.apache.hadoop.yarn.api.records.NodeState -->
  10083. <class name="NodeState" extends="java.lang.Enum"
  10084. abstract="false"
  10085. static="false" final="true" visibility="public"
  10086. deprecated="not deprecated">
  10087. <method name="values" return="org.apache.hadoop.yarn.api.records.NodeState[]"
  10088. abstract="false" native="false" synchronized="false"
  10089. static="true" final="false" visibility="public"
  10090. deprecated="not deprecated">
  10091. </method>
  10092. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.NodeState"
  10093. abstract="false" native="false" synchronized="false"
  10094. static="true" final="false" visibility="public"
  10095. deprecated="not deprecated">
  10096. <param name="name" type="java.lang.String"/>
  10097. </method>
  10098. <method name="isUnusable" return="boolean"
  10099. abstract="false" native="false" synchronized="false"
  10100. static="false" final="false" visibility="public"
  10101. deprecated="not deprecated">
  10102. </method>
  10103. <method name="isInactiveState" return="boolean"
  10104. abstract="false" native="false" synchronized="false"
  10105. static="false" final="false" visibility="public"
  10106. deprecated="not deprecated">
  10107. </method>
  10108. <method name="isActiveState" return="boolean"
  10109. abstract="false" native="false" synchronized="false"
  10110. static="false" final="false" visibility="public"
  10111. deprecated="not deprecated">
  10112. </method>
  10113. <doc>
  10114. <![CDATA[<p>State of a <code>Node</code>.</p>]]>
  10115. </doc>
  10116. </class>
  10117. <!-- end class org.apache.hadoop.yarn.api.records.NodeState -->
  10118. <!-- start class org.apache.hadoop.yarn.api.records.NodeToAttributeValue -->
  10119. <class name="NodeToAttributeValue" extends="java.lang.Object"
  10120. abstract="true"
  10121. static="false" final="false" visibility="public"
  10122. deprecated="not deprecated">
  10123. <constructor name="NodeToAttributeValue"
  10124. static="false" final="false" visibility="public"
  10125. deprecated="not deprecated">
  10126. </constructor>
  10127. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeToAttributeValue"
  10128. abstract="false" native="false" synchronized="false"
  10129. static="true" final="false" visibility="public"
  10130. deprecated="not deprecated">
  10131. <param name="hostname" type="java.lang.String"/>
  10132. <param name="attributeValue" type="java.lang.String"/>
  10133. </method>
  10134. <method name="getAttributeValue" return="java.lang.String"
  10135. abstract="true" native="false" synchronized="false"
  10136. static="false" final="false" visibility="public"
  10137. deprecated="not deprecated">
  10138. </method>
  10139. <method name="setAttributeValue"
  10140. abstract="true" native="false" synchronized="false"
  10141. static="false" final="false" visibility="public"
  10142. deprecated="not deprecated">
  10143. <param name="attributeValue" type="java.lang.String"/>
  10144. </method>
  10145. <method name="getHostname" return="java.lang.String"
  10146. abstract="true" native="false" synchronized="false"
  10147. static="false" final="false" visibility="public"
  10148. deprecated="not deprecated">
  10149. </method>
  10150. <method name="setHostname"
  10151. abstract="true" native="false" synchronized="false"
  10152. static="false" final="false" visibility="public"
  10153. deprecated="not deprecated">
  10154. <param name="hostname" type="java.lang.String"/>
  10155. </method>
  10156. <doc>
  10157. <![CDATA[<p>
  10158. Mapping of Attribute Value to a Node.
  10159. </p>]]>
  10160. </doc>
  10161. </class>
  10162. <!-- end class org.apache.hadoop.yarn.api.records.NodeToAttributeValue -->
  10163. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
  10164. <class name="PreemptionContainer" extends="java.lang.Object"
  10165. abstract="true"
  10166. static="false" final="false" visibility="public"
  10167. deprecated="not deprecated">
  10168. <constructor name="PreemptionContainer"
  10169. static="false" final="false" visibility="public"
  10170. deprecated="not deprecated">
  10171. </constructor>
  10172. <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  10173. abstract="true" native="false" synchronized="false"
  10174. static="false" final="false" visibility="public"
  10175. deprecated="not deprecated">
  10176. <doc>
  10177. <![CDATA[@return Container referenced by this handle.]]>
  10178. </doc>
  10179. </method>
  10180. <doc>
  10181. <![CDATA[Specific container requested back by the <code>ResourceManager</code>.
  10182. @see PreemptionContract
  10183. @see StrictPreemptionContract]]>
  10184. </doc>
  10185. </class>
  10186. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
  10187. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContract -->
  10188. <class name="PreemptionContract" extends="java.lang.Object"
  10189. abstract="true"
  10190. static="false" final="false" visibility="public"
  10191. deprecated="not deprecated">
  10192. <constructor name="PreemptionContract"
  10193. static="false" final="false" visibility="public"
  10194. deprecated="not deprecated">
  10195. </constructor>
  10196. <method name="getResourceRequest" return="java.util.List"
  10197. abstract="true" native="false" synchronized="false"
  10198. static="false" final="false" visibility="public"
  10199. deprecated="not deprecated">
  10200. <doc>
  10201. <![CDATA[If the AM releases resources matching these requests, then the {@link
  10202. PreemptionContainer}s enumerated in {@link #getContainers()} should not be
  10203. evicted from the cluster. Due to delays in propagating cluster state and
  10204. sending these messages, there are conditions where satisfied contracts may
  10205. not prevent the platform from killing containers.
  10206. @return List of {@link PreemptionResourceRequest} to update the
  10207. <code>ApplicationMaster</code> about resources requested back by the
  10208. <code>ResourceManager</code>.
  10209. @see AllocateRequest#setAskList(List)]]>
  10210. </doc>
  10211. </method>
  10212. <method name="getContainers" return="java.util.Set"
  10213. abstract="true" native="false" synchronized="false"
  10214. static="false" final="false" visibility="public"
  10215. deprecated="not deprecated">
  10216. <doc>
  10217. <![CDATA[Assign the set of {@link PreemptionContainer} specifying which containers
  10218. owned by the <code>ApplicationMaster</code> that may be reclaimed by the
  10219. <code>ResourceManager</code>. If the AM prefers a different set of
  10220. containers, then it may checkpoint or kill containers matching the
  10221. description in {@link #getResourceRequest}.
  10222. @return Set of containers at risk if the contract is not met.]]>
  10223. </doc>
  10224. </method>
  10225. <doc>
  10226. <![CDATA[Description of resources requested back by the <code>ResourceManager</code>.
  10227. The <code>ApplicationMaster</code> (AM) can satisfy this request according
  10228. to its own priorities to prevent containers from being forcibly killed by
  10229. the platform.
  10230. @see PreemptionMessage]]>
  10231. </doc>
  10232. </class>
  10233. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContract -->
  10234. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
  10235. <class name="PreemptionMessage" extends="java.lang.Object"
  10236. abstract="true"
  10237. static="false" final="false" visibility="public"
  10238. deprecated="not deprecated">
  10239. <constructor name="PreemptionMessage"
  10240. static="false" final="false" visibility="public"
  10241. deprecated="not deprecated">
  10242. </constructor>
  10243. <method name="getStrictContract" return="org.apache.hadoop.yarn.api.records.StrictPreemptionContract"
  10244. abstract="true" native="false" synchronized="false"
  10245. static="false" final="false" visibility="public"
  10246. deprecated="not deprecated">
  10247. <doc>
  10248. <![CDATA[@return Specific resources that may be killed by the
  10249. <code>ResourceManager</code>]]>
  10250. </doc>
  10251. </method>
  10252. <method name="getContract" return="org.apache.hadoop.yarn.api.records.PreemptionContract"
  10253. abstract="true" native="false" synchronized="false"
  10254. static="false" final="false" visibility="public"
  10255. deprecated="not deprecated">
  10256. <doc>
  10257. <![CDATA[@return Contract describing resources to return to the cluster.]]>
  10258. </doc>
  10259. </method>
  10260. <doc>
  10261. <![CDATA[A {@link PreemptionMessage} is part of the RM-AM protocol, and it is used by
  10262. the RM to specify resources that the RM wants to reclaim from this
  10263. {@code ApplicationMaster} (AM). The AM receives a {@link
  10264. StrictPreemptionContract} message encoding which containers the platform may
  10265. forcibly kill, granting it an opportunity to checkpoint state or adjust its
  10266. execution plan. The message may also include a {@link PreemptionContract}
  10267. granting the AM more latitude in selecting which resources to return to the
  10268. cluster.
  10269. <p>
  10270. The AM should decode both parts of the message. The {@link
  10271. StrictPreemptionContract} specifies particular allocations that the RM
  10272. requires back. The AM can checkpoint containers' state, adjust its execution
  10273. plan to move the computation, or take no action and hope that conditions that
  10274. caused the RM to ask for the container will change.
  10275. <p>
  10276. In contrast, the {@link PreemptionContract} also includes a description of
  10277. resources with a set of containers. If the AM releases containers matching
  10278. that profile, then the containers enumerated in {@link
  10279. PreemptionContract#getContainers()} may not be killed.
  10280. <p>
  10281. Each preemption message reflects the RM's current understanding of the
  10282. cluster state, so a request to return <em>N</em> containers may not
  10283. reflect containers the AM is releasing, recently exited containers the RM has
  10284. yet to learn about, or new containers allocated before the message was
  10285. generated. Conversely, an RM may request a different profile of containers in
  10286. subsequent requests.
  10287. <p>
  10288. The policy enforced by the RM is part of the scheduler. Generally, only
  10289. containers that have been requested consistently should be killed, but the
  10290. details are not specified.]]>
  10291. </doc>
  10292. </class>
  10293. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
  10294. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
  10295. <class name="PreemptionResourceRequest" extends="java.lang.Object"
  10296. abstract="true"
  10297. static="false" final="false" visibility="public"
  10298. deprecated="not deprecated">
  10299. <constructor name="PreemptionResourceRequest"
  10300. static="false" final="false" visibility="public"
  10301. deprecated="not deprecated">
  10302. </constructor>
  10303. <method name="getResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  10304. abstract="true" native="false" synchronized="false"
  10305. static="false" final="false" visibility="public"
  10306. deprecated="not deprecated">
  10307. <doc>
  10308. <![CDATA[@return Resource described in this request, to be matched against running
  10309. containers.]]>
  10310. </doc>
  10311. </method>
  10312. <doc>
  10313. <![CDATA[Description of resources requested back by the cluster.
  10314. @see PreemptionContract
  10315. @see AllocateRequest#setAskList(java.util.List)]]>
  10316. </doc>
  10317. </class>
  10318. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
  10319. <!-- start class org.apache.hadoop.yarn.api.records.Priority -->
  10320. <class name="Priority" extends="java.lang.Object"
  10321. abstract="true"
  10322. static="false" final="false" visibility="public"
  10323. deprecated="not deprecated">
  10324. <implements name="java.lang.Comparable"/>
  10325. <constructor name="Priority"
  10326. static="false" final="false" visibility="public"
  10327. deprecated="not deprecated">
  10328. </constructor>
  10329. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Priority"
  10330. abstract="false" native="false" synchronized="false"
  10331. static="true" final="false" visibility="public"
  10332. deprecated="not deprecated">
  10333. <param name="p" type="int"/>
  10334. </method>
  10335. <method name="getPriority" return="int"
  10336. abstract="true" native="false" synchronized="false"
  10337. static="false" final="false" visibility="public"
  10338. deprecated="not deprecated">
  10339. <doc>
  10340. <![CDATA[Get the assigned priority
  10341. @return the assigned priority]]>
  10342. </doc>
  10343. </method>
  10344. <method name="setPriority"
  10345. abstract="true" native="false" synchronized="false"
  10346. static="false" final="false" visibility="public"
  10347. deprecated="not deprecated">
  10348. <param name="priority" type="int"/>
  10349. <doc>
  10350. <![CDATA[Set the assigned priority
  10351. @param priority the assigned priority]]>
  10352. </doc>
  10353. </method>
  10354. <method name="hashCode" return="int"
  10355. abstract="false" native="false" synchronized="false"
  10356. static="false" final="false" visibility="public"
  10357. deprecated="not deprecated">
  10358. </method>
  10359. <method name="equals" return="boolean"
  10360. abstract="false" native="false" synchronized="false"
  10361. static="false" final="false" visibility="public"
  10362. deprecated="not deprecated">
  10363. <param name="obj" type="java.lang.Object"/>
  10364. </method>
  10365. <method name="compareTo" return="int"
  10366. abstract="false" native="false" synchronized="false"
  10367. static="false" final="false" visibility="public"
  10368. deprecated="not deprecated">
  10369. <param name="other" type="org.apache.hadoop.yarn.api.records.Priority"/>
  10370. </method>
  10371. <method name="toString" return="java.lang.String"
  10372. abstract="false" native="false" synchronized="false"
  10373. static="false" final="false" visibility="public"
  10374. deprecated="not deprecated">
  10375. </method>
  10376. <field name="UNDEFINED" type="org.apache.hadoop.yarn.api.records.Priority"
  10377. transient="false" volatile="false"
  10378. static="true" final="true" visibility="public"
  10379. deprecated="not deprecated">
  10380. </field>
  10381. <doc>
  10382. <![CDATA[The priority assigned to a ResourceRequest or Application or Container
  10383. allocation]]>
  10384. </doc>
  10385. </class>
  10386. <!-- end class org.apache.hadoop.yarn.api.records.Priority -->
  10387. <!-- start class org.apache.hadoop.yarn.api.records.QueueACL -->
  10388. <class name="QueueACL" extends="java.lang.Enum"
  10389. abstract="false"
  10390. static="false" final="true" visibility="public"
  10391. deprecated="not deprecated">
  10392. <method name="values" return="org.apache.hadoop.yarn.api.records.QueueACL[]"
  10393. abstract="false" native="false" synchronized="false"
  10394. static="true" final="false" visibility="public"
  10395. deprecated="not deprecated">
  10396. </method>
  10397. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueACL"
  10398. abstract="false" native="false" synchronized="false"
  10399. static="true" final="false" visibility="public"
  10400. deprecated="not deprecated">
  10401. <param name="name" type="java.lang.String"/>
  10402. </method>
  10403. <doc>
  10404. <![CDATA[{@code QueueACL} enumerates the various ACLs for queues.
  10405. <p>
  10406. The ACL is one of:
  10407. <ul>
  10408. <li>
  10409. {@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the queue.
  10410. </li>
  10411. <li>{@link #ADMINISTER_QUEUE} - ACL to administer the queue.</li>
  10412. </ul>
  10413. @see QueueInfo
  10414. @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
  10415. </doc>
  10416. </class>
  10417. <!-- end class org.apache.hadoop.yarn.api.records.QueueACL -->
  10418. <!-- start class org.apache.hadoop.yarn.api.records.QueueInfo -->
  10419. <class name="QueueInfo" extends="java.lang.Object"
  10420. abstract="true"
  10421. static="false" final="false" visibility="public"
  10422. deprecated="not deprecated">
  10423. <constructor name="QueueInfo"
  10424. static="false" final="false" visibility="public"
  10425. deprecated="not deprecated">
  10426. </constructor>
  10427. <method name="getQueueName" return="java.lang.String"
  10428. abstract="true" native="false" synchronized="false"
  10429. static="false" final="false" visibility="public"
  10430. deprecated="not deprecated">
  10431. <doc>
  10432. <![CDATA[Get the <em>name</em> of the queue.
  10433. @return <em>name</em> of the queue]]>
  10434. </doc>
  10435. </method>
  10436. <method name="getCapacity" return="float"
  10437. abstract="true" native="false" synchronized="false"
  10438. static="false" final="false" visibility="public"
  10439. deprecated="not deprecated">
  10440. <doc>
  10441. <![CDATA[Get the <em>configured capacity</em> of the queue.
  10442. @return <em>configured capacity</em> of the queue]]>
  10443. </doc>
  10444. </method>
  10445. <method name="getMaximumCapacity" return="float"
  10446. abstract="true" native="false" synchronized="false"
  10447. static="false" final="false" visibility="public"
  10448. deprecated="not deprecated">
  10449. <doc>
  10450. <![CDATA[Get the <em>maximum capacity</em> of the queue.
  10451. @return <em>maximum capacity</em> of the queue]]>
  10452. </doc>
  10453. </method>
  10454. <method name="getCurrentCapacity" return="float"
  10455. abstract="true" native="false" synchronized="false"
  10456. static="false" final="false" visibility="public"
  10457. deprecated="not deprecated">
  10458. <doc>
  10459. <![CDATA[Get the <em>current capacity</em> of the queue.
  10460. @return <em>current capacity</em> of the queue]]>
  10461. </doc>
  10462. </method>
  10463. <method name="getChildQueues" return="java.util.List"
  10464. abstract="true" native="false" synchronized="false"
  10465. static="false" final="false" visibility="public"
  10466. deprecated="not deprecated">
  10467. <doc>
  10468. <![CDATA[Get the <em>child queues</em> of the queue.
  10469. @return <em>child queues</em> of the queue]]>
  10470. </doc>
  10471. </method>
  10472. <method name="getApplications" return="java.util.List"
  10473. abstract="true" native="false" synchronized="false"
  10474. static="false" final="false" visibility="public"
  10475. deprecated="not deprecated">
  10476. <doc>
  10477. <![CDATA[Get the <em>running applications</em> of the queue.
  10478. @return <em>running applications</em> of the queue]]>
  10479. </doc>
  10480. </method>
  10481. <method name="getQueueState" return="org.apache.hadoop.yarn.api.records.QueueState"
  10482. abstract="true" native="false" synchronized="false"
  10483. static="false" final="false" visibility="public"
  10484. deprecated="not deprecated">
  10485. <doc>
  10486. <![CDATA[Get the <code>QueueState</code> of the queue.
  10487. @return <code>QueueState</code> of the queue]]>
  10488. </doc>
  10489. </method>
  10490. <method name="getAccessibleNodeLabels" return="java.util.Set"
  10491. abstract="true" native="false" synchronized="false"
  10492. static="false" final="false" visibility="public"
  10493. deprecated="not deprecated">
  10494. <doc>
  10495. <![CDATA[Get the <code>accessible node labels</code> of the queue.
  10496. @return <code>accessible node labels</code> of the queue]]>
  10497. </doc>
  10498. </method>
  10499. <method name="getDefaultNodeLabelExpression" return="java.lang.String"
  10500. abstract="true" native="false" synchronized="false"
  10501. static="false" final="false" visibility="public"
  10502. deprecated="not deprecated">
  10503. <doc>
  10504. <![CDATA[Get the <code>default node label expression</code> of the queue, this takes
  10505. affect only when the <code>ApplicationSubmissionContext</code> and
  10506. <code>ResourceRequest</code> don't specify their
  10507. <code>NodeLabelExpression</code>.
  10508. @return <code>default node label expression</code> of the queue]]>
  10509. </doc>
  10510. </method>
  10511. <method name="setDefaultNodeLabelExpression"
  10512. abstract="true" native="false" synchronized="false"
  10513. static="false" final="false" visibility="public"
  10514. deprecated="not deprecated">
  10515. <param name="defaultLabelExpression" type="java.lang.String"/>
  10516. </method>
  10517. <method name="getQueueStatistics" return="org.apache.hadoop.yarn.api.records.QueueStatistics"
  10518. abstract="true" native="false" synchronized="false"
  10519. static="false" final="false" visibility="public"
  10520. deprecated="not deprecated">
  10521. <doc>
  10522. <![CDATA[Get the <code>queue stats</code> for the queue
  10523. @return <code>queue stats</code> of the queue]]>
  10524. </doc>
  10525. </method>
  10526. <method name="setQueueStatistics"
  10527. abstract="true" native="false" synchronized="false"
  10528. static="false" final="false" visibility="public"
  10529. deprecated="not deprecated">
  10530. <param name="queueStatistics" type="org.apache.hadoop.yarn.api.records.QueueStatistics"/>
  10531. <doc>
  10532. <![CDATA[Set the queue statistics for the queue
  10533. @param queueStatistics
  10534. the queue statistics]]>
  10535. </doc>
  10536. </method>
  10537. <method name="getPreemptionDisabled" return="java.lang.Boolean"
  10538. abstract="true" native="false" synchronized="false"
  10539. static="false" final="false" visibility="public"
  10540. deprecated="not deprecated">
  10541. <doc>
  10542. <![CDATA[Get the <em>preemption status</em> of the queue.
  10543. @return if property is not in proto, return null;
  10544. otherwise, return <em>preemption status</em> of the queue]]>
  10545. </doc>
  10546. </method>
  10547. <method name="getQueueConfigurations" return="java.util.Map"
  10548. abstract="true" native="false" synchronized="false"
  10549. static="false" final="false" visibility="public"
  10550. deprecated="not deprecated">
  10551. <doc>
  10552. <![CDATA[Get the per-node-label queue configurations of the queue.
  10553. @return the per-node-label queue configurations of the queue.]]>
  10554. </doc>
  10555. </method>
  10556. <method name="getIntraQueuePreemptionDisabled" return="java.lang.Boolean"
  10557. abstract="true" native="false" synchronized="false"
  10558. static="false" final="false" visibility="public"
  10559. deprecated="not deprecated">
  10560. <doc>
  10561. <![CDATA[Get the intra-queue preemption status of the queue.
  10562. @return if property is not in proto, return null;
  10563. otherwise, return intra-queue preemption status of the queue]]>
  10564. </doc>
  10565. </method>
  10566. <doc>
  10567. <![CDATA[QueueInfo is a report of the runtime information of the queue.
  10568. <p>
  10569. It includes information such as:
  10570. <ul>
  10571. <li>Queue name.</li>
  10572. <li>Capacity of the queue.</li>
  10573. <li>Maximum capacity of the queue.</li>
  10574. <li>Current capacity of the queue.</li>
  10575. <li>Child queues.</li>
  10576. <li>Running applications.</li>
  10577. <li>{@link QueueState} of the queue.</li>
  10578. <li>{@link QueueConfigurations} of the queue.</li>
  10579. </ul>
  10580. @see QueueState
  10581. @see QueueConfigurations
  10582. @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
  10583. </doc>
  10584. </class>
  10585. <!-- end class org.apache.hadoop.yarn.api.records.QueueInfo -->
  10586. <!-- start class org.apache.hadoop.yarn.api.records.QueueState -->
  10587. <class name="QueueState" extends="java.lang.Enum"
  10588. abstract="false"
  10589. static="false" final="true" visibility="public"
  10590. deprecated="not deprecated">
  10591. <method name="values" return="org.apache.hadoop.yarn.api.records.QueueState[]"
  10592. abstract="false" native="false" synchronized="false"
  10593. static="true" final="false" visibility="public"
  10594. deprecated="not deprecated">
  10595. </method>
  10596. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueState"
  10597. abstract="false" native="false" synchronized="false"
  10598. static="true" final="false" visibility="public"
  10599. deprecated="not deprecated">
  10600. <param name="name" type="java.lang.String"/>
  10601. </method>
  10602. <doc>
  10603. <![CDATA[State of a Queue.
  10604. <p>
  10605. A queue is in one of:
  10606. <ul>
  10607. <li>{@link #RUNNING} - normal state.</li>
  10608. <li>{@link #STOPPED} - not accepting new application submissions.</li>
  10609. <li>
  10610. {@link #DRAINING} - not accepting new application submissions
  10611. and waiting for applications finish.
  10612. </li>
  10613. </ul>
  10614. @see QueueInfo
  10615. @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
  10616. </doc>
  10617. </class>
  10618. <!-- end class org.apache.hadoop.yarn.api.records.QueueState -->
  10619. <!-- start class org.apache.hadoop.yarn.api.records.QueueStatistics -->
  10620. <class name="QueueStatistics" extends="java.lang.Object"
  10621. abstract="true"
  10622. static="false" final="false" visibility="public"
  10623. deprecated="not deprecated">
  10624. <constructor name="QueueStatistics"
  10625. static="false" final="false" visibility="public"
  10626. deprecated="not deprecated">
  10627. </constructor>
  10628. <method name="getNumAppsSubmitted" return="long"
  10629. abstract="true" native="false" synchronized="false"
  10630. static="false" final="false" visibility="public"
  10631. deprecated="not deprecated">
  10632. <doc>
  10633. <![CDATA[Get the number of apps submitted
  10634. @return the number of apps submitted]]>
  10635. </doc>
  10636. </method>
  10637. <method name="setNumAppsSubmitted"
  10638. abstract="true" native="false" synchronized="false"
  10639. static="false" final="false" visibility="public"
  10640. deprecated="not deprecated">
  10641. <param name="numAppsSubmitted" type="long"/>
  10642. <doc>
  10643. <![CDATA[Set the number of apps submitted
  10644. @param numAppsSubmitted
  10645. the number of apps submitted]]>
  10646. </doc>
  10647. </method>
  10648. <method name="getNumAppsRunning" return="long"
  10649. abstract="true" native="false" synchronized="false"
  10650. static="false" final="false" visibility="public"
  10651. deprecated="not deprecated">
  10652. <doc>
  10653. <![CDATA[Get the number of running apps
  10654. @return the number of running apps]]>
  10655. </doc>
  10656. </method>
  10657. <method name="setNumAppsRunning"
  10658. abstract="true" native="false" synchronized="false"
  10659. static="false" final="false" visibility="public"
  10660. deprecated="not deprecated">
  10661. <param name="numAppsRunning" type="long"/>
  10662. <doc>
  10663. <![CDATA[Set the number of running apps
  10664. @param numAppsRunning
  10665. the number of running apps]]>
  10666. </doc>
  10667. </method>
  10668. <method name="getNumAppsPending" return="long"
  10669. abstract="true" native="false" synchronized="false"
  10670. static="false" final="false" visibility="public"
  10671. deprecated="not deprecated">
  10672. <doc>
  10673. <![CDATA[Get the number of pending apps
  10674. @return the number of pending apps]]>
  10675. </doc>
  10676. </method>
  10677. <method name="setNumAppsPending"
  10678. abstract="true" native="false" synchronized="false"
  10679. static="false" final="false" visibility="public"
  10680. deprecated="not deprecated">
  10681. <param name="numAppsPending" type="long"/>
  10682. <doc>
  10683. <![CDATA[Set the number of pending apps
  10684. @param numAppsPending
  10685. the number of pending apps]]>
  10686. </doc>
  10687. </method>
  10688. <method name="getNumAppsCompleted" return="long"
  10689. abstract="true" native="false" synchronized="false"
  10690. static="false" final="false" visibility="public"
  10691. deprecated="not deprecated">
  10692. <doc>
  10693. <![CDATA[Get the number of completed apps
  10694. @return the number of completed apps]]>
  10695. </doc>
  10696. </method>
  10697. <method name="setNumAppsCompleted"
  10698. abstract="true" native="false" synchronized="false"
  10699. static="false" final="false" visibility="public"
  10700. deprecated="not deprecated">
  10701. <param name="numAppsCompleted" type="long"/>
  10702. <doc>
  10703. <![CDATA[Set the number of completed apps
  10704. @param numAppsCompleted
  10705. the number of completed apps]]>
  10706. </doc>
  10707. </method>
  10708. <method name="getNumAppsKilled" return="long"
  10709. abstract="true" native="false" synchronized="false"
  10710. static="false" final="false" visibility="public"
  10711. deprecated="not deprecated">
  10712. <doc>
  10713. <![CDATA[Get the number of killed apps
  10714. @return the number of killed apps]]>
  10715. </doc>
  10716. </method>
  10717. <method name="setNumAppsKilled"
  10718. abstract="true" native="false" synchronized="false"
  10719. static="false" final="false" visibility="public"
  10720. deprecated="not deprecated">
  10721. <param name="numAppsKilled" type="long"/>
  10722. <doc>
  10723. <![CDATA[Set the number of killed apps
  10724. @param numAppsKilled
  10725. the number of killed apps]]>
  10726. </doc>
  10727. </method>
  10728. <method name="getNumAppsFailed" return="long"
  10729. abstract="true" native="false" synchronized="false"
  10730. static="false" final="false" visibility="public"
  10731. deprecated="not deprecated">
  10732. <doc>
  10733. <![CDATA[Get the number of failed apps
  10734. @return the number of failed apps]]>
  10735. </doc>
  10736. </method>
  10737. <method name="setNumAppsFailed"
  10738. abstract="true" native="false" synchronized="false"
  10739. static="false" final="false" visibility="public"
  10740. deprecated="not deprecated">
  10741. <param name="numAppsFailed" type="long"/>
  10742. <doc>
  10743. <![CDATA[Set the number of failed apps
  10744. @param numAppsFailed
  10745. the number of failed apps]]>
  10746. </doc>
  10747. </method>
  10748. <method name="getNumActiveUsers" return="long"
  10749. abstract="true" native="false" synchronized="false"
  10750. static="false" final="false" visibility="public"
  10751. deprecated="not deprecated">
  10752. <doc>
  10753. <![CDATA[Get the number of active users
  10754. @return the number of active users]]>
  10755. </doc>
  10756. </method>
  10757. <method name="setNumActiveUsers"
  10758. abstract="true" native="false" synchronized="false"
  10759. static="false" final="false" visibility="public"
  10760. deprecated="not deprecated">
  10761. <param name="numActiveUsers" type="long"/>
  10762. <doc>
  10763. <![CDATA[Set the number of active users
  10764. @param numActiveUsers
  10765. the number of active users]]>
  10766. </doc>
  10767. </method>
  10768. <method name="getAvailableMemoryMB" return="long"
  10769. abstract="true" native="false" synchronized="false"
  10770. static="false" final="false" visibility="public"
  10771. deprecated="not deprecated">
  10772. <doc>
  10773. <![CDATA[Get the available memory in MB
  10774. @return the available memory]]>
  10775. </doc>
  10776. </method>
  10777. <method name="setAvailableMemoryMB"
  10778. abstract="true" native="false" synchronized="false"
  10779. static="false" final="false" visibility="public"
  10780. deprecated="not deprecated">
  10781. <param name="availableMemoryMB" type="long"/>
  10782. <doc>
  10783. <![CDATA[Set the available memory in MB
  10784. @param availableMemoryMB
  10785. the available memory]]>
  10786. </doc>
  10787. </method>
  10788. <method name="getAllocatedMemoryMB" return="long"
  10789. abstract="true" native="false" synchronized="false"
  10790. static="false" final="false" visibility="public"
  10791. deprecated="not deprecated">
  10792. <doc>
  10793. <![CDATA[Get the allocated memory in MB
  10794. @return the allocated memory]]>
  10795. </doc>
  10796. </method>
  10797. <method name="setAllocatedMemoryMB"
  10798. abstract="true" native="false" synchronized="false"
  10799. static="false" final="false" visibility="public"
  10800. deprecated="not deprecated">
  10801. <param name="allocatedMemoryMB" type="long"/>
  10802. <doc>
  10803. <![CDATA[Set the allocated memory in MB
  10804. @param allocatedMemoryMB
  10805. the allocate memory]]>
  10806. </doc>
  10807. </method>
  10808. <method name="getPendingMemoryMB" return="long"
  10809. abstract="true" native="false" synchronized="false"
  10810. static="false" final="false" visibility="public"
  10811. deprecated="not deprecated">
  10812. <doc>
  10813. <![CDATA[Get the pending memory in MB
  10814. @return the pending memory]]>
  10815. </doc>
  10816. </method>
  10817. <method name="setPendingMemoryMB"
  10818. abstract="true" native="false" synchronized="false"
  10819. static="false" final="false" visibility="public"
  10820. deprecated="not deprecated">
  10821. <param name="pendingMemoryMB" type="long"/>
  10822. <doc>
  10823. <![CDATA[Set the pending memory in MB
  10824. @param pendingMemoryMB
  10825. the pending memory]]>
  10826. </doc>
  10827. </method>
  10828. <method name="getReservedMemoryMB" return="long"
  10829. abstract="true" native="false" synchronized="false"
  10830. static="false" final="false" visibility="public"
  10831. deprecated="not deprecated">
  10832. <doc>
  10833. <![CDATA[Get the reserved memory in MB
  10834. @return the reserved memory]]>
  10835. </doc>
  10836. </method>
  10837. <method name="setReservedMemoryMB"
  10838. abstract="true" native="false" synchronized="false"
  10839. static="false" final="false" visibility="public"
  10840. deprecated="not deprecated">
  10841. <param name="reservedMemoryMB" type="long"/>
  10842. <doc>
  10843. <![CDATA[Set the reserved memory in MB
  10844. @param reservedMemoryMB
  10845. the reserved memory]]>
  10846. </doc>
  10847. </method>
  10848. <method name="getAvailableVCores" return="long"
  10849. abstract="true" native="false" synchronized="false"
  10850. static="false" final="false" visibility="public"
  10851. deprecated="not deprecated">
  10852. <doc>
  10853. <![CDATA[Get the available vcores
  10854. @return the available vcores]]>
  10855. </doc>
  10856. </method>
  10857. <method name="setAvailableVCores"
  10858. abstract="true" native="false" synchronized="false"
  10859. static="false" final="false" visibility="public"
  10860. deprecated="not deprecated">
  10861. <param name="availableVCores" type="long"/>
  10862. <doc>
  10863. <![CDATA[Set the available vcores
  10864. @param availableVCores
  10865. the available vcores]]>
  10866. </doc>
  10867. </method>
  10868. <method name="getAllocatedVCores" return="long"
  10869. abstract="true" native="false" synchronized="false"
  10870. static="false" final="false" visibility="public"
  10871. deprecated="not deprecated">
  10872. <doc>
  10873. <![CDATA[Get the allocated vcores
  10874. @return the allocated vcores]]>
  10875. </doc>
  10876. </method>
  10877. <method name="setAllocatedVCores"
  10878. abstract="true" native="false" synchronized="false"
  10879. static="false" final="false" visibility="public"
  10880. deprecated="not deprecated">
  10881. <param name="allocatedVCores" type="long"/>
  10882. <doc>
  10883. <![CDATA[Set the allocated vcores
  10884. @param allocatedVCores
  10885. the allocated vcores]]>
  10886. </doc>
  10887. </method>
  10888. <method name="getPendingVCores" return="long"
  10889. abstract="true" native="false" synchronized="false"
  10890. static="false" final="false" visibility="public"
  10891. deprecated="not deprecated">
  10892. <doc>
  10893. <![CDATA[Get the pending vcores
  10894. @return the pending vcores]]>
  10895. </doc>
  10896. </method>
  10897. <method name="setPendingVCores"
  10898. abstract="true" native="false" synchronized="false"
  10899. static="false" final="false" visibility="public"
  10900. deprecated="not deprecated">
  10901. <param name="pendingVCores" type="long"/>
  10902. <doc>
  10903. <![CDATA[Set the pending vcores
  10904. @param pendingVCores
  10905. the pending vcores]]>
  10906. </doc>
  10907. </method>
  10908. <method name="getPendingContainers" return="long"
  10909. abstract="true" native="false" synchronized="false"
  10910. static="false" final="false" visibility="public"
  10911. deprecated="not deprecated">
  10912. <doc>
  10913. <![CDATA[Get the number of pending containers.
  10914. @return the number of pending containers.]]>
  10915. </doc>
  10916. </method>
  10917. <method name="setPendingContainers"
  10918. abstract="true" native="false" synchronized="false"
  10919. static="false" final="false" visibility="public"
  10920. deprecated="not deprecated">
  10921. <param name="pendingContainers" type="long"/>
  10922. <doc>
  10923. <![CDATA[Set the number of pending containers.
  10924. @param pendingContainers the pending containers.]]>
  10925. </doc>
  10926. </method>
  10927. <method name="getAllocatedContainers" return="long"
  10928. abstract="true" native="false" synchronized="false"
  10929. static="false" final="false" visibility="public"
  10930. deprecated="not deprecated">
  10931. <doc>
  10932. <![CDATA[Get the number of allocated containers.
  10933. @return the number of allocated containers.]]>
  10934. </doc>
  10935. </method>
  10936. <method name="setAllocatedContainers"
  10937. abstract="true" native="false" synchronized="false"
  10938. static="false" final="false" visibility="public"
  10939. deprecated="not deprecated">
  10940. <param name="allocatedContainers" type="long"/>
  10941. <doc>
  10942. <![CDATA[Set the number of allocated containers.
  10943. @param allocatedContainers the allocated containers.]]>
  10944. </doc>
  10945. </method>
  10946. <method name="getReservedContainers" return="long"
  10947. abstract="true" native="false" synchronized="false"
  10948. static="false" final="false" visibility="public"
  10949. deprecated="not deprecated">
  10950. <doc>
  10951. <![CDATA[Get the number of reserved containers.
  10952. @return the number of reserved containers.]]>
  10953. </doc>
  10954. </method>
  10955. <method name="setReservedContainers"
  10956. abstract="true" native="false" synchronized="false"
  10957. static="false" final="false" visibility="public"
  10958. deprecated="not deprecated">
  10959. <param name="reservedContainers" type="long"/>
  10960. <doc>
  10961. <![CDATA[Set the number of reserved containers.
  10962. @param reservedContainers the reserved containers.]]>
  10963. </doc>
  10964. </method>
  10965. <method name="getReservedVCores" return="long"
  10966. abstract="true" native="false" synchronized="false"
  10967. static="false" final="false" visibility="public"
  10968. deprecated="not deprecated">
  10969. <doc>
  10970. <![CDATA[Get the reserved vcores
  10971. @return the reserved vcores]]>
  10972. </doc>
  10973. </method>
  10974. <method name="setReservedVCores"
  10975. abstract="true" native="false" synchronized="false"
  10976. static="false" final="false" visibility="public"
  10977. deprecated="not deprecated">
  10978. <param name="reservedVCores" type="long"/>
  10979. <doc>
  10980. <![CDATA[Set the reserved vcores
  10981. @param reservedVCores
  10982. the reserved vcores]]>
  10983. </doc>
  10984. </method>
  10985. </class>
  10986. <!-- end class org.apache.hadoop.yarn.api.records.QueueStatistics -->
  10987. <!-- start class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
  10988. <class name="QueueUserACLInfo" extends="java.lang.Object"
  10989. abstract="true"
  10990. static="false" final="false" visibility="public"
  10991. deprecated="not deprecated">
  10992. <constructor name="QueueUserACLInfo"
  10993. static="false" final="false" visibility="public"
  10994. deprecated="not deprecated">
  10995. </constructor>
  10996. <method name="getQueueName" return="java.lang.String"
  10997. abstract="true" native="false" synchronized="false"
  10998. static="false" final="false" visibility="public"
  10999. deprecated="not deprecated">
  11000. <doc>
  11001. <![CDATA[Get the <em>queue name</em> of the queue.
  11002. @return <em>queue name</em> of the queue]]>
  11003. </doc>
  11004. </method>
  11005. <method name="getUserAcls" return="java.util.List"
  11006. abstract="true" native="false" synchronized="false"
  11007. static="false" final="false" visibility="public"
  11008. deprecated="not deprecated">
  11009. <doc>
  11010. <![CDATA[Get the list of <code>QueueACL</code> for the given user.
  11011. @return list of <code>QueueACL</code> for the given user]]>
  11012. </doc>
  11013. </method>
  11014. <doc>
  11015. <![CDATA[<p><code>QueueUserACLInfo</code> provides information {@link QueueACL} for
  11016. the given user.</p>
  11017. @see QueueACL
  11018. @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
  11019. </doc>
  11020. </class>
  11021. <!-- end class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
  11022. <!-- start class org.apache.hadoop.yarn.api.records.RejectedSchedulingRequest -->
  11023. <class name="RejectedSchedulingRequest" extends="java.lang.Object"
  11024. abstract="true"
  11025. static="false" final="false" visibility="public"
  11026. deprecated="not deprecated">
  11027. <constructor name="RejectedSchedulingRequest"
  11028. static="false" final="false" visibility="public"
  11029. deprecated="not deprecated">
  11030. </constructor>
  11031. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.RejectedSchedulingRequest"
  11032. abstract="false" native="false" synchronized="false"
  11033. static="true" final="false" visibility="public"
  11034. deprecated="not deprecated">
  11035. <param name="reason" type="org.apache.hadoop.yarn.api.records.RejectionReason"/>
  11036. <param name="request" type="org.apache.hadoop.yarn.api.records.SchedulingRequest"/>
  11037. <doc>
  11038. <![CDATA[Create new RejectedSchedulingRequest.
  11039. @param reason Rejection Reason.
  11040. @param request Rejected Scheduling Request.
  11041. @return RejectedSchedulingRequest.]]>
  11042. </doc>
  11043. </method>
  11044. <method name="getReason" return="org.apache.hadoop.yarn.api.records.RejectionReason"
  11045. abstract="true" native="false" synchronized="false"
  11046. static="false" final="false" visibility="public"
  11047. deprecated="not deprecated">
  11048. <doc>
  11049. <![CDATA[Get Rejection Reason.
  11050. @return Rejection reason.]]>
  11051. </doc>
  11052. </method>
  11053. <method name="setReason"
  11054. abstract="true" native="false" synchronized="false"
  11055. static="false" final="false" visibility="public"
  11056. deprecated="not deprecated">
  11057. <param name="reason" type="org.apache.hadoop.yarn.api.records.RejectionReason"/>
  11058. <doc>
  11059. <![CDATA[Set Rejection Reason.
  11060. @param reason Rejection Reason.]]>
  11061. </doc>
  11062. </method>
  11063. <method name="getRequest" return="org.apache.hadoop.yarn.api.records.SchedulingRequest"
  11064. abstract="true" native="false" synchronized="false"
  11065. static="false" final="false" visibility="public"
  11066. deprecated="not deprecated">
  11067. <doc>
  11068. <![CDATA[Get the Rejected Scheduling Request.
  11069. @return SchedulingRequest.]]>
  11070. </doc>
  11071. </method>
  11072. <method name="setRequest"
  11073. abstract="true" native="false" synchronized="false"
  11074. static="false" final="false" visibility="public"
  11075. deprecated="not deprecated">
  11076. <param name="request" type="org.apache.hadoop.yarn.api.records.SchedulingRequest"/>
  11077. <doc>
  11078. <![CDATA[Set the SchedulingRequest.
  11079. @param request SchedulingRequest.]]>
  11080. </doc>
  11081. </method>
  11082. <doc>
  11083. <![CDATA[This encapsulates a Rejected SchedulingRequest. It contains the offending
  11084. Scheduling Request along with the reason for rejection.]]>
  11085. </doc>
  11086. </class>
  11087. <!-- end class org.apache.hadoop.yarn.api.records.RejectedSchedulingRequest -->
  11088. <!-- start class org.apache.hadoop.yarn.api.records.RejectionReason -->
  11089. <class name="RejectionReason" extends="java.lang.Enum"
  11090. abstract="false"
  11091. static="false" final="true" visibility="public"
  11092. deprecated="not deprecated">
  11093. <method name="values" return="org.apache.hadoop.yarn.api.records.RejectionReason[]"
  11094. abstract="false" native="false" synchronized="false"
  11095. static="true" final="false" visibility="public"
  11096. deprecated="not deprecated">
  11097. </method>
  11098. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.RejectionReason"
  11099. abstract="false" native="false" synchronized="false"
  11100. static="true" final="false" visibility="public"
  11101. deprecated="not deprecated">
  11102. <param name="name" type="java.lang.String"/>
  11103. </method>
  11104. <doc>
  11105. <![CDATA[Reason for rejecting a Scheduling Request.]]>
  11106. </doc>
  11107. </class>
  11108. <!-- end class org.apache.hadoop.yarn.api.records.RejectionReason -->
  11109. <!-- start class org.apache.hadoop.yarn.api.records.ReservationACL -->
  11110. <class name="ReservationACL" extends="java.lang.Enum"
  11111. abstract="false"
  11112. static="false" final="true" visibility="public"
  11113. deprecated="not deprecated">
  11114. <method name="values" return="org.apache.hadoop.yarn.api.records.ReservationACL[]"
  11115. abstract="false" native="false" synchronized="false"
  11116. static="true" final="false" visibility="public"
  11117. deprecated="not deprecated">
  11118. </method>
  11119. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ReservationACL"
  11120. abstract="false" native="false" synchronized="false"
  11121. static="true" final="false" visibility="public"
  11122. deprecated="not deprecated">
  11123. <param name="name" type="java.lang.String"/>
  11124. </method>
  11125. <doc>
  11126. <![CDATA[{@code ReservationACL} enumerates the various ACLs for reservations.
  11127. <p>
  11128. The ACL is one of:
  11129. <ul>
  11130. <li>
  11131. {@link #ADMINISTER_RESERVATIONS} - ACL to create, list, update and
  11132. delete reservations.
  11133. </li>
  11134. <li> {@link #LIST_RESERVATIONS} - ACL to list reservations. </li>
  11135. <li> {@link #SUBMIT_RESERVATIONS} - ACL to create reservations. </li>
  11136. </ul>
  11137. Users can always list, update and delete their own reservations.]]>
  11138. </doc>
  11139. </class>
  11140. <!-- end class org.apache.hadoop.yarn.api.records.ReservationACL -->
  11141. <!-- start class org.apache.hadoop.yarn.api.records.ReservationAllocationState -->
  11142. <class name="ReservationAllocationState" extends="java.lang.Object"
  11143. abstract="true"
  11144. static="false" final="false" visibility="public"
  11145. deprecated="not deprecated">
  11146. <constructor name="ReservationAllocationState"
  11147. static="false" final="false" visibility="public"
  11148. deprecated="not deprecated">
  11149. </constructor>
  11150. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationAllocationState"
  11151. abstract="false" native="false" synchronized="false"
  11152. static="true" final="false" visibility="public"
  11153. deprecated="not deprecated">
  11154. <param name="acceptanceTime" type="long"/>
  11155. <param name="user" type="java.lang.String"/>
  11156. <param name="resourceAllocations" type="java.util.List"/>
  11157. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  11158. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  11159. <doc>
  11160. <![CDATA[@param acceptanceTime The acceptance time of the reservation.
  11161. @param user The username of the user who made the reservation.
  11162. @param resourceAllocations List of {@link ResourceAllocationRequest}
  11163. representing the current state of the
  11164. reservation resource allocations. This is
  11165. subject to change in the event of re-planning.
  11166. @param reservationId {@link ReservationId } of the reservation being
  11167. listed.
  11168. @param reservationDefinition {@link ReservationDefinition} used to make
  11169. the reservation.
  11170. @return {@code ReservationAllocationState} that represents the state of
  11171. the reservation.]]>
  11172. </doc>
  11173. </method>
  11174. <method name="getAcceptanceTime" return="long"
  11175. abstract="true" native="false" synchronized="false"
  11176. static="false" final="false" visibility="public"
  11177. deprecated="not deprecated">
  11178. <doc>
  11179. <![CDATA[Get the acceptance time of the reservation.
  11180. @return the time that the reservation was accepted.]]>
  11181. </doc>
  11182. </method>
  11183. <method name="getUser" return="java.lang.String"
  11184. abstract="true" native="false" synchronized="false"
  11185. static="false" final="false" visibility="public"
  11186. deprecated="not deprecated">
  11187. <doc>
  11188. <![CDATA[Get the user who made the reservation.
  11189. @return the name of the user who made the reservation.]]>
  11190. </doc>
  11191. </method>
  11192. <method name="getResourceAllocationRequests" return="java.util.List"
  11193. abstract="true" native="false" synchronized="false"
  11194. static="false" final="false" visibility="public"
  11195. deprecated="not deprecated">
  11196. <doc>
  11197. <![CDATA[Get the Resource allocations of the reservation based on the current state
  11198. of the plan. This is subject to change in the event of re-planning.
  11199. The allocations will be constraint to the user contract as described by
  11200. the {@link ReservationDefinition}
  11201. @return a list of resource allocations for the reservation.]]>
  11202. </doc>
  11203. </method>
  11204. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  11205. abstract="true" native="false" synchronized="false"
  11206. static="false" final="false" visibility="public"
  11207. deprecated="not deprecated">
  11208. <doc>
  11209. <![CDATA[Get the id of the reservation.
  11210. @return the reservation id corresponding to the reservation.]]>
  11211. </doc>
  11212. </method>
  11213. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  11214. abstract="true" native="false" synchronized="false"
  11215. static="false" final="false" visibility="public"
  11216. deprecated="not deprecated">
  11217. <doc>
  11218. <![CDATA[Get the reservation definition used to make the reservation.
  11219. @return the reservation definition used to make the reservation.]]>
  11220. </doc>
  11221. </method>
  11222. <doc>
  11223. <![CDATA[{@code ReservationAllocationState} represents the reservation that is
  11224. made by a user.
  11225. <p>
  11226. It includes:
  11227. <ul>
  11228. <li>Duration of the reservation.</li>
  11229. <li>Acceptance time of the duration.</li>
  11230. <li>
  11231. List of {@link ResourceAllocationRequest}, which includes the time
  11232. interval, and capability of the allocation.
  11233. {@code ResourceAllocationRequest} represents an allocation
  11234. made for a reservation for the current state of the queue. This can be
  11235. changed for reasons such as re-planning, but will always be subject to
  11236. the constraints of the user contract as described by
  11237. {@link ReservationDefinition}
  11238. </li>
  11239. <li>{@link ReservationId} of the reservation.</li>
  11240. <li>{@link ReservationDefinition} used to make the reservation.</li>
  11241. </ul>
  11242. @see ResourceAllocationRequest
  11243. @see ReservationId
  11244. @see ReservationDefinition]]>
  11245. </doc>
  11246. </class>
  11247. <!-- end class org.apache.hadoop.yarn.api.records.ReservationAllocationState -->
  11248. <!-- start class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
  11249. <class name="ReservationDefinition" extends="java.lang.Object"
  11250. abstract="true"
  11251. static="false" final="false" visibility="public"
  11252. deprecated="not deprecated">
  11253. <constructor name="ReservationDefinition"
  11254. static="false" final="false" visibility="public"
  11255. deprecated="not deprecated">
  11256. </constructor>
  11257. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  11258. abstract="false" native="false" synchronized="false"
  11259. static="true" final="false" visibility="public"
  11260. deprecated="not deprecated">
  11261. <param name="arrival" type="long"/>
  11262. <param name="deadline" type="long"/>
  11263. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  11264. <param name="name" type="java.lang.String"/>
  11265. <param name="recurrenceExpression" type="java.lang.String"/>
  11266. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  11267. </method>
  11268. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  11269. abstract="false" native="false" synchronized="false"
  11270. static="true" final="false" visibility="public"
  11271. deprecated="not deprecated">
  11272. <param name="arrival" type="long"/>
  11273. <param name="deadline" type="long"/>
  11274. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  11275. <param name="name" type="java.lang.String"/>
  11276. </method>
  11277. <method name="getArrival" return="long"
  11278. abstract="true" native="false" synchronized="false"
  11279. static="false" final="false" visibility="public"
  11280. deprecated="not deprecated">
  11281. <doc>
  11282. <![CDATA[Get the arrival time or the earliest time from which the resource(s) can be
  11283. allocated. Time expressed as UTC.
  11284. @return the earliest valid time for this reservation]]>
  11285. </doc>
  11286. </method>
  11287. <method name="setArrival"
  11288. abstract="true" native="false" synchronized="false"
  11289. static="false" final="false" visibility="public"
  11290. deprecated="not deprecated">
  11291. <param name="earliestStartTime" type="long"/>
  11292. <doc>
  11293. <![CDATA[Set the arrival time or the earliest time from which the resource(s) can be
  11294. allocated. Time expressed as UTC.
  11295. @param earliestStartTime the earliest valid time for this reservation]]>
  11296. </doc>
  11297. </method>
  11298. <method name="getDeadline" return="long"
  11299. abstract="true" native="false" synchronized="false"
  11300. static="false" final="false" visibility="public"
  11301. deprecated="not deprecated">
  11302. <doc>
  11303. <![CDATA[Get the deadline or the latest time by when the resource(s) must be
  11304. allocated. Time expressed as UTC.
  11305. @return the deadline or the latest time by when the resource(s) must be
  11306. allocated]]>
  11307. </doc>
  11308. </method>
  11309. <method name="setDeadline"
  11310. abstract="true" native="false" synchronized="false"
  11311. static="false" final="false" visibility="public"
  11312. deprecated="not deprecated">
  11313. <param name="latestEndTime" type="long"/>
  11314. <doc>
  11315. <![CDATA[Set the deadline or the latest time by when the resource(s) must be
  11316. allocated. Time expressed as UTC.
  11317. @param latestEndTime the deadline or the latest time by when the
  11318. resource(s) should be allocated]]>
  11319. </doc>
  11320. </method>
  11321. <method name="getReservationRequests" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
  11322. abstract="true" native="false" synchronized="false"
  11323. static="false" final="false" visibility="public"
  11324. deprecated="not deprecated">
  11325. <doc>
  11326. <![CDATA[Get the list of {@link ReservationRequests} representing the resources
  11327. required by the application
  11328. @return the list of {@link ReservationRequests}]]>
  11329. </doc>
  11330. </method>
  11331. <method name="setReservationRequests"
  11332. abstract="true" native="false" synchronized="false"
  11333. static="false" final="false" visibility="public"
  11334. deprecated="not deprecated">
  11335. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  11336. <doc>
  11337. <![CDATA[Set the list of {@link ReservationRequests} representing the resources
  11338. required by the application
  11339. @param reservationRequests the list of {@link ReservationRequests}]]>
  11340. </doc>
  11341. </method>
  11342. <method name="getReservationName" return="java.lang.String"
  11343. abstract="true" native="false" synchronized="false"
  11344. static="false" final="false" visibility="public"
  11345. deprecated="not deprecated">
  11346. <doc>
  11347. <![CDATA[Get the name for this reservation. The name need-not be unique, and it is
  11348. just a mnemonic for the user (akin to job names). Accepted reservations are
  11349. uniquely identified by a system-generated ReservationId.
  11350. @return string representing the name of the corresponding reserved resource
  11351. allocation in the scheduler]]>
  11352. </doc>
  11353. </method>
  11354. <method name="setReservationName"
  11355. abstract="true" native="false" synchronized="false"
  11356. static="false" final="false" visibility="public"
  11357. deprecated="not deprecated">
  11358. <param name="name" type="java.lang.String"/>
  11359. <doc>
  11360. <![CDATA[Set the name for this reservation. The name need-not be unique, and it is
  11361. just a mnemonic for the user (akin to job names). Accepted reservations are
  11362. uniquely identified by a system-generated ReservationId.
  11363. @param name representing the name of the corresponding reserved resource
  11364. allocation in the scheduler]]>
  11365. </doc>
  11366. </method>
  11367. <method name="getRecurrenceExpression" return="java.lang.String"
  11368. abstract="true" native="false" synchronized="false"
  11369. static="false" final="false" visibility="public"
  11370. deprecated="not deprecated">
  11371. <doc>
  11372. <![CDATA[Get the recurrence of this reservation representing the time period of
  11373. the periodic job. Currently, only long values are supported. Later,
  11374. support for regular expressions denoting arbitrary recurrence patterns
  11375. (e.g., every Tuesday and Thursday) will be added.
  11376. Recurrence is represented in milliseconds for periodic jobs.
  11377. Recurrence is 0 for non-periodic jobs. Periodic jobs are valid until they
  11378. are explicitly cancelled and have higher priority than non-periodic jobs
  11379. (during initial placement and replanning). Periodic job allocations are
  11380. consistent across runs (flexibility in allocation is leveraged only during
  11381. initial placement, allocations remain consistent thereafter). Note that
  11382. as a long, the recurrence expression must be greater than the duration of
  11383. the reservation (deadline - arrival). Also note that the configured max
  11384. period must be divisible by the recurrence expression if expressed as a
  11385. long.
  11386. @return recurrence of this reservation]]>
  11387. </doc>
  11388. </method>
  11389. <method name="setRecurrenceExpression"
  11390. abstract="true" native="false" synchronized="false"
  11391. static="false" final="false" visibility="public"
  11392. deprecated="not deprecated">
  11393. <param name="recurrenceExpression" type="java.lang.String"/>
  11394. <doc>
  11395. <![CDATA[Set the recurrence of this reservation representing the time period of
  11396. the periodic job. Currently, only long values are supported. Later,
  11397. support for regular expressions denoting arbitrary recurrence patterns
  11398. (e.g., every Tuesday and Thursday) will be added.
  11399. Recurrence is represented in milliseconds for periodic jobs.
  11400. Recurrence is 0 for non-periodic jobs. Periodic jobs are valid until they
  11401. are explicitly cancelled and have higher priority than non-periodic jobs
  11402. (during initial placement and replanning). Periodic job allocations are
  11403. consistent across runs (flexibility in allocation is leveraged only during
  11404. initial placement, allocations remain consistent thereafter). Note that
  11405. as a long, the recurrence expression must be greater than the duration of
  11406. the reservation (deadline - arrival). Also note that the configured max
  11407. period must be divisible by the recurrence expression if expressed as a
  11408. long.
  11409. @param recurrenceExpression recurrence interval of this reservation]]>
  11410. </doc>
  11411. </method>
  11412. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  11413. abstract="true" native="false" synchronized="false"
  11414. static="false" final="false" visibility="public"
  11415. deprecated="not deprecated">
  11416. <doc>
  11417. <![CDATA[Get the priority for this reservation. A lower number for priority
  11418. indicates a higher priority reservation. Recurring reservations are
  11419. always higher priority than non-recurring reservations. Priority for
  11420. non-recurring reservations are only compared with non-recurring
  11421. reservations. Likewise for recurring reservations.
  11422. @return int representing the priority of the reserved resource
  11423. allocation in the scheduler]]>
  11424. </doc>
  11425. </method>
  11426. <method name="setPriority"
  11427. abstract="true" native="false" synchronized="false"
  11428. static="false" final="false" visibility="public"
  11429. deprecated="not deprecated">
  11430. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  11431. <doc>
  11432. <![CDATA[Set the priority for this reservation. A lower number for priority
  11433. indicates a higher priority reservation. Recurring reservations are
  11434. always higher priority than non-recurring reservations. Priority for
  11435. non-recurring reservations are only compared with non-recurring
  11436. reservations. Likewise for recurring reservations.
  11437. @param priority representing the priority of the reserved resource
  11438. allocation in the scheduler]]>
  11439. </doc>
  11440. </method>
  11441. <doc>
  11442. <![CDATA[{@link ReservationDefinition} captures the set of resource and time
  11443. constraints the user cares about regarding a reservation.
  11444. @see ResourceRequest]]>
  11445. </doc>
  11446. </class>
  11447. <!-- end class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
  11448. <!-- start class org.apache.hadoop.yarn.api.records.ReservationId -->
  11449. <class name="ReservationId" extends="java.lang.Object"
  11450. abstract="true"
  11451. static="false" final="false" visibility="public"
  11452. deprecated="not deprecated">
  11453. <implements name="java.lang.Comparable"/>
  11454. <constructor name="ReservationId"
  11455. static="false" final="false" visibility="public"
  11456. deprecated="not deprecated">
  11457. </constructor>
  11458. <method name="getId" return="long"
  11459. abstract="true" native="false" synchronized="false"
  11460. static="false" final="false" visibility="public"
  11461. deprecated="not deprecated">
  11462. <doc>
  11463. <![CDATA[Get the long identifier of the {@link ReservationId} which is unique for
  11464. all Reservations started by a particular instance of the
  11465. {@code ResourceManager}.
  11466. @return long identifier of the {@link ReservationId}]]>
  11467. </doc>
  11468. </method>
  11469. <method name="getClusterTimestamp" return="long"
  11470. abstract="true" native="false" synchronized="false"
  11471. static="false" final="false" visibility="public"
  11472. deprecated="not deprecated">
  11473. <doc>
  11474. <![CDATA[Get the <em>start time</em> of the {@code ResourceManager} which is used to
  11475. generate globally unique {@link ReservationId}.
  11476. @return <em>start time</em> of the {@code ResourceManager}]]>
  11477. </doc>
  11478. </method>
  11479. <method name="build"
  11480. abstract="true" native="false" synchronized="false"
  11481. static="false" final="false" visibility="protected"
  11482. deprecated="not deprecated">
  11483. </method>
  11484. <method name="compareTo" return="int"
  11485. abstract="false" native="false" synchronized="false"
  11486. static="false" final="false" visibility="public"
  11487. deprecated="not deprecated">
  11488. <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  11489. </method>
  11490. <method name="toString" return="java.lang.String"
  11491. abstract="false" native="false" synchronized="false"
  11492. static="false" final="false" visibility="public"
  11493. deprecated="not deprecated">
  11494. </method>
  11495. <method name="parseReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  11496. abstract="false" native="false" synchronized="false"
  11497. static="true" final="false" visibility="public"
  11498. deprecated="not deprecated">
  11499. <param name="reservationId" type="java.lang.String"/>
  11500. <exception name="IOException" type="java.io.IOException"/>
  11501. <doc>
  11502. <![CDATA[Parse the string argument as a {@link ReservationId}
  11503. @param reservationId the string representation of the {@link ReservationId}
  11504. @return the {@link ReservationId} corresponding to the input string if
  11505. valid, null if input is null
  11506. @throws IOException if unable to parse the input string]]>
  11507. </doc>
  11508. </method>
  11509. <method name="hashCode" return="int"
  11510. abstract="false" native="false" synchronized="false"
  11511. static="false" final="false" visibility="public"
  11512. deprecated="not deprecated">
  11513. </method>
  11514. <method name="equals" return="boolean"
  11515. abstract="false" native="false" synchronized="false"
  11516. static="false" final="false" visibility="public"
  11517. deprecated="not deprecated">
  11518. <param name="obj" type="java.lang.Object"/>
  11519. </method>
  11520. <field name="reserveIdStrPrefix" type="java.lang.String"
  11521. transient="false" volatile="false"
  11522. static="true" final="true" visibility="public"
  11523. deprecated="not deprecated">
  11524. </field>
  11525. <field name="clusterTimestamp" type="long"
  11526. transient="false" volatile="false"
  11527. static="false" final="false" visibility="protected"
  11528. deprecated="not deprecated">
  11529. </field>
  11530. <field name="id" type="long"
  11531. transient="false" volatile="false"
  11532. static="false" final="false" visibility="protected"
  11533. deprecated="not deprecated">
  11534. </field>
  11535. <doc>
  11536. <![CDATA[<p>
  11537. {@link ReservationId} represents the <em>globally unique</em> identifier for
  11538. a reservation.
  11539. </p>
  11540. <p>
  11541. The globally unique nature of the identifier is achieved by using the
  11542. <em>cluster timestamp</em> i.e. start-time of the {@code ResourceManager}
  11543. along with a monotonically increasing counter for the reservation.
  11544. </p>]]>
  11545. </doc>
  11546. </class>
  11547. <!-- end class org.apache.hadoop.yarn.api.records.ReservationId -->
  11548. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest -->
  11549. <class name="ReservationRequest" extends="java.lang.Object"
  11550. abstract="true"
  11551. static="false" final="false" visibility="public"
  11552. deprecated="not deprecated">
  11553. <implements name="java.lang.Comparable"/>
  11554. <constructor name="ReservationRequest"
  11555. static="false" final="false" visibility="public"
  11556. deprecated="not deprecated">
  11557. </constructor>
  11558. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
  11559. abstract="false" native="false" synchronized="false"
  11560. static="true" final="false" visibility="public"
  11561. deprecated="not deprecated">
  11562. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11563. <param name="numContainers" type="int"/>
  11564. </method>
  11565. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
  11566. abstract="false" native="false" synchronized="false"
  11567. static="true" final="false" visibility="public"
  11568. deprecated="not deprecated">
  11569. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11570. <param name="numContainers" type="int"/>
  11571. <param name="concurrency" type="int"/>
  11572. <param name="duration" type="long"/>
  11573. </method>
  11574. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  11575. abstract="true" native="false" synchronized="false"
  11576. static="false" final="false" visibility="public"
  11577. deprecated="not deprecated">
  11578. <doc>
  11579. <![CDATA[Get the {@link Resource} capability of the request.
  11580. @return {@link Resource} capability of the request]]>
  11581. </doc>
  11582. </method>
  11583. <method name="setCapability"
  11584. abstract="true" native="false" synchronized="false"
  11585. static="false" final="false" visibility="public"
  11586. deprecated="not deprecated">
  11587. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11588. <doc>
  11589. <![CDATA[Set the {@link Resource} capability of the request
  11590. @param capability {@link Resource} capability of the request]]>
  11591. </doc>
  11592. </method>
  11593. <method name="getNumContainers" return="int"
  11594. abstract="true" native="false" synchronized="false"
  11595. static="false" final="false" visibility="public"
  11596. deprecated="not deprecated">
  11597. <doc>
  11598. <![CDATA[Get the number of containers required with the given specifications.
  11599. @return number of containers required with the given specifications]]>
  11600. </doc>
  11601. </method>
  11602. <method name="setNumContainers"
  11603. abstract="true" native="false" synchronized="false"
  11604. static="false" final="false" visibility="public"
  11605. deprecated="not deprecated">
  11606. <param name="numContainers" type="int"/>
  11607. <doc>
  11608. <![CDATA[Set the number of containers required with the given specifications
  11609. @param numContainers number of containers required with the given
  11610. specifications]]>
  11611. </doc>
  11612. </method>
  11613. <method name="getConcurrency" return="int"
  11614. abstract="true" native="false" synchronized="false"
  11615. static="false" final="false" visibility="public"
  11616. deprecated="not deprecated">
  11617. <doc>
  11618. <![CDATA[Get the number of containers that need to be scheduled concurrently. The
  11619. default value of 1 would fall back to the current non concurrency
  11620. constraints on the scheduling behavior.
  11621. @return the number of containers to be concurrently scheduled]]>
  11622. </doc>
  11623. </method>
  11624. <method name="setConcurrency"
  11625. abstract="true" native="false" synchronized="false"
  11626. static="false" final="false" visibility="public"
  11627. deprecated="not deprecated">
  11628. <param name="numContainers" type="int"/>
  11629. <doc>
  11630. <![CDATA[Set the number of containers that need to be scheduled concurrently. The
  11631. default value of 1 would fall back to the current non concurrency
  11632. constraints on the scheduling behavior.
  11633. @param numContainers the number of containers to be concurrently scheduled]]>
  11634. </doc>
  11635. </method>
  11636. <method name="getDuration" return="long"
  11637. abstract="true" native="false" synchronized="false"
  11638. static="false" final="false" visibility="public"
  11639. deprecated="not deprecated">
  11640. <doc>
  11641. <![CDATA[Get the duration in milliseconds for which the resource is required. A
  11642. default value of -1, indicates an unspecified lease duration, and fallback
  11643. to current behavior.
  11644. @return the duration in milliseconds for which the resource is required]]>
  11645. </doc>
  11646. </method>
  11647. <method name="setDuration"
  11648. abstract="true" native="false" synchronized="false"
  11649. static="false" final="false" visibility="public"
  11650. deprecated="not deprecated">
  11651. <param name="duration" type="long"/>
  11652. <doc>
  11653. <![CDATA[Set the duration in milliseconds for which the resource is required.
  11654. @param duration the duration in milliseconds for which the resource is
  11655. required]]>
  11656. </doc>
  11657. </method>
  11658. <method name="hashCode" return="int"
  11659. abstract="false" native="false" synchronized="false"
  11660. static="false" final="false" visibility="public"
  11661. deprecated="not deprecated">
  11662. </method>
  11663. <method name="equals" return="boolean"
  11664. abstract="false" native="false" synchronized="false"
  11665. static="false" final="false" visibility="public"
  11666. deprecated="not deprecated">
  11667. <param name="obj" type="java.lang.Object"/>
  11668. </method>
  11669. <method name="compareTo" return="int"
  11670. abstract="false" native="false" synchronized="false"
  11671. static="false" final="false" visibility="public"
  11672. deprecated="not deprecated">
  11673. <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  11674. </method>
  11675. <doc>
  11676. <![CDATA[{@link ReservationRequest} represents the request made by an application to
  11677. the {@code ResourceManager} to reserve {@link Resource}s.
  11678. <p>
  11679. It includes:
  11680. <ul>
  11681. <li>{@link Resource} required for each request.</li>
  11682. <li>
  11683. Number of containers, of above specifications, which are required by the
  11684. application.
  11685. </li>
  11686. <li>Concurrency that indicates the gang size of the request.</li>
  11687. </ul>]]>
  11688. </doc>
  11689. </class>
  11690. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest -->
  11691. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
  11692. <class name="ReservationRequest.ReservationRequestComparator" extends="java.lang.Object"
  11693. abstract="false"
  11694. static="true" final="false" visibility="public"
  11695. deprecated="not deprecated">
  11696. <implements name="java.util.Comparator"/>
  11697. <implements name="java.io.Serializable"/>
  11698. <constructor name="ReservationRequestComparator"
  11699. static="false" final="false" visibility="public"
  11700. deprecated="not deprecated">
  11701. </constructor>
  11702. <method name="compare" return="int"
  11703. abstract="false" native="false" synchronized="false"
  11704. static="false" final="false" visibility="public"
  11705. deprecated="not deprecated">
  11706. <param name="r1" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  11707. <param name="r2" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  11708. </method>
  11709. </class>
  11710. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
  11711. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
  11712. <class name="ReservationRequestInterpreter" extends="java.lang.Enum"
  11713. abstract="false"
  11714. static="false" final="true" visibility="public"
  11715. deprecated="not deprecated">
  11716. <method name="values" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter[]"
  11717. abstract="false" native="false" synchronized="false"
  11718. static="true" final="false" visibility="public"
  11719. deprecated="not deprecated">
  11720. </method>
  11721. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
  11722. abstract="false" native="false" synchronized="false"
  11723. static="true" final="false" visibility="public"
  11724. deprecated="not deprecated">
  11725. <param name="name" type="java.lang.String"/>
  11726. </method>
  11727. <doc>
  11728. <![CDATA[Enumeration of various types of dependencies among multiple
  11729. {@link ReservationRequests} within one {@link ReservationDefinition} (from
  11730. least constraining to most constraining).]]>
  11731. </doc>
  11732. </class>
  11733. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
  11734. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequests -->
  11735. <class name="ReservationRequests" extends="java.lang.Object"
  11736. abstract="true"
  11737. static="false" final="false" visibility="public"
  11738. deprecated="not deprecated">
  11739. <constructor name="ReservationRequests"
  11740. static="false" final="false" visibility="public"
  11741. deprecated="not deprecated">
  11742. </constructor>
  11743. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
  11744. abstract="false" native="false" synchronized="false"
  11745. static="true" final="false" visibility="public"
  11746. deprecated="not deprecated">
  11747. <param name="reservationResources" type="java.util.List"/>
  11748. <param name="type" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
  11749. </method>
  11750. <method name="getReservationResources" return="java.util.List"
  11751. abstract="true" native="false" synchronized="false"
  11752. static="false" final="false" visibility="public"
  11753. deprecated="not deprecated">
  11754. <doc>
  11755. <![CDATA[Get the list of {@link ReservationRequest} representing the resources
  11756. required by the application
  11757. @return the list of {@link ReservationRequest}]]>
  11758. </doc>
  11759. </method>
  11760. <method name="setReservationResources"
  11761. abstract="true" native="false" synchronized="false"
  11762. static="false" final="false" visibility="public"
  11763. deprecated="not deprecated">
  11764. <param name="reservationResources" type="java.util.List"/>
  11765. <doc>
  11766. <![CDATA[Set the list of {@link ReservationRequest} representing the resources
  11767. required by the application
  11768. @param reservationResources the list of {@link ReservationRequest}]]>
  11769. </doc>
  11770. </method>
  11771. <method name="getInterpreter" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
  11772. abstract="true" native="false" synchronized="false"
  11773. static="false" final="false" visibility="public"
  11774. deprecated="not deprecated">
  11775. <doc>
  11776. <![CDATA[Get the {@link ReservationRequestInterpreter}, representing how the list of
  11777. resources should be allocated, this captures temporal ordering and other
  11778. constraints.
  11779. @return the list of {@link ReservationRequestInterpreter}]]>
  11780. </doc>
  11781. </method>
  11782. <method name="setInterpreter"
  11783. abstract="true" native="false" synchronized="false"
  11784. static="false" final="false" visibility="public"
  11785. deprecated="not deprecated">
  11786. <param name="interpreter" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
  11787. <doc>
  11788. <![CDATA[Set the {@link ReservationRequestInterpreter}, representing how the list of
  11789. resources should be allocated, this captures temporal ordering and other
  11790. constraints.
  11791. @param interpreter the {@link ReservationRequestInterpreter} for this
  11792. reservation]]>
  11793. </doc>
  11794. </method>
  11795. <doc>
  11796. <![CDATA[{@link ReservationRequests} captures the set of resource and constraints the
  11797. user cares about regarding a reservation.
  11798. @see ReservationRequest]]>
  11799. </doc>
  11800. </class>
  11801. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequests -->
  11802. <!-- start class org.apache.hadoop.yarn.api.records.Resource -->
  11803. <class name="Resource" extends="java.lang.Object"
  11804. abstract="true"
  11805. static="false" final="false" visibility="public"
  11806. deprecated="not deprecated">
  11807. <implements name="java.lang.Comparable"/>
  11808. <constructor name="Resource"
  11809. static="false" final="false" visibility="public"
  11810. deprecated="not deprecated">
  11811. </constructor>
  11812. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
  11813. abstract="false" native="false" synchronized="false"
  11814. static="true" final="false" visibility="public"
  11815. deprecated="not deprecated">
  11816. <param name="memory" type="int"/>
  11817. <param name="vCores" type="int"/>
  11818. </method>
  11819. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
  11820. abstract="false" native="false" synchronized="false"
  11821. static="true" final="false" visibility="public"
  11822. deprecated="not deprecated">
  11823. <param name="memory" type="long"/>
  11824. <param name="vCores" type="int"/>
  11825. </method>
  11826. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
  11827. abstract="false" native="false" synchronized="false"
  11828. static="true" final="false" visibility="public"
  11829. deprecated="not deprecated">
  11830. <param name="memory" type="long"/>
  11831. <param name="vCores" type="int"/>
  11832. <param name="others" type="java.util.Map"/>
  11833. <doc>
  11834. <![CDATA[Create a new {@link Resource} instance with the given CPU and memory
  11835. values and additional resource values as set in the {@code others}
  11836. parameter. Note that the CPU and memory settings in the {@code others}
  11837. parameter will be ignored.
  11838. @param memory the memory value
  11839. @param vCores the CPU value
  11840. @param others a map of other resource values indexed by resource name
  11841. @return a {@link Resource} instance with the given resource values]]>
  11842. </doc>
  11843. </method>
  11844. <method name="getMemory" return="int"
  11845. abstract="true" native="false" synchronized="false"
  11846. static="false" final="false" visibility="public"
  11847. deprecated="not deprecated">
  11848. <doc>
  11849. <![CDATA[This method is DEPRECATED:
  11850. Use {@link Resource#getMemorySize()} instead
  11851. Get <em>memory</em> of the resource. Note - while memory has
  11852. never had a unit specified, all YARN configurations have specified memory
  11853. in MB. The assumption has been that the daemons and applications are always
  11854. using the same units. With the introduction of the ResourceInformation
  11855. class we have support for units - so this function will continue to return
  11856. memory but in the units of MB
  11857. @return <em>memory</em>(in MB) of the resource]]>
  11858. </doc>
  11859. </method>
  11860. <method name="getMemorySize" return="long"
  11861. abstract="false" native="false" synchronized="false"
  11862. static="false" final="false" visibility="public"
  11863. deprecated="not deprecated">
  11864. <doc>
  11865. <![CDATA[Get <em>memory</em> of the resource. Note - while memory has
  11866. never had a unit specified, all YARN configurations have specified memory
  11867. in MB. The assumption has been that the daemons and applications are always
  11868. using the same units. With the introduction of the ResourceInformation
  11869. class we have support for units - so this function will continue to return
  11870. memory but in the units of MB
  11871. @return <em>memory</em> of the resource]]>
  11872. </doc>
  11873. </method>
  11874. <method name="setMemory"
  11875. abstract="true" native="false" synchronized="false"
  11876. static="false" final="false" visibility="public"
  11877. deprecated="not deprecated">
  11878. <param name="memory" type="int"/>
  11879. <doc>
  11880. <![CDATA[Set <em>memory</em> of the resource. Note - while memory has
  11881. never had a unit specified, all YARN configurations have specified memory
  11882. in MB. The assumption has been that the daemons and applications are always
  11883. using the same units. With the introduction of the ResourceInformation
  11884. class we have support for units - so this function will continue to set
  11885. memory but the assumption is that the value passed is in units of MB.
  11886. @param memory <em>memory</em>(in MB) of the resource]]>
  11887. </doc>
  11888. </method>
  11889. <method name="setMemorySize"
  11890. abstract="false" native="false" synchronized="false"
  11891. static="false" final="false" visibility="public"
  11892. deprecated="not deprecated">
  11893. <param name="memory" type="long"/>
  11894. <doc>
  11895. <![CDATA[Set <em>memory</em> of the resource.
  11896. @param memory <em>memory</em> of the resource]]>
  11897. </doc>
  11898. </method>
  11899. <method name="getVirtualCores" return="int"
  11900. abstract="true" native="false" synchronized="false"
  11901. static="false" final="false" visibility="public"
  11902. deprecated="not deprecated">
  11903. <doc>
  11904. <![CDATA[Get <em>number of virtual cpu cores</em> of the resource.
  11905. Virtual cores are a unit for expressing CPU parallelism. A node's capacity
  11906. should be configured with virtual cores equal to its number of physical
  11907. cores. A container should be requested with the number of cores it can
  11908. saturate, i.e. the average number of threads it expects to have runnable
  11909. at a time.
  11910. @return <em>num of virtual cpu cores</em> of the resource]]>
  11911. </doc>
  11912. </method>
  11913. <method name="setVirtualCores"
  11914. abstract="true" native="false" synchronized="false"
  11915. static="false" final="false" visibility="public"
  11916. deprecated="not deprecated">
  11917. <param name="vCores" type="int"/>
  11918. <doc>
  11919. <![CDATA[Set <em>number of virtual cpu cores</em> of the resource.
  11920. Virtual cores are a unit for expressing CPU parallelism. A node's capacity
  11921. should be configured with virtual cores equal to its number of physical
  11922. cores. A container should be requested with the number of cores it can
  11923. saturate, i.e. the average number of threads it expects to have runnable
  11924. at a time.
  11925. @param vCores <em>number of virtual cpu cores</em> of the resource]]>
  11926. </doc>
  11927. </method>
  11928. <method name="getResourceInformation" return="org.apache.hadoop.yarn.api.records.ResourceInformation"
  11929. abstract="false" native="false" synchronized="false"
  11930. static="false" final="false" visibility="public"
  11931. deprecated="not deprecated">
  11932. <param name="resource" type="java.lang.String"/>
  11933. <doc>
  11934. <![CDATA[Get ResourceInformation for a specified resource.
  11935. @param resource name of the resource
  11936. @return the ResourceInformation object for the resource]]>
  11937. </doc>
  11938. </method>
  11939. <method name="getResourceValue" return="long"
  11940. abstract="false" native="false" synchronized="false"
  11941. static="false" final="false" visibility="public"
  11942. deprecated="not deprecated">
  11943. <param name="resource" type="java.lang.String"/>
  11944. <doc>
  11945. <![CDATA[Get the value for a specified resource. No information about the units is
  11946. returned.
  11947. @param resource name of the resource
  11948. @return the value for the resource]]>
  11949. </doc>
  11950. </method>
  11951. <method name="setResourceInformation"
  11952. abstract="false" native="false" synchronized="false"
  11953. static="false" final="false" visibility="public"
  11954. deprecated="not deprecated">
  11955. <param name="resource" type="java.lang.String"/>
  11956. <param name="resourceInformation" type="org.apache.hadoop.yarn.api.records.ResourceInformation"/>
  11957. <doc>
  11958. <![CDATA[Set the ResourceInformation object for a particular resource.
  11959. @param resource the resource for which the ResourceInformation is provided
  11960. @param resourceInformation ResourceInformation object]]>
  11961. </doc>
  11962. </method>
  11963. <method name="setResourceValue"
  11964. abstract="false" native="false" synchronized="false"
  11965. static="false" final="false" visibility="public"
  11966. deprecated="not deprecated">
  11967. <param name="resource" type="java.lang.String"/>
  11968. <param name="value" type="long"/>
  11969. <doc>
  11970. <![CDATA[Set the value of a resource in the ResourceInformation object. The unit of
  11971. the value is assumed to be the one in the ResourceInformation object.
  11972. @param resource the resource for which the value is provided.
  11973. @param value the value to set]]>
  11974. </doc>
  11975. </method>
  11976. <method name="throwExceptionWhenArrayOutOfBound"
  11977. abstract="false" native="false" synchronized="false"
  11978. static="false" final="false" visibility="protected"
  11979. deprecated="not deprecated">
  11980. <param name="index" type="int"/>
  11981. </method>
  11982. <method name="equals" return="boolean"
  11983. abstract="false" native="false" synchronized="false"
  11984. static="false" final="false" visibility="public"
  11985. deprecated="not deprecated">
  11986. <param name="obj" type="java.lang.Object"/>
  11987. </method>
  11988. <method name="compareTo" return="int"
  11989. abstract="false" native="false" synchronized="false"
  11990. static="false" final="false" visibility="public"
  11991. deprecated="not deprecated">
  11992. <param name="other" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11993. </method>
  11994. <method name="toString" return="java.lang.String"
  11995. abstract="false" native="false" synchronized="false"
  11996. static="false" final="false" visibility="public"
  11997. deprecated="not deprecated">
  11998. </method>
  11999. <method name="getFormattedString" return="java.lang.String"
  12000. abstract="false" native="false" synchronized="false"
  12001. static="false" final="false" visibility="public"
  12002. deprecated="not deprecated">
  12003. <doc>
  12004. <![CDATA[This method is to get memory in terms of KB|MB|GB.
  12005. @return string containing all resources]]>
  12006. </doc>
  12007. </method>
  12008. <method name="hashCode" return="int"
  12009. abstract="false" native="false" synchronized="false"
  12010. static="false" final="false" visibility="public"
  12011. deprecated="not deprecated">
  12012. </method>
  12013. <method name="castToIntSafely" return="int"
  12014. abstract="false" native="false" synchronized="false"
  12015. static="true" final="false" visibility="protected"
  12016. deprecated="not deprecated">
  12017. <param name="value" type="long"/>
  12018. <doc>
  12019. <![CDATA[Convert long to int for a resource value safely. This method assumes
  12020. resource value is positive.
  12021. @param value long resource value
  12022. @return int resource value]]>
  12023. </doc>
  12024. </method>
  12025. <method name="newDefaultInformation" return="org.apache.hadoop.yarn.api.records.ResourceInformation"
  12026. abstract="false" native="false" synchronized="false"
  12027. static="true" final="false" visibility="protected"
  12028. deprecated="not deprecated">
  12029. <param name="name" type="java.lang.String"/>
  12030. <param name="unit" type="java.lang.String"/>
  12031. <param name="value" type="long"/>
  12032. <doc>
  12033. <![CDATA[Create ResourceInformation with basic fields.
  12034. @param name Resource Type Name
  12035. @param unit Default unit of provided resource type
  12036. @param value Value associated with giveb resource
  12037. @return ResourceInformation object]]>
  12038. </doc>
  12039. </method>
  12040. <field name="resources" type="org.apache.hadoop.yarn.api.records.ResourceInformation[]"
  12041. transient="false" volatile="false"
  12042. static="false" final="false" visibility="protected"
  12043. deprecated="not deprecated">
  12044. </field>
  12045. <field name="MEMORY_INDEX" type="int"
  12046. transient="false" volatile="false"
  12047. static="true" final="true" visibility="public"
  12048. deprecated="not deprecated">
  12049. </field>
  12050. <field name="VCORES_INDEX" type="int"
  12051. transient="false" volatile="false"
  12052. static="true" final="true" visibility="public"
  12053. deprecated="not deprecated">
  12054. </field>
  12055. <doc>
  12056. <![CDATA[<p><code>Resource</code> models a set of computer resources in the
  12057. cluster.</p>
  12058. <p>Currently it models both <em>memory</em> and <em>CPU</em>.</p>
  12059. <p>The unit for memory is megabytes. CPU is modeled with virtual cores
  12060. (vcores), a unit for expressing parallelism. A node's capacity should
  12061. be configured with virtual cores equal to its number of physical cores. A
  12062. container should be requested with the number of cores it can saturate, i.e.
  12063. the average number of threads it expects to have runnable at a time.</p>
  12064. <p>Virtual cores take integer values and thus currently CPU-scheduling is
  12065. very coarse. A complementary axis for CPU requests that represents
  12066. processing power will likely be added in the future to enable finer-grained
  12067. resource configuration.</p>
  12068. <p>Typically, applications request <code>Resource</code> of suitable
  12069. capability to run their component tasks.</p>
  12070. @see ResourceRequest
  12071. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  12072. </doc>
  12073. </class>
  12074. <!-- end class org.apache.hadoop.yarn.api.records.Resource -->
  12075. <!-- start class org.apache.hadoop.yarn.api.records.ResourceAllocationRequest -->
  12076. <class name="ResourceAllocationRequest" extends="java.lang.Object"
  12077. abstract="true"
  12078. static="false" final="false" visibility="public"
  12079. deprecated="not deprecated">
  12080. <constructor name="ResourceAllocationRequest"
  12081. static="false" final="false" visibility="public"
  12082. deprecated="not deprecated">
  12083. </constructor>
  12084. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceAllocationRequest"
  12085. abstract="false" native="false" synchronized="false"
  12086. static="true" final="false" visibility="public"
  12087. deprecated="not deprecated">
  12088. <param name="startTime" type="long"/>
  12089. <param name="endTime" type="long"/>
  12090. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12091. <doc>
  12092. <![CDATA[@param startTime The start time that the capability is reserved for.
  12093. @param endTime The end time that the capability is reserved for.
  12094. @param capability {@link Resource} representing the capability of the
  12095. resource allocation.
  12096. @return {ResourceAllocationRequest} which represents the capability of
  12097. the resource allocation for a time interval.]]>
  12098. </doc>
  12099. </method>
  12100. <method name="getStartTime" return="long"
  12101. abstract="true" native="false" synchronized="false"
  12102. static="false" final="false" visibility="public"
  12103. deprecated="not deprecated">
  12104. <doc>
  12105. <![CDATA[Get the start time that the resource is allocated.
  12106. @return the start time that the resource is allocated.]]>
  12107. </doc>
  12108. </method>
  12109. <method name="getEndTime" return="long"
  12110. abstract="true" native="false" synchronized="false"
  12111. static="false" final="false" visibility="public"
  12112. deprecated="not deprecated">
  12113. <doc>
  12114. <![CDATA[Get the end time that the resource is allocated.
  12115. @return the end time that the resource is allocated.]]>
  12116. </doc>
  12117. </method>
  12118. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  12119. abstract="true" native="false" synchronized="false"
  12120. static="false" final="false" visibility="public"
  12121. deprecated="not deprecated">
  12122. <doc>
  12123. <![CDATA[Get the allocated resource.
  12124. @return the allocated resource.]]>
  12125. </doc>
  12126. </method>
  12127. <doc>
  12128. <![CDATA[{@code ResourceAllocationRequest} represents an allocation
  12129. made for a reservation for the current state of the plan. This can be
  12130. changed for reasons such as re-planning, but will always be subject to the
  12131. constraints of the user contract as described by
  12132. {@link ReservationDefinition}
  12133. {@link Resource}
  12134. <p>
  12135. It includes:
  12136. <ul>
  12137. <li>StartTime of the allocation.</li>
  12138. <li>EndTime of the allocation.</li>
  12139. <li>{@link Resource} reserved for the allocation.</li>
  12140. </ul>
  12141. @see Resource]]>
  12142. </doc>
  12143. </class>
  12144. <!-- end class org.apache.hadoop.yarn.api.records.ResourceAllocationRequest -->
  12145. <!-- start class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
  12146. <class name="ResourceBlacklistRequest" extends="java.lang.Object"
  12147. abstract="true"
  12148. static="false" final="false" visibility="public"
  12149. deprecated="not deprecated">
  12150. <constructor name="ResourceBlacklistRequest"
  12151. static="false" final="false" visibility="public"
  12152. deprecated="not deprecated">
  12153. </constructor>
  12154. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
  12155. abstract="false" native="false" synchronized="false"
  12156. static="true" final="false" visibility="public"
  12157. deprecated="not deprecated">
  12158. <param name="additions" type="java.util.List"/>
  12159. <param name="removals" type="java.util.List"/>
  12160. </method>
  12161. <method name="getBlacklistAdditions" return="java.util.List"
  12162. abstract="true" native="false" synchronized="false"
  12163. static="false" final="false" visibility="public"
  12164. deprecated="not deprecated">
  12165. <doc>
  12166. <![CDATA[Get the list of resource-names which should be added to the
  12167. application blacklist.
  12168. @return list of resource-names which should be added to the
  12169. application blacklist]]>
  12170. </doc>
  12171. </method>
  12172. <method name="setBlacklistAdditions"
  12173. abstract="true" native="false" synchronized="false"
  12174. static="false" final="false" visibility="public"
  12175. deprecated="not deprecated">
  12176. <param name="resourceNames" type="java.util.List"/>
  12177. <doc>
  12178. <![CDATA[Set list of resource-names which should be added to the application blacklist.
  12179. @param resourceNames list of resource-names which should be added to the
  12180. application blacklist]]>
  12181. </doc>
  12182. </method>
  12183. <method name="getBlacklistRemovals" return="java.util.List"
  12184. abstract="true" native="false" synchronized="false"
  12185. static="false" final="false" visibility="public"
  12186. deprecated="not deprecated">
  12187. <doc>
  12188. <![CDATA[Get the list of resource-names which should be removed from the
  12189. application blacklist.
  12190. @return list of resource-names which should be removed from the
  12191. application blacklist]]>
  12192. </doc>
  12193. </method>
  12194. <method name="setBlacklistRemovals"
  12195. abstract="true" native="false" synchronized="false"
  12196. static="false" final="false" visibility="public"
  12197. deprecated="not deprecated">
  12198. <param name="resourceNames" type="java.util.List"/>
  12199. <doc>
  12200. <![CDATA[Set list of resource-names which should be removed from the
  12201. application blacklist.
  12202. @param resourceNames list of resource-names which should be removed from the
  12203. application blacklist]]>
  12204. </doc>
  12205. </method>
  12206. <doc>
  12207. <![CDATA[{@link ResourceBlacklistRequest} encapsulates the list of resource-names
  12208. which should be added or removed from the <em>blacklist</em> of resources
  12209. for the application.
  12210. @see ResourceRequest
  12211. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  12212. </doc>
  12213. </class>
  12214. <!-- end class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
  12215. <!-- start class org.apache.hadoop.yarn.api.records.ResourceOption -->
  12216. <class name="ResourceOption" extends="java.lang.Object"
  12217. abstract="true"
  12218. static="false" final="false" visibility="public"
  12219. deprecated="not deprecated">
  12220. <constructor name="ResourceOption"
  12221. static="false" final="false" visibility="public"
  12222. deprecated="not deprecated">
  12223. </constructor>
  12224. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceOption"
  12225. abstract="false" native="false" synchronized="false"
  12226. static="true" final="false" visibility="public"
  12227. deprecated="not deprecated">
  12228. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12229. <param name="overCommitTimeout" type="int"/>
  12230. </method>
  12231. <method name="toString" return="java.lang.String"
  12232. abstract="false" native="false" synchronized="false"
  12233. static="false" final="false" visibility="public"
  12234. deprecated="not deprecated">
  12235. </method>
  12236. <field name="OVER_COMMIT_TIMEOUT_MILLIS_DEFAULT" type="int"
  12237. transient="false" volatile="false"
  12238. static="true" final="true" visibility="public"
  12239. deprecated="not deprecated">
  12240. <doc>
  12241. <![CDATA[Negative value means no timeout.]]>
  12242. </doc>
  12243. </field>
  12244. </class>
  12245. <!-- end class org.apache.hadoop.yarn.api.records.ResourceOption -->
  12246. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest -->
  12247. <class name="ResourceRequest" extends="java.lang.Object"
  12248. abstract="true"
  12249. static="false" final="false" visibility="public"
  12250. deprecated="not deprecated">
  12251. <implements name="java.lang.Comparable"/>
  12252. <constructor name="ResourceRequest"
  12253. static="false" final="false" visibility="public"
  12254. deprecated="not deprecated">
  12255. </constructor>
  12256. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  12257. abstract="false" native="false" synchronized="false"
  12258. static="true" final="false" visibility="public"
  12259. deprecated="not deprecated">
  12260. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12261. <param name="hostName" type="java.lang.String"/>
  12262. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12263. <param name="numContainers" type="int"/>
  12264. </method>
  12265. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  12266. abstract="false" native="false" synchronized="false"
  12267. static="true" final="false" visibility="public"
  12268. deprecated="not deprecated">
  12269. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12270. <param name="hostName" type="java.lang.String"/>
  12271. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12272. <param name="numContainers" type="int"/>
  12273. <param name="relaxLocality" type="boolean"/>
  12274. </method>
  12275. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  12276. abstract="false" native="false" synchronized="false"
  12277. static="true" final="false" visibility="public"
  12278. deprecated="not deprecated">
  12279. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12280. <param name="hostName" type="java.lang.String"/>
  12281. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12282. <param name="numContainers" type="int"/>
  12283. <param name="relaxLocality" type="boolean"/>
  12284. <param name="labelExpression" type="java.lang.String"/>
  12285. </method>
  12286. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  12287. abstract="false" native="false" synchronized="false"
  12288. static="true" final="false" visibility="public"
  12289. deprecated="not deprecated">
  12290. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12291. <param name="hostName" type="java.lang.String"/>
  12292. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12293. <param name="numContainers" type="int"/>
  12294. <param name="relaxLocality" type="boolean"/>
  12295. <param name="labelExpression" type="java.lang.String"/>
  12296. <param name="executionTypeRequest" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  12297. </method>
  12298. <method name="clone" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  12299. abstract="false" native="false" synchronized="false"
  12300. static="true" final="false" visibility="public"
  12301. deprecated="not deprecated">
  12302. <param name="rr" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  12303. <doc>
  12304. <![CDATA[Clone a ResourceRequest object (shallow copy). Please keep it loaded with
  12305. all (new) fields
  12306. @param rr the object to copy from
  12307. @return the copied object]]>
  12308. </doc>
  12309. </method>
  12310. <method name="newBuilder" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12311. abstract="false" native="false" synchronized="false"
  12312. static="true" final="false" visibility="public"
  12313. deprecated="not deprecated">
  12314. </method>
  12315. <method name="isAnyLocation" return="boolean"
  12316. abstract="false" native="false" synchronized="false"
  12317. static="true" final="false" visibility="public"
  12318. deprecated="not deprecated">
  12319. <param name="hostName" type="java.lang.String"/>
  12320. <doc>
  12321. <![CDATA[Check whether the given <em>host/rack</em> string represents an arbitrary
  12322. host name.
  12323. @param hostName <em>host/rack</em> on which the allocation is desired
  12324. @return whether the given <em>host/rack</em> string represents an arbitrary
  12325. host name]]>
  12326. </doc>
  12327. </method>
  12328. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  12329. abstract="true" native="false" synchronized="false"
  12330. static="false" final="false" visibility="public"
  12331. deprecated="not deprecated">
  12332. <doc>
  12333. <![CDATA[Get the <code>Priority</code> of the request.
  12334. @return <code>Priority</code> of the request]]>
  12335. </doc>
  12336. </method>
  12337. <method name="setPriority"
  12338. abstract="true" native="false" synchronized="false"
  12339. static="false" final="false" visibility="public"
  12340. deprecated="not deprecated">
  12341. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12342. <doc>
  12343. <![CDATA[Set the <code>Priority</code> of the request
  12344. @param priority <code>Priority</code> of the request]]>
  12345. </doc>
  12346. </method>
  12347. <method name="getResourceName" return="java.lang.String"
  12348. abstract="true" native="false" synchronized="false"
  12349. static="false" final="false" visibility="public"
  12350. deprecated="not deprecated">
  12351. <doc>
  12352. <![CDATA[Get the resource (e.g. <em>host/rack</em>) on which the allocation
  12353. is desired.
  12354. A special value of <em>*</em> signifies that <em>any</em> resource
  12355. (host/rack) is acceptable.
  12356. @return resource (e.g. <em>host/rack</em>) on which the allocation
  12357. is desired]]>
  12358. </doc>
  12359. </method>
  12360. <method name="setResourceName"
  12361. abstract="true" native="false" synchronized="false"
  12362. static="false" final="false" visibility="public"
  12363. deprecated="not deprecated">
  12364. <param name="resourceName" type="java.lang.String"/>
  12365. <doc>
  12366. <![CDATA[Set the resource name (e.g. <em>host/rack</em>) on which the allocation
  12367. is desired.
  12368. A special value of <em>*</em> signifies that <em>any</em> resource name
  12369. (e.g. host/rack) is acceptable.
  12370. @param resourceName (e.g. <em>host/rack</em>) on which the
  12371. allocation is desired]]>
  12372. </doc>
  12373. </method>
  12374. <method name="getNumContainers" return="int"
  12375. abstract="true" native="false" synchronized="false"
  12376. static="false" final="false" visibility="public"
  12377. deprecated="not deprecated">
  12378. <doc>
  12379. <![CDATA[Get the number of containers required with the given specifications.
  12380. @return number of containers required with the given specifications]]>
  12381. </doc>
  12382. </method>
  12383. <method name="setNumContainers"
  12384. abstract="true" native="false" synchronized="false"
  12385. static="false" final="false" visibility="public"
  12386. deprecated="not deprecated">
  12387. <param name="numContainers" type="int"/>
  12388. <doc>
  12389. <![CDATA[Set the number of containers required with the given specifications
  12390. @param numContainers number of containers required with the given
  12391. specifications]]>
  12392. </doc>
  12393. </method>
  12394. <method name="getRelaxLocality" return="boolean"
  12395. abstract="true" native="false" synchronized="false"
  12396. static="false" final="false" visibility="public"
  12397. deprecated="not deprecated">
  12398. <doc>
  12399. <![CDATA[Get whether locality relaxation is enabled with this
  12400. <code>ResourceRequest</code>. Defaults to true.
  12401. @return whether locality relaxation is enabled with this
  12402. <code>ResourceRequest</code>.]]>
  12403. </doc>
  12404. </method>
  12405. <method name="setExecutionTypeRequest"
  12406. abstract="false" native="false" synchronized="false"
  12407. static="false" final="false" visibility="public"
  12408. deprecated="not deprecated">
  12409. <param name="execSpec" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  12410. <doc>
  12411. <![CDATA[Set the <code>ExecutionTypeRequest</code> of the requested container.
  12412. @param execSpec
  12413. ExecutionTypeRequest of the requested container]]>
  12414. </doc>
  12415. </method>
  12416. <method name="getExecutionTypeRequest" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
  12417. abstract="false" native="false" synchronized="false"
  12418. static="false" final="false" visibility="public"
  12419. deprecated="not deprecated">
  12420. <doc>
  12421. <![CDATA[Get whether locality relaxation is enabled with this
  12422. <code>ResourceRequest</code>. Defaults to true.
  12423. @return whether locality relaxation is enabled with this
  12424. <code>ResourceRequest</code>.]]>
  12425. </doc>
  12426. </method>
  12427. <method name="setRelaxLocality"
  12428. abstract="true" native="false" synchronized="false"
  12429. static="false" final="false" visibility="public"
  12430. deprecated="not deprecated">
  12431. <param name="relaxLocality" type="boolean"/>
  12432. <doc>
  12433. <![CDATA[<p>For a request at a network hierarchy level, set whether locality can be relaxed
  12434. to that level and beyond.<p>
  12435. <p>If the flag is off on a rack-level <code>ResourceRequest</code>,
  12436. containers at that request's priority will not be assigned to nodes on that
  12437. request's rack unless requests specifically for those nodes have also been
  12438. submitted.<p>
  12439. <p>If the flag is off on an {@link ResourceRequest#ANY}-level
  12440. <code>ResourceRequest</code>, containers at that request's priority will
  12441. only be assigned on racks for which specific requests have also been
  12442. submitted.<p>
  12443. <p>For example, to request a container strictly on a specific node, the
  12444. corresponding rack-level and any-level requests should have locality
  12445. relaxation set to false. Similarly, to request a container strictly on a
  12446. specific rack, the corresponding any-level request should have locality
  12447. relaxation set to false.<p>
  12448. @param relaxLocality whether locality relaxation is enabled with this
  12449. <code>ResourceRequest</code>.]]>
  12450. </doc>
  12451. </method>
  12452. <method name="getNodeLabelExpression" return="java.lang.String"
  12453. abstract="true" native="false" synchronized="false"
  12454. static="false" final="false" visibility="public"
  12455. deprecated="not deprecated">
  12456. <doc>
  12457. <![CDATA[Get node-label-expression for this Resource Request. If this is set, all
  12458. containers allocated to satisfy this resource-request will be only on those
  12459. nodes that satisfy this node-label-expression.
  12460. Please note that node label expression now can only take effect when the
  12461. resource request has resourceName = ANY
  12462. @return node-label-expression]]>
  12463. </doc>
  12464. </method>
  12465. <method name="setNodeLabelExpression"
  12466. abstract="true" native="false" synchronized="false"
  12467. static="false" final="false" visibility="public"
  12468. deprecated="not deprecated">
  12469. <param name="nodelabelExpression" type="java.lang.String"/>
  12470. <doc>
  12471. <![CDATA[Set node label expression of this resource request. Now only support
  12472. specifying a single node label. In the future we will support more complex
  12473. node label expression specification like {@code AND(&&), OR(||)}, etc.
  12474. Any please note that node label expression now can only take effect when
  12475. the resource request has resourceName = ANY
  12476. @param nodelabelExpression
  12477. node-label-expression of this ResourceRequest]]>
  12478. </doc>
  12479. </method>
  12480. <method name="getAllocationRequestId" return="long"
  12481. abstract="false" native="false" synchronized="false"
  12482. static="false" final="false" visibility="public"
  12483. deprecated="not deprecated">
  12484. <doc>
  12485. <![CDATA[Get the optional <em>ID</em> corresponding to this allocation request. This
  12486. ID is an identifier for different {@code ResourceRequest}s from the <b>same
  12487. application</b>. The allocated {@code Container}(s) received as part of the
  12488. {@code AllocateResponse} response will have the ID corresponding to the
  12489. original {@code ResourceRequest} for which the RM made the allocation.
  12490. <p>
  12491. The scheduler may return multiple {@code AllocateResponse}s corresponding
  12492. to the same ID as and when scheduler allocates {@code Container}(s).
  12493. <b>Applications</b> can continue to completely ignore the returned ID in
  12494. the response and use the allocation for any of their outstanding requests.
  12495. <p>
  12496. If one wishes to replace an entire {@code ResourceRequest} corresponding to
  12497. a specific ID, they can simply cancel the corresponding {@code
  12498. ResourceRequest} and submit a new one afresh.
  12499. @return the <em>ID</em> corresponding to this allocation request.]]>
  12500. </doc>
  12501. </method>
  12502. <method name="setAllocationRequestId"
  12503. abstract="false" native="false" synchronized="false"
  12504. static="false" final="false" visibility="public"
  12505. deprecated="not deprecated">
  12506. <param name="allocationRequestID" type="long"/>
  12507. <doc>
  12508. <![CDATA[Set the optional <em>ID</em> corresponding to this allocation request. This
  12509. ID is an identifier for different {@code ResourceRequest}s from the <b>same
  12510. application</b>. The allocated {@code Container}(s) received as part of the
  12511. {@code AllocateResponse} response will have the ID corresponding to the
  12512. original {@code ResourceRequest} for which the RM made the allocation.
  12513. <p>
  12514. The scheduler may return multiple {@code AllocateResponse}s corresponding
  12515. to the same ID as and when scheduler allocates {@code Container}(s).
  12516. <b>Applications</b> can continue to completely ignore the returned ID in
  12517. the response and use the allocation for any of their outstanding requests.
  12518. <p>
  12519. If one wishes to replace an entire {@code ResourceRequest} corresponding to
  12520. a specific ID, they can simply cancel the corresponding {@code
  12521. ResourceRequest} and submit a new one afresh.
  12522. <p>
  12523. If the ID is not set, scheduler will continue to work as previously and all
  12524. allocated {@code Container}(s) will have the default ID, -1.
  12525. @param allocationRequestID the <em>ID</em> corresponding to this allocation
  12526. request.]]>
  12527. </doc>
  12528. </method>
  12529. <method name="setCapability"
  12530. abstract="true" native="false" synchronized="false"
  12531. static="false" final="false" visibility="public"
  12532. deprecated="not deprecated">
  12533. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12534. <doc>
  12535. <![CDATA[Set the <code>Resource</code> capability of the request.
  12536. @param capability <code>Resource</code> capability of the request]]>
  12537. </doc>
  12538. </method>
  12539. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  12540. abstract="true" native="false" synchronized="false"
  12541. static="false" final="false" visibility="public"
  12542. deprecated="not deprecated">
  12543. <doc>
  12544. <![CDATA[Get the <code>Resource</code> capability of the request.
  12545. @return <code>Resource</code> capability of the request]]>
  12546. </doc>
  12547. </method>
  12548. <method name="hashCode" return="int"
  12549. abstract="false" native="false" synchronized="false"
  12550. static="false" final="false" visibility="public"
  12551. deprecated="not deprecated">
  12552. </method>
  12553. <method name="equals" return="boolean"
  12554. abstract="false" native="false" synchronized="false"
  12555. static="false" final="false" visibility="public"
  12556. deprecated="not deprecated">
  12557. <param name="obj" type="java.lang.Object"/>
  12558. </method>
  12559. <method name="compareTo" return="int"
  12560. abstract="false" native="false" synchronized="false"
  12561. static="false" final="false" visibility="public"
  12562. deprecated="not deprecated">
  12563. <param name="other" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  12564. </method>
  12565. <field name="ANY" type="java.lang.String"
  12566. transient="false" volatile="false"
  12567. static="true" final="true" visibility="public"
  12568. deprecated="not deprecated">
  12569. <doc>
  12570. <![CDATA[The constant string representing no locality.
  12571. It should be used by all references that want to pass an arbitrary host
  12572. name in.]]>
  12573. </doc>
  12574. </field>
  12575. <doc>
  12576. <![CDATA[{@code ResourceRequest} represents the request made
  12577. by an application to the {@code ResourceManager}
  12578. to obtain various {@code Container} allocations.
  12579. <p>
  12580. It includes:
  12581. <ul>
  12582. <li>{@link Priority} of the request.</li>
  12583. <li>
  12584. The <em>name</em> of the host or rack on which the allocation is
  12585. desired. A special value of <em>*</em> signifies that
  12586. <em>any</em> host/rack is acceptable to the application.
  12587. </li>
  12588. <li>{@link Resource} required for each request.</li>
  12589. <li>
  12590. Number of containers, of above specifications, which are required
  12591. by the application.
  12592. </li>
  12593. <li>
  12594. A boolean <em>relaxLocality</em> flag, defaulting to {@code true},
  12595. which tells the {@code ResourceManager} if the application wants
  12596. locality to be loose (i.e. allows fall-through to rack or <em>any</em>)
  12597. or strict (i.e. specify hard constraint on resource allocation).
  12598. </li>
  12599. </ul>
  12600. @see Resource
  12601. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  12602. </doc>
  12603. </class>
  12604. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest -->
  12605. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder -->
  12606. <class name="ResourceRequest.ResourceRequestBuilder" extends="java.lang.Object"
  12607. abstract="false"
  12608. static="true" final="true" visibility="public"
  12609. deprecated="not deprecated">
  12610. <method name="priority" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12611. abstract="false" native="false" synchronized="false"
  12612. static="false" final="false" visibility="public"
  12613. deprecated="not deprecated">
  12614. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  12615. <doc>
  12616. <![CDATA[Set the <code>priority</code> of the request.
  12617. @see ResourceRequest#setPriority(Priority)
  12618. @param priority <code>priority</code> of the request
  12619. @return {@link ResourceRequestBuilder}]]>
  12620. </doc>
  12621. </method>
  12622. <method name="resourceName" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12623. abstract="false" native="false" synchronized="false"
  12624. static="false" final="false" visibility="public"
  12625. deprecated="not deprecated">
  12626. <param name="resourceName" type="java.lang.String"/>
  12627. <doc>
  12628. <![CDATA[Set the <code>resourceName</code> of the request.
  12629. @see ResourceRequest#setResourceName(String)
  12630. @param resourceName <code>resourceName</code> of the request
  12631. @return {@link ResourceRequestBuilder}]]>
  12632. </doc>
  12633. </method>
  12634. <method name="capability" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12635. abstract="false" native="false" synchronized="false"
  12636. static="false" final="false" visibility="public"
  12637. deprecated="not deprecated">
  12638. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12639. <doc>
  12640. <![CDATA[Set the <code>capability</code> of the request.
  12641. @see ResourceRequest#setCapability(Resource)
  12642. @param capability <code>capability</code> of the request
  12643. @return {@link ResourceRequestBuilder}]]>
  12644. </doc>
  12645. </method>
  12646. <method name="numContainers" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12647. abstract="false" native="false" synchronized="false"
  12648. static="false" final="false" visibility="public"
  12649. deprecated="not deprecated">
  12650. <param name="numContainers" type="int"/>
  12651. <doc>
  12652. <![CDATA[Set the <code>numContainers</code> of the request.
  12653. @see ResourceRequest#setNumContainers(int)
  12654. @param numContainers <code>numContainers</code> of the request
  12655. @return {@link ResourceRequestBuilder}]]>
  12656. </doc>
  12657. </method>
  12658. <method name="relaxLocality" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12659. abstract="false" native="false" synchronized="false"
  12660. static="false" final="false" visibility="public"
  12661. deprecated="not deprecated">
  12662. <param name="relaxLocality" type="boolean"/>
  12663. <doc>
  12664. <![CDATA[Set the <code>relaxLocality</code> of the request.
  12665. @see ResourceRequest#setRelaxLocality(boolean)
  12666. @param relaxLocality <code>relaxLocality</code> of the request
  12667. @return {@link ResourceRequestBuilder}]]>
  12668. </doc>
  12669. </method>
  12670. <method name="nodeLabelExpression" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12671. abstract="false" native="false" synchronized="false"
  12672. static="false" final="false" visibility="public"
  12673. deprecated="not deprecated">
  12674. <param name="nodeLabelExpression" type="java.lang.String"/>
  12675. <doc>
  12676. <![CDATA[Set the <code>nodeLabelExpression</code> of the request.
  12677. @see ResourceRequest#setNodeLabelExpression(String)
  12678. @param nodeLabelExpression
  12679. <code>nodeLabelExpression</code> of the request
  12680. @return {@link ResourceRequestBuilder}]]>
  12681. </doc>
  12682. </method>
  12683. <method name="executionTypeRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12684. abstract="false" native="false" synchronized="false"
  12685. static="false" final="false" visibility="public"
  12686. deprecated="not deprecated">
  12687. <param name="executionTypeRequest" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  12688. <doc>
  12689. <![CDATA[Set the <code>executionTypeRequest</code> of the request.
  12690. @see ResourceRequest#setExecutionTypeRequest(
  12691. ExecutionTypeRequest)
  12692. @param executionTypeRequest
  12693. <code>executionTypeRequest</code> of the request
  12694. @return {@link ResourceRequestBuilder}]]>
  12695. </doc>
  12696. </method>
  12697. <method name="executionType" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12698. abstract="false" native="false" synchronized="false"
  12699. static="false" final="false" visibility="public"
  12700. deprecated="not deprecated">
  12701. <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  12702. <doc>
  12703. <![CDATA[Set the <code>executionTypeRequest</code> of the request with 'ensure
  12704. execution type' flag set to true.
  12705. @see ResourceRequest#setExecutionTypeRequest(
  12706. ExecutionTypeRequest)
  12707. @param executionType <code>executionType</code> of the request.
  12708. @return {@link ResourceRequestBuilder}]]>
  12709. </doc>
  12710. </method>
  12711. <method name="allocationRequestId" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  12712. abstract="false" native="false" synchronized="false"
  12713. static="false" final="false" visibility="public"
  12714. deprecated="not deprecated">
  12715. <param name="allocationRequestId" type="long"/>
  12716. <doc>
  12717. <![CDATA[Set the <code>allocationRequestId</code> of the request.
  12718. @see ResourceRequest#setAllocationRequestId(long)
  12719. @param allocationRequestId
  12720. <code>allocationRequestId</code> of the request
  12721. @return {@link ResourceRequestBuilder}]]>
  12722. </doc>
  12723. </method>
  12724. <method name="build" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  12725. abstract="false" native="false" synchronized="false"
  12726. static="false" final="false" visibility="public"
  12727. deprecated="not deprecated">
  12728. <doc>
  12729. <![CDATA[Return generated {@link ResourceRequest} object.
  12730. @return {@link ResourceRequest}]]>
  12731. </doc>
  12732. </method>
  12733. <doc>
  12734. <![CDATA[Class to construct instances of {@link ResourceRequest} with specific
  12735. options.]]>
  12736. </doc>
  12737. </class>
  12738. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder -->
  12739. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
  12740. <class name="ResourceRequest.ResourceRequestComparator" extends="java.lang.Object"
  12741. abstract="false"
  12742. static="true" final="false" visibility="public"
  12743. deprecated="not deprecated">
  12744. <implements name="java.util.Comparator"/>
  12745. <implements name="java.io.Serializable"/>
  12746. <constructor name="ResourceRequestComparator"
  12747. static="false" final="false" visibility="public"
  12748. deprecated="not deprecated">
  12749. </constructor>
  12750. <method name="compare" return="int"
  12751. abstract="false" native="false" synchronized="false"
  12752. static="false" final="false" visibility="public"
  12753. deprecated="not deprecated">
  12754. <param name="r1" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  12755. <param name="r2" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  12756. </method>
  12757. </class>
  12758. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
  12759. <!-- start class org.apache.hadoop.yarn.api.records.ResourceSizing -->
  12760. <class name="ResourceSizing" extends="java.lang.Object"
  12761. abstract="true"
  12762. static="false" final="false" visibility="public"
  12763. deprecated="not deprecated">
  12764. <constructor name="ResourceSizing"
  12765. static="false" final="false" visibility="public"
  12766. deprecated="not deprecated">
  12767. </constructor>
  12768. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceSizing"
  12769. abstract="false" native="false" synchronized="false"
  12770. static="true" final="false" visibility="public"
  12771. deprecated="not deprecated">
  12772. <param name="resources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12773. </method>
  12774. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceSizing"
  12775. abstract="false" native="false" synchronized="false"
  12776. static="true" final="false" visibility="public"
  12777. deprecated="not deprecated">
  12778. <param name="numAllocations" type="int"/>
  12779. <param name="resources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12780. </method>
  12781. <method name="getNumAllocations" return="int"
  12782. abstract="true" native="false" synchronized="false"
  12783. static="false" final="false" visibility="public"
  12784. deprecated="not deprecated">
  12785. </method>
  12786. <method name="setNumAllocations"
  12787. abstract="true" native="false" synchronized="false"
  12788. static="false" final="false" visibility="public"
  12789. deprecated="not deprecated">
  12790. <param name="numAllocations" type="int"/>
  12791. </method>
  12792. <method name="getResources" return="org.apache.hadoop.yarn.api.records.Resource"
  12793. abstract="true" native="false" synchronized="false"
  12794. static="false" final="false" visibility="public"
  12795. deprecated="not deprecated">
  12796. </method>
  12797. <method name="setResources"
  12798. abstract="true" native="false" synchronized="false"
  12799. static="false" final="false" visibility="public"
  12800. deprecated="not deprecated">
  12801. <param name="resources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  12802. </method>
  12803. <method name="hashCode" return="int"
  12804. abstract="false" native="false" synchronized="false"
  12805. static="false" final="false" visibility="public"
  12806. deprecated="not deprecated">
  12807. </method>
  12808. <method name="equals" return="boolean"
  12809. abstract="false" native="false" synchronized="false"
  12810. static="false" final="false" visibility="public"
  12811. deprecated="not deprecated">
  12812. <param name="obj" type="java.lang.Object"/>
  12813. </method>
  12814. <doc>
  12815. <![CDATA[{@code ResourceSizing} contains information for the size of a
  12816. {@link SchedulingRequest}, such as the number of requested allocations and
  12817. the resources for each allocation.]]>
  12818. </doc>
  12819. </class>
  12820. <!-- end class org.apache.hadoop.yarn.api.records.ResourceSizing -->
  12821. <!-- start class org.apache.hadoop.yarn.api.records.ResourceUtilization -->
  12822. <class name="ResourceUtilization" extends="java.lang.Object"
  12823. abstract="true"
  12824. static="false" final="false" visibility="public"
  12825. deprecated="not deprecated">
  12826. <implements name="java.lang.Comparable"/>
  12827. <constructor name="ResourceUtilization"
  12828. static="false" final="false" visibility="public"
  12829. deprecated="not deprecated">
  12830. </constructor>
  12831. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  12832. abstract="false" native="false" synchronized="false"
  12833. static="true" final="false" visibility="public"
  12834. deprecated="not deprecated">
  12835. <param name="pmem" type="int"/>
  12836. <param name="vmem" type="int"/>
  12837. <param name="cpu" type="float"/>
  12838. </method>
  12839. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  12840. abstract="false" native="false" synchronized="false"
  12841. static="true" final="false" visibility="public"
  12842. deprecated="not deprecated">
  12843. <param name="pmem" type="int"/>
  12844. <param name="vmem" type="int"/>
  12845. <param name="cpu" type="float"/>
  12846. <param name="customResources" type="java.util.Map"/>
  12847. </method>
  12848. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  12849. abstract="false" native="false" synchronized="false"
  12850. static="true" final="false" visibility="public"
  12851. deprecated="not deprecated">
  12852. <param name="resourceUtil" type="org.apache.hadoop.yarn.api.records.ResourceUtilization"/>
  12853. </method>
  12854. <method name="getVirtualMemory" return="int"
  12855. abstract="true" native="false" synchronized="false"
  12856. static="false" final="false" visibility="public"
  12857. deprecated="not deprecated">
  12858. <doc>
  12859. <![CDATA[Get used <em>virtual memory</em>.
  12860. @return <em>virtual memory</em> in MB]]>
  12861. </doc>
  12862. </method>
  12863. <method name="setVirtualMemory"
  12864. abstract="true" native="false" synchronized="false"
  12865. static="false" final="false" visibility="public"
  12866. deprecated="not deprecated">
  12867. <param name="vmem" type="int"/>
  12868. <doc>
  12869. <![CDATA[Set used <em>virtual memory</em>.
  12870. @param vmem <em>virtual memory</em> in MB]]>
  12871. </doc>
  12872. </method>
  12873. <method name="getPhysicalMemory" return="int"
  12874. abstract="true" native="false" synchronized="false"
  12875. static="false" final="false" visibility="public"
  12876. deprecated="not deprecated">
  12877. <doc>
  12878. <![CDATA[Get <em>physical memory</em>.
  12879. @return <em>physical memory</em> in MB]]>
  12880. </doc>
  12881. </method>
  12882. <method name="setPhysicalMemory"
  12883. abstract="true" native="false" synchronized="false"
  12884. static="false" final="false" visibility="public"
  12885. deprecated="not deprecated">
  12886. <param name="pmem" type="int"/>
  12887. <doc>
  12888. <![CDATA[Set <em>physical memory</em>.
  12889. @param pmem <em>physical memory</em> in MB]]>
  12890. </doc>
  12891. </method>
  12892. <method name="getCPU" return="float"
  12893. abstract="true" native="false" synchronized="false"
  12894. static="false" final="false" visibility="public"
  12895. deprecated="not deprecated">
  12896. <doc>
  12897. <![CDATA[Get <em>CPU</em> utilization (The amount of vcores used).
  12898. @return <em>CPU utilization</em>]]>
  12899. </doc>
  12900. </method>
  12901. <method name="setCPU"
  12902. abstract="true" native="false" synchronized="false"
  12903. static="false" final="false" visibility="public"
  12904. deprecated="not deprecated">
  12905. <param name="cpu" type="float"/>
  12906. <doc>
  12907. <![CDATA[Set <em>CPU</em> utilization (The amount of vcores used).
  12908. @param cpu <em>CPU utilization</em>]]>
  12909. </doc>
  12910. </method>
  12911. <method name="getCustomResource" return="float"
  12912. abstract="false" native="false" synchronized="false"
  12913. static="false" final="false" visibility="public"
  12914. deprecated="not deprecated">
  12915. <param name="resourceName" type="java.lang.String"/>
  12916. <doc>
  12917. <![CDATA[Get <em>custom resource</em> utilization
  12918. (The amount of custom resource used).
  12919. @param resourceName <em>resourceName of custom resource</em>
  12920. @return <em>resourceName utilization</em>]]>
  12921. </doc>
  12922. </method>
  12923. <method name="getCustomResources" return="java.util.Map"
  12924. abstract="false" native="false" synchronized="false"
  12925. static="false" final="false" visibility="public"
  12926. deprecated="not deprecated">
  12927. </method>
  12928. <method name="setCustomResources"
  12929. abstract="false" native="false" synchronized="false"
  12930. static="false" final="false" visibility="public"
  12931. deprecated="not deprecated">
  12932. <param name="customResources" type="java.util.Map"/>
  12933. </method>
  12934. <method name="setCustomResource"
  12935. abstract="false" native="false" synchronized="false"
  12936. static="false" final="false" visibility="public"
  12937. deprecated="not deprecated">
  12938. <param name="resourceName" type="java.lang.String"/>
  12939. <param name="utilization" type="float"/>
  12940. <doc>
  12941. <![CDATA[Set <em>custom resource</em> utilization
  12942. (The amount of custom resource used).
  12943. @param resourceName <em>resourceName</em>
  12944. @param utilization <em>utilization of custom resource</em>]]>
  12945. </doc>
  12946. </method>
  12947. <method name="hashCode" return="int"
  12948. abstract="false" native="false" synchronized="false"
  12949. static="false" final="false" visibility="public"
  12950. deprecated="not deprecated">
  12951. </method>
  12952. <method name="equals" return="boolean"
  12953. abstract="false" native="false" synchronized="false"
  12954. static="false" final="false" visibility="public"
  12955. deprecated="not deprecated">
  12956. <param name="obj" type="java.lang.Object"/>
  12957. </method>
  12958. <method name="toString" return="java.lang.String"
  12959. abstract="false" native="false" synchronized="false"
  12960. static="false" final="false" visibility="public"
  12961. deprecated="not deprecated">
  12962. </method>
  12963. <method name="addTo"
  12964. abstract="false" native="false" synchronized="false"
  12965. static="false" final="false" visibility="public"
  12966. deprecated="not deprecated">
  12967. <param name="pmem" type="int"/>
  12968. <param name="vmem" type="int"/>
  12969. <param name="cpu" type="float"/>
  12970. <doc>
  12971. <![CDATA[Add utilization to the current one.
  12972. @param pmem Physical memory used to add.
  12973. @param vmem Virtual memory used to add.
  12974. @param cpu CPU utilization to add.]]>
  12975. </doc>
  12976. </method>
  12977. <method name="addTo"
  12978. abstract="false" native="false" synchronized="false"
  12979. static="false" final="false" visibility="public"
  12980. deprecated="not deprecated">
  12981. <param name="pmem" type="int"/>
  12982. <param name="vmem" type="int"/>
  12983. <param name="cpu" type="float"/>
  12984. <param name="resourceName" type="java.lang.String"/>
  12985. <param name="utilization" type="float"/>
  12986. <doc>
  12987. <![CDATA[Add utilization to the current one.
  12988. @param pmem Physical memory used to add.
  12989. @param vmem Virtual memory used to add.
  12990. @param cpu CPU utilization to add.
  12991. @param resourceName of custom resource to add.
  12992. @param utilization of custom resource to add.]]>
  12993. </doc>
  12994. </method>
  12995. <method name="subtractFrom"
  12996. abstract="false" native="false" synchronized="false"
  12997. static="false" final="false" visibility="public"
  12998. deprecated="not deprecated">
  12999. <param name="pmem" type="int"/>
  13000. <param name="vmem" type="int"/>
  13001. <param name="cpu" type="float"/>
  13002. <doc>
  13003. <![CDATA[Subtract utilization from the current one.
  13004. @param pmem Physical memory to be subtracted.
  13005. @param vmem Virtual memory to be subtracted.
  13006. @param cpu CPU utilization to be subtracted.]]>
  13007. </doc>
  13008. </method>
  13009. <method name="subtractFrom"
  13010. abstract="false" native="false" synchronized="false"
  13011. static="false" final="false" visibility="public"
  13012. deprecated="not deprecated">
  13013. <param name="pmem" type="int"/>
  13014. <param name="vmem" type="int"/>
  13015. <param name="cpu" type="float"/>
  13016. <param name="resourceName" type="java.lang.String"/>
  13017. <param name="utilization" type="float"/>
  13018. <doc>
  13019. <![CDATA[Subtract utilization from the current one.
  13020. @param pmem Physical memory to be subtracted.
  13021. @param vmem Virtual memory to be subtracted.
  13022. @param cpu CPU utilization to be subtracted.
  13023. @param resourceName of custom resource to be subtracted.
  13024. @param utilization of custom resource to be subtracted.]]>
  13025. </doc>
  13026. </method>
  13027. <doc>
  13028. <![CDATA[<p>
  13029. <code>ResourceUtilization</code> models the utilization of a set of computer
  13030. resources in the cluster.
  13031. </p>]]>
  13032. </doc>
  13033. </class>
  13034. <!-- end class org.apache.hadoop.yarn.api.records.ResourceUtilization -->
  13035. <!-- start class org.apache.hadoop.yarn.api.records.SchedulingRequest -->
  13036. <class name="SchedulingRequest" extends="java.lang.Object"
  13037. abstract="true"
  13038. static="false" final="false" visibility="public"
  13039. deprecated="not deprecated">
  13040. <constructor name="SchedulingRequest"
  13041. static="false" final="false" visibility="public"
  13042. deprecated="not deprecated">
  13043. </constructor>
  13044. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.SchedulingRequest"
  13045. abstract="false" native="false" synchronized="false"
  13046. static="true" final="false" visibility="public"
  13047. deprecated="not deprecated">
  13048. <param name="allocationRequestId" type="long"/>
  13049. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  13050. <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  13051. <param name="allocationTags" type="java.util.Set"/>
  13052. <param name="resourceSizing" type="org.apache.hadoop.yarn.api.records.ResourceSizing"/>
  13053. <param name="placementConstraintExpression" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint"/>
  13054. </method>
  13055. <method name="newBuilder" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
  13056. abstract="false" native="false" synchronized="false"
  13057. static="true" final="false" visibility="public"
  13058. deprecated="not deprecated">
  13059. </method>
  13060. <method name="getAllocationRequestId" return="long"
  13061. abstract="true" native="false" synchronized="false"
  13062. static="false" final="false" visibility="public"
  13063. deprecated="not deprecated">
  13064. </method>
  13065. <method name="setAllocationRequestId"
  13066. abstract="true" native="false" synchronized="false"
  13067. static="false" final="false" visibility="public"
  13068. deprecated="not deprecated">
  13069. <param name="allocationRequestId" type="long"/>
  13070. </method>
  13071. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  13072. abstract="true" native="false" synchronized="false"
  13073. static="false" final="false" visibility="public"
  13074. deprecated="not deprecated">
  13075. </method>
  13076. <method name="setPriority"
  13077. abstract="true" native="false" synchronized="false"
  13078. static="false" final="false" visibility="public"
  13079. deprecated="not deprecated">
  13080. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  13081. </method>
  13082. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
  13083. abstract="true" native="false" synchronized="false"
  13084. static="false" final="false" visibility="public"
  13085. deprecated="not deprecated">
  13086. </method>
  13087. <method name="setExecutionType"
  13088. abstract="true" native="false" synchronized="false"
  13089. static="false" final="false" visibility="public"
  13090. deprecated="not deprecated">
  13091. <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  13092. </method>
  13093. <method name="getAllocationTags" return="java.util.Set"
  13094. abstract="true" native="false" synchronized="false"
  13095. static="false" final="false" visibility="public"
  13096. deprecated="not deprecated">
  13097. </method>
  13098. <method name="setAllocationTags"
  13099. abstract="true" native="false" synchronized="false"
  13100. static="false" final="false" visibility="public"
  13101. deprecated="not deprecated">
  13102. <param name="allocationTags" type="java.util.Set"/>
  13103. </method>
  13104. <method name="getResourceSizing" return="org.apache.hadoop.yarn.api.records.ResourceSizing"
  13105. abstract="true" native="false" synchronized="false"
  13106. static="false" final="false" visibility="public"
  13107. deprecated="not deprecated">
  13108. </method>
  13109. <method name="setResourceSizing"
  13110. abstract="true" native="false" synchronized="false"
  13111. static="false" final="false" visibility="public"
  13112. deprecated="not deprecated">
  13113. <param name="resourceSizing" type="org.apache.hadoop.yarn.api.records.ResourceSizing"/>
  13114. </method>
  13115. <method name="getPlacementConstraint" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint"
  13116. abstract="true" native="false" synchronized="false"
  13117. static="false" final="false" visibility="public"
  13118. deprecated="not deprecated">
  13119. </method>
  13120. <method name="setPlacementConstraint"
  13121. abstract="true" native="false" synchronized="false"
  13122. static="false" final="false" visibility="public"
  13123. deprecated="not deprecated">
  13124. <param name="placementConstraint" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint"/>
  13125. </method>
  13126. <doc>
  13127. <![CDATA[{@code SchedulingRequest} represents a request made by an application to the
  13128. {@code ResourceManager} to obtain an allocation. It is similar to the
  13129. {@link ResourceRequest}. However, it is more complete than the latter, as it
  13130. allows applications to specify allocation tags (e.g., to express that an
  13131. allocation belongs to {@code Spark} or is an {@code HBase-master}), as well
  13132. as involved {@link PlacementConstraint}s (e.g., anti-affinity between Spark
  13133. and HBase allocations).
  13134. The size specification of the allocation is in {@code ResourceSizing}.]]>
  13135. </doc>
  13136. </class>
  13137. <!-- end class org.apache.hadoop.yarn.api.records.SchedulingRequest -->
  13138. <!-- start class org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder -->
  13139. <class name="SchedulingRequest.SchedulingRequestBuilder" extends="java.lang.Object"
  13140. abstract="false"
  13141. static="true" final="true" visibility="public"
  13142. deprecated="not deprecated">
  13143. <method name="allocationRequestId" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
  13144. abstract="false" native="false" synchronized="false"
  13145. static="false" final="false" visibility="public"
  13146. deprecated="not deprecated">
  13147. <param name="allocationRequestId" type="long"/>
  13148. <doc>
  13149. <![CDATA[Set the <code>allocationRequestId</code> of the request.
  13150. @see SchedulingRequest#setAllocationRequestId(long)
  13151. @param allocationRequestId <code>allocationRequestId</code> of the
  13152. request
  13153. @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
  13154. </doc>
  13155. </method>
  13156. <method name="priority" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
  13157. abstract="false" native="false" synchronized="false"
  13158. static="false" final="false" visibility="public"
  13159. deprecated="not deprecated">
  13160. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  13161. <doc>
  13162. <![CDATA[Set the <code>priority</code> of the request.
  13163. @param priority <code>priority</code> of the request
  13164. @return {@link SchedulingRequest.SchedulingRequestBuilder}
  13165. @see SchedulingRequest#setPriority(Priority)]]>
  13166. </doc>
  13167. </method>
  13168. <method name="executionType" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
  13169. abstract="false" native="false" synchronized="false"
  13170. static="false" final="false" visibility="public"
  13171. deprecated="not deprecated">
  13172. <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  13173. <doc>
  13174. <![CDATA[Set the <code>executionType</code> of the request.
  13175. @see SchedulingRequest#setExecutionType(ExecutionTypeRequest)
  13176. @param executionType <code>executionType</code> of the request
  13177. @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
  13178. </doc>
  13179. </method>
  13180. <method name="allocationTags" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
  13181. abstract="false" native="false" synchronized="false"
  13182. static="false" final="false" visibility="public"
  13183. deprecated="not deprecated">
  13184. <param name="allocationTags" type="java.util.Set"/>
  13185. <doc>
  13186. <![CDATA[Set the <code>allocationTags</code> of the request.
  13187. @see SchedulingRequest#setAllocationTags(Set)
  13188. @param allocationTags <code>allocationsTags</code> of the request
  13189. @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
  13190. </doc>
  13191. </method>
  13192. <method name="resourceSizing" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
  13193. abstract="false" native="false" synchronized="false"
  13194. static="false" final="false" visibility="public"
  13195. deprecated="not deprecated">
  13196. <param name="resourceSizing" type="org.apache.hadoop.yarn.api.records.ResourceSizing"/>
  13197. <doc>
  13198. <![CDATA[Set the <code>executionType</code> of the request.
  13199. @see SchedulingRequest#setResourceSizing(ResourceSizing)
  13200. @param resourceSizing <code>resourceSizing</code> of the request
  13201. @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
  13202. </doc>
  13203. </method>
  13204. <method name="placementConstraintExpression" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
  13205. abstract="false" native="false" synchronized="false"
  13206. static="false" final="false" visibility="public"
  13207. deprecated="not deprecated">
  13208. <param name="placementConstraintExpression" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint"/>
  13209. <doc>
  13210. <![CDATA[Set the <code>placementConstraintExpression</code> of the request.
  13211. @see SchedulingRequest#setPlacementConstraint(
  13212. PlacementConstraint)
  13213. @param placementConstraintExpression <code>placementConstraints</code> of
  13214. the request
  13215. @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
  13216. </doc>
  13217. </method>
  13218. <method name="build" return="org.apache.hadoop.yarn.api.records.SchedulingRequest"
  13219. abstract="false" native="false" synchronized="false"
  13220. static="false" final="false" visibility="public"
  13221. deprecated="not deprecated">
  13222. <doc>
  13223. <![CDATA[Return generated {@link SchedulingRequest} object.
  13224. @return {@link SchedulingRequest}]]>
  13225. </doc>
  13226. </method>
  13227. <doc>
  13228. <![CDATA[Class to construct instances of {@link SchedulingRequest} with specific
  13229. options.]]>
  13230. </doc>
  13231. </class>
  13232. <!-- end class org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder -->
  13233. <!-- start class org.apache.hadoop.yarn.api.records.ShellContainerCommand -->
  13234. <class name="ShellContainerCommand" extends="java.lang.Enum"
  13235. abstract="false"
  13236. static="false" final="true" visibility="public"
  13237. deprecated="not deprecated">
  13238. <method name="values" return="org.apache.hadoop.yarn.api.records.ShellContainerCommand[]"
  13239. abstract="false" native="false" synchronized="false"
  13240. static="true" final="false" visibility="public"
  13241. deprecated="not deprecated">
  13242. </method>
  13243. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ShellContainerCommand"
  13244. abstract="false" native="false" synchronized="false"
  13245. static="true" final="false" visibility="public"
  13246. deprecated="not deprecated">
  13247. <param name="name" type="java.lang.String"/>
  13248. </method>
  13249. <doc>
  13250. <![CDATA[Enumeration of various signal container commands.]]>
  13251. </doc>
  13252. </class>
  13253. <!-- end class org.apache.hadoop.yarn.api.records.ShellContainerCommand -->
  13254. <!-- start class org.apache.hadoop.yarn.api.records.SignalContainerCommand -->
  13255. <class name="SignalContainerCommand" extends="java.lang.Enum"
  13256. abstract="false"
  13257. static="false" final="true" visibility="public"
  13258. deprecated="not deprecated">
  13259. <method name="values" return="org.apache.hadoop.yarn.api.records.SignalContainerCommand[]"
  13260. abstract="false" native="false" synchronized="false"
  13261. static="true" final="false" visibility="public"
  13262. deprecated="not deprecated">
  13263. </method>
  13264. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.SignalContainerCommand"
  13265. abstract="false" native="false" synchronized="false"
  13266. static="true" final="false" visibility="public"
  13267. deprecated="not deprecated">
  13268. <param name="name" type="java.lang.String"/>
  13269. </method>
  13270. <doc>
  13271. <![CDATA[Enumeration of various signal container commands.]]>
  13272. </doc>
  13273. </class>
  13274. <!-- end class org.apache.hadoop.yarn.api.records.SignalContainerCommand -->
  13275. <!-- start class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
  13276. <class name="StrictPreemptionContract" extends="java.lang.Object"
  13277. abstract="true"
  13278. static="false" final="false" visibility="public"
  13279. deprecated="not deprecated">
  13280. <constructor name="StrictPreemptionContract"
  13281. static="false" final="false" visibility="public"
  13282. deprecated="not deprecated">
  13283. </constructor>
  13284. <method name="getContainers" return="java.util.Set"
  13285. abstract="true" native="false" synchronized="false"
  13286. static="false" final="false" visibility="public"
  13287. deprecated="not deprecated">
  13288. <doc>
  13289. <![CDATA[Get the set of {@link PreemptionContainer} specifying containers owned by
  13290. the <code>ApplicationMaster</code> that may be reclaimed by the
  13291. <code>ResourceManager</code>.
  13292. @return the set of {@link ContainerId} to be preempted.]]>
  13293. </doc>
  13294. </method>
  13295. <doc>
  13296. <![CDATA[Enumeration of particular allocations to be reclaimed. The platform will
  13297. reclaim exactly these resources, so the <code>ApplicationMaster</code> (AM)
  13298. may attempt to checkpoint work or adjust its execution plan to accommodate
  13299. it. In contrast to {@link PreemptionContract}, the AM has no flexibility in
  13300. selecting which resources to return to the cluster.
  13301. @see PreemptionMessage]]>
  13302. </doc>
  13303. </class>
  13304. <!-- end class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
  13305. <!-- start class org.apache.hadoop.yarn.api.records.Token -->
  13306. <class name="Token" extends="java.lang.Object"
  13307. abstract="true"
  13308. static="false" final="false" visibility="public"
  13309. deprecated="not deprecated">
  13310. <constructor name="Token"
  13311. static="false" final="false" visibility="public"
  13312. deprecated="not deprecated">
  13313. </constructor>
  13314. <method name="getIdentifier" return="java.nio.ByteBuffer"
  13315. abstract="true" native="false" synchronized="false"
  13316. static="false" final="false" visibility="public"
  13317. deprecated="not deprecated">
  13318. <doc>
  13319. <![CDATA[Get the token identifier.
  13320. @return token identifier]]>
  13321. </doc>
  13322. </method>
  13323. <method name="getPassword" return="java.nio.ByteBuffer"
  13324. abstract="true" native="false" synchronized="false"
  13325. static="false" final="false" visibility="public"
  13326. deprecated="not deprecated">
  13327. <doc>
  13328. <![CDATA[Get the token password
  13329. @return token password]]>
  13330. </doc>
  13331. </method>
  13332. <method name="getKind" return="java.lang.String"
  13333. abstract="true" native="false" synchronized="false"
  13334. static="false" final="false" visibility="public"
  13335. deprecated="not deprecated">
  13336. <doc>
  13337. <![CDATA[Get the token kind.
  13338. @return token kind]]>
  13339. </doc>
  13340. </method>
  13341. <method name="getService" return="java.lang.String"
  13342. abstract="true" native="false" synchronized="false"
  13343. static="false" final="false" visibility="public"
  13344. deprecated="not deprecated">
  13345. <doc>
  13346. <![CDATA[Get the service to which the token is allocated.
  13347. @return service to which the token is allocated]]>
  13348. </doc>
  13349. </method>
  13350. <doc>
  13351. <![CDATA[<p><code>Token</code> is the security entity used by the framework
  13352. to verify authenticity of any resource.</p>]]>
  13353. </doc>
  13354. </class>
  13355. <!-- end class org.apache.hadoop.yarn.api.records.Token -->
  13356. <!-- start class org.apache.hadoop.yarn.api.records.UpdateContainerError -->
  13357. <class name="UpdateContainerError" extends="java.lang.Object"
  13358. abstract="true"
  13359. static="false" final="false" visibility="public"
  13360. deprecated="not deprecated">
  13361. <constructor name="UpdateContainerError"
  13362. static="false" final="false" visibility="public"
  13363. deprecated="not deprecated">
  13364. </constructor>
  13365. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdateContainerError"
  13366. abstract="false" native="false" synchronized="false"
  13367. static="true" final="false" visibility="public"
  13368. deprecated="not deprecated">
  13369. <param name="reason" type="java.lang.String"/>
  13370. <param name="updateContainerRequest" type="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"/>
  13371. </method>
  13372. <method name="getReason" return="java.lang.String"
  13373. abstract="true" native="false" synchronized="false"
  13374. static="false" final="false" visibility="public"
  13375. deprecated="not deprecated">
  13376. <doc>
  13377. <![CDATA[Get reason why the update request was not satisfiable.
  13378. @return Reason]]>
  13379. </doc>
  13380. </method>
  13381. <method name="setReason"
  13382. abstract="true" native="false" synchronized="false"
  13383. static="false" final="false" visibility="public"
  13384. deprecated="not deprecated">
  13385. <param name="reason" type="java.lang.String"/>
  13386. <doc>
  13387. <![CDATA[Set reason why the update request was not satisfiable.
  13388. @param reason Reason]]>
  13389. </doc>
  13390. </method>
  13391. <method name="getCurrentContainerVersion" return="int"
  13392. abstract="true" native="false" synchronized="false"
  13393. static="false" final="false" visibility="public"
  13394. deprecated="not deprecated">
  13395. <doc>
  13396. <![CDATA[Get current container version.
  13397. @return Current container Version.]]>
  13398. </doc>
  13399. </method>
  13400. <method name="setCurrentContainerVersion"
  13401. abstract="true" native="false" synchronized="false"
  13402. static="false" final="false" visibility="public"
  13403. deprecated="not deprecated">
  13404. <param name="currentVersion" type="int"/>
  13405. <doc>
  13406. <![CDATA[Set current container version.
  13407. @param currentVersion Current container version.]]>
  13408. </doc>
  13409. </method>
  13410. <method name="getUpdateContainerRequest" return="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"
  13411. abstract="true" native="false" synchronized="false"
  13412. static="false" final="false" visibility="public"
  13413. deprecated="not deprecated">
  13414. <doc>
  13415. <![CDATA[Get the {@code UpdateContainerRequest} that was not satisfiable.
  13416. @return UpdateContainerRequest]]>
  13417. </doc>
  13418. </method>
  13419. <method name="setUpdateContainerRequest"
  13420. abstract="true" native="false" synchronized="false"
  13421. static="false" final="false" visibility="public"
  13422. deprecated="not deprecated">
  13423. <param name="updateContainerRequest" type="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"/>
  13424. <doc>
  13425. <![CDATA[Set the {@code UpdateContainerRequest} that was not satisfiable.
  13426. @param updateContainerRequest Update Container Request]]>
  13427. </doc>
  13428. </method>
  13429. <method name="hashCode" return="int"
  13430. abstract="false" native="false" synchronized="false"
  13431. static="false" final="false" visibility="public"
  13432. deprecated="not deprecated">
  13433. </method>
  13434. <method name="toString" return="java.lang.String"
  13435. abstract="false" native="false" synchronized="false"
  13436. static="false" final="false" visibility="public"
  13437. deprecated="not deprecated">
  13438. </method>
  13439. <method name="equals" return="boolean"
  13440. abstract="false" native="false" synchronized="false"
  13441. static="false" final="false" visibility="public"
  13442. deprecated="not deprecated">
  13443. <param name="obj" type="java.lang.Object"/>
  13444. </method>
  13445. <doc>
  13446. <![CDATA[{@code UpdateContainerError} is used by the Scheduler to notify the
  13447. ApplicationMaster of an UpdateContainerRequest it cannot satisfy due to
  13448. an error in the request. It includes the update request as well as
  13449. a reason for why the request was not satisfiable.]]>
  13450. </doc>
  13451. </class>
  13452. <!-- end class org.apache.hadoop.yarn.api.records.UpdateContainerError -->
  13453. <!-- start class org.apache.hadoop.yarn.api.records.UpdateContainerRequest -->
  13454. <class name="UpdateContainerRequest" extends="java.lang.Object"
  13455. abstract="true"
  13456. static="false" final="false" visibility="public"
  13457. deprecated="not deprecated">
  13458. <constructor name="UpdateContainerRequest"
  13459. static="false" final="false" visibility="public"
  13460. deprecated="not deprecated">
  13461. </constructor>
  13462. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"
  13463. abstract="false" native="false" synchronized="false"
  13464. static="true" final="false" visibility="public"
  13465. deprecated="not deprecated">
  13466. <param name="version" type="int"/>
  13467. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  13468. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  13469. <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  13470. <param name="targetExecutionType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  13471. </method>
  13472. <method name="getContainerVersion" return="int"
  13473. abstract="true" native="false" synchronized="false"
  13474. static="false" final="false" visibility="public"
  13475. deprecated="not deprecated">
  13476. <doc>
  13477. <![CDATA[Get the <code>ContainerId</code> of the container.
  13478. @return <code>ContainerId</code> of the container]]>
  13479. </doc>
  13480. </method>
  13481. <method name="setContainerVersion"
  13482. abstract="true" native="false" synchronized="false"
  13483. static="false" final="false" visibility="public"
  13484. deprecated="not deprecated">
  13485. <param name="containerVersion" type="int"/>
  13486. <doc>
  13487. <![CDATA[Set the current version of the container.
  13488. @param containerVersion of the container]]>
  13489. </doc>
  13490. </method>
  13491. <method name="getContainerUpdateType" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType"
  13492. abstract="true" native="false" synchronized="false"
  13493. static="false" final="false" visibility="public"
  13494. deprecated="not deprecated">
  13495. <doc>
  13496. <![CDATA[Get the <code>ContainerUpdateType</code> of the container.
  13497. @return <code>ContainerUpdateType</code> of the container.]]>
  13498. </doc>
  13499. </method>
  13500. <method name="setContainerUpdateType"
  13501. abstract="true" native="false" synchronized="false"
  13502. static="false" final="false" visibility="public"
  13503. deprecated="not deprecated">
  13504. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  13505. <doc>
  13506. <![CDATA[Set the <code>ContainerUpdateType</code> of the container.
  13507. @param updateType of the Container]]>
  13508. </doc>
  13509. </method>
  13510. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  13511. abstract="true" native="false" synchronized="false"
  13512. static="false" final="false" visibility="public"
  13513. deprecated="not deprecated">
  13514. <doc>
  13515. <![CDATA[Get the <code>ContainerId</code> of the container.
  13516. @return <code>ContainerId</code> of the container]]>
  13517. </doc>
  13518. </method>
  13519. <method name="setContainerId"
  13520. abstract="true" native="false" synchronized="false"
  13521. static="false" final="false" visibility="public"
  13522. deprecated="not deprecated">
  13523. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  13524. <doc>
  13525. <![CDATA[Set the <code>ContainerId</code> of the container.
  13526. @param containerId <code>ContainerId</code> of the container]]>
  13527. </doc>
  13528. </method>
  13529. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  13530. abstract="true" native="false" synchronized="false"
  13531. static="false" final="false" visibility="public"
  13532. deprecated="not deprecated">
  13533. <doc>
  13534. <![CDATA[Get the target <code>ExecutionType</code> of the container.
  13535. @return <code>ExecutionType</code> of the container]]>
  13536. </doc>
  13537. </method>
  13538. <method name="setExecutionType"
  13539. abstract="true" native="false" synchronized="false"
  13540. static="false" final="false" visibility="public"
  13541. deprecated="not deprecated">
  13542. <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  13543. <doc>
  13544. <![CDATA[Set the target <code>ExecutionType</code> of the container.
  13545. @param executionType <code>ExecutionType</code> of the container]]>
  13546. </doc>
  13547. </method>
  13548. <method name="setCapability"
  13549. abstract="true" native="false" synchronized="false"
  13550. static="false" final="false" visibility="public"
  13551. deprecated="not deprecated">
  13552. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  13553. <doc>
  13554. <![CDATA[Set the <code>Resource</code> capability of the request.
  13555. @param capability <code>Resource</code> capability of the request]]>
  13556. </doc>
  13557. </method>
  13558. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  13559. abstract="true" native="false" synchronized="false"
  13560. static="false" final="false" visibility="public"
  13561. deprecated="not deprecated">
  13562. <doc>
  13563. <![CDATA[Get the <code>Resource</code> capability of the request.
  13564. @return <code>Resource</code> capability of the request]]>
  13565. </doc>
  13566. </method>
  13567. <method name="hashCode" return="int"
  13568. abstract="false" native="false" synchronized="false"
  13569. static="false" final="false" visibility="public"
  13570. deprecated="not deprecated">
  13571. </method>
  13572. <method name="toString" return="java.lang.String"
  13573. abstract="false" native="false" synchronized="false"
  13574. static="false" final="false" visibility="public"
  13575. deprecated="not deprecated">
  13576. </method>
  13577. <method name="equals" return="boolean"
  13578. abstract="false" native="false" synchronized="false"
  13579. static="false" final="false" visibility="public"
  13580. deprecated="not deprecated">
  13581. <param name="obj" type="java.lang.Object"/>
  13582. </method>
  13583. <doc>
  13584. <![CDATA[{@code UpdateContainerRequest} represents the request made by an
  13585. application to the {@code ResourceManager} to update an attribute of a
  13586. {@code Container} such as its Resource allocation or (@code ExecutionType}
  13587. <p>
  13588. It includes:
  13589. <ul>
  13590. <li>version for the container.</li>
  13591. <li>{@link ContainerId} for the container.</li>
  13592. <li>
  13593. {@link Resource} capability of the container after the update request
  13594. is completed.
  13595. </li>
  13596. <li>
  13597. {@link ExecutionType} of the container after the update request is
  13598. completed.
  13599. </li>
  13600. </ul>
  13601. Update rules:
  13602. <ul>
  13603. <li>
  13604. Currently only ONE aspect of the container can be updated per request
  13605. (user can either update Capability OR ExecutionType in one request..
  13606. not both).
  13607. </li>
  13608. <li>
  13609. There must be only 1 update request per container in an allocate call.
  13610. </li>
  13611. <li>
  13612. If a new update request is sent for a container (in a subsequent allocate
  13613. call) before the first one is satisfied by the Scheduler, it will
  13614. overwrite the previous request.
  13615. </li>
  13616. </ul>
  13617. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  13618. </doc>
  13619. </class>
  13620. <!-- end class org.apache.hadoop.yarn.api.records.UpdateContainerRequest -->
  13621. <!-- start class org.apache.hadoop.yarn.api.records.UpdatedContainer -->
  13622. <class name="UpdatedContainer" extends="java.lang.Object"
  13623. abstract="true"
  13624. static="false" final="false" visibility="public"
  13625. deprecated="not deprecated">
  13626. <constructor name="UpdatedContainer"
  13627. static="false" final="false" visibility="public"
  13628. deprecated="not deprecated">
  13629. </constructor>
  13630. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdatedContainer"
  13631. abstract="false" native="false" synchronized="false"
  13632. static="true" final="false" visibility="public"
  13633. deprecated="not deprecated">
  13634. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  13635. <param name="container" type="org.apache.hadoop.yarn.api.records.Container"/>
  13636. <doc>
  13637. <![CDATA[Static Factory method.
  13638. @param updateType ContainerUpdateType
  13639. @param container Container
  13640. @return UpdatedContainer]]>
  13641. </doc>
  13642. </method>
  13643. <method name="getUpdateType" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType"
  13644. abstract="true" native="false" synchronized="false"
  13645. static="false" final="false" visibility="public"
  13646. deprecated="not deprecated">
  13647. <doc>
  13648. <![CDATA[Get the <code>ContainerUpdateType</code>.
  13649. @return ContainerUpdateType]]>
  13650. </doc>
  13651. </method>
  13652. <method name="setUpdateType"
  13653. abstract="true" native="false" synchronized="false"
  13654. static="false" final="false" visibility="public"
  13655. deprecated="not deprecated">
  13656. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  13657. <doc>
  13658. <![CDATA[Set the <code>ContainerUpdateType</code>.
  13659. @param updateType ContainerUpdateType]]>
  13660. </doc>
  13661. </method>
  13662. <method name="getContainer" return="org.apache.hadoop.yarn.api.records.Container"
  13663. abstract="true" native="false" synchronized="false"
  13664. static="false" final="false" visibility="public"
  13665. deprecated="not deprecated">
  13666. <doc>
  13667. <![CDATA[Get the <code>Container</code>.
  13668. @return Container]]>
  13669. </doc>
  13670. </method>
  13671. <method name="setContainer"
  13672. abstract="true" native="false" synchronized="false"
  13673. static="false" final="false" visibility="public"
  13674. deprecated="not deprecated">
  13675. <param name="container" type="org.apache.hadoop.yarn.api.records.Container"/>
  13676. <doc>
  13677. <![CDATA[Set the <code>Container</code>.
  13678. @param container Container]]>
  13679. </doc>
  13680. </method>
  13681. <method name="hashCode" return="int"
  13682. abstract="false" native="false" synchronized="false"
  13683. static="false" final="false" visibility="public"
  13684. deprecated="not deprecated">
  13685. </method>
  13686. <method name="equals" return="boolean"
  13687. abstract="false" native="false" synchronized="false"
  13688. static="false" final="false" visibility="public"
  13689. deprecated="not deprecated">
  13690. <param name="obj" type="java.lang.Object"/>
  13691. </method>
  13692. <doc>
  13693. <![CDATA[An object that encapsulates an updated container and the
  13694. type of Update.]]>
  13695. </doc>
  13696. </class>
  13697. <!-- end class org.apache.hadoop.yarn.api.records.UpdatedContainer -->
  13698. <!-- start class org.apache.hadoop.yarn.api.records.URL -->
  13699. <class name="URL" extends="java.lang.Object"
  13700. abstract="true"
  13701. static="false" final="false" visibility="public"
  13702. deprecated="not deprecated">
  13703. <constructor name="URL"
  13704. static="false" final="false" visibility="public"
  13705. deprecated="not deprecated">
  13706. </constructor>
  13707. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.URL"
  13708. abstract="false" native="false" synchronized="false"
  13709. static="true" final="false" visibility="public"
  13710. deprecated="not deprecated">
  13711. <param name="scheme" type="java.lang.String"/>
  13712. <param name="host" type="java.lang.String"/>
  13713. <param name="port" type="int"/>
  13714. <param name="file" type="java.lang.String"/>
  13715. </method>
  13716. <method name="getScheme" return="java.lang.String"
  13717. abstract="true" native="false" synchronized="false"
  13718. static="false" final="false" visibility="public"
  13719. deprecated="not deprecated">
  13720. <doc>
  13721. <![CDATA[Get the scheme of the URL.
  13722. @return scheme of the URL]]>
  13723. </doc>
  13724. </method>
  13725. <method name="setScheme"
  13726. abstract="true" native="false" synchronized="false"
  13727. static="false" final="false" visibility="public"
  13728. deprecated="not deprecated">
  13729. <param name="scheme" type="java.lang.String"/>
  13730. <doc>
  13731. <![CDATA[Set the scheme of the URL
  13732. @param scheme scheme of the URL]]>
  13733. </doc>
  13734. </method>
  13735. <method name="getUserInfo" return="java.lang.String"
  13736. abstract="true" native="false" synchronized="false"
  13737. static="false" final="false" visibility="public"
  13738. deprecated="not deprecated">
  13739. <doc>
  13740. <![CDATA[Get the user info of the URL.
  13741. @return user info of the URL]]>
  13742. </doc>
  13743. </method>
  13744. <method name="setUserInfo"
  13745. abstract="true" native="false" synchronized="false"
  13746. static="false" final="false" visibility="public"
  13747. deprecated="not deprecated">
  13748. <param name="userInfo" type="java.lang.String"/>
  13749. <doc>
  13750. <![CDATA[Set the user info of the URL.
  13751. @param userInfo user info of the URL]]>
  13752. </doc>
  13753. </method>
  13754. <method name="getHost" return="java.lang.String"
  13755. abstract="true" native="false" synchronized="false"
  13756. static="false" final="false" visibility="public"
  13757. deprecated="not deprecated">
  13758. <doc>
  13759. <![CDATA[Get the host of the URL.
  13760. @return host of the URL]]>
  13761. </doc>
  13762. </method>
  13763. <method name="setHost"
  13764. abstract="true" native="false" synchronized="false"
  13765. static="false" final="false" visibility="public"
  13766. deprecated="not deprecated">
  13767. <param name="host" type="java.lang.String"/>
  13768. <doc>
  13769. <![CDATA[Set the host of the URL.
  13770. @param host host of the URL]]>
  13771. </doc>
  13772. </method>
  13773. <method name="getPort" return="int"
  13774. abstract="true" native="false" synchronized="false"
  13775. static="false" final="false" visibility="public"
  13776. deprecated="not deprecated">
  13777. <doc>
  13778. <![CDATA[Get the port of the URL.
  13779. @return port of the URL]]>
  13780. </doc>
  13781. </method>
  13782. <method name="setPort"
  13783. abstract="true" native="false" synchronized="false"
  13784. static="false" final="false" visibility="public"
  13785. deprecated="not deprecated">
  13786. <param name="port" type="int"/>
  13787. <doc>
  13788. <![CDATA[Set the port of the URL
  13789. @param port port of the URL]]>
  13790. </doc>
  13791. </method>
  13792. <method name="getFile" return="java.lang.String"
  13793. abstract="true" native="false" synchronized="false"
  13794. static="false" final="false" visibility="public"
  13795. deprecated="not deprecated">
  13796. <doc>
  13797. <![CDATA[Get the file of the URL.
  13798. @return file of the URL]]>
  13799. </doc>
  13800. </method>
  13801. <method name="setFile"
  13802. abstract="true" native="false" synchronized="false"
  13803. static="false" final="false" visibility="public"
  13804. deprecated="not deprecated">
  13805. <param name="file" type="java.lang.String"/>
  13806. <doc>
  13807. <![CDATA[Set the file of the URL.
  13808. @param file file of the URL]]>
  13809. </doc>
  13810. </method>
  13811. <method name="toPath" return="org.apache.hadoop.fs.Path"
  13812. abstract="false" native="false" synchronized="false"
  13813. static="false" final="false" visibility="public"
  13814. deprecated="not deprecated">
  13815. <exception name="URISyntaxException" type="java.net.URISyntaxException"/>
  13816. </method>
  13817. <method name="fromURI" return="org.apache.hadoop.yarn.api.records.URL"
  13818. abstract="false" native="false" synchronized="false"
  13819. static="true" final="false" visibility="public"
  13820. deprecated="not deprecated">
  13821. <param name="uri" type="java.net.URI"/>
  13822. </method>
  13823. <method name="fromPath" return="org.apache.hadoop.yarn.api.records.URL"
  13824. abstract="false" native="false" synchronized="false"
  13825. static="true" final="false" visibility="public"
  13826. deprecated="not deprecated">
  13827. <param name="path" type="org.apache.hadoop.fs.Path"/>
  13828. </method>
  13829. <doc>
  13830. <![CDATA[<p><code>URL</code> represents a serializable {@link java.net.URL}.</p>]]>
  13831. </doc>
  13832. </class>
  13833. <!-- end class org.apache.hadoop.yarn.api.records.URL -->
  13834. <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
  13835. <class name="YarnApplicationAttemptState" extends="java.lang.Enum"
  13836. abstract="false"
  13837. static="false" final="true" visibility="public"
  13838. deprecated="not deprecated">
  13839. <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState[]"
  13840. abstract="false" native="false" synchronized="false"
  13841. static="true" final="false" visibility="public"
  13842. deprecated="not deprecated">
  13843. </method>
  13844. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
  13845. abstract="false" native="false" synchronized="false"
  13846. static="true" final="false" visibility="public"
  13847. deprecated="not deprecated">
  13848. <param name="name" type="java.lang.String"/>
  13849. </method>
  13850. <doc>
  13851. <![CDATA[Enumeration of various states of a <code>RMAppAttempt</code>.]]>
  13852. </doc>
  13853. </class>
  13854. <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
  13855. <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
  13856. <class name="YarnApplicationState" extends="java.lang.Enum"
  13857. abstract="false"
  13858. static="false" final="true" visibility="public"
  13859. deprecated="not deprecated">
  13860. <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationState[]"
  13861. abstract="false" native="false" synchronized="false"
  13862. static="true" final="false" visibility="public"
  13863. deprecated="not deprecated">
  13864. </method>
  13865. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
  13866. abstract="false" native="false" synchronized="false"
  13867. static="true" final="false" visibility="public"
  13868. deprecated="not deprecated">
  13869. <param name="name" type="java.lang.String"/>
  13870. </method>
  13871. <doc>
  13872. <![CDATA[Enumeration of various states of an <code>ApplicationMaster</code>.]]>
  13873. </doc>
  13874. </class>
  13875. <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
  13876. <!-- start class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
  13877. <class name="YarnClusterMetrics" extends="java.lang.Object"
  13878. abstract="true"
  13879. static="false" final="false" visibility="public"
  13880. deprecated="not deprecated">
  13881. <constructor name="YarnClusterMetrics"
  13882. static="false" final="false" visibility="public"
  13883. deprecated="not deprecated">
  13884. </constructor>
  13885. <method name="getNumNodeManagers" return="int"
  13886. abstract="true" native="false" synchronized="false"
  13887. static="false" final="false" visibility="public"
  13888. deprecated="not deprecated">
  13889. <doc>
  13890. <![CDATA[Get the number of <code>NodeManager</code>s in the cluster.
  13891. @return number of <code>NodeManager</code>s in the cluster]]>
  13892. </doc>
  13893. </method>
  13894. <method name="getNumDecommissioningNodeManagers" return="int"
  13895. abstract="true" native="false" synchronized="false"
  13896. static="false" final="false" visibility="public"
  13897. deprecated="not deprecated">
  13898. <doc>
  13899. <![CDATA[Get the number of <code>DecommissioningNodeManager</code>s in the cluster.
  13900. @return number of <code>DecommissioningNodeManager</code>s in the cluster]]>
  13901. </doc>
  13902. </method>
  13903. <method name="getNumDecommissionedNodeManagers" return="int"
  13904. abstract="true" native="false" synchronized="false"
  13905. static="false" final="false" visibility="public"
  13906. deprecated="not deprecated">
  13907. <doc>
  13908. <![CDATA[Get the number of <code>DecommissionedNodeManager</code>s in the cluster.
  13909. @return number of <code>DecommissionedNodeManager</code>s in the cluster]]>
  13910. </doc>
  13911. </method>
  13912. <method name="getNumActiveNodeManagers" return="int"
  13913. abstract="true" native="false" synchronized="false"
  13914. static="false" final="false" visibility="public"
  13915. deprecated="not deprecated">
  13916. <doc>
  13917. <![CDATA[Get the number of <code>ActiveNodeManager</code>s in the cluster.
  13918. @return number of <code>ActiveNodeManager</code>s in the cluster]]>
  13919. </doc>
  13920. </method>
  13921. <method name="getNumLostNodeManagers" return="int"
  13922. abstract="true" native="false" synchronized="false"
  13923. static="false" final="false" visibility="public"
  13924. deprecated="not deprecated">
  13925. <doc>
  13926. <![CDATA[Get the number of <code>LostNodeManager</code>s in the cluster.
  13927. @return number of <code>LostNodeManager</code>s in the cluster]]>
  13928. </doc>
  13929. </method>
  13930. <method name="getNumUnhealthyNodeManagers" return="int"
  13931. abstract="true" native="false" synchronized="false"
  13932. static="false" final="false" visibility="public"
  13933. deprecated="not deprecated">
  13934. <doc>
  13935. <![CDATA[Get the number of <code>UnhealthyNodeManager</code>s in the cluster.
  13936. @return number of <code>UnhealthyNodeManager</code>s in the cluster]]>
  13937. </doc>
  13938. </method>
  13939. <method name="getNumRebootedNodeManagers" return="int"
  13940. abstract="true" native="false" synchronized="false"
  13941. static="false" final="false" visibility="public"
  13942. deprecated="not deprecated">
  13943. <doc>
  13944. <![CDATA[Get the number of <code>RebootedNodeManager</code>s in the cluster.
  13945. @return number of <code>RebootedNodeManager</code>s in the cluster]]>
  13946. </doc>
  13947. </method>
  13948. <method name="getNumShutdownNodeManagers" return="int"
  13949. abstract="true" native="false" synchronized="false"
  13950. static="false" final="false" visibility="public"
  13951. deprecated="not deprecated">
  13952. <doc>
  13953. <![CDATA[Get the number of <code>ShutdownNodeManager</code>s in the cluster.
  13954. @return number of <code>ShutdownNodeManager</code>s in the cluster]]>
  13955. </doc>
  13956. </method>
  13957. <doc>
  13958. <![CDATA[<p><code>YarnClusterMetrics</code> represents cluster metrics.</p>
  13959. <p>Currently only number of <code>NodeManager</code>s is provided.</p>]]>
  13960. </doc>
  13961. </class>
  13962. <!-- end class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
  13963. </package>
  13964. <package name="org.apache.hadoop.yarn.api.records.impl">
  13965. </package>
  13966. <package name="org.apache.hadoop.yarn.api.records.timeline">
  13967. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineAbout -->
  13968. <class name="TimelineAbout" extends="java.lang.Object"
  13969. abstract="false"
  13970. static="false" final="false" visibility="public"
  13971. deprecated="not deprecated">
  13972. <constructor name="TimelineAbout"
  13973. static="false" final="false" visibility="public"
  13974. deprecated="not deprecated">
  13975. </constructor>
  13976. <constructor name="TimelineAbout" type="java.lang.String"
  13977. static="false" final="false" visibility="public"
  13978. deprecated="not deprecated">
  13979. </constructor>
  13980. <method name="getAbout" return="java.lang.String"
  13981. abstract="false" native="false" synchronized="false"
  13982. static="false" final="false" visibility="public"
  13983. deprecated="not deprecated">
  13984. </method>
  13985. <method name="setAbout"
  13986. abstract="false" native="false" synchronized="false"
  13987. static="false" final="false" visibility="public"
  13988. deprecated="not deprecated">
  13989. <param name="about" type="java.lang.String"/>
  13990. </method>
  13991. <method name="getTimelineServiceVersion" return="java.lang.String"
  13992. abstract="false" native="false" synchronized="false"
  13993. static="false" final="false" visibility="public"
  13994. deprecated="not deprecated">
  13995. </method>
  13996. <method name="setTimelineServiceVersion"
  13997. abstract="false" native="false" synchronized="false"
  13998. static="false" final="false" visibility="public"
  13999. deprecated="not deprecated">
  14000. <param name="timelineServiceVersion" type="java.lang.String"/>
  14001. </method>
  14002. <method name="getTimelineServiceBuildVersion" return="java.lang.String"
  14003. abstract="false" native="false" synchronized="false"
  14004. static="false" final="false" visibility="public"
  14005. deprecated="not deprecated">
  14006. </method>
  14007. <method name="setTimelineServiceBuildVersion"
  14008. abstract="false" native="false" synchronized="false"
  14009. static="false" final="false" visibility="public"
  14010. deprecated="not deprecated">
  14011. <param name="timelineServiceBuildVersion" type="java.lang.String"/>
  14012. </method>
  14013. <method name="getTimelineServiceVersionBuiltOn" return="java.lang.String"
  14014. abstract="false" native="false" synchronized="false"
  14015. static="false" final="false" visibility="public"
  14016. deprecated="not deprecated">
  14017. </method>
  14018. <method name="setTimelineServiceVersionBuiltOn"
  14019. abstract="false" native="false" synchronized="false"
  14020. static="false" final="false" visibility="public"
  14021. deprecated="not deprecated">
  14022. <param name="timelineServiceVersionBuiltOn" type="java.lang.String"/>
  14023. </method>
  14024. <method name="getHadoopVersion" return="java.lang.String"
  14025. abstract="false" native="false" synchronized="false"
  14026. static="false" final="false" visibility="public"
  14027. deprecated="not deprecated">
  14028. </method>
  14029. <method name="setHadoopVersion"
  14030. abstract="false" native="false" synchronized="false"
  14031. static="false" final="false" visibility="public"
  14032. deprecated="not deprecated">
  14033. <param name="hadoopVersion" type="java.lang.String"/>
  14034. </method>
  14035. <method name="getHadoopBuildVersion" return="java.lang.String"
  14036. abstract="false" native="false" synchronized="false"
  14037. static="false" final="false" visibility="public"
  14038. deprecated="not deprecated">
  14039. </method>
  14040. <method name="setHadoopBuildVersion"
  14041. abstract="false" native="false" synchronized="false"
  14042. static="false" final="false" visibility="public"
  14043. deprecated="not deprecated">
  14044. <param name="hadoopBuildVersion" type="java.lang.String"/>
  14045. </method>
  14046. <method name="getHadoopVersionBuiltOn" return="java.lang.String"
  14047. abstract="false" native="false" synchronized="false"
  14048. static="false" final="false" visibility="public"
  14049. deprecated="not deprecated">
  14050. </method>
  14051. <method name="setHadoopVersionBuiltOn"
  14052. abstract="false" native="false" synchronized="false"
  14053. static="false" final="false" visibility="public"
  14054. deprecated="not deprecated">
  14055. <param name="hadoopVersionBuiltOn" type="java.lang.String"/>
  14056. </method>
  14057. </class>
  14058. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineAbout -->
  14059. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
  14060. <class name="TimelineDelegationTokenResponse" extends="java.lang.Object"
  14061. abstract="false"
  14062. static="false" final="false" visibility="public"
  14063. deprecated="not deprecated">
  14064. <constructor name="TimelineDelegationTokenResponse"
  14065. static="false" final="false" visibility="public"
  14066. deprecated="not deprecated">
  14067. </constructor>
  14068. <method name="getType" return="java.lang.String"
  14069. abstract="false" native="false" synchronized="false"
  14070. static="false" final="false" visibility="public"
  14071. deprecated="not deprecated">
  14072. </method>
  14073. <method name="setType"
  14074. abstract="false" native="false" synchronized="false"
  14075. static="false" final="false" visibility="public"
  14076. deprecated="not deprecated">
  14077. <param name="type" type="java.lang.String"/>
  14078. </method>
  14079. <method name="getContent" return="java.lang.Object"
  14080. abstract="false" native="false" synchronized="false"
  14081. static="false" final="false" visibility="public"
  14082. deprecated="not deprecated">
  14083. </method>
  14084. <method name="setContent"
  14085. abstract="false" native="false" synchronized="false"
  14086. static="false" final="false" visibility="public"
  14087. deprecated="not deprecated">
  14088. <param name="content" type="java.lang.Object"/>
  14089. </method>
  14090. <doc>
  14091. <![CDATA[The response of delegation token related request]]>
  14092. </doc>
  14093. </class>
  14094. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
  14095. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
  14096. <class name="TimelineDomain" extends="java.lang.Object"
  14097. abstract="false"
  14098. static="false" final="false" visibility="public"
  14099. deprecated="not deprecated">
  14100. <constructor name="TimelineDomain"
  14101. static="false" final="false" visibility="public"
  14102. deprecated="not deprecated">
  14103. </constructor>
  14104. <method name="getId" return="java.lang.String"
  14105. abstract="false" native="false" synchronized="false"
  14106. static="false" final="false" visibility="public"
  14107. deprecated="not deprecated">
  14108. <doc>
  14109. <![CDATA[Get the domain ID
  14110. @return the domain ID]]>
  14111. </doc>
  14112. </method>
  14113. <method name="setId"
  14114. abstract="false" native="false" synchronized="false"
  14115. static="false" final="false" visibility="public"
  14116. deprecated="not deprecated">
  14117. <param name="id" type="java.lang.String"/>
  14118. <doc>
  14119. <![CDATA[Set the domain ID
  14120. @param id the domain ID]]>
  14121. </doc>
  14122. </method>
  14123. <method name="getDescription" return="java.lang.String"
  14124. abstract="false" native="false" synchronized="false"
  14125. static="false" final="false" visibility="public"
  14126. deprecated="not deprecated">
  14127. <doc>
  14128. <![CDATA[Get the domain description
  14129. @return the domain description]]>
  14130. </doc>
  14131. </method>
  14132. <method name="setDescription"
  14133. abstract="false" native="false" synchronized="false"
  14134. static="false" final="false" visibility="public"
  14135. deprecated="not deprecated">
  14136. <param name="description" type="java.lang.String"/>
  14137. <doc>
  14138. <![CDATA[Set the domain description
  14139. @param description the domain description]]>
  14140. </doc>
  14141. </method>
  14142. <method name="getOwner" return="java.lang.String"
  14143. abstract="false" native="false" synchronized="false"
  14144. static="false" final="false" visibility="public"
  14145. deprecated="not deprecated">
  14146. <doc>
  14147. <![CDATA[Get the domain owner
  14148. @return the domain owner]]>
  14149. </doc>
  14150. </method>
  14151. <method name="setOwner"
  14152. abstract="false" native="false" synchronized="false"
  14153. static="false" final="false" visibility="public"
  14154. deprecated="not deprecated">
  14155. <param name="owner" type="java.lang.String"/>
  14156. <doc>
  14157. <![CDATA[Set the domain owner. The user doesn't need to set it, which will
  14158. automatically set to the user who puts the domain.
  14159. @param owner the domain owner]]>
  14160. </doc>
  14161. </method>
  14162. <method name="getReaders" return="java.lang.String"
  14163. abstract="false" native="false" synchronized="false"
  14164. static="false" final="false" visibility="public"
  14165. deprecated="not deprecated">
  14166. <doc>
  14167. <![CDATA[Get the reader (and/or reader group) list string
  14168. @return the reader (and/or reader group) list string]]>
  14169. </doc>
  14170. </method>
  14171. <method name="setReaders"
  14172. abstract="false" native="false" synchronized="false"
  14173. static="false" final="false" visibility="public"
  14174. deprecated="not deprecated">
  14175. <param name="readers" type="java.lang.String"/>
  14176. <doc>
  14177. <![CDATA[Set the reader (and/or reader group) list string
  14178. @param readers the reader (and/or reader group) list string]]>
  14179. </doc>
  14180. </method>
  14181. <method name="getWriters" return="java.lang.String"
  14182. abstract="false" native="false" synchronized="false"
  14183. static="false" final="false" visibility="public"
  14184. deprecated="not deprecated">
  14185. <doc>
  14186. <![CDATA[Get the writer (and/or writer group) list string
  14187. @return the writer (and/or writer group) list string]]>
  14188. </doc>
  14189. </method>
  14190. <method name="setWriters"
  14191. abstract="false" native="false" synchronized="false"
  14192. static="false" final="false" visibility="public"
  14193. deprecated="not deprecated">
  14194. <param name="writers" type="java.lang.String"/>
  14195. <doc>
  14196. <![CDATA[Set the writer (and/or writer group) list string
  14197. @param writers the writer (and/or writer group) list string]]>
  14198. </doc>
  14199. </method>
  14200. <method name="getCreatedTime" return="java.lang.Long"
  14201. abstract="false" native="false" synchronized="false"
  14202. static="false" final="false" visibility="public"
  14203. deprecated="not deprecated">
  14204. <doc>
  14205. <![CDATA[Get the created time of the domain
  14206. @return the created time of the domain]]>
  14207. </doc>
  14208. </method>
  14209. <method name="setCreatedTime"
  14210. abstract="false" native="false" synchronized="false"
  14211. static="false" final="false" visibility="public"
  14212. deprecated="not deprecated">
  14213. <param name="createdTime" type="java.lang.Long"/>
  14214. <doc>
  14215. <![CDATA[Set the created time of the domain
  14216. @param createdTime the created time of the domain]]>
  14217. </doc>
  14218. </method>
  14219. <method name="getModifiedTime" return="java.lang.Long"
  14220. abstract="false" native="false" synchronized="false"
  14221. static="false" final="false" visibility="public"
  14222. deprecated="not deprecated">
  14223. <doc>
  14224. <![CDATA[Get the modified time of the domain
  14225. @return the modified time of the domain]]>
  14226. </doc>
  14227. </method>
  14228. <method name="setModifiedTime"
  14229. abstract="false" native="false" synchronized="false"
  14230. static="false" final="false" visibility="public"
  14231. deprecated="not deprecated">
  14232. <param name="modifiedTime" type="java.lang.Long"/>
  14233. <doc>
  14234. <![CDATA[Set the modified time of the domain
  14235. @param modifiedTime the modified time of the domain]]>
  14236. </doc>
  14237. </method>
  14238. <doc>
  14239. <![CDATA[<p>
  14240. This class contains the information about a timeline domain, which is used
  14241. to a user to host a number of timeline entities, isolating them from others'.
  14242. The user can also define the reader and writer users/groups for the the
  14243. domain, which is used to control the access to its entities.
  14244. </p>
  14245. <p>
  14246. The reader and writer users/groups pattern that the user can supply is the
  14247. same as what <code>AccessControlList</code> takes.
  14248. </p>]]>
  14249. </doc>
  14250. </class>
  14251. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
  14252. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
  14253. <class name="TimelineDomains" extends="java.lang.Object"
  14254. abstract="false"
  14255. static="false" final="false" visibility="public"
  14256. deprecated="not deprecated">
  14257. <constructor name="TimelineDomains"
  14258. static="false" final="false" visibility="public"
  14259. deprecated="not deprecated">
  14260. </constructor>
  14261. <method name="getDomains" return="java.util.List"
  14262. abstract="false" native="false" synchronized="false"
  14263. static="false" final="false" visibility="public"
  14264. deprecated="not deprecated">
  14265. <doc>
  14266. <![CDATA[Get a list of domains
  14267. @return a list of domains]]>
  14268. </doc>
  14269. </method>
  14270. <method name="addDomain"
  14271. abstract="false" native="false" synchronized="false"
  14272. static="false" final="false" visibility="public"
  14273. deprecated="not deprecated">
  14274. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  14275. <doc>
  14276. <![CDATA[Add a single domain into the existing domain list
  14277. @param domain
  14278. a single domain]]>
  14279. </doc>
  14280. </method>
  14281. <method name="addDomains"
  14282. abstract="false" native="false" synchronized="false"
  14283. static="false" final="false" visibility="public"
  14284. deprecated="not deprecated">
  14285. <param name="domains" type="java.util.List"/>
  14286. <doc>
  14287. <![CDATA[All a list of domains into the existing domain list
  14288. @param domains
  14289. a list of domains]]>
  14290. </doc>
  14291. </method>
  14292. <method name="setDomains"
  14293. abstract="false" native="false" synchronized="false"
  14294. static="false" final="false" visibility="public"
  14295. deprecated="not deprecated">
  14296. <param name="domains" type="java.util.List"/>
  14297. <doc>
  14298. <![CDATA[Set the domain list to the given list of domains
  14299. @param domains
  14300. a list of domains]]>
  14301. </doc>
  14302. </method>
  14303. <doc>
  14304. <![CDATA[The class that hosts a list of timeline domains.]]>
  14305. </doc>
  14306. </class>
  14307. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
  14308. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
  14309. <class name="TimelineEntities" extends="java.lang.Object"
  14310. abstract="false"
  14311. static="false" final="false" visibility="public"
  14312. deprecated="not deprecated">
  14313. <constructor name="TimelineEntities"
  14314. static="false" final="false" visibility="public"
  14315. deprecated="not deprecated">
  14316. </constructor>
  14317. <method name="getEntities" return="java.util.List"
  14318. abstract="false" native="false" synchronized="false"
  14319. static="false" final="false" visibility="public"
  14320. deprecated="not deprecated">
  14321. <doc>
  14322. <![CDATA[Get a list of entities
  14323. @return a list of entities]]>
  14324. </doc>
  14325. </method>
  14326. <method name="addEntity"
  14327. abstract="false" native="false" synchronized="false"
  14328. static="false" final="false" visibility="public"
  14329. deprecated="not deprecated">
  14330. <param name="entity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
  14331. <doc>
  14332. <![CDATA[Add a single entity into the existing entity list
  14333. @param entity
  14334. a single entity]]>
  14335. </doc>
  14336. </method>
  14337. <method name="addEntities"
  14338. abstract="false" native="false" synchronized="false"
  14339. static="false" final="false" visibility="public"
  14340. deprecated="not deprecated">
  14341. <param name="entities" type="java.util.List"/>
  14342. <doc>
  14343. <![CDATA[All a list of entities into the existing entity list
  14344. @param entities
  14345. a list of entities]]>
  14346. </doc>
  14347. </method>
  14348. <method name="setEntities"
  14349. abstract="false" native="false" synchronized="false"
  14350. static="false" final="false" visibility="public"
  14351. deprecated="not deprecated">
  14352. <param name="entities" type="java.util.List"/>
  14353. <doc>
  14354. <![CDATA[Set the entity list to the given list of entities
  14355. @param entities
  14356. a list of entities]]>
  14357. </doc>
  14358. </method>
  14359. <doc>
  14360. <![CDATA[The class that hosts a list of timeline entities.]]>
  14361. </doc>
  14362. </class>
  14363. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
  14364. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
  14365. <class name="TimelineEntity" extends="java.lang.Object"
  14366. abstract="false"
  14367. static="false" final="false" visibility="public"
  14368. deprecated="not deprecated">
  14369. <implements name="java.lang.Comparable"/>
  14370. <constructor name="TimelineEntity"
  14371. static="false" final="false" visibility="public"
  14372. deprecated="not deprecated">
  14373. </constructor>
  14374. <method name="getEntityType" return="java.lang.String"
  14375. abstract="false" native="false" synchronized="false"
  14376. static="false" final="false" visibility="public"
  14377. deprecated="not deprecated">
  14378. <doc>
  14379. <![CDATA[Get the entity type
  14380. @return the entity type]]>
  14381. </doc>
  14382. </method>
  14383. <method name="setEntityType"
  14384. abstract="false" native="false" synchronized="false"
  14385. static="false" final="false" visibility="public"
  14386. deprecated="not deprecated">
  14387. <param name="entityType" type="java.lang.String"/>
  14388. <doc>
  14389. <![CDATA[Set the entity type
  14390. @param entityType
  14391. the entity type]]>
  14392. </doc>
  14393. </method>
  14394. <method name="getEntityId" return="java.lang.String"
  14395. abstract="false" native="false" synchronized="false"
  14396. static="false" final="false" visibility="public"
  14397. deprecated="not deprecated">
  14398. <doc>
  14399. <![CDATA[Get the entity Id
  14400. @return the entity Id]]>
  14401. </doc>
  14402. </method>
  14403. <method name="setEntityId"
  14404. abstract="false" native="false" synchronized="false"
  14405. static="false" final="false" visibility="public"
  14406. deprecated="not deprecated">
  14407. <param name="entityId" type="java.lang.String"/>
  14408. <doc>
  14409. <![CDATA[Set the entity Id
  14410. @param entityId
  14411. the entity Id]]>
  14412. </doc>
  14413. </method>
  14414. <method name="getStartTime" return="java.lang.Long"
  14415. abstract="false" native="false" synchronized="false"
  14416. static="false" final="false" visibility="public"
  14417. deprecated="not deprecated">
  14418. <doc>
  14419. <![CDATA[Get the start time of the entity
  14420. @return the start time of the entity]]>
  14421. </doc>
  14422. </method>
  14423. <method name="setStartTime"
  14424. abstract="false" native="false" synchronized="false"
  14425. static="false" final="false" visibility="public"
  14426. deprecated="not deprecated">
  14427. <param name="startTime" type="java.lang.Long"/>
  14428. <doc>
  14429. <![CDATA[Set the start time of the entity
  14430. @param startTime
  14431. the start time of the entity]]>
  14432. </doc>
  14433. </method>
  14434. <method name="getEvents" return="java.util.List"
  14435. abstract="false" native="false" synchronized="false"
  14436. static="false" final="false" visibility="public"
  14437. deprecated="not deprecated">
  14438. <doc>
  14439. <![CDATA[Get a list of events related to the entity
  14440. @return a list of events related to the entity]]>
  14441. </doc>
  14442. </method>
  14443. <method name="addEvent"
  14444. abstract="false" native="false" synchronized="false"
  14445. static="false" final="false" visibility="public"
  14446. deprecated="not deprecated">
  14447. <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  14448. <doc>
  14449. <![CDATA[Add a single event related to the entity to the existing event list
  14450. @param event
  14451. a single event related to the entity]]>
  14452. </doc>
  14453. </method>
  14454. <method name="addEvents"
  14455. abstract="false" native="false" synchronized="false"
  14456. static="false" final="false" visibility="public"
  14457. deprecated="not deprecated">
  14458. <param name="events" type="java.util.List"/>
  14459. <doc>
  14460. <![CDATA[Add a list of events related to the entity to the existing event list
  14461. @param events
  14462. a list of events related to the entity]]>
  14463. </doc>
  14464. </method>
  14465. <method name="setEvents"
  14466. abstract="false" native="false" synchronized="false"
  14467. static="false" final="false" visibility="public"
  14468. deprecated="not deprecated">
  14469. <param name="events" type="java.util.List"/>
  14470. <doc>
  14471. <![CDATA[Set the event list to the given list of events related to the entity
  14472. @param events
  14473. events a list of events related to the entity]]>
  14474. </doc>
  14475. </method>
  14476. <method name="getRelatedEntities" return="java.util.Map"
  14477. abstract="false" native="false" synchronized="false"
  14478. static="false" final="false" visibility="public"
  14479. deprecated="not deprecated">
  14480. <doc>
  14481. <![CDATA[Get the related entities
  14482. @return the related entities]]>
  14483. </doc>
  14484. </method>
  14485. <method name="addRelatedEntity"
  14486. abstract="false" native="false" synchronized="false"
  14487. static="false" final="false" visibility="public"
  14488. deprecated="not deprecated">
  14489. <param name="entityType" type="java.lang.String"/>
  14490. <param name="entityId" type="java.lang.String"/>
  14491. <doc>
  14492. <![CDATA[Add an entity to the existing related entity map
  14493. @param entityType
  14494. the entity type
  14495. @param entityId
  14496. the entity Id]]>
  14497. </doc>
  14498. </method>
  14499. <method name="addRelatedEntities"
  14500. abstract="false" native="false" synchronized="false"
  14501. static="false" final="false" visibility="public"
  14502. deprecated="not deprecated">
  14503. <param name="relatedEntities" type="java.util.Map"/>
  14504. <doc>
  14505. <![CDATA[Add a map of related entities to the existing related entity map
  14506. @param relatedEntities
  14507. a map of related entities]]>
  14508. </doc>
  14509. </method>
  14510. <method name="setRelatedEntities"
  14511. abstract="false" native="false" synchronized="false"
  14512. static="false" final="false" visibility="public"
  14513. deprecated="not deprecated">
  14514. <param name="relatedEntities" type="java.util.Map"/>
  14515. <doc>
  14516. <![CDATA[Set the related entity map to the given map of related entities
  14517. @param relatedEntities
  14518. a map of related entities]]>
  14519. </doc>
  14520. </method>
  14521. <method name="getPrimaryFilters" return="java.util.Map"
  14522. abstract="false" native="false" synchronized="false"
  14523. static="false" final="false" visibility="public"
  14524. deprecated="not deprecated">
  14525. <doc>
  14526. <![CDATA[Get the primary filters
  14527. @return the primary filters]]>
  14528. </doc>
  14529. </method>
  14530. <method name="addPrimaryFilter"
  14531. abstract="false" native="false" synchronized="false"
  14532. static="false" final="false" visibility="public"
  14533. deprecated="not deprecated">
  14534. <param name="key" type="java.lang.String"/>
  14535. <param name="value" type="java.lang.Object"/>
  14536. <doc>
  14537. <![CDATA[Add a single piece of primary filter to the existing primary filter map
  14538. @param key
  14539. the primary filter key
  14540. @param value
  14541. the primary filter value]]>
  14542. </doc>
  14543. </method>
  14544. <method name="addPrimaryFilters"
  14545. abstract="false" native="false" synchronized="false"
  14546. static="false" final="false" visibility="public"
  14547. deprecated="not deprecated">
  14548. <param name="primaryFilters" type="java.util.Map"/>
  14549. <doc>
  14550. <![CDATA[Add a map of primary filters to the existing primary filter map
  14551. @param primaryFilters
  14552. a map of primary filters]]>
  14553. </doc>
  14554. </method>
  14555. <method name="setPrimaryFilters"
  14556. abstract="false" native="false" synchronized="false"
  14557. static="false" final="false" visibility="public"
  14558. deprecated="not deprecated">
  14559. <param name="primaryFilters" type="java.util.Map"/>
  14560. <doc>
  14561. <![CDATA[Set the primary filter map to the given map of primary filters
  14562. @param primaryFilters
  14563. a map of primary filters]]>
  14564. </doc>
  14565. </method>
  14566. <method name="getOtherInfo" return="java.util.Map"
  14567. abstract="false" native="false" synchronized="false"
  14568. static="false" final="false" visibility="public"
  14569. deprecated="not deprecated">
  14570. <doc>
  14571. <![CDATA[Get the other information of the entity
  14572. @return the other information of the entity]]>
  14573. </doc>
  14574. </method>
  14575. <method name="addOtherInfo"
  14576. abstract="false" native="false" synchronized="false"
  14577. static="false" final="false" visibility="public"
  14578. deprecated="not deprecated">
  14579. <param name="key" type="java.lang.String"/>
  14580. <param name="value" type="java.lang.Object"/>
  14581. <doc>
  14582. <![CDATA[Add one piece of other information of the entity to the existing other info
  14583. map
  14584. @param key
  14585. the other information key
  14586. @param value
  14587. the other information value]]>
  14588. </doc>
  14589. </method>
  14590. <method name="addOtherInfo"
  14591. abstract="false" native="false" synchronized="false"
  14592. static="false" final="false" visibility="public"
  14593. deprecated="not deprecated">
  14594. <param name="otherInfo" type="java.util.Map"/>
  14595. <doc>
  14596. <![CDATA[Add a map of other information of the entity to the existing other info map
  14597. @param otherInfo
  14598. a map of other information]]>
  14599. </doc>
  14600. </method>
  14601. <method name="setOtherInfo"
  14602. abstract="false" native="false" synchronized="false"
  14603. static="false" final="false" visibility="public"
  14604. deprecated="not deprecated">
  14605. <param name="otherInfo" type="java.util.Map"/>
  14606. <doc>
  14607. <![CDATA[Set the other info map to the given map of other information
  14608. @param otherInfo
  14609. a map of other information]]>
  14610. </doc>
  14611. </method>
  14612. <method name="getDomainId" return="java.lang.String"
  14613. abstract="false" native="false" synchronized="false"
  14614. static="false" final="false" visibility="public"
  14615. deprecated="not deprecated">
  14616. <doc>
  14617. <![CDATA[Get the ID of the domain that the entity is to be put
  14618. @return the domain ID]]>
  14619. </doc>
  14620. </method>
  14621. <method name="setDomainId"
  14622. abstract="false" native="false" synchronized="false"
  14623. static="false" final="false" visibility="public"
  14624. deprecated="not deprecated">
  14625. <param name="domainId" type="java.lang.String"/>
  14626. <doc>
  14627. <![CDATA[Set the ID of the domain that the entity is to be put
  14628. @param domainId
  14629. the name space ID]]>
  14630. </doc>
  14631. </method>
  14632. <method name="hashCode" return="int"
  14633. abstract="false" native="false" synchronized="false"
  14634. static="false" final="false" visibility="public"
  14635. deprecated="not deprecated">
  14636. </method>
  14637. <method name="equals" return="boolean"
  14638. abstract="false" native="false" synchronized="false"
  14639. static="false" final="false" visibility="public"
  14640. deprecated="not deprecated">
  14641. <param name="obj" type="java.lang.Object"/>
  14642. </method>
  14643. <method name="compareTo" return="int"
  14644. abstract="false" native="false" synchronized="false"
  14645. static="false" final="false" visibility="public"
  14646. deprecated="not deprecated">
  14647. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
  14648. </method>
  14649. <doc>
  14650. <![CDATA[<p>
  14651. The class that contains the the meta information of some conceptual entity
  14652. and its related events. The entity can be an application, an application
  14653. attempt, a container or whatever the user-defined object.
  14654. </p>
  14655. <p>
  14656. Primary filters will be used to index the entities in
  14657. <code>TimelineStore</code>, such that users should carefully choose the
  14658. information they want to store as the primary filters. The remaining can be
  14659. stored as other information.
  14660. </p>]]>
  14661. </doc>
  14662. </class>
  14663. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
  14664. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId -->
  14665. <class name="TimelineEntityGroupId" extends="java.lang.Object"
  14666. abstract="false"
  14667. static="false" final="false" visibility="public"
  14668. deprecated="not deprecated">
  14669. <implements name="java.lang.Comparable"/>
  14670. <constructor name="TimelineEntityGroupId"
  14671. static="false" final="false" visibility="public"
  14672. deprecated="not deprecated">
  14673. </constructor>
  14674. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"
  14675. abstract="false" native="false" synchronized="false"
  14676. static="true" final="false" visibility="public"
  14677. deprecated="not deprecated">
  14678. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  14679. <param name="id" type="java.lang.String"/>
  14680. </method>
  14681. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  14682. abstract="false" native="false" synchronized="false"
  14683. static="false" final="false" visibility="public"
  14684. deprecated="not deprecated">
  14685. <doc>
  14686. <![CDATA[Get the <code>ApplicationId</code> of the
  14687. <code>TimelineEntityGroupId</code>.
  14688. @return <code>ApplicationId</code> of the
  14689. <code>TimelineEntityGroupId</code>]]>
  14690. </doc>
  14691. </method>
  14692. <method name="setApplicationId"
  14693. abstract="false" native="false" synchronized="false"
  14694. static="false" final="false" visibility="public"
  14695. deprecated="not deprecated">
  14696. <param name="appID" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  14697. </method>
  14698. <method name="getTimelineEntityGroupId" return="java.lang.String"
  14699. abstract="false" native="false" synchronized="false"
  14700. static="false" final="false" visibility="public"
  14701. deprecated="not deprecated">
  14702. <doc>
  14703. <![CDATA[Get the <code>timelineEntityGroupId</code>.
  14704. @return <code>timelineEntityGroupId</code>]]>
  14705. </doc>
  14706. </method>
  14707. <method name="hashCode" return="int"
  14708. abstract="false" native="false" synchronized="false"
  14709. static="false" final="false" visibility="public"
  14710. deprecated="not deprecated">
  14711. </method>
  14712. <method name="equals" return="boolean"
  14713. abstract="false" native="false" synchronized="false"
  14714. static="false" final="false" visibility="public"
  14715. deprecated="not deprecated">
  14716. <param name="obj" type="java.lang.Object"/>
  14717. </method>
  14718. <method name="compareTo" return="int"
  14719. abstract="false" native="false" synchronized="false"
  14720. static="false" final="false" visibility="public"
  14721. deprecated="not deprecated">
  14722. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"/>
  14723. </method>
  14724. <method name="toString" return="java.lang.String"
  14725. abstract="false" native="false" synchronized="false"
  14726. static="false" final="false" visibility="public"
  14727. deprecated="not deprecated">
  14728. </method>
  14729. <method name="fromString" return="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"
  14730. abstract="false" native="false" synchronized="false"
  14731. static="true" final="false" visibility="public"
  14732. deprecated="not deprecated">
  14733. <param name="timelineEntityGroupIdStr" type="java.lang.String"/>
  14734. </method>
  14735. <field name="TIMELINE_ENTITY_GROUPID_STR_PREFIX" type="java.lang.String"
  14736. transient="false" volatile="false"
  14737. static="true" final="true" visibility="public"
  14738. deprecated="not deprecated">
  14739. </field>
  14740. <doc>
  14741. <![CDATA[<p><code>TimelineEntityGroupId</code> is an abstract way for
  14742. timeline service users to represent #a group of related timeline data.
  14743. For example, all entities that represents one data flow DAG execution
  14744. can be grouped into one timeline entity group. </p>]]>
  14745. </doc>
  14746. </class>
  14747. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId -->
  14748. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
  14749. <class name="TimelineEvent" extends="java.lang.Object"
  14750. abstract="false"
  14751. static="false" final="false" visibility="public"
  14752. deprecated="not deprecated">
  14753. <implements name="java.lang.Comparable"/>
  14754. <constructor name="TimelineEvent"
  14755. static="false" final="false" visibility="public"
  14756. deprecated="not deprecated">
  14757. </constructor>
  14758. <method name="getTimestamp" return="long"
  14759. abstract="false" native="false" synchronized="false"
  14760. static="false" final="false" visibility="public"
  14761. deprecated="not deprecated">
  14762. <doc>
  14763. <![CDATA[Get the timestamp of the event
  14764. @return the timestamp of the event]]>
  14765. </doc>
  14766. </method>
  14767. <method name="setTimestamp"
  14768. abstract="false" native="false" synchronized="false"
  14769. static="false" final="false" visibility="public"
  14770. deprecated="not deprecated">
  14771. <param name="timestamp" type="long"/>
  14772. <doc>
  14773. <![CDATA[Set the timestamp of the event
  14774. @param timestamp
  14775. the timestamp of the event]]>
  14776. </doc>
  14777. </method>
  14778. <method name="getEventType" return="java.lang.String"
  14779. abstract="false" native="false" synchronized="false"
  14780. static="false" final="false" visibility="public"
  14781. deprecated="not deprecated">
  14782. <doc>
  14783. <![CDATA[Get the event type
  14784. @return the event type]]>
  14785. </doc>
  14786. </method>
  14787. <method name="setEventType"
  14788. abstract="false" native="false" synchronized="false"
  14789. static="false" final="false" visibility="public"
  14790. deprecated="not deprecated">
  14791. <param name="eventType" type="java.lang.String"/>
  14792. <doc>
  14793. <![CDATA[Set the event type
  14794. @param eventType
  14795. the event type]]>
  14796. </doc>
  14797. </method>
  14798. <method name="getEventInfo" return="java.util.Map"
  14799. abstract="false" native="false" synchronized="false"
  14800. static="false" final="false" visibility="public"
  14801. deprecated="not deprecated">
  14802. <doc>
  14803. <![CDATA[Set the information of the event
  14804. @return the information of the event]]>
  14805. </doc>
  14806. </method>
  14807. <method name="addEventInfo"
  14808. abstract="false" native="false" synchronized="false"
  14809. static="false" final="false" visibility="public"
  14810. deprecated="not deprecated">
  14811. <param name="key" type="java.lang.String"/>
  14812. <param name="value" type="java.lang.Object"/>
  14813. <doc>
  14814. <![CDATA[Add one piece of the information of the event to the existing information
  14815. map
  14816. @param key
  14817. the information key
  14818. @param value
  14819. the information value]]>
  14820. </doc>
  14821. </method>
  14822. <method name="addEventInfo"
  14823. abstract="false" native="false" synchronized="false"
  14824. static="false" final="false" visibility="public"
  14825. deprecated="not deprecated">
  14826. <param name="eventInfo" type="java.util.Map"/>
  14827. <doc>
  14828. <![CDATA[Add a map of the information of the event to the existing information map
  14829. @param eventInfo
  14830. a map of of the information of the event]]>
  14831. </doc>
  14832. </method>
  14833. <method name="setEventInfo"
  14834. abstract="false" native="false" synchronized="false"
  14835. static="false" final="false" visibility="public"
  14836. deprecated="not deprecated">
  14837. <param name="eventInfo" type="java.util.Map"/>
  14838. <doc>
  14839. <![CDATA[Set the information map to the given map of the information of the event
  14840. @param eventInfo
  14841. a map of of the information of the event]]>
  14842. </doc>
  14843. </method>
  14844. <method name="compareTo" return="int"
  14845. abstract="false" native="false" synchronized="false"
  14846. static="false" final="false" visibility="public"
  14847. deprecated="not deprecated">
  14848. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  14849. </method>
  14850. <method name="equals" return="boolean"
  14851. abstract="false" native="false" synchronized="false"
  14852. static="false" final="false" visibility="public"
  14853. deprecated="not deprecated">
  14854. <param name="o" type="java.lang.Object"/>
  14855. </method>
  14856. <method name="hashCode" return="int"
  14857. abstract="false" native="false" synchronized="false"
  14858. static="false" final="false" visibility="public"
  14859. deprecated="not deprecated">
  14860. </method>
  14861. <doc>
  14862. <![CDATA[The class that contains the information of an event that is related to some
  14863. conceptual entity of an application. Users are free to define what the event
  14864. means, such as starting an application, getting allocated a container and
  14865. etc.]]>
  14866. </doc>
  14867. </class>
  14868. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
  14869. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
  14870. <class name="TimelineEvents" extends="java.lang.Object"
  14871. abstract="false"
  14872. static="false" final="false" visibility="public"
  14873. deprecated="not deprecated">
  14874. <constructor name="TimelineEvents"
  14875. static="false" final="false" visibility="public"
  14876. deprecated="not deprecated">
  14877. </constructor>
  14878. <method name="getAllEvents" return="java.util.List"
  14879. abstract="false" native="false" synchronized="false"
  14880. static="false" final="false" visibility="public"
  14881. deprecated="not deprecated">
  14882. <doc>
  14883. <![CDATA[Get a list of {@link EventsOfOneEntity} instances
  14884. @return a list of {@link EventsOfOneEntity} instances]]>
  14885. </doc>
  14886. </method>
  14887. <method name="addEvent"
  14888. abstract="false" native="false" synchronized="false"
  14889. static="false" final="false" visibility="public"
  14890. deprecated="not deprecated">
  14891. <param name="eventsOfOneEntity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity"/>
  14892. <doc>
  14893. <![CDATA[Add a single {@link EventsOfOneEntity} instance into the existing list
  14894. @param eventsOfOneEntity
  14895. a single {@link EventsOfOneEntity} instance]]>
  14896. </doc>
  14897. </method>
  14898. <method name="addEvents"
  14899. abstract="false" native="false" synchronized="false"
  14900. static="false" final="false" visibility="public"
  14901. deprecated="not deprecated">
  14902. <param name="allEvents" type="java.util.List"/>
  14903. <doc>
  14904. <![CDATA[Add a list of {@link EventsOfOneEntity} instances into the existing list
  14905. @param allEvents
  14906. a list of {@link EventsOfOneEntity} instances]]>
  14907. </doc>
  14908. </method>
  14909. <method name="setEvents"
  14910. abstract="false" native="false" synchronized="false"
  14911. static="false" final="false" visibility="public"
  14912. deprecated="not deprecated">
  14913. <param name="allEvents" type="java.util.List"/>
  14914. <doc>
  14915. <![CDATA[Set the list to the given list of {@link EventsOfOneEntity} instances
  14916. @param allEvents
  14917. a list of {@link EventsOfOneEntity} instances]]>
  14918. </doc>
  14919. </method>
  14920. <doc>
  14921. <![CDATA[The class that hosts a list of events, which are categorized according to
  14922. their related entities.]]>
  14923. </doc>
  14924. </class>
  14925. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
  14926. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
  14927. <class name="TimelineEvents.EventsOfOneEntity" extends="java.lang.Object"
  14928. abstract="false"
  14929. static="true" final="false" visibility="public"
  14930. deprecated="not deprecated">
  14931. <constructor name="EventsOfOneEntity"
  14932. static="false" final="false" visibility="public"
  14933. deprecated="not deprecated">
  14934. </constructor>
  14935. <method name="getEntityId" return="java.lang.String"
  14936. abstract="false" native="false" synchronized="false"
  14937. static="false" final="false" visibility="public"
  14938. deprecated="not deprecated">
  14939. <doc>
  14940. <![CDATA[Get the entity Id
  14941. @return the entity Id]]>
  14942. </doc>
  14943. </method>
  14944. <method name="setEntityId"
  14945. abstract="false" native="false" synchronized="false"
  14946. static="false" final="false" visibility="public"
  14947. deprecated="not deprecated">
  14948. <param name="entityId" type="java.lang.String"/>
  14949. <doc>
  14950. <![CDATA[Set the entity Id
  14951. @param entityId
  14952. the entity Id]]>
  14953. </doc>
  14954. </method>
  14955. <method name="getEntityType" return="java.lang.String"
  14956. abstract="false" native="false" synchronized="false"
  14957. static="false" final="false" visibility="public"
  14958. deprecated="not deprecated">
  14959. <doc>
  14960. <![CDATA[Get the entity type
  14961. @return the entity type]]>
  14962. </doc>
  14963. </method>
  14964. <method name="setEntityType"
  14965. abstract="false" native="false" synchronized="false"
  14966. static="false" final="false" visibility="public"
  14967. deprecated="not deprecated">
  14968. <param name="entityType" type="java.lang.String"/>
  14969. <doc>
  14970. <![CDATA[Set the entity type
  14971. @param entityType
  14972. the entity type]]>
  14973. </doc>
  14974. </method>
  14975. <method name="getEvents" return="java.util.List"
  14976. abstract="false" native="false" synchronized="false"
  14977. static="false" final="false" visibility="public"
  14978. deprecated="not deprecated">
  14979. <doc>
  14980. <![CDATA[Get a list of events
  14981. @return a list of events]]>
  14982. </doc>
  14983. </method>
  14984. <method name="addEvent"
  14985. abstract="false" native="false" synchronized="false"
  14986. static="false" final="false" visibility="public"
  14987. deprecated="not deprecated">
  14988. <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  14989. <doc>
  14990. <![CDATA[Add a single event to the existing event list
  14991. @param event
  14992. a single event]]>
  14993. </doc>
  14994. </method>
  14995. <method name="addEvents"
  14996. abstract="false" native="false" synchronized="false"
  14997. static="false" final="false" visibility="public"
  14998. deprecated="not deprecated">
  14999. <param name="events" type="java.util.List"/>
  15000. <doc>
  15001. <![CDATA[Add a list of event to the existing event list
  15002. @param events
  15003. a list of events]]>
  15004. </doc>
  15005. </method>
  15006. <method name="setEvents"
  15007. abstract="false" native="false" synchronized="false"
  15008. static="false" final="false" visibility="public"
  15009. deprecated="not deprecated">
  15010. <param name="events" type="java.util.List"/>
  15011. <doc>
  15012. <![CDATA[Set the event list to the given list of events
  15013. @param events
  15014. a list of events]]>
  15015. </doc>
  15016. </method>
  15017. <doc>
  15018. <![CDATA[The class that hosts a list of events that are only related to one entity.]]>
  15019. </doc>
  15020. </class>
  15021. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
  15022. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineHealth -->
  15023. <class name="TimelineHealth" extends="java.lang.Object"
  15024. abstract="false"
  15025. static="false" final="false" visibility="public"
  15026. deprecated="not deprecated">
  15027. <constructor name="TimelineHealth" type="org.apache.hadoop.yarn.api.records.timeline.TimelineHealth.TimelineHealthStatus, java.lang.String"
  15028. static="false" final="false" visibility="public"
  15029. deprecated="not deprecated">
  15030. </constructor>
  15031. <constructor name="TimelineHealth"
  15032. static="false" final="false" visibility="public"
  15033. deprecated="not deprecated">
  15034. </constructor>
  15035. <method name="getHealthStatus" return="org.apache.hadoop.yarn.api.records.timeline.TimelineHealth.TimelineHealthStatus"
  15036. abstract="false" native="false" synchronized="false"
  15037. static="false" final="false" visibility="public"
  15038. deprecated="not deprecated">
  15039. </method>
  15040. <method name="getDiagnosticsInfo" return="java.lang.String"
  15041. abstract="false" native="false" synchronized="false"
  15042. static="false" final="false" visibility="public"
  15043. deprecated="not deprecated">
  15044. </method>
  15045. <method name="setHealthStatus"
  15046. abstract="false" native="false" synchronized="false"
  15047. static="false" final="false" visibility="public"
  15048. deprecated="not deprecated">
  15049. <param name="healthStatus" type="org.apache.hadoop.yarn.api.records.timeline.TimelineHealth.TimelineHealthStatus"/>
  15050. </method>
  15051. <method name="setDiagnosticsInfo"
  15052. abstract="false" native="false" synchronized="false"
  15053. static="false" final="false" visibility="public"
  15054. deprecated="not deprecated">
  15055. <param name="diagnosticsInfo" type="java.lang.String"/>
  15056. </method>
  15057. <doc>
  15058. <![CDATA[This class holds health information for ATS.]]>
  15059. </doc>
  15060. </class>
  15061. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineHealth -->
  15062. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
  15063. <class name="TimelinePutResponse" extends="java.lang.Object"
  15064. abstract="false"
  15065. static="false" final="false" visibility="public"
  15066. deprecated="not deprecated">
  15067. <constructor name="TimelinePutResponse"
  15068. static="false" final="false" visibility="public"
  15069. deprecated="not deprecated">
  15070. </constructor>
  15071. <method name="getErrors" return="java.util.List"
  15072. abstract="false" native="false" synchronized="false"
  15073. static="false" final="false" visibility="public"
  15074. deprecated="not deprecated">
  15075. <doc>
  15076. <![CDATA[Get a list of {@link TimelinePutError} instances
  15077. @return a list of {@link TimelinePutError} instances]]>
  15078. </doc>
  15079. </method>
  15080. <method name="addError"
  15081. abstract="false" native="false" synchronized="false"
  15082. static="false" final="false" visibility="public"
  15083. deprecated="not deprecated">
  15084. <param name="error" type="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError"/>
  15085. <doc>
  15086. <![CDATA[Add a single {@link TimelinePutError} instance into the existing list
  15087. @param error
  15088. a single {@link TimelinePutError} instance]]>
  15089. </doc>
  15090. </method>
  15091. <method name="addErrors"
  15092. abstract="false" native="false" synchronized="false"
  15093. static="false" final="false" visibility="public"
  15094. deprecated="not deprecated">
  15095. <param name="errors" type="java.util.List"/>
  15096. <doc>
  15097. <![CDATA[Add a list of {@link TimelinePutError} instances into the existing list
  15098. @param errors
  15099. a list of {@link TimelinePutError} instances]]>
  15100. </doc>
  15101. </method>
  15102. <method name="setErrors"
  15103. abstract="false" native="false" synchronized="false"
  15104. static="false" final="false" visibility="public"
  15105. deprecated="not deprecated">
  15106. <param name="errors" type="java.util.List"/>
  15107. <doc>
  15108. <![CDATA[Set the list to the given list of {@link TimelinePutError} instances
  15109. @param errors
  15110. a list of {@link TimelinePutError} instances]]>
  15111. </doc>
  15112. </method>
  15113. <doc>
  15114. <![CDATA[A class that holds a list of put errors. This is the response returned when a
  15115. list of {@link TimelineEntity} objects is added to the timeline. If there are errors
  15116. in storing individual entity objects, they will be indicated in the list of
  15117. errors.]]>
  15118. </doc>
  15119. </class>
  15120. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
  15121. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
  15122. <class name="TimelinePutResponse.TimelinePutError" extends="java.lang.Object"
  15123. abstract="false"
  15124. static="true" final="false" visibility="public"
  15125. deprecated="not deprecated">
  15126. <constructor name="TimelinePutError"
  15127. static="false" final="false" visibility="public"
  15128. deprecated="not deprecated">
  15129. </constructor>
  15130. <method name="getEntityId" return="java.lang.String"
  15131. abstract="false" native="false" synchronized="false"
  15132. static="false" final="false" visibility="public"
  15133. deprecated="not deprecated">
  15134. <doc>
  15135. <![CDATA[Get the entity Id
  15136. @return the entity Id]]>
  15137. </doc>
  15138. </method>
  15139. <method name="setEntityId"
  15140. abstract="false" native="false" synchronized="false"
  15141. static="false" final="false" visibility="public"
  15142. deprecated="not deprecated">
  15143. <param name="entityId" type="java.lang.String"/>
  15144. <doc>
  15145. <![CDATA[Set the entity Id
  15146. @param entityId
  15147. the entity Id]]>
  15148. </doc>
  15149. </method>
  15150. <method name="getEntityType" return="java.lang.String"
  15151. abstract="false" native="false" synchronized="false"
  15152. static="false" final="false" visibility="public"
  15153. deprecated="not deprecated">
  15154. <doc>
  15155. <![CDATA[Get the entity type
  15156. @return the entity type]]>
  15157. </doc>
  15158. </method>
  15159. <method name="setEntityType"
  15160. abstract="false" native="false" synchronized="false"
  15161. static="false" final="false" visibility="public"
  15162. deprecated="not deprecated">
  15163. <param name="entityType" type="java.lang.String"/>
  15164. <doc>
  15165. <![CDATA[Set the entity type
  15166. @param entityType
  15167. the entity type]]>
  15168. </doc>
  15169. </method>
  15170. <method name="getErrorCode" return="int"
  15171. abstract="false" native="false" synchronized="false"
  15172. static="false" final="false" visibility="public"
  15173. deprecated="not deprecated">
  15174. <doc>
  15175. <![CDATA[Get the error code
  15176. @return an error code]]>
  15177. </doc>
  15178. </method>
  15179. <method name="setErrorCode"
  15180. abstract="false" native="false" synchronized="false"
  15181. static="false" final="false" visibility="public"
  15182. deprecated="not deprecated">
  15183. <param name="errorCode" type="int"/>
  15184. <doc>
  15185. <![CDATA[Set the error code to the given error code
  15186. @param errorCode
  15187. an error code]]>
  15188. </doc>
  15189. </method>
  15190. <field name="NO_START_TIME" type="int"
  15191. transient="false" volatile="false"
  15192. static="true" final="true" visibility="public"
  15193. deprecated="not deprecated">
  15194. <doc>
  15195. <![CDATA[Error code returned when no start time can be found when putting an
  15196. entity. This occurs when the entity does not already exist in the store
  15197. and it is put with no start time or events specified.]]>
  15198. </doc>
  15199. </field>
  15200. <field name="IO_EXCEPTION" type="int"
  15201. transient="false" volatile="false"
  15202. static="true" final="true" visibility="public"
  15203. deprecated="not deprecated">
  15204. <doc>
  15205. <![CDATA[Error code returned if an IOException is encountered when putting an
  15206. entity.]]>
  15207. </doc>
  15208. </field>
  15209. <field name="SYSTEM_FILTER_CONFLICT" type="int"
  15210. transient="false" volatile="false"
  15211. static="true" final="true" visibility="public"
  15212. deprecated="not deprecated">
  15213. <doc>
  15214. <![CDATA[Error code returned if the user specifies the timeline system reserved
  15215. filter key]]>
  15216. </doc>
  15217. </field>
  15218. <field name="ACCESS_DENIED" type="int"
  15219. transient="false" volatile="false"
  15220. static="true" final="true" visibility="public"
  15221. deprecated="not deprecated">
  15222. <doc>
  15223. <![CDATA[Error code returned if the user is denied to access the timeline data]]>
  15224. </doc>
  15225. </field>
  15226. <field name="NO_DOMAIN" type="int"
  15227. transient="false" volatile="false"
  15228. static="true" final="true" visibility="public"
  15229. deprecated="not deprecated">
  15230. <doc>
  15231. <![CDATA[Error code returned if the entity doesn't have an valid domain ID]]>
  15232. </doc>
  15233. </field>
  15234. <field name="FORBIDDEN_RELATION" type="int"
  15235. transient="false" volatile="false"
  15236. static="true" final="true" visibility="public"
  15237. deprecated="not deprecated">
  15238. <doc>
  15239. <![CDATA[Error code returned if the user is denied to relate the entity to another
  15240. one in different domain]]>
  15241. </doc>
  15242. </field>
  15243. <field name="EXPIRED_ENTITY" type="int"
  15244. transient="false" volatile="false"
  15245. static="true" final="true" visibility="public"
  15246. deprecated="not deprecated">
  15247. <doc>
  15248. <![CDATA[Error code returned if the entity start time is before the eviction
  15249. period of old data.]]>
  15250. </doc>
  15251. </field>
  15252. <doc>
  15253. <![CDATA[A class that holds the error code for one entity.]]>
  15254. </doc>
  15255. </class>
  15256. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
  15257. </package>
  15258. <package name="org.apache.hadoop.yarn.api.records.timelineservice">
  15259. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationAttemptEntity -->
  15260. <class name="ApplicationAttemptEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  15261. abstract="false"
  15262. static="false" final="false" visibility="public"
  15263. deprecated="not deprecated">
  15264. <constructor name="ApplicationAttemptEntity"
  15265. static="false" final="false" visibility="public"
  15266. deprecated="not deprecated">
  15267. </constructor>
  15268. <constructor name="ApplicationAttemptEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15269. static="false" final="false" visibility="public"
  15270. deprecated="not deprecated">
  15271. </constructor>
  15272. <doc>
  15273. <![CDATA[This entity represents an application attempt.]]>
  15274. </doc>
  15275. </class>
  15276. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationAttemptEntity -->
  15277. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationEntity -->
  15278. <class name="ApplicationEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  15279. abstract="false"
  15280. static="false" final="false" visibility="public"
  15281. deprecated="not deprecated">
  15282. <constructor name="ApplicationEntity"
  15283. static="false" final="false" visibility="public"
  15284. deprecated="not deprecated">
  15285. </constructor>
  15286. <constructor name="ApplicationEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15287. static="false" final="false" visibility="public"
  15288. deprecated="not deprecated">
  15289. </constructor>
  15290. <method name="getQueue" return="java.lang.String"
  15291. abstract="false" native="false" synchronized="false"
  15292. static="false" final="false" visibility="public"
  15293. deprecated="not deprecated">
  15294. </method>
  15295. <method name="setQueue"
  15296. abstract="false" native="false" synchronized="false"
  15297. static="false" final="false" visibility="public"
  15298. deprecated="not deprecated">
  15299. <param name="queue" type="java.lang.String"/>
  15300. </method>
  15301. <method name="isApplicationEntity" return="boolean"
  15302. abstract="false" native="false" synchronized="false"
  15303. static="true" final="false" visibility="public"
  15304. deprecated="not deprecated">
  15305. <param name="te" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  15306. <doc>
  15307. <![CDATA[Checks if the input TimelineEntity object is an ApplicationEntity.
  15308. @param te TimelineEntity object.
  15309. @return true if input is an ApplicationEntity, false otherwise]]>
  15310. </doc>
  15311. </method>
  15312. <method name="getApplicationEvent" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent"
  15313. abstract="false" native="false" synchronized="false"
  15314. static="true" final="false" visibility="public"
  15315. deprecated="not deprecated">
  15316. <param name="te" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  15317. <param name="eventId" type="java.lang.String"/>
  15318. <doc>
  15319. <![CDATA[@param te TimelineEntity object.
  15320. @param eventId event with this id needs to be fetched
  15321. @return TimelineEvent if TimelineEntity contains the desired event.]]>
  15322. </doc>
  15323. </method>
  15324. <field name="QUEUE_INFO_KEY" type="java.lang.String"
  15325. transient="false" volatile="false"
  15326. static="true" final="true" visibility="public"
  15327. deprecated="not deprecated">
  15328. </field>
  15329. <doc>
  15330. <![CDATA[This entity represents an application.]]>
  15331. </doc>
  15332. </class>
  15333. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationEntity -->
  15334. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ClusterEntity -->
  15335. <class name="ClusterEntity" 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="ClusterEntity"
  15340. static="false" final="false" visibility="public"
  15341. deprecated="not deprecated">
  15342. </constructor>
  15343. <constructor name="ClusterEntity" 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 YARN cluster.]]>
  15349. </doc>
  15350. </class>
  15351. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ClusterEntity -->
  15352. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ContainerEntity -->
  15353. <class name="ContainerEntity" 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="ContainerEntity"
  15358. static="false" final="false" visibility="public"
  15359. deprecated="not deprecated">
  15360. </constructor>
  15361. <constructor name="ContainerEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15362. static="false" final="false" visibility="public"
  15363. deprecated="not deprecated">
  15364. </constructor>
  15365. <doc>
  15366. <![CDATA[This entity represents a container belonging to an application attempt.]]>
  15367. </doc>
  15368. </class>
  15369. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ContainerEntity -->
  15370. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.FlowActivityEntity -->
  15371. <class name="FlowActivityEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15372. abstract="false"
  15373. static="false" final="false" visibility="public"
  15374. deprecated="not deprecated">
  15375. <constructor name="FlowActivityEntity"
  15376. static="false" final="false" visibility="public"
  15377. deprecated="not deprecated">
  15378. </constructor>
  15379. <constructor name="FlowActivityEntity" type="java.lang.String, long, java.lang.String, java.lang.String"
  15380. static="false" final="false" visibility="public"
  15381. deprecated="not deprecated">
  15382. </constructor>
  15383. <constructor name="FlowActivityEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15384. static="false" final="false" visibility="public"
  15385. deprecated="not deprecated">
  15386. </constructor>
  15387. <method name="getId" return="java.lang.String"
  15388. abstract="false" native="false" synchronized="false"
  15389. static="false" final="false" visibility="public"
  15390. deprecated="not deprecated">
  15391. </method>
  15392. <method name="compareTo" return="int"
  15393. abstract="false" native="false" synchronized="false"
  15394. static="false" final="false" visibility="public"
  15395. deprecated="not deprecated">
  15396. <param name="entity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  15397. </method>
  15398. <method name="equals" return="boolean"
  15399. abstract="false" native="false" synchronized="false"
  15400. static="false" final="false" visibility="public"
  15401. deprecated="not deprecated">
  15402. <param name="obj" type="java.lang.Object"/>
  15403. <doc>
  15404. <![CDATA[Reuse the base class equals method.]]>
  15405. </doc>
  15406. </method>
  15407. <method name="hashCode" return="int"
  15408. abstract="false" native="false" synchronized="false"
  15409. static="false" final="false" visibility="public"
  15410. deprecated="not deprecated">
  15411. <doc>
  15412. <![CDATA[Reuse the base class hashCode method.]]>
  15413. </doc>
  15414. </method>
  15415. <method name="getCluster" return="java.lang.String"
  15416. abstract="false" native="false" synchronized="false"
  15417. static="false" final="false" visibility="public"
  15418. deprecated="not deprecated">
  15419. </method>
  15420. <method name="setCluster"
  15421. abstract="false" native="false" synchronized="false"
  15422. static="false" final="false" visibility="public"
  15423. deprecated="not deprecated">
  15424. <param name="cluster" type="java.lang.String"/>
  15425. </method>
  15426. <method name="getDate" return="java.util.Date"
  15427. abstract="false" native="false" synchronized="false"
  15428. static="false" final="false" visibility="public"
  15429. deprecated="not deprecated">
  15430. </method>
  15431. <method name="setDate"
  15432. abstract="false" native="false" synchronized="false"
  15433. static="false" final="false" visibility="public"
  15434. deprecated="not deprecated">
  15435. <param name="time" type="long"/>
  15436. </method>
  15437. <method name="getUser" return="java.lang.String"
  15438. abstract="false" native="false" synchronized="false"
  15439. static="false" final="false" visibility="public"
  15440. deprecated="not deprecated">
  15441. </method>
  15442. <method name="setUser"
  15443. abstract="false" native="false" synchronized="false"
  15444. static="false" final="false" visibility="public"
  15445. deprecated="not deprecated">
  15446. <param name="user" type="java.lang.String"/>
  15447. </method>
  15448. <method name="getFlowName" return="java.lang.String"
  15449. abstract="false" native="false" synchronized="false"
  15450. static="false" final="false" visibility="public"
  15451. deprecated="not deprecated">
  15452. </method>
  15453. <method name="setFlowName"
  15454. abstract="false" native="false" synchronized="false"
  15455. static="false" final="false" visibility="public"
  15456. deprecated="not deprecated">
  15457. <param name="flowName" type="java.lang.String"/>
  15458. </method>
  15459. <method name="addFlowRun"
  15460. abstract="false" native="false" synchronized="false"
  15461. static="false" final="false" visibility="public"
  15462. deprecated="not deprecated">
  15463. <param name="run" type="org.apache.hadoop.yarn.api.records.timelineservice.FlowRunEntity"/>
  15464. </method>
  15465. <method name="addFlowRuns"
  15466. abstract="false" native="false" synchronized="false"
  15467. static="false" final="false" visibility="public"
  15468. deprecated="not deprecated">
  15469. <param name="runs" type="java.util.Collection"/>
  15470. </method>
  15471. <method name="getFlowRuns" return="java.util.NavigableSet"
  15472. abstract="false" native="false" synchronized="false"
  15473. static="false" final="false" visibility="public"
  15474. deprecated="not deprecated">
  15475. </method>
  15476. <method name="getNumberOfRuns" return="int"
  15477. abstract="false" native="false" synchronized="false"
  15478. static="false" final="false" visibility="public"
  15479. deprecated="not deprecated">
  15480. </method>
  15481. <field name="CLUSTER_INFO_KEY" type="java.lang.String"
  15482. transient="false" volatile="false"
  15483. static="true" final="true" visibility="public"
  15484. deprecated="not deprecated">
  15485. </field>
  15486. <field name="DATE_INFO_KEY" type="java.lang.String"
  15487. transient="false" volatile="false"
  15488. static="true" final="true" visibility="public"
  15489. deprecated="not deprecated">
  15490. </field>
  15491. <field name="USER_INFO_KEY" type="java.lang.String"
  15492. transient="false" volatile="false"
  15493. static="true" final="true" visibility="public"
  15494. deprecated="not deprecated">
  15495. </field>
  15496. <field name="FLOW_NAME_INFO_KEY" type="java.lang.String"
  15497. transient="false" volatile="false"
  15498. static="true" final="true" visibility="public"
  15499. deprecated="not deprecated">
  15500. </field>
  15501. <doc>
  15502. <![CDATA[Entity that represents a record for flow activity. It's essentially a
  15503. container entity for flow runs with limited information.]]>
  15504. </doc>
  15505. </class>
  15506. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.FlowActivityEntity -->
  15507. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.FlowRunEntity -->
  15508. <class name="FlowRunEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  15509. abstract="false"
  15510. static="false" final="false" visibility="public"
  15511. deprecated="not deprecated">
  15512. <constructor name="FlowRunEntity"
  15513. static="false" final="false" visibility="public"
  15514. deprecated="not deprecated">
  15515. </constructor>
  15516. <constructor name="FlowRunEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15517. static="false" final="false" visibility="public"
  15518. deprecated="not deprecated">
  15519. </constructor>
  15520. <method name="getId" return="java.lang.String"
  15521. abstract="false" native="false" synchronized="false"
  15522. static="false" final="false" visibility="public"
  15523. deprecated="not deprecated">
  15524. </method>
  15525. <method name="getUser" return="java.lang.String"
  15526. abstract="false" native="false" synchronized="false"
  15527. static="false" final="false" visibility="public"
  15528. deprecated="not deprecated">
  15529. </method>
  15530. <method name="setUser"
  15531. abstract="false" native="false" synchronized="false"
  15532. static="false" final="false" visibility="public"
  15533. deprecated="not deprecated">
  15534. <param name="user" type="java.lang.String"/>
  15535. </method>
  15536. <method name="getName" return="java.lang.String"
  15537. abstract="false" native="false" synchronized="false"
  15538. static="false" final="false" visibility="public"
  15539. deprecated="not deprecated">
  15540. </method>
  15541. <method name="setName"
  15542. abstract="false" native="false" synchronized="false"
  15543. static="false" final="false" visibility="public"
  15544. deprecated="not deprecated">
  15545. <param name="name" type="java.lang.String"/>
  15546. </method>
  15547. <method name="getVersion" return="java.lang.String"
  15548. abstract="false" native="false" synchronized="false"
  15549. static="false" final="false" visibility="public"
  15550. deprecated="not deprecated">
  15551. </method>
  15552. <method name="setVersion"
  15553. abstract="false" native="false" synchronized="false"
  15554. static="false" final="false" visibility="public"
  15555. deprecated="not deprecated">
  15556. <param name="version" type="java.lang.String"/>
  15557. </method>
  15558. <method name="getRunId" return="long"
  15559. abstract="false" native="false" synchronized="false"
  15560. static="false" final="false" visibility="public"
  15561. deprecated="not deprecated">
  15562. </method>
  15563. <method name="setRunId"
  15564. abstract="false" native="false" synchronized="false"
  15565. static="false" final="false" visibility="public"
  15566. deprecated="not deprecated">
  15567. <param name="runId" type="long"/>
  15568. </method>
  15569. <method name="getStartTime" return="long"
  15570. abstract="false" native="false" synchronized="false"
  15571. static="false" final="false" visibility="public"
  15572. deprecated="not deprecated">
  15573. </method>
  15574. <method name="setStartTime"
  15575. abstract="false" native="false" synchronized="false"
  15576. static="false" final="false" visibility="public"
  15577. deprecated="not deprecated">
  15578. <param name="startTime" type="long"/>
  15579. </method>
  15580. <method name="getMaxEndTime" return="long"
  15581. abstract="false" native="false" synchronized="false"
  15582. static="false" final="false" visibility="public"
  15583. deprecated="not deprecated">
  15584. </method>
  15585. <method name="setMaxEndTime"
  15586. abstract="false" native="false" synchronized="false"
  15587. static="false" final="false" visibility="public"
  15588. deprecated="not deprecated">
  15589. <param name="endTime" type="long"/>
  15590. </method>
  15591. <field name="USER_INFO_KEY" type="java.lang.String"
  15592. transient="false" volatile="false"
  15593. static="true" final="true" visibility="public"
  15594. deprecated="not deprecated">
  15595. </field>
  15596. <field name="FLOW_NAME_INFO_KEY" type="java.lang.String"
  15597. transient="false" volatile="false"
  15598. static="true" final="true" visibility="public"
  15599. deprecated="not deprecated">
  15600. </field>
  15601. <field name="FLOW_VERSION_INFO_KEY" type="java.lang.String"
  15602. transient="false" volatile="false"
  15603. static="true" final="true" visibility="public"
  15604. deprecated="not deprecated">
  15605. </field>
  15606. <field name="FLOW_RUN_ID_INFO_KEY" type="java.lang.String"
  15607. transient="false" volatile="false"
  15608. static="true" final="true" visibility="public"
  15609. deprecated="not deprecated">
  15610. </field>
  15611. <field name="FLOW_RUN_END_TIME" type="java.lang.String"
  15612. transient="false" volatile="false"
  15613. static="true" final="true" visibility="public"
  15614. deprecated="not deprecated">
  15615. </field>
  15616. <doc>
  15617. <![CDATA[This entity represents a flow run.]]>
  15618. </doc>
  15619. </class>
  15620. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.FlowRunEntity -->
  15621. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity -->
  15622. <class name="HierarchicalTimelineEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15623. abstract="true"
  15624. static="false" final="false" visibility="public"
  15625. deprecated="not deprecated">
  15626. <method name="getParent" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"
  15627. abstract="false" native="false" synchronized="false"
  15628. static="false" final="false" visibility="public"
  15629. deprecated="not deprecated">
  15630. </method>
  15631. <method name="setParent"
  15632. abstract="false" native="false" synchronized="false"
  15633. static="false" final="false" visibility="public"
  15634. deprecated="not deprecated">
  15635. <param name="parent" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"/>
  15636. </method>
  15637. <method name="setParent"
  15638. abstract="false" native="false" synchronized="false"
  15639. static="false" final="false" visibility="public"
  15640. deprecated="not deprecated">
  15641. <param name="type" type="java.lang.String"/>
  15642. <param name="id" type="java.lang.String"/>
  15643. </method>
  15644. <method name="getChildren" return="java.util.Set"
  15645. abstract="false" native="false" synchronized="false"
  15646. static="false" final="false" visibility="public"
  15647. deprecated="not deprecated">
  15648. </method>
  15649. <method name="setChildren"
  15650. abstract="false" native="false" synchronized="false"
  15651. static="false" final="false" visibility="public"
  15652. deprecated="not deprecated">
  15653. <param name="children" type="java.util.Set"/>
  15654. </method>
  15655. <method name="addChildren"
  15656. abstract="false" native="false" synchronized="false"
  15657. static="false" final="false" visibility="public"
  15658. deprecated="not deprecated">
  15659. <param name="children" type="java.util.Set"/>
  15660. </method>
  15661. <method name="addChild"
  15662. abstract="false" native="false" synchronized="false"
  15663. static="false" final="false" visibility="public"
  15664. deprecated="not deprecated">
  15665. <param name="child" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"/>
  15666. </method>
  15667. <method name="addChild"
  15668. abstract="false" native="false" synchronized="false"
  15669. static="false" final="false" visibility="public"
  15670. deprecated="not deprecated">
  15671. <param name="type" type="java.lang.String"/>
  15672. <param name="id" type="java.lang.String"/>
  15673. </method>
  15674. <field name="PARENT_INFO_KEY" type="java.lang.String"
  15675. transient="false" volatile="false"
  15676. static="true" final="true" visibility="public"
  15677. deprecated="not deprecated">
  15678. </field>
  15679. <field name="CHILDREN_INFO_KEY" type="java.lang.String"
  15680. transient="false" volatile="false"
  15681. static="true" final="true" visibility="public"
  15682. deprecated="not deprecated">
  15683. </field>
  15684. <doc>
  15685. <![CDATA[This class extends timeline entity and defines parent-child relationships
  15686. with other entities.]]>
  15687. </doc>
  15688. </class>
  15689. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity -->
  15690. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.QueueEntity -->
  15691. <class name="QueueEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  15692. abstract="false"
  15693. static="false" final="false" visibility="public"
  15694. deprecated="not deprecated">
  15695. <constructor name="QueueEntity"
  15696. static="false" final="false" visibility="public"
  15697. deprecated="not deprecated">
  15698. </constructor>
  15699. <constructor name="QueueEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15700. static="false" final="false" visibility="public"
  15701. deprecated="not deprecated">
  15702. </constructor>
  15703. <doc>
  15704. <![CDATA[This entity represents a queue.]]>
  15705. </doc>
  15706. </class>
  15707. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.QueueEntity -->
  15708. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.SubApplicationEntity -->
  15709. <class name="SubApplicationEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  15710. abstract="false"
  15711. static="false" final="false" visibility="public"
  15712. deprecated="not deprecated">
  15713. <constructor name="SubApplicationEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15714. static="false" final="false" visibility="public"
  15715. deprecated="not deprecated">
  15716. </constructor>
  15717. <method name="isSubApplicationEntity" return="boolean"
  15718. abstract="false" native="false" synchronized="false"
  15719. static="true" final="false" visibility="public"
  15720. deprecated="not deprecated">
  15721. <param name="te" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  15722. <doc>
  15723. <![CDATA[Checks if the input TimelineEntity object is an SubApplicationEntity.
  15724. @param te TimelineEntity object.
  15725. @return true if input is an SubApplicationEntity, false otherwise]]>
  15726. </doc>
  15727. </method>
  15728. <method name="setApplicationId"
  15729. abstract="false" native="false" synchronized="false"
  15730. static="false" final="false" visibility="public"
  15731. deprecated="not deprecated">
  15732. <param name="appId" type="java.lang.String"/>
  15733. </method>
  15734. <field name="YARN_APPLICATION_ID" type="java.lang.String"
  15735. transient="false" volatile="false"
  15736. static="true" final="true" visibility="public"
  15737. deprecated="not deprecated">
  15738. </field>
  15739. <doc>
  15740. <![CDATA[This entity represents a user defined entities to be stored under sub
  15741. application table.]]>
  15742. </doc>
  15743. </class>
  15744. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.SubApplicationEntity -->
  15745. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain -->
  15746. <class name="TimelineDomain" extends="java.lang.Object"
  15747. abstract="false"
  15748. static="false" final="false" visibility="public"
  15749. deprecated="not deprecated">
  15750. <constructor name="TimelineDomain"
  15751. static="false" final="false" visibility="public"
  15752. deprecated="not deprecated">
  15753. </constructor>
  15754. <method name="getId" return="java.lang.String"
  15755. abstract="false" native="false" synchronized="false"
  15756. static="false" final="false" visibility="public"
  15757. deprecated="not deprecated">
  15758. <doc>
  15759. <![CDATA[Get the domain ID.
  15760. @return the domain ID]]>
  15761. </doc>
  15762. </method>
  15763. <method name="setId"
  15764. abstract="false" native="false" synchronized="false"
  15765. static="false" final="false" visibility="public"
  15766. deprecated="not deprecated">
  15767. <param name="id" type="java.lang.String"/>
  15768. <doc>
  15769. <![CDATA[Set the domain ID.
  15770. @param id the domain ID]]>
  15771. </doc>
  15772. </method>
  15773. <method name="getDescription" return="java.lang.String"
  15774. abstract="false" native="false" synchronized="false"
  15775. static="false" final="false" visibility="public"
  15776. deprecated="not deprecated">
  15777. <doc>
  15778. <![CDATA[Get the domain description.
  15779. @return the domain description]]>
  15780. </doc>
  15781. </method>
  15782. <method name="setDescription"
  15783. abstract="false" native="false" synchronized="false"
  15784. static="false" final="false" visibility="public"
  15785. deprecated="not deprecated">
  15786. <param name="description" type="java.lang.String"/>
  15787. <doc>
  15788. <![CDATA[Set the domain description.
  15789. @param description the domain description]]>
  15790. </doc>
  15791. </method>
  15792. <method name="getOwner" return="java.lang.String"
  15793. abstract="false" native="false" synchronized="false"
  15794. static="false" final="false" visibility="public"
  15795. deprecated="not deprecated">
  15796. <doc>
  15797. <![CDATA[Get the domain owner.
  15798. @return the domain owner]]>
  15799. </doc>
  15800. </method>
  15801. <method name="setOwner"
  15802. abstract="false" native="false" synchronized="false"
  15803. static="false" final="false" visibility="public"
  15804. deprecated="not deprecated">
  15805. <param name="owner" type="java.lang.String"/>
  15806. <doc>
  15807. <![CDATA[Set the domain owner. The user doesn't need to set it, which will
  15808. automatically set to the user who puts the domain.
  15809. @param owner the domain owner]]>
  15810. </doc>
  15811. </method>
  15812. <method name="getReaders" return="java.lang.String"
  15813. abstract="false" native="false" synchronized="false"
  15814. static="false" final="false" visibility="public"
  15815. deprecated="not deprecated">
  15816. <doc>
  15817. <![CDATA[Get the reader (and/or reader group) list string.
  15818. @return the reader (and/or reader group) list string]]>
  15819. </doc>
  15820. </method>
  15821. <method name="setReaders"
  15822. abstract="false" native="false" synchronized="false"
  15823. static="false" final="false" visibility="public"
  15824. deprecated="not deprecated">
  15825. <param name="readers" type="java.lang.String"/>
  15826. <doc>
  15827. <![CDATA[Set the reader (and/or reader group) list string.
  15828. @param readers the reader (and/or reader group) list string]]>
  15829. </doc>
  15830. </method>
  15831. <method name="getWriters" return="java.lang.String"
  15832. abstract="false" native="false" synchronized="false"
  15833. static="false" final="false" visibility="public"
  15834. deprecated="not deprecated">
  15835. <doc>
  15836. <![CDATA[Get the writer (and/or writer group) list string.
  15837. @return the writer (and/or writer group) list string]]>
  15838. </doc>
  15839. </method>
  15840. <method name="setWriters"
  15841. abstract="false" native="false" synchronized="false"
  15842. static="false" final="false" visibility="public"
  15843. deprecated="not deprecated">
  15844. <param name="writers" type="java.lang.String"/>
  15845. <doc>
  15846. <![CDATA[Set the writer (and/or writer group) list string.
  15847. @param writers the writer (and/or writer group) list string]]>
  15848. </doc>
  15849. </method>
  15850. <method name="getCreatedTime" return="java.lang.Long"
  15851. abstract="false" native="false" synchronized="false"
  15852. static="false" final="false" visibility="public"
  15853. deprecated="not deprecated">
  15854. <doc>
  15855. <![CDATA[Get the created time of the domain.
  15856. @return the created time of the domain]]>
  15857. </doc>
  15858. </method>
  15859. <method name="setCreatedTime"
  15860. abstract="false" native="false" synchronized="false"
  15861. static="false" final="false" visibility="public"
  15862. deprecated="not deprecated">
  15863. <param name="createdTime" type="java.lang.Long"/>
  15864. <doc>
  15865. <![CDATA[Set the created time of the domain.
  15866. @param createdTime the created time of the domain]]>
  15867. </doc>
  15868. </method>
  15869. <method name="getModifiedTime" return="java.lang.Long"
  15870. abstract="false" native="false" synchronized="false"
  15871. static="false" final="false" visibility="public"
  15872. deprecated="not deprecated">
  15873. <doc>
  15874. <![CDATA[Get the modified time of the domain.
  15875. @return the modified time of the domain]]>
  15876. </doc>
  15877. </method>
  15878. <method name="setModifiedTime"
  15879. abstract="false" native="false" synchronized="false"
  15880. static="false" final="false" visibility="public"
  15881. deprecated="not deprecated">
  15882. <param name="modifiedTime" type="java.lang.Long"/>
  15883. <doc>
  15884. <![CDATA[Set the modified time of the domain.
  15885. @param modifiedTime the modified time of the domain]]>
  15886. </doc>
  15887. </method>
  15888. <doc>
  15889. <![CDATA[<p>
  15890. This class contains the information about a timeline service domain, which is
  15891. used to a user to host a number of timeline entities, isolating them from
  15892. others'. The user can also define the reader and writer users/groups for
  15893. the domain, which is used to control the access to its entities.
  15894. </p>
  15895. <p>
  15896. The reader and writer users/groups pattern that the user can supply is the
  15897. same as what <code>AccessControlList</code> takes.
  15898. </p>]]>
  15899. </doc>
  15900. </class>
  15901. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain -->
  15902. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities -->
  15903. <class name="TimelineEntities" extends="java.lang.Object"
  15904. abstract="false"
  15905. static="false" final="false" visibility="public"
  15906. deprecated="not deprecated">
  15907. <constructor name="TimelineEntities"
  15908. static="false" final="false" visibility="public"
  15909. deprecated="not deprecated">
  15910. </constructor>
  15911. <method name="getEntities" return="java.util.List"
  15912. abstract="false" native="false" synchronized="false"
  15913. static="false" final="false" visibility="public"
  15914. deprecated="not deprecated">
  15915. </method>
  15916. <method name="setEntities"
  15917. abstract="false" native="false" synchronized="false"
  15918. static="false" final="false" visibility="public"
  15919. deprecated="not deprecated">
  15920. <param name="timelineEntities" type="java.util.List"/>
  15921. </method>
  15922. <method name="addEntities"
  15923. abstract="false" native="false" synchronized="false"
  15924. static="false" final="false" visibility="public"
  15925. deprecated="not deprecated">
  15926. <param name="timelineEntities" type="java.util.List"/>
  15927. </method>
  15928. <method name="addEntity"
  15929. abstract="false" native="false" synchronized="false"
  15930. static="false" final="false" visibility="public"
  15931. deprecated="not deprecated">
  15932. <param name="entity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  15933. </method>
  15934. <doc>
  15935. <![CDATA[This class hosts a set of timeline entities.]]>
  15936. </doc>
  15937. </class>
  15938. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities -->
  15939. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity -->
  15940. <class name="TimelineEntity" extends="java.lang.Object"
  15941. abstract="false"
  15942. static="false" final="false" visibility="public"
  15943. deprecated="not deprecated">
  15944. <implements name="java.lang.Comparable"/>
  15945. <constructor name="TimelineEntity"
  15946. static="false" final="false" visibility="public"
  15947. deprecated="not deprecated">
  15948. </constructor>
  15949. <constructor name="TimelineEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  15950. static="false" final="false" visibility="public"
  15951. deprecated="not deprecated">
  15952. <doc>
  15953. <![CDATA[<p>
  15954. The constuctor is used to construct a proxy {@link TimelineEntity} or its
  15955. subclass object from the real entity object that carries information.
  15956. </p>
  15957. <p>
  15958. It is usually used in the case where we want to recover class polymorphism
  15959. after deserializing the entity from its JSON form.
  15960. </p>
  15961. @param entity the real entity that carries information]]>
  15962. </doc>
  15963. </constructor>
  15964. <constructor name="TimelineEntity" type="java.lang.String"
  15965. static="false" final="false" visibility="protected"
  15966. deprecated="not deprecated">
  15967. </constructor>
  15968. <method name="getType" return="java.lang.String"
  15969. abstract="false" native="false" synchronized="false"
  15970. static="false" final="false" visibility="public"
  15971. deprecated="not deprecated">
  15972. </method>
  15973. <method name="setType"
  15974. abstract="false" native="false" synchronized="false"
  15975. static="false" final="false" visibility="public"
  15976. deprecated="not deprecated">
  15977. <param name="type" type="java.lang.String"/>
  15978. </method>
  15979. <method name="getId" return="java.lang.String"
  15980. abstract="false" native="false" synchronized="false"
  15981. static="false" final="false" visibility="public"
  15982. deprecated="not deprecated">
  15983. </method>
  15984. <method name="setId"
  15985. abstract="false" native="false" synchronized="false"
  15986. static="false" final="false" visibility="public"
  15987. deprecated="not deprecated">
  15988. <param name="id" type="java.lang.String"/>
  15989. </method>
  15990. <method name="getIdentifier" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"
  15991. abstract="false" native="false" synchronized="false"
  15992. static="false" final="false" visibility="public"
  15993. deprecated="not deprecated">
  15994. </method>
  15995. <method name="setIdentifier"
  15996. abstract="false" native="false" synchronized="false"
  15997. static="false" final="false" visibility="public"
  15998. deprecated="not deprecated">
  15999. <param name="entityIdentifier" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"/>
  16000. </method>
  16001. <method name="getInfo" return="java.util.Map"
  16002. abstract="false" native="false" synchronized="false"
  16003. static="false" final="false" visibility="public"
  16004. deprecated="not deprecated">
  16005. </method>
  16006. <method name="setInfo"
  16007. abstract="false" native="false" synchronized="false"
  16008. static="false" final="false" visibility="public"
  16009. deprecated="not deprecated">
  16010. <param name="entityInfos" type="java.util.Map"/>
  16011. </method>
  16012. <method name="addInfo"
  16013. abstract="false" native="false" synchronized="false"
  16014. static="false" final="false" visibility="public"
  16015. deprecated="not deprecated">
  16016. <param name="entityInfos" type="java.util.Map"/>
  16017. </method>
  16018. <method name="addInfo"
  16019. abstract="false" native="false" synchronized="false"
  16020. static="false" final="false" visibility="public"
  16021. deprecated="not deprecated">
  16022. <param name="key" type="java.lang.String"/>
  16023. <param name="value" type="java.lang.Object"/>
  16024. </method>
  16025. <method name="getConfigs" return="java.util.Map"
  16026. abstract="false" native="false" synchronized="false"
  16027. static="false" final="false" visibility="public"
  16028. deprecated="not deprecated">
  16029. </method>
  16030. <method name="setConfigs"
  16031. abstract="false" native="false" synchronized="false"
  16032. static="false" final="false" visibility="public"
  16033. deprecated="not deprecated">
  16034. <param name="entityConfigs" type="java.util.Map"/>
  16035. </method>
  16036. <method name="addConfigs"
  16037. abstract="false" native="false" synchronized="false"
  16038. static="false" final="false" visibility="public"
  16039. deprecated="not deprecated">
  16040. <param name="entityConfigs" type="java.util.Map"/>
  16041. </method>
  16042. <method name="addConfig"
  16043. abstract="false" native="false" synchronized="false"
  16044. static="false" final="false" visibility="public"
  16045. deprecated="not deprecated">
  16046. <param name="key" type="java.lang.String"/>
  16047. <param name="value" type="java.lang.String"/>
  16048. </method>
  16049. <method name="getMetrics" return="java.util.Set"
  16050. abstract="false" native="false" synchronized="false"
  16051. static="false" final="false" visibility="public"
  16052. deprecated="not deprecated">
  16053. </method>
  16054. <method name="setMetrics"
  16055. abstract="false" native="false" synchronized="false"
  16056. static="false" final="false" visibility="public"
  16057. deprecated="not deprecated">
  16058. <param name="entityMetrics" type="java.util.Set"/>
  16059. </method>
  16060. <method name="addMetrics"
  16061. abstract="false" native="false" synchronized="false"
  16062. static="false" final="false" visibility="public"
  16063. deprecated="not deprecated">
  16064. <param name="entityMetrics" type="java.util.Set"/>
  16065. </method>
  16066. <method name="addMetric"
  16067. abstract="false" native="false" synchronized="false"
  16068. static="false" final="false" visibility="public"
  16069. deprecated="not deprecated">
  16070. <param name="metric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  16071. </method>
  16072. <method name="getEvents" return="java.util.NavigableSet"
  16073. abstract="false" native="false" synchronized="false"
  16074. static="false" final="false" visibility="public"
  16075. deprecated="not deprecated">
  16076. </method>
  16077. <method name="setEvents"
  16078. abstract="false" native="false" synchronized="false"
  16079. static="false" final="false" visibility="public"
  16080. deprecated="not deprecated">
  16081. <param name="entityEvents" type="java.util.NavigableSet"/>
  16082. </method>
  16083. <method name="addEvents"
  16084. abstract="false" native="false" synchronized="false"
  16085. static="false" final="false" visibility="public"
  16086. deprecated="not deprecated">
  16087. <param name="entityEvents" type="java.util.Set"/>
  16088. </method>
  16089. <method name="addEvent"
  16090. abstract="false" native="false" synchronized="false"
  16091. static="false" final="false" visibility="public"
  16092. deprecated="not deprecated">
  16093. <param name="event" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent"/>
  16094. </method>
  16095. <method name="getIsRelatedToEntities" 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="setIsRelatedToEntities"
  16101. abstract="false" native="false" synchronized="false"
  16102. static="false" final="false" visibility="public"
  16103. deprecated="not deprecated">
  16104. <param name="isRelatedTo" type="java.util.Map"/>
  16105. </method>
  16106. <method name="addIsRelatedToEntities"
  16107. abstract="false" native="false" synchronized="false"
  16108. static="false" final="false" visibility="public"
  16109. deprecated="not deprecated">
  16110. <param name="isRelatedTo" type="java.util.Map"/>
  16111. </method>
  16112. <method name="addIsRelatedToEntity"
  16113. abstract="false" native="false" synchronized="false"
  16114. static="false" final="false" visibility="public"
  16115. deprecated="not deprecated">
  16116. <param name="type" type="java.lang.String"/>
  16117. <param name="id" type="java.lang.String"/>
  16118. </method>
  16119. <method name="getRelatesToEntities" return="java.util.Map"
  16120. abstract="false" native="false" synchronized="false"
  16121. static="false" final="false" visibility="public"
  16122. deprecated="not deprecated">
  16123. </method>
  16124. <method name="addRelatesToEntities"
  16125. abstract="false" native="false" synchronized="false"
  16126. static="false" final="false" visibility="public"
  16127. deprecated="not deprecated">
  16128. <param name="relatesTo" type="java.util.Map"/>
  16129. </method>
  16130. <method name="addRelatesToEntity"
  16131. abstract="false" native="false" synchronized="false"
  16132. static="false" final="false" visibility="public"
  16133. deprecated="not deprecated">
  16134. <param name="type" type="java.lang.String"/>
  16135. <param name="id" type="java.lang.String"/>
  16136. </method>
  16137. <method name="setRelatesToEntities"
  16138. abstract="false" native="false" synchronized="false"
  16139. static="false" final="false" visibility="public"
  16140. deprecated="not deprecated">
  16141. <param name="relatesTo" type="java.util.Map"/>
  16142. </method>
  16143. <method name="getCreatedTime" return="java.lang.Long"
  16144. abstract="false" native="false" synchronized="false"
  16145. static="false" final="false" visibility="public"
  16146. deprecated="not deprecated">
  16147. </method>
  16148. <method name="setCreatedTime"
  16149. abstract="false" native="false" synchronized="false"
  16150. static="false" final="false" visibility="public"
  16151. deprecated="not deprecated">
  16152. <param name="createdTs" type="java.lang.Long"/>
  16153. </method>
  16154. <method name="setUID"
  16155. abstract="false" native="false" synchronized="false"
  16156. static="false" final="false" visibility="public"
  16157. deprecated="not deprecated">
  16158. <param name="uidKey" type="java.lang.String"/>
  16159. <param name="uId" type="java.lang.String"/>
  16160. <doc>
  16161. <![CDATA[Set UID in info which will be then used for query by UI.
  16162. @param uidKey key for UID in info.
  16163. @param uId UID to be set for the key.]]>
  16164. </doc>
  16165. </method>
  16166. <method name="isValid" return="boolean"
  16167. abstract="false" native="false" synchronized="false"
  16168. static="false" final="false" visibility="public"
  16169. deprecated="not deprecated">
  16170. </method>
  16171. <method name="hashCode" return="int"
  16172. abstract="false" native="false" synchronized="false"
  16173. static="false" final="false" visibility="public"
  16174. deprecated="not deprecated">
  16175. </method>
  16176. <method name="equals" return="boolean"
  16177. abstract="false" native="false" synchronized="false"
  16178. static="false" final="false" visibility="public"
  16179. deprecated="not deprecated">
  16180. <param name="obj" type="java.lang.Object"/>
  16181. </method>
  16182. <method name="compareTo" return="int"
  16183. abstract="false" native="false" synchronized="false"
  16184. static="false" final="false" visibility="public"
  16185. deprecated="not deprecated">
  16186. <param name="other" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  16187. </method>
  16188. <method name="getReal" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  16189. abstract="false" native="false" synchronized="false"
  16190. static="false" final="false" visibility="protected"
  16191. deprecated="not deprecated">
  16192. </method>
  16193. <method name="toString" return="java.lang.String"
  16194. abstract="false" native="false" synchronized="false"
  16195. static="false" final="false" visibility="public"
  16196. deprecated="not deprecated">
  16197. </method>
  16198. <method name="getIdPrefix" return="long"
  16199. abstract="false" native="false" synchronized="false"
  16200. static="false" final="false" visibility="public"
  16201. deprecated="not deprecated">
  16202. </method>
  16203. <method name="setIdPrefix"
  16204. abstract="false" native="false" synchronized="false"
  16205. static="false" final="false" visibility="public"
  16206. deprecated="not deprecated">
  16207. <param name="entityIdPrefix" type="long"/>
  16208. <doc>
  16209. <![CDATA[Sets idPrefix for an entity.
  16210. <p>
  16211. <b>Note</b>: Entities will be stored in the order of idPrefix specified.
  16212. If users decide to set idPrefix for an entity, they <b>MUST</b> provide
  16213. the same prefix for every update of this entity.
  16214. </p>
  16215. Example: <blockquote><pre>
  16216. TimelineEntity entity = new TimelineEntity();
  16217. entity.setIdPrefix(value);
  16218. </pre></blockquote>
  16219. Users can use {@link TimelineServiceHelper#invertLong(long)} to invert
  16220. the prefix if necessary.
  16221. @param entityIdPrefix prefix for an entity.]]>
  16222. </doc>
  16223. </method>
  16224. <field name="SYSTEM_INFO_KEY_PREFIX" type="java.lang.String"
  16225. transient="false" volatile="false"
  16226. static="true" final="true" visibility="protected"
  16227. deprecated="not deprecated">
  16228. </field>
  16229. <field name="DEFAULT_ENTITY_PREFIX" type="long"
  16230. transient="false" volatile="false"
  16231. static="true" final="true" visibility="public"
  16232. deprecated="not deprecated">
  16233. </field>
  16234. <doc>
  16235. <![CDATA[The basic timeline entity data structure for timeline service v2. Timeline
  16236. entity objects are not thread safe and should not be accessed concurrently.
  16237. All collection members will be initialized into empty collections. Two
  16238. timeline entities are equal iff. their type and id are identical.
  16239. All non-primitive type, non-collection members will be initialized into null.
  16240. User should set the type and id of a timeline entity to make it valid (can be
  16241. checked by using the {@link #isValid()} method). Callers to the getters
  16242. should perform null checks for non-primitive type, non-collection members.
  16243. Callers are recommended not to alter the returned collection objects from the
  16244. getters.]]>
  16245. </doc>
  16246. </class>
  16247. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity -->
  16248. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType -->
  16249. <class name="TimelineEntityType" extends="java.lang.Enum"
  16250. abstract="false"
  16251. static="false" final="true" visibility="public"
  16252. deprecated="not deprecated">
  16253. <method name="values" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType[]"
  16254. abstract="false" native="false" synchronized="false"
  16255. static="true" final="false" visibility="public"
  16256. deprecated="not deprecated">
  16257. </method>
  16258. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType"
  16259. abstract="false" native="false" synchronized="false"
  16260. static="true" final="false" visibility="public"
  16261. deprecated="not deprecated">
  16262. <param name="name" type="java.lang.String"/>
  16263. </method>
  16264. <method name="isParent" return="boolean"
  16265. abstract="false" native="false" synchronized="false"
  16266. static="false" final="false" visibility="public"
  16267. deprecated="not deprecated">
  16268. <param name="type" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType"/>
  16269. <doc>
  16270. <![CDATA[Whether the input type can be a parent of this entity.
  16271. @param type entity type.
  16272. @return true, if this entity type is parent of passed entity type, false
  16273. otherwise.]]>
  16274. </doc>
  16275. </method>
  16276. <method name="isChild" return="boolean"
  16277. abstract="false" native="false" synchronized="false"
  16278. static="false" final="false" visibility="public"
  16279. deprecated="not deprecated">
  16280. <param name="type" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType"/>
  16281. <doc>
  16282. <![CDATA[Whether the input type can be a child of this entity.
  16283. @param type entity type.
  16284. @return true, if this entity type is child of passed entity type, false
  16285. otherwise.]]>
  16286. </doc>
  16287. </method>
  16288. <method name="matches" return="boolean"
  16289. abstract="false" native="false" synchronized="false"
  16290. static="false" final="false" visibility="public"
  16291. deprecated="not deprecated">
  16292. <param name="typeString" type="java.lang.String"/>
  16293. <doc>
  16294. <![CDATA[Whether the type of this entity matches the type indicated by the input
  16295. argument.
  16296. @param typeString entity type represented as a string.
  16297. @return true, if string representation of this entity type matches the
  16298. entity type passed.]]>
  16299. </doc>
  16300. </method>
  16301. <doc>
  16302. <![CDATA[Defines type of entity.]]>
  16303. </doc>
  16304. </class>
  16305. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType -->
  16306. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent -->
  16307. <class name="TimelineEvent" extends="java.lang.Object"
  16308. abstract="false"
  16309. static="false" final="false" visibility="public"
  16310. deprecated="not deprecated">
  16311. <implements name="java.lang.Comparable"/>
  16312. <constructor name="TimelineEvent"
  16313. static="false" final="false" visibility="public"
  16314. deprecated="not deprecated">
  16315. </constructor>
  16316. <method name="getId" return="java.lang.String"
  16317. abstract="false" native="false" synchronized="false"
  16318. static="false" final="false" visibility="public"
  16319. deprecated="not deprecated">
  16320. </method>
  16321. <method name="setId"
  16322. abstract="false" native="false" synchronized="false"
  16323. static="false" final="false" visibility="public"
  16324. deprecated="not deprecated">
  16325. <param name="eventId" type="java.lang.String"/>
  16326. </method>
  16327. <method name="getInfo" return="java.util.Map"
  16328. abstract="false" native="false" synchronized="false"
  16329. static="false" final="false" visibility="public"
  16330. deprecated="not deprecated">
  16331. </method>
  16332. <method name="setInfo"
  16333. abstract="false" native="false" synchronized="false"
  16334. static="false" final="false" visibility="public"
  16335. deprecated="not deprecated">
  16336. <param name="infos" type="java.util.Map"/>
  16337. </method>
  16338. <method name="addInfo"
  16339. abstract="false" native="false" synchronized="false"
  16340. static="false" final="false" visibility="public"
  16341. deprecated="not deprecated">
  16342. <param name="infos" type="java.util.Map"/>
  16343. </method>
  16344. <method name="addInfo"
  16345. abstract="false" native="false" synchronized="false"
  16346. static="false" final="false" visibility="public"
  16347. deprecated="not deprecated">
  16348. <param name="key" type="java.lang.String"/>
  16349. <param name="value" type="java.lang.Object"/>
  16350. </method>
  16351. <method name="getTimestamp" return="long"
  16352. abstract="false" native="false" synchronized="false"
  16353. static="false" final="false" visibility="public"
  16354. deprecated="not deprecated">
  16355. </method>
  16356. <method name="setTimestamp"
  16357. abstract="false" native="false" synchronized="false"
  16358. static="false" final="false" visibility="public"
  16359. deprecated="not deprecated">
  16360. <param name="ts" type="long"/>
  16361. </method>
  16362. <method name="isValid" return="boolean"
  16363. abstract="false" native="false" synchronized="false"
  16364. static="false" final="false" visibility="public"
  16365. deprecated="not deprecated">
  16366. </method>
  16367. <method name="hashCode" return="int"
  16368. abstract="false" native="false" synchronized="false"
  16369. static="false" final="false" visibility="public"
  16370. deprecated="not deprecated">
  16371. </method>
  16372. <method name="equals" return="boolean"
  16373. abstract="false" native="false" synchronized="false"
  16374. static="false" final="false" visibility="public"
  16375. deprecated="not deprecated">
  16376. <param name="o" type="java.lang.Object"/>
  16377. </method>
  16378. <method name="compareTo" return="int"
  16379. abstract="false" native="false" synchronized="false"
  16380. static="false" final="false" visibility="public"
  16381. deprecated="not deprecated">
  16382. <param name="other" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent"/>
  16383. </method>
  16384. <field name="INVALID_TIMESTAMP" type="long"
  16385. transient="false" volatile="false"
  16386. static="true" final="true" visibility="public"
  16387. deprecated="not deprecated">
  16388. </field>
  16389. <doc>
  16390. <![CDATA[This class contains the information of an event that belongs to an entity.
  16391. Users are free to define what the event means, such as starting an
  16392. application, container being allocated, etc.]]>
  16393. </doc>
  16394. </class>
  16395. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent -->
  16396. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric -->
  16397. <class name="TimelineMetric" extends="java.lang.Object"
  16398. abstract="false"
  16399. static="false" final="false" visibility="public"
  16400. deprecated="not deprecated">
  16401. <constructor name="TimelineMetric"
  16402. static="false" final="false" visibility="public"
  16403. deprecated="not deprecated">
  16404. </constructor>
  16405. <constructor name="TimelineMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric.Type"
  16406. static="false" final="false" visibility="public"
  16407. deprecated="not deprecated">
  16408. </constructor>
  16409. <method name="getType" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric.Type"
  16410. abstract="false" native="false" synchronized="false"
  16411. static="false" final="false" visibility="public"
  16412. deprecated="not deprecated">
  16413. </method>
  16414. <method name="setType"
  16415. abstract="false" native="false" synchronized="false"
  16416. static="false" final="false" visibility="public"
  16417. deprecated="not deprecated">
  16418. <param name="metricType" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric.Type"/>
  16419. </method>
  16420. <method name="getId" return="java.lang.String"
  16421. abstract="false" native="false" synchronized="false"
  16422. static="false" final="false" visibility="public"
  16423. deprecated="not deprecated">
  16424. </method>
  16425. <method name="setId"
  16426. abstract="false" native="false" synchronized="false"
  16427. static="false" final="false" visibility="public"
  16428. deprecated="not deprecated">
  16429. <param name="metricId" type="java.lang.String"/>
  16430. </method>
  16431. <method name="getRealtimeAggregationOp" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetricOperation"
  16432. abstract="false" native="false" synchronized="false"
  16433. static="false" final="false" visibility="public"
  16434. deprecated="not deprecated">
  16435. <doc>
  16436. <![CDATA[Get the real time aggregation operation of this metric.
  16437. @return Real time aggregation operation]]>
  16438. </doc>
  16439. </method>
  16440. <method name="setRealtimeAggregationOp"
  16441. abstract="false" native="false" synchronized="false"
  16442. static="false" final="false" visibility="public"
  16443. deprecated="not deprecated">
  16444. <param name="op" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetricOperation"/>
  16445. <doc>
  16446. <![CDATA[Set the real time aggregation operation of this metric.
  16447. @param op A timeline metric operation that the metric should perform on
  16448. real time aggregations]]>
  16449. </doc>
  16450. </method>
  16451. <method name="getValues" return="java.util.Map"
  16452. abstract="false" native="false" synchronized="false"
  16453. static="false" final="false" visibility="public"
  16454. deprecated="not deprecated">
  16455. </method>
  16456. <method name="setValues"
  16457. abstract="false" native="false" synchronized="false"
  16458. static="false" final="false" visibility="public"
  16459. deprecated="not deprecated">
  16460. <param name="vals" type="java.util.Map"/>
  16461. </method>
  16462. <method name="addValues"
  16463. abstract="false" native="false" synchronized="false"
  16464. static="false" final="false" visibility="public"
  16465. deprecated="not deprecated">
  16466. <param name="vals" type="java.util.Map"/>
  16467. </method>
  16468. <method name="addValue"
  16469. abstract="false" native="false" synchronized="false"
  16470. static="false" final="false" visibility="public"
  16471. deprecated="not deprecated">
  16472. <param name="timestamp" type="long"/>
  16473. <param name="value" type="java.lang.Number"/>
  16474. </method>
  16475. <method name="isValid" return="boolean"
  16476. abstract="false" native="false" synchronized="false"
  16477. static="false" final="false" visibility="public"
  16478. deprecated="not deprecated">
  16479. </method>
  16480. <method name="hashCode" return="int"
  16481. abstract="false" native="false" synchronized="false"
  16482. static="false" final="false" visibility="public"
  16483. deprecated="not deprecated">
  16484. </method>
  16485. <method name="equals" return="boolean"
  16486. abstract="false" native="false" synchronized="false"
  16487. static="false" final="false" visibility="public"
  16488. deprecated="not deprecated">
  16489. <param name="o" type="java.lang.Object"/>
  16490. </method>
  16491. <method name="toString" return="java.lang.String"
  16492. abstract="false" native="false" synchronized="false"
  16493. static="false" final="false" visibility="public"
  16494. deprecated="not deprecated">
  16495. </method>
  16496. <method name="getLatestSingleValueMetric" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"
  16497. abstract="false" native="false" synchronized="false"
  16498. static="true" final="false" visibility="public"
  16499. deprecated="not deprecated">
  16500. <param name="metric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  16501. <doc>
  16502. <![CDATA[Get the latest timeline metric as single value type.
  16503. @param metric Incoming timeline metric
  16504. @return The latest metric in the incoming metric]]>
  16505. </doc>
  16506. </method>
  16507. <method name="getSingleDataTimestamp" return="long"
  16508. abstract="false" native="false" synchronized="false"
  16509. static="false" final="false" visibility="public"
  16510. deprecated="not deprecated">
  16511. <doc>
  16512. <![CDATA[Get single data timestamp of the metric.
  16513. @return the single data timestamp]]>
  16514. </doc>
  16515. </method>
  16516. <method name="getSingleDataValue" return="java.lang.Number"
  16517. abstract="false" native="false" synchronized="false"
  16518. static="false" final="false" visibility="public"
  16519. deprecated="not deprecated">
  16520. <doc>
  16521. <![CDATA[Get single data value of the metric.
  16522. @return the single data value]]>
  16523. </doc>
  16524. </method>
  16525. <method name="aggregateTo" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"
  16526. abstract="false" native="false" synchronized="false"
  16527. static="true" final="false" visibility="public"
  16528. deprecated="not deprecated">
  16529. <param name="incomingMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  16530. <param name="baseAggregatedMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  16531. <doc>
  16532. <![CDATA[Aggregate an incoming metric to the base aggregated metric with the given
  16533. operation state in a stateless fashion. The assumption here is
  16534. baseAggregatedMetric and latestMetric should be single value data if not
  16535. null.
  16536. @param incomingMetric Incoming timeline metric to aggregate
  16537. @param baseAggregatedMetric Base timeline metric
  16538. @return Result metric after aggregation]]>
  16539. </doc>
  16540. </method>
  16541. <method name="aggregateTo" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"
  16542. abstract="false" native="false" synchronized="false"
  16543. static="true" final="false" visibility="public"
  16544. deprecated="not deprecated">
  16545. <param name="incomingMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  16546. <param name="baseAggregatedMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  16547. <param name="state" type="java.util.Map"/>
  16548. <doc>
  16549. <![CDATA[Aggregate an incoming metric to the base aggregated metric with the given
  16550. operation state. The assumption here is baseAggregatedMetric and
  16551. latestMetric should be single value data if not null.
  16552. @param incomingMetric Incoming timeline metric to aggregate
  16553. @param baseAggregatedMetric Base timeline metric
  16554. @param state Operation state
  16555. @return Result metric after aggregation]]>
  16556. </doc>
  16557. </method>
  16558. <doc>
  16559. <![CDATA[This class contains the information of a metric that is related to some
  16560. entity. Metric can either be a time series or single value.]]>
  16561. </doc>
  16562. </class>
  16563. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric -->
  16564. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse -->
  16565. <class name="TimelineWriteResponse" extends="java.lang.Object"
  16566. abstract="false"
  16567. static="false" final="false" visibility="public"
  16568. deprecated="not deprecated">
  16569. <constructor name="TimelineWriteResponse"
  16570. static="false" final="false" visibility="public"
  16571. deprecated="not deprecated">
  16572. </constructor>
  16573. <method name="getErrors" return="java.util.List"
  16574. abstract="false" native="false" synchronized="false"
  16575. static="false" final="false" visibility="public"
  16576. deprecated="not deprecated">
  16577. <doc>
  16578. <![CDATA[Get a list of {@link TimelineWriteError} instances.
  16579. @return a list of {@link TimelineWriteError} instances]]>
  16580. </doc>
  16581. </method>
  16582. <method name="addError"
  16583. abstract="false" native="false" synchronized="false"
  16584. static="false" final="false" visibility="public"
  16585. deprecated="not deprecated">
  16586. <param name="error" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse.TimelineWriteError"/>
  16587. <doc>
  16588. <![CDATA[Add a single {@link TimelineWriteError} instance into the existing list.
  16589. @param error
  16590. a single {@link TimelineWriteError} instance]]>
  16591. </doc>
  16592. </method>
  16593. <method name="addErrors"
  16594. abstract="false" native="false" synchronized="false"
  16595. static="false" final="false" visibility="public"
  16596. deprecated="not deprecated">
  16597. <param name="writeErrors" type="java.util.List"/>
  16598. <doc>
  16599. <![CDATA[Add a list of {@link TimelineWriteError} instances into the existing list.
  16600. @param writeErrors
  16601. a list of {@link TimelineWriteError} instances]]>
  16602. </doc>
  16603. </method>
  16604. <method name="setErrors"
  16605. abstract="false" native="false" synchronized="false"
  16606. static="false" final="false" visibility="public"
  16607. deprecated="not deprecated">
  16608. <param name="writeErrors" type="java.util.List"/>
  16609. <doc>
  16610. <![CDATA[Set the list to the given list of {@link TimelineWriteError} instances.
  16611. @param writeErrors
  16612. a list of {@link TimelineWriteError} instances]]>
  16613. </doc>
  16614. </method>
  16615. <doc>
  16616. <![CDATA[A class that holds a list of put errors. This is the response returned when a
  16617. list of {@link TimelineEntity} objects is added to the timeline. If there are
  16618. errors in storing individual entity objects, they will be indicated in the
  16619. list of errors.]]>
  16620. </doc>
  16621. </class>
  16622. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse -->
  16623. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse.TimelineWriteError -->
  16624. <class name="TimelineWriteResponse.TimelineWriteError" extends="java.lang.Object"
  16625. abstract="false"
  16626. static="true" final="false" visibility="public"
  16627. deprecated="not deprecated">
  16628. <constructor name="TimelineWriteError"
  16629. static="false" final="false" visibility="public"
  16630. deprecated="not deprecated">
  16631. </constructor>
  16632. <method name="getEntityId" return="java.lang.String"
  16633. abstract="false" native="false" synchronized="false"
  16634. static="false" final="false" visibility="public"
  16635. deprecated="not deprecated">
  16636. <doc>
  16637. <![CDATA[Get the entity Id.
  16638. @return the entity Id]]>
  16639. </doc>
  16640. </method>
  16641. <method name="setEntityId"
  16642. abstract="false" native="false" synchronized="false"
  16643. static="false" final="false" visibility="public"
  16644. deprecated="not deprecated">
  16645. <param name="id" type="java.lang.String"/>
  16646. <doc>
  16647. <![CDATA[Set the entity Id.
  16648. @param id the entity Id.]]>
  16649. </doc>
  16650. </method>
  16651. <method name="getEntityType" return="java.lang.String"
  16652. abstract="false" native="false" synchronized="false"
  16653. static="false" final="false" visibility="public"
  16654. deprecated="not deprecated">
  16655. <doc>
  16656. <![CDATA[Get the entity type.
  16657. @return the entity type]]>
  16658. </doc>
  16659. </method>
  16660. <method name="setEntityType"
  16661. abstract="false" native="false" synchronized="false"
  16662. static="false" final="false" visibility="public"
  16663. deprecated="not deprecated">
  16664. <param name="type" type="java.lang.String"/>
  16665. <doc>
  16666. <![CDATA[Set the entity type.
  16667. @param type the entity type.]]>
  16668. </doc>
  16669. </method>
  16670. <method name="getErrorCode" return="int"
  16671. abstract="false" native="false" synchronized="false"
  16672. static="false" final="false" visibility="public"
  16673. deprecated="not deprecated">
  16674. <doc>
  16675. <![CDATA[Get the error code.
  16676. @return an error code]]>
  16677. </doc>
  16678. </method>
  16679. <method name="setErrorCode"
  16680. abstract="false" native="false" synchronized="false"
  16681. static="false" final="false" visibility="public"
  16682. deprecated="not deprecated">
  16683. <param name="code" type="int"/>
  16684. <doc>
  16685. <![CDATA[Set the error code to the given error code.
  16686. @param code an error code.]]>
  16687. </doc>
  16688. </method>
  16689. <field name="IO_EXCEPTION" type="int"
  16690. transient="false" volatile="false"
  16691. static="true" final="true" visibility="public"
  16692. deprecated="not deprecated">
  16693. <doc>
  16694. <![CDATA[Error code returned if an IOException is encountered when storing an
  16695. entity.]]>
  16696. </doc>
  16697. </field>
  16698. <doc>
  16699. <![CDATA[A class that holds the error code for one entity.]]>
  16700. </doc>
  16701. </class>
  16702. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse.TimelineWriteError -->
  16703. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.UserEntity -->
  16704. <class name="UserEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  16705. abstract="false"
  16706. static="false" final="false" visibility="public"
  16707. deprecated="not deprecated">
  16708. <constructor name="UserEntity"
  16709. static="false" final="false" visibility="public"
  16710. deprecated="not deprecated">
  16711. </constructor>
  16712. <constructor name="UserEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  16713. static="false" final="false" visibility="public"
  16714. deprecated="not deprecated">
  16715. </constructor>
  16716. <doc>
  16717. <![CDATA[This entity represents a user.]]>
  16718. </doc>
  16719. </class>
  16720. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.UserEntity -->
  16721. </package>
  16722. <package name="org.apache.hadoop.yarn.api.resource">
  16723. <!-- start class org.apache.hadoop.yarn.api.resource.PlacementConstraint -->
  16724. <class name="PlacementConstraint" extends="java.lang.Object"
  16725. abstract="false"
  16726. static="false" final="false" visibility="public"
  16727. deprecated="not deprecated">
  16728. <constructor name="PlacementConstraint" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16729. static="false" final="false" visibility="public"
  16730. deprecated="not deprecated">
  16731. </constructor>
  16732. <method name="toString" return="java.lang.String"
  16733. abstract="false" native="false" synchronized="false"
  16734. static="false" final="false" visibility="public"
  16735. deprecated="not deprecated">
  16736. </method>
  16737. <method name="getConstraintExpr" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16738. abstract="false" native="false" synchronized="false"
  16739. static="false" final="false" visibility="public"
  16740. deprecated="not deprecated">
  16741. <doc>
  16742. <![CDATA[Get the constraint expression of the placement constraint.
  16743. @return the constraint expression]]>
  16744. </doc>
  16745. </method>
  16746. <method name="equals" return="boolean"
  16747. abstract="false" native="false" synchronized="false"
  16748. static="false" final="false" visibility="public"
  16749. deprecated="not deprecated">
  16750. <param name="o" type="java.lang.Object"/>
  16751. </method>
  16752. <method name="hashCode" return="int"
  16753. abstract="false" native="false" synchronized="false"
  16754. static="false" final="false" visibility="public"
  16755. deprecated="not deprecated">
  16756. </method>
  16757. <doc>
  16758. <![CDATA[{@code PlacementConstraint} represents a placement constraint for a resource
  16759. allocation.]]>
  16760. </doc>
  16761. </class>
  16762. <!-- end class org.apache.hadoop.yarn.api.resource.PlacementConstraint -->
  16763. <!-- start class org.apache.hadoop.yarn.api.resource.PlacementConstraints -->
  16764. <class name="PlacementConstraints" extends="java.lang.Object"
  16765. abstract="false"
  16766. static="false" final="true" visibility="public"
  16767. deprecated="not deprecated">
  16768. <method name="targetIn" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16769. abstract="false" native="false" synchronized="false"
  16770. static="true" final="false" visibility="public"
  16771. deprecated="not deprecated">
  16772. <param name="scope" type="java.lang.String"/>
  16773. <param name="targetExpressions" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TargetExpression[]"/>
  16774. <doc>
  16775. <![CDATA[Creates a constraint that requires allocations to be placed on nodes that
  16776. satisfy all target expressions within the given scope (e.g., node or rack).
  16777. For example, {@code targetIn(RACK, allocationTag("hbase-m"))}, allows
  16778. allocations on nodes that belong to a rack that has at least one tag with
  16779. value "hbase-m".
  16780. @param scope the scope within which the target expressions should be
  16781. satisfied
  16782. @param targetExpressions the expressions that need to be satisfied within
  16783. the scope
  16784. @return the resulting placement constraint]]>
  16785. </doc>
  16786. </method>
  16787. <method name="targetNotIn" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16788. abstract="false" native="false" synchronized="false"
  16789. static="true" final="false" visibility="public"
  16790. deprecated="not deprecated">
  16791. <param name="scope" type="java.lang.String"/>
  16792. <param name="targetExpressions" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TargetExpression[]"/>
  16793. <doc>
  16794. <![CDATA[Creates a constraint that requires allocations to be placed on nodes that
  16795. belong to a scope (e.g., node or rack) that does not satisfy any of the
  16796. target expressions.
  16797. @param scope the scope within which the target expressions should not be
  16798. true
  16799. @param targetExpressions the expressions that need to not be true within
  16800. the scope
  16801. @return the resulting placement constraint]]>
  16802. </doc>
  16803. </method>
  16804. <method name="targetNodeAttribute" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16805. abstract="false" native="false" synchronized="false"
  16806. static="true" final="false" visibility="public"
  16807. deprecated="not deprecated">
  16808. <param name="scope" type="java.lang.String"/>
  16809. <param name="opCode" type="org.apache.hadoop.yarn.api.records.NodeAttributeOpCode"/>
  16810. <param name="targetExpressions" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TargetExpression[]"/>
  16811. <doc>
  16812. <![CDATA[Creates a constraint that requires allocations to be placed on nodes that
  16813. belong to a scope (e.g., node or rack) that satisfy any of the
  16814. target expressions based on node attribute op code.
  16815. @param scope the scope within which the target expressions should not be
  16816. true
  16817. @param opCode Node Attribute code which could be equals, not equals.
  16818. @param targetExpressions the expressions that need to not be true within
  16819. the scope
  16820. @return the resulting placement constraint]]>
  16821. </doc>
  16822. </method>
  16823. <method name="cardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16824. abstract="false" native="false" synchronized="false"
  16825. static="true" final="false" visibility="public"
  16826. deprecated="not deprecated">
  16827. <param name="scope" type="java.lang.String"/>
  16828. <param name="minCardinality" type="int"/>
  16829. <param name="maxCardinality" type="int"/>
  16830. <param name="allocationTags" type="java.lang.String[]"/>
  16831. <doc>
  16832. <![CDATA[Creates a constraint that restricts the number of allocations within a
  16833. given scope (e.g., node or rack).
  16834. For example, {@code cardinality(NODE, 3, 10, "zk")} is satisfied on nodes
  16835. where there are no less than 3 allocations with tag "zk" and no more than
  16836. 10.
  16837. @param scope the scope of the constraint
  16838. @param minCardinality determines the minimum number of allocations within
  16839. the scope
  16840. @param maxCardinality determines the maximum number of allocations within
  16841. the scope
  16842. @param allocationTags the constraint targets allocations with these tags
  16843. @return the resulting placement constraint]]>
  16844. </doc>
  16845. </method>
  16846. <method name="cardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16847. abstract="false" native="false" synchronized="false"
  16848. static="true" final="false" visibility="public"
  16849. deprecated="not deprecated">
  16850. <param name="scope" type="java.lang.String"/>
  16851. <param name="namespace" type="java.lang.String"/>
  16852. <param name="minCardinality" type="int"/>
  16853. <param name="maxCardinality" type="int"/>
  16854. <param name="allocationTags" type="java.lang.String[]"/>
  16855. <doc>
  16856. <![CDATA[Similar to {@link #cardinality(String, int, int, String...)}, but let you
  16857. attach a namespace to the given allocation tags.
  16858. @param scope the scope of the constraint
  16859. @param namespace the namespace of the allocation tags
  16860. @param minCardinality determines the minimum number of allocations within
  16861. the scope
  16862. @param maxCardinality determines the maximum number of allocations within
  16863. the scope
  16864. @param allocationTags allocation tags
  16865. @return the resulting placement constraint]]>
  16866. </doc>
  16867. </method>
  16868. <method name="minCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16869. abstract="false" native="false" synchronized="false"
  16870. static="true" final="false" visibility="public"
  16871. deprecated="not deprecated">
  16872. <param name="scope" type="java.lang.String"/>
  16873. <param name="minCardinality" type="int"/>
  16874. <param name="allocationTags" type="java.lang.String[]"/>
  16875. <doc>
  16876. <![CDATA[Similar to {@link #cardinality(String, int, int, String...)}, but
  16877. determines only the minimum cardinality (the maximum cardinality is
  16878. unbound).
  16879. @param scope the scope of the constraint
  16880. @param minCardinality determines the minimum number of allocations within
  16881. the scope
  16882. @param allocationTags the constraint targets allocations with these tags
  16883. @return the resulting placement constraint]]>
  16884. </doc>
  16885. </method>
  16886. <method name="minCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16887. abstract="false" native="false" synchronized="false"
  16888. static="true" final="false" visibility="public"
  16889. deprecated="not deprecated">
  16890. <param name="scope" type="java.lang.String"/>
  16891. <param name="namespace" type="java.lang.String"/>
  16892. <param name="minCardinality" type="int"/>
  16893. <param name="allocationTags" type="java.lang.String[]"/>
  16894. <doc>
  16895. <![CDATA[Similar to {@link #minCardinality(String, int, String...)}, but let you
  16896. attach a namespace to the allocation tags.
  16897. @param scope the scope of the constraint
  16898. @param namespace the namespace of these tags
  16899. @param minCardinality determines the minimum number of allocations within
  16900. the scope
  16901. @param allocationTags the constraint targets allocations with these tags
  16902. @return the resulting placement constraint]]>
  16903. </doc>
  16904. </method>
  16905. <method name="maxCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16906. abstract="false" native="false" synchronized="false"
  16907. static="true" final="false" visibility="public"
  16908. deprecated="not deprecated">
  16909. <param name="scope" type="java.lang.String"/>
  16910. <param name="maxCardinality" type="int"/>
  16911. <param name="allocationTags" type="java.lang.String[]"/>
  16912. <doc>
  16913. <![CDATA[Similar to {@link #cardinality(String, int, int, String...)}, but
  16914. determines only the maximum cardinality (the minimum cardinality is 0).
  16915. @param scope the scope of the constraint
  16916. @param maxCardinality determines the maximum number of allocations within
  16917. the scope
  16918. @param allocationTags the constraint targets allocations with these tags
  16919. @return the resulting placement constraint]]>
  16920. </doc>
  16921. </method>
  16922. <method name="maxCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16923. abstract="false" native="false" synchronized="false"
  16924. static="true" final="false" visibility="public"
  16925. deprecated="not deprecated">
  16926. <param name="scope" type="java.lang.String"/>
  16927. <param name="tagNamespace" type="java.lang.String"/>
  16928. <param name="maxCardinality" type="int"/>
  16929. <param name="allocationTags" type="java.lang.String[]"/>
  16930. <doc>
  16931. <![CDATA[Similar to {@link #maxCardinality(String, int, String...)}, but let you
  16932. specify a namespace for the tags, see supported namespaces in
  16933. {@link AllocationTagNamespaceType}.
  16934. @param scope the scope of the constraint
  16935. @param tagNamespace the namespace of these tags
  16936. @param maxCardinality determines the maximum number of allocations within
  16937. the scope
  16938. @param allocationTags allocation tags
  16939. @return the resulting placement constraint]]>
  16940. </doc>
  16941. </method>
  16942. <method name="targetCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  16943. abstract="false" native="false" synchronized="false"
  16944. static="true" final="false" visibility="public"
  16945. deprecated="not deprecated">
  16946. <param name="scope" type="java.lang.String"/>
  16947. <param name="minCardinality" type="int"/>
  16948. <param name="maxCardinality" type="int"/>
  16949. <param name="targetExpressions" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TargetExpression[]"/>
  16950. <doc>
  16951. <![CDATA[This constraint generalizes the cardinality and target constraints.
  16952. Consider a set of nodes N that belongs to the scope specified in the
  16953. constraint. If the target expressions are satisfied at least minCardinality
  16954. times and at most maxCardinality times in the node set N, then the
  16955. constraint is satisfied.
  16956. For example, {@code targetCardinality(RACK, 2, 10, allocationTag("zk"))},
  16957. requires an allocation to be placed within a rack that has at least 2 and
  16958. at most 10 other allocations with tag "zk".
  16959. @param scope the scope of the constraint
  16960. @param minCardinality the minimum number of times the target expressions
  16961. have to be satisfied with the given scope
  16962. @param maxCardinality the maximum number of times the target expressions
  16963. have to be satisfied with the given scope
  16964. @param targetExpressions the target expressions
  16965. @return the resulting placement constraint]]>
  16966. </doc>
  16967. </method>
  16968. <method name="and" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.And"
  16969. abstract="false" native="false" synchronized="false"
  16970. static="true" final="false" visibility="public"
  16971. deprecated="not deprecated">
  16972. <param name="children" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint[]"/>
  16973. <doc>
  16974. <![CDATA[A conjunction of constraints.
  16975. @param children the children constraints that should all be satisfied
  16976. @return the resulting placement constraint]]>
  16977. </doc>
  16978. </method>
  16979. <method name="or" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.Or"
  16980. abstract="false" native="false" synchronized="false"
  16981. static="true" final="false" visibility="public"
  16982. deprecated="not deprecated">
  16983. <param name="children" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint[]"/>
  16984. <doc>
  16985. <![CDATA[A disjunction of constraints.
  16986. @param children the children constraints, one of which should be satisfied
  16987. @return the resulting placement constraint]]>
  16988. </doc>
  16989. </method>
  16990. <method name="delayedOr" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.DelayedOr"
  16991. abstract="false" native="false" synchronized="false"
  16992. static="true" final="false" visibility="public"
  16993. deprecated="not deprecated">
  16994. <param name="children" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TimedPlacementConstraint[]"/>
  16995. <doc>
  16996. <![CDATA[Creates a composite constraint that includes a list of timed placement
  16997. constraints. The scheduler should try to satisfy first the first timed
  16998. child constraint within the specified time window. If this is not possible,
  16999. it should attempt to satisfy the second, and so on.
  17000. @param children the timed children constraints
  17001. @return the resulting composite constraint]]>
  17002. </doc>
  17003. </method>
  17004. <method name="timedClockConstraint" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TimedPlacementConstraint"
  17005. abstract="false" native="false" synchronized="false"
  17006. static="true" final="false" visibility="public"
  17007. deprecated="not deprecated">
  17008. <param name="constraint" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"/>
  17009. <param name="delay" type="long"/>
  17010. <param name="timeUnit" type="java.util.concurrent.TimeUnit"/>
  17011. <doc>
  17012. <![CDATA[Creates a placement constraint that has to be satisfied within a time
  17013. window.
  17014. @param constraint the placement constraint
  17015. @param delay the length of the time window within which the constraint has
  17016. to be satisfied
  17017. @param timeUnit the unit of time of the time window
  17018. @return the resulting timed placement constraint]]>
  17019. </doc>
  17020. </method>
  17021. <method name="timedOpportunitiesConstraint" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TimedPlacementConstraint"
  17022. abstract="false" native="false" synchronized="false"
  17023. static="true" final="false" visibility="public"
  17024. deprecated="not deprecated">
  17025. <param name="constraint" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"/>
  17026. <param name="delay" type="long"/>
  17027. <doc>
  17028. <![CDATA[Creates a placement constraint that has to be satisfied within a number of
  17029. placement opportunities (invocations of the scheduler).
  17030. @param constraint the placement constraint
  17031. @param delay the number of scheduling opportunities within which the
  17032. constraint has to be satisfied
  17033. @return the resulting timed placement constraint]]>
  17034. </doc>
  17035. </method>
  17036. <method name="build" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint"
  17037. abstract="false" native="false" synchronized="false"
  17038. static="true" final="false" visibility="public"
  17039. deprecated="not deprecated">
  17040. <param name="constraintExpr" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"/>
  17041. <doc>
  17042. <![CDATA[Creates a {@link PlacementConstraint} given a constraint expression.
  17043. @param constraintExpr the constraint expression
  17044. @return the placement constraint]]>
  17045. </doc>
  17046. </method>
  17047. <field name="NODE" type="java.lang.String"
  17048. transient="false" volatile="false"
  17049. static="true" final="true" visibility="public"
  17050. deprecated="not deprecated">
  17051. </field>
  17052. <field name="RACK" type="java.lang.String"
  17053. transient="false" volatile="false"
  17054. static="true" final="true" visibility="public"
  17055. deprecated="not deprecated">
  17056. </field>
  17057. <field name="NODE_PARTITION" type="java.lang.String"
  17058. transient="false" volatile="false"
  17059. static="true" final="true" visibility="public"
  17060. deprecated="not deprecated">
  17061. </field>
  17062. <doc>
  17063. <![CDATA[This class contains various static methods for the applications to create
  17064. placement constraints (see also {@link PlacementConstraint}).]]>
  17065. </doc>
  17066. </class>
  17067. <!-- end class org.apache.hadoop.yarn.api.resource.PlacementConstraints -->
  17068. </package>
  17069. <package name="org.apache.hadoop.yarn.conf">
  17070. <!-- start class org.apache.hadoop.yarn.conf.YarnConfiguration -->
  17071. <class name="YarnConfiguration" extends="org.apache.hadoop.conf.Configuration"
  17072. abstract="false"
  17073. static="false" final="false" visibility="public"
  17074. deprecated="not deprecated">
  17075. <constructor name="YarnConfiguration"
  17076. static="false" final="false" visibility="public"
  17077. deprecated="not deprecated">
  17078. </constructor>
  17079. <constructor name="YarnConfiguration" type="org.apache.hadoop.conf.Configuration"
  17080. static="false" final="false" visibility="public"
  17081. deprecated="not deprecated">
  17082. </constructor>
  17083. <method name="isAclEnabled" return="boolean"
  17084. abstract="false" native="false" synchronized="false"
  17085. static="true" final="false" visibility="public"
  17086. deprecated="not deprecated">
  17087. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  17088. </method>
  17089. <method name="getSocketAddr" return="java.net.InetSocketAddress"
  17090. abstract="false" native="false" synchronized="false"
  17091. static="false" final="false" visibility="public"
  17092. deprecated="not deprecated">
  17093. <param name="name" type="java.lang.String"/>
  17094. <param name="defaultAddress" type="java.lang.String"/>
  17095. <param name="defaultPort" type="int"/>
  17096. <doc>
  17097. <![CDATA[Get the socket address for <code>name</code> property as a
  17098. <code>InetSocketAddress</code>. On an HA cluster,
  17099. this fetches the address corresponding to the RM identified by
  17100. {@link #RM_HA_ID}.
  17101. @param name property name.
  17102. @param defaultAddress the default value
  17103. @param defaultPort the default port
  17104. @return InetSocketAddress]]>
  17105. </doc>
  17106. </method>
  17107. <method name="updateConnectAddr" return="java.net.InetSocketAddress"
  17108. abstract="false" native="false" synchronized="false"
  17109. static="false" final="false" visibility="public"
  17110. deprecated="not deprecated">
  17111. <param name="name" type="java.lang.String"/>
  17112. <param name="addr" type="java.net.InetSocketAddress"/>
  17113. </method>
  17114. <method name="useHttps" return="boolean"
  17115. abstract="false" native="false" synchronized="false"
  17116. static="true" final="false" visibility="public"
  17117. deprecated="not deprecated">
  17118. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  17119. </method>
  17120. <method name="shouldRMFailFast" return="boolean"
  17121. abstract="false" native="false" synchronized="false"
  17122. static="true" final="false" visibility="public"
  17123. deprecated="not deprecated">
  17124. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  17125. </method>
  17126. <method name="isDistSchedulingEnabled" return="boolean"
  17127. abstract="false" native="false" synchronized="false"
  17128. static="true" final="false" visibility="public"
  17129. deprecated="not deprecated">
  17130. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  17131. </method>
  17132. <method name="isOpportunisticContainerAllocationEnabled" return="boolean"
  17133. abstract="false" native="false" synchronized="false"
  17134. static="true" final="false" visibility="public"
  17135. deprecated="not deprecated">
  17136. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  17137. </method>
  17138. <method name="timelineServiceEnabled" return="boolean"
  17139. abstract="false" native="false" synchronized="false"
  17140. static="true" final="false" visibility="public"
  17141. deprecated="not deprecated">
  17142. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  17143. <doc>
  17144. <![CDATA[Returns whether the timeline service is enabled via configuration.
  17145. @param conf the configuration
  17146. @return whether the timeline service is enabled.]]>
  17147. </doc>
  17148. </method>
  17149. <method name="getTimelineServiceVersion" return="float"
  17150. abstract="false" native="false" synchronized="false"
  17151. static="true" final="false" visibility="public"
  17152. deprecated="not deprecated">
  17153. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  17154. <doc>
  17155. <![CDATA[Returns the timeline service version. It does not check whether the
  17156. timeline service itself is enabled.
  17157. @param conf the configuration
  17158. @return the timeline service version as a float.]]>
  17159. </doc>
  17160. </method>
  17161. <method name="timelineServiceV2Enabled" return="boolean"
  17162. abstract="false" native="false" synchronized="false"
  17163. static="true" final="false" visibility="public"
  17164. deprecated="not deprecated">
  17165. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  17166. <doc>
  17167. <![CDATA[Returns whether the timeline service v.2 is enabled via configuration.
  17168. @param conf the configuration
  17169. @return whether the timeline service v.2 is enabled. V.2 refers to a
  17170. version greater than equal to 2 but smaller than 3.]]>
  17171. </doc>
  17172. </method>
  17173. <method name="timelineServiceV1Enabled" return="boolean"
  17174. abstract="false" native="false" synchronized="false"
  17175. static="true" final="false" visibility="public"
  17176. deprecated="not deprecated">
  17177. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  17178. <doc>
  17179. <![CDATA[Returns whether the timeline service v.1 is enabled via configuration.
  17180. @param conf the configuration
  17181. @return whether the timeline service v.1 is enabled. V.1 refers to a
  17182. version greater than equal to 1 but smaller than 2.]]>
  17183. </doc>
  17184. </method>
  17185. <method name="timelineServiceV15Enabled" return="boolean"
  17186. abstract="false" native="false" synchronized="false"
  17187. static="true" final="false" visibility="public"
  17188. deprecated="not deprecated">
  17189. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  17190. <doc>
  17191. <![CDATA[Returns whether the timeline service v.1,5 is enabled via configuration.
  17192. @param conf the configuration
  17193. @return whether the timeline service v.1.5 is enabled. V.1.5 refers to a
  17194. version equal to 1.5.]]>
  17195. </doc>
  17196. </method>
  17197. <method name="systemMetricsPublisherEnabled" return="boolean"
  17198. abstract="false" native="false" synchronized="false"
  17199. static="true" final="false" visibility="public"
  17200. deprecated="not deprecated">
  17201. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  17202. <doc>
  17203. <![CDATA[Returns whether the system publisher is enabled.
  17204. @param conf the configuration
  17205. @return whether the system publisher is enabled.]]>
  17206. </doc>
  17207. </method>
  17208. <method name="numaAwarenessEnabled" return="boolean"
  17209. abstract="false" native="false" synchronized="false"
  17210. static="true" final="false" visibility="public"
  17211. deprecated="not deprecated">
  17212. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  17213. <doc>
  17214. <![CDATA[Returns whether the NUMA awareness is enabled.
  17215. @param conf the configuration
  17216. @return whether the NUMA awareness is enabled.]]>
  17217. </doc>
  17218. </method>
  17219. <method name="main"
  17220. abstract="false" native="false" synchronized="false"
  17221. static="true" final="false" visibility="public"
  17222. deprecated="not deprecated">
  17223. <param name="args" type="java.lang.String[]"/>
  17224. <exception name="Exception" type="java.lang.Exception"/>
  17225. </method>
  17226. <field name="DR_CONFIGURATION_FILE" 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="CS_CONFIGURATION_FILE" type="java.lang.String"
  17232. transient="false" volatile="false"
  17233. static="true" final="true" visibility="public"
  17234. deprecated="not deprecated">
  17235. </field>
  17236. <field name="HADOOP_POLICY_CONFIGURATION_FILE" type="java.lang.String"
  17237. transient="false" volatile="false"
  17238. static="true" final="true" visibility="public"
  17239. deprecated="not deprecated">
  17240. </field>
  17241. <field name="YARN_SITE_CONFIGURATION_FILE" type="java.lang.String"
  17242. transient="false" volatile="false"
  17243. static="true" final="true" visibility="public"
  17244. deprecated="not deprecated">
  17245. </field>
  17246. <field name="CORE_SITE_CONFIGURATION_FILE" type="java.lang.String"
  17247. transient="false" volatile="false"
  17248. static="true" final="true" visibility="public"
  17249. deprecated="not deprecated">
  17250. </field>
  17251. <field name="RESOURCE_TYPES_CONFIGURATION_FILE" type="java.lang.String"
  17252. transient="false" volatile="false"
  17253. static="true" final="true" visibility="public"
  17254. deprecated="not deprecated">
  17255. </field>
  17256. <field name="NODE_RESOURCES_CONFIGURATION_FILE" type="java.lang.String"
  17257. transient="false" volatile="false"
  17258. static="true" final="true" visibility="public"
  17259. deprecated="not deprecated">
  17260. </field>
  17261. <field name="RM_CONFIGURATION_FILES" type="java.util.List"
  17262. transient="false" volatile="false"
  17263. static="true" final="true" visibility="public"
  17264. deprecated="not deprecated">
  17265. </field>
  17266. <field name="NM_CONFIGURATION_FILES" type="java.util.List"
  17267. transient="false" volatile="false"
  17268. static="true" final="true" visibility="public"
  17269. deprecated="not deprecated">
  17270. </field>
  17271. <field name="APPLICATION_MAX_TAGS" type="int"
  17272. transient="false" volatile="false"
  17273. static="true" final="true" visibility="public"
  17274. deprecated="not deprecated">
  17275. </field>
  17276. <field name="APPLICATION_MAX_TAG_LENGTH" type="int"
  17277. transient="false" volatile="false"
  17278. static="true" final="true" visibility="public"
  17279. deprecated="not deprecated">
  17280. </field>
  17281. <field name="YARN_PREFIX" 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="RESOURCE_TYPES" type="java.lang.String"
  17287. transient="false" volatile="false"
  17288. static="true" final="true" visibility="public"
  17289. deprecated="not deprecated">
  17290. </field>
  17291. <field name="NM_RESOURCES_PREFIX" type="java.lang.String"
  17292. transient="false" volatile="false"
  17293. static="true" final="true" visibility="public"
  17294. deprecated="not deprecated">
  17295. </field>
  17296. <field name="DEBUG_NM_DELETE_DELAY_SEC" type="java.lang.String"
  17297. transient="false" volatile="false"
  17298. static="true" final="true" visibility="public"
  17299. deprecated="not deprecated">
  17300. <doc>
  17301. <![CDATA[Delay before deleting resource to ease debugging of NM issues]]>
  17302. </doc>
  17303. </field>
  17304. <field name="NM_LOG_CONTAINER_DEBUG_INFO" type="java.lang.String"
  17305. transient="false" volatile="false"
  17306. static="true" final="true" visibility="public"
  17307. deprecated="not deprecated">
  17308. </field>
  17309. <field name="DEFAULT_NM_LOG_CONTAINER_DEBUG_INFO" type="boolean"
  17310. transient="false" volatile="false"
  17311. static="true" final="true" visibility="public"
  17312. deprecated="not deprecated">
  17313. </field>
  17314. <field name="IPC_PREFIX" type="java.lang.String"
  17315. transient="false" volatile="false"
  17316. static="true" final="true" visibility="public"
  17317. deprecated="not deprecated">
  17318. </field>
  17319. <field name="IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
  17320. transient="false" volatile="false"
  17321. static="true" final="true" visibility="public"
  17322. deprecated="not deprecated">
  17323. <doc>
  17324. <![CDATA[Factory to create client IPC classes.]]>
  17325. </doc>
  17326. </field>
  17327. <field name="DEFAULT_IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
  17328. transient="false" volatile="false"
  17329. static="true" final="true" visibility="public"
  17330. deprecated="not deprecated">
  17331. </field>
  17332. <field name="IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
  17333. transient="false" volatile="false"
  17334. static="true" final="true" visibility="public"
  17335. deprecated="not deprecated">
  17336. <doc>
  17337. <![CDATA[Factory to create server IPC classes.]]>
  17338. </doc>
  17339. </field>
  17340. <field name="DEFAULT_IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
  17341. transient="false" volatile="false"
  17342. static="true" final="true" visibility="public"
  17343. deprecated="not deprecated">
  17344. </field>
  17345. <field name="IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
  17346. transient="false" volatile="false"
  17347. static="true" final="true" visibility="public"
  17348. deprecated="not deprecated">
  17349. <doc>
  17350. <![CDATA[Factory to create serializable records.]]>
  17351. </doc>
  17352. </field>
  17353. <field name="DEFAULT_IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
  17354. transient="false" volatile="false"
  17355. static="true" final="true" visibility="public"
  17356. deprecated="not deprecated">
  17357. </field>
  17358. <field name="IPC_RPC_IMPL" type="java.lang.String"
  17359. transient="false" volatile="false"
  17360. static="true" final="true" visibility="public"
  17361. deprecated="not deprecated">
  17362. <doc>
  17363. <![CDATA[RPC class implementation]]>
  17364. </doc>
  17365. </field>
  17366. <field name="DEFAULT_IPC_RPC_IMPL" type="java.lang.String"
  17367. transient="false" volatile="false"
  17368. static="true" final="true" visibility="public"
  17369. deprecated="not deprecated">
  17370. </field>
  17371. <field name="RM_PREFIX" type="java.lang.String"
  17372. transient="false" volatile="false"
  17373. static="true" final="true" visibility="public"
  17374. deprecated="not deprecated">
  17375. </field>
  17376. <field name="RM_CLUSTER_ID" type="java.lang.String"
  17377. transient="false" volatile="false"
  17378. static="true" final="true" visibility="public"
  17379. deprecated="not deprecated">
  17380. </field>
  17381. <field name="DEFAULT_RM_CLUSTER_ID" type="java.lang.String"
  17382. transient="false" volatile="false"
  17383. static="true" final="true" visibility="public"
  17384. deprecated="not deprecated">
  17385. </field>
  17386. <field name="RM_HOSTNAME" type="java.lang.String"
  17387. transient="false" volatile="false"
  17388. static="true" final="true" visibility="public"
  17389. deprecated="not deprecated">
  17390. </field>
  17391. <field name="RM_EPOCH" type="java.lang.String"
  17392. transient="false" volatile="false"
  17393. static="true" final="true" visibility="public"
  17394. deprecated="not deprecated">
  17395. </field>
  17396. <field name="DEFAULT_RM_EPOCH" type="long"
  17397. transient="false" volatile="false"
  17398. static="true" final="true" visibility="public"
  17399. deprecated="not deprecated">
  17400. </field>
  17401. <field name="RM_EPOCH_RANGE" type="java.lang.String"
  17402. transient="false" volatile="false"
  17403. static="true" final="true" visibility="public"
  17404. deprecated="not deprecated">
  17405. <doc>
  17406. <![CDATA[The epoch range before wrap around. 0 disables wrap around]]>
  17407. </doc>
  17408. </field>
  17409. <field name="DEFAULT_RM_EPOCH_RANGE" type="long"
  17410. transient="false" volatile="false"
  17411. static="true" final="true" visibility="public"
  17412. deprecated="not deprecated">
  17413. </field>
  17414. <field name="RM_ADDRESS" type="java.lang.String"
  17415. transient="false" volatile="false"
  17416. static="true" final="true" visibility="public"
  17417. deprecated="not deprecated">
  17418. <doc>
  17419. <![CDATA[The address of the applications manager interface in the RM.]]>
  17420. </doc>
  17421. </field>
  17422. <field name="DEFAULT_RM_PORT" type="int"
  17423. transient="false" volatile="false"
  17424. static="true" final="true" visibility="public"
  17425. deprecated="not deprecated">
  17426. </field>
  17427. <field name="DEFAULT_RM_ADDRESS" type="java.lang.String"
  17428. transient="false" volatile="false"
  17429. static="true" final="true" visibility="public"
  17430. deprecated="not deprecated">
  17431. </field>
  17432. <field name="RM_APPLICATION_MAX_TAGS" type="java.lang.String"
  17433. transient="false" volatile="false"
  17434. static="true" final="true" visibility="public"
  17435. deprecated="not deprecated">
  17436. <doc>
  17437. <![CDATA[Max number of application tags.]]>
  17438. </doc>
  17439. </field>
  17440. <field name="DEFAULT_RM_APPLICATION_MAX_TAGS" type="int"
  17441. transient="false" volatile="false"
  17442. static="true" final="true" visibility="public"
  17443. deprecated="not deprecated">
  17444. </field>
  17445. <field name="RM_APPLICATION_MAX_TAG_LENGTH" type="java.lang.String"
  17446. transient="false" volatile="false"
  17447. static="true" final="true" visibility="public"
  17448. deprecated="not deprecated">
  17449. <doc>
  17450. <![CDATA[Max length of each application tag.]]>
  17451. </doc>
  17452. </field>
  17453. <field name="DEFAULT_RM_APPLICATION_MAX_TAG_LENGTH" type="int"
  17454. transient="false" volatile="false"
  17455. static="true" final="true" visibility="public"
  17456. deprecated="not deprecated">
  17457. </field>
  17458. <field name="RM_APPLICATION_MASTER_SERVICE_PROCESSORS" type="java.lang.String"
  17459. transient="false" volatile="false"
  17460. static="true" final="true" visibility="public"
  17461. deprecated="not deprecated">
  17462. </field>
  17463. <field name="RM_AUTO_UPDATE_CONTAINERS" type="java.lang.String"
  17464. transient="false" volatile="false"
  17465. static="true" final="true" visibility="public"
  17466. deprecated="not deprecated">
  17467. </field>
  17468. <field name="DEFAULT_RM_AUTO_UPDATE_CONTAINERS" type="boolean"
  17469. transient="false" volatile="false"
  17470. static="true" final="true" visibility="public"
  17471. deprecated="not deprecated">
  17472. </field>
  17473. <field name="RM_BIND_HOST" type="java.lang.String"
  17474. transient="false" volatile="false"
  17475. static="true" final="true" visibility="public"
  17476. deprecated="not deprecated">
  17477. <doc>
  17478. <![CDATA[The actual bind address for the RM.]]>
  17479. </doc>
  17480. </field>
  17481. <field name="RM_CLIENT_THREAD_COUNT" type="java.lang.String"
  17482. transient="false" volatile="false"
  17483. static="true" final="true" visibility="public"
  17484. deprecated="not deprecated">
  17485. <doc>
  17486. <![CDATA[The number of threads used to handle applications manager requests.]]>
  17487. </doc>
  17488. </field>
  17489. <field name="DEFAULT_RM_CLIENT_THREAD_COUNT" type="int"
  17490. transient="false" volatile="false"
  17491. static="true" final="true" visibility="public"
  17492. deprecated="not deprecated">
  17493. </field>
  17494. <field name="RM_AMLAUNCHER_THREAD_COUNT" type="java.lang.String"
  17495. transient="false" volatile="false"
  17496. static="true" final="true" visibility="public"
  17497. deprecated="not deprecated">
  17498. <doc>
  17499. <![CDATA[Number of threads used to launch/cleanup AM.]]>
  17500. </doc>
  17501. </field>
  17502. <field name="DEFAULT_RM_AMLAUNCHER_THREAD_COUNT" type="int"
  17503. transient="false" volatile="false"
  17504. static="true" final="true" visibility="public"
  17505. deprecated="not deprecated">
  17506. </field>
  17507. <field name="RM_NODEMANAGER_CONNECT_RETRIES" type="java.lang.String"
  17508. transient="false" volatile="false"
  17509. static="true" final="true" visibility="public"
  17510. deprecated="not deprecated">
  17511. <doc>
  17512. <![CDATA[Retry times to connect with NM.]]>
  17513. </doc>
  17514. </field>
  17515. <field name="DEFAULT_RM_NODEMANAGER_CONNECT_RETRIES" type="int"
  17516. transient="false" volatile="false"
  17517. static="true" final="true" visibility="public"
  17518. deprecated="not deprecated">
  17519. </field>
  17520. <field name="RM_PRINCIPAL" type="java.lang.String"
  17521. transient="false" volatile="false"
  17522. static="true" final="true" visibility="public"
  17523. deprecated="not deprecated">
  17524. <doc>
  17525. <![CDATA[The Kerberos principal for the resource manager.]]>
  17526. </doc>
  17527. </field>
  17528. <field name="RM_SCHEDULER_ADDRESS" type="java.lang.String"
  17529. transient="false" volatile="false"
  17530. static="true" final="true" visibility="public"
  17531. deprecated="not deprecated">
  17532. <doc>
  17533. <![CDATA[The address of the scheduler interface.]]>
  17534. </doc>
  17535. </field>
  17536. <field name="DEFAULT_RM_SCHEDULER_PORT" type="int"
  17537. transient="false" volatile="false"
  17538. static="true" final="true" visibility="public"
  17539. deprecated="not deprecated">
  17540. </field>
  17541. <field name="DEFAULT_RM_SCHEDULER_ADDRESS" type="java.lang.String"
  17542. transient="false" volatile="false"
  17543. static="true" final="true" visibility="public"
  17544. deprecated="not deprecated">
  17545. </field>
  17546. <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="java.lang.String"
  17547. transient="false" volatile="false"
  17548. static="true" final="true" visibility="public"
  17549. deprecated="not deprecated">
  17550. <doc>
  17551. <![CDATA[Minimum request grant-able by the RM scheduler.]]>
  17552. </doc>
  17553. </field>
  17554. <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="int"
  17555. transient="false" volatile="false"
  17556. static="true" final="true" visibility="public"
  17557. deprecated="not deprecated">
  17558. </field>
  17559. <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="java.lang.String"
  17560. transient="false" volatile="false"
  17561. static="true" final="true" visibility="public"
  17562. deprecated="not deprecated">
  17563. </field>
  17564. <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="int"
  17565. transient="false" volatile="false"
  17566. static="true" final="true" visibility="public"
  17567. deprecated="not deprecated">
  17568. </field>
  17569. <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="java.lang.String"
  17570. transient="false" volatile="false"
  17571. static="true" final="true" visibility="public"
  17572. deprecated="not deprecated">
  17573. <doc>
  17574. <![CDATA[Maximum request grant-able by the RM scheduler.]]>
  17575. </doc>
  17576. </field>
  17577. <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="int"
  17578. transient="false" volatile="false"
  17579. static="true" final="true" visibility="public"
  17580. deprecated="not deprecated">
  17581. </field>
  17582. <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="java.lang.String"
  17583. transient="false" volatile="false"
  17584. static="true" final="true" visibility="public"
  17585. deprecated="not deprecated">
  17586. </field>
  17587. <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="int"
  17588. transient="false" volatile="false"
  17589. static="true" final="true" visibility="public"
  17590. deprecated="not deprecated">
  17591. </field>
  17592. <field name="RM_SCHEDULER_CLIENT_THREAD_COUNT" type="java.lang.String"
  17593. transient="false" volatile="false"
  17594. static="true" final="true" visibility="public"
  17595. deprecated="not deprecated">
  17596. <doc>
  17597. <![CDATA[Number of threads to handle scheduler interface.]]>
  17598. </doc>
  17599. </field>
  17600. <field name="DEFAULT_RM_SCHEDULER_CLIENT_THREAD_COUNT" type="int"
  17601. transient="false" volatile="false"
  17602. static="true" final="true" visibility="public"
  17603. deprecated="not deprecated">
  17604. </field>
  17605. <field name="RM_SCHEDULER_INCLUDE_PORT_IN_NODE_NAME" type="java.lang.String"
  17606. transient="false" volatile="false"
  17607. static="true" final="true" visibility="public"
  17608. deprecated="not deprecated">
  17609. <doc>
  17610. <![CDATA[If the port should be included or not in the node name. The node name
  17611. is used by the scheduler for resource requests allocation location
  17612. matching. Typically this is just the hostname, using the port is needed
  17613. when using minicluster and specific NM are required.]]>
  17614. </doc>
  17615. </field>
  17616. <field name="DEFAULT_RM_SCHEDULER_USE_PORT_FOR_NODE_NAME" type="boolean"
  17617. transient="false" volatile="false"
  17618. static="true" final="true" visibility="public"
  17619. deprecated="not deprecated">
  17620. </field>
  17621. <field name="QUEUE_PLACEMENT_RULES" type="java.lang.String"
  17622. transient="false" volatile="false"
  17623. static="true" final="true" visibility="public"
  17624. deprecated="not deprecated">
  17625. <doc>
  17626. <![CDATA[Configured scheduler queue placement rules.]]>
  17627. </doc>
  17628. </field>
  17629. <field name="USER_GROUP_PLACEMENT_RULE" type="java.lang.String"
  17630. transient="false" volatile="false"
  17631. static="true" final="true" visibility="public"
  17632. deprecated="not deprecated">
  17633. <doc>
  17634. <![CDATA[UserGroupMappingPlacementRule configuration string.]]>
  17635. </doc>
  17636. </field>
  17637. <field name="APP_NAME_PLACEMENT_RULE" type="java.lang.String"
  17638. transient="false" volatile="false"
  17639. static="true" final="true" visibility="public"
  17640. deprecated="not deprecated">
  17641. </field>
  17642. <field name="RM_WEBAPP_UI_ACTIONS_ENABLED" type="java.lang.String"
  17643. transient="false" volatile="false"
  17644. static="true" final="true" visibility="public"
  17645. deprecated="not deprecated">
  17646. <doc>
  17647. <![CDATA[Enable Resource Manager webapp ui actions]]>
  17648. </doc>
  17649. </field>
  17650. <field name="DEFAULT_RM_WEBAPP_UI_ACTIONS_ENABLED" type="boolean"
  17651. transient="false" volatile="false"
  17652. static="true" final="true" visibility="public"
  17653. deprecated="not deprecated">
  17654. </field>
  17655. <field name="RM_RESERVATION_SYSTEM_ENABLE" type="java.lang.String"
  17656. transient="false" volatile="false"
  17657. static="true" final="true" visibility="public"
  17658. deprecated="not deprecated">
  17659. <doc>
  17660. <![CDATA[Whether the RM should enable Reservation System]]>
  17661. </doc>
  17662. </field>
  17663. <field name="DEFAULT_RM_RESERVATION_SYSTEM_ENABLE" type="boolean"
  17664. transient="false" volatile="false"
  17665. static="true" final="true" visibility="public"
  17666. deprecated="not deprecated">
  17667. </field>
  17668. <field name="RM_RESERVATION_SYSTEM_CLASS" type="java.lang.String"
  17669. transient="false" volatile="false"
  17670. static="true" final="true" visibility="public"
  17671. deprecated="not deprecated">
  17672. <doc>
  17673. <![CDATA[The class to use as the Reservation System.]]>
  17674. </doc>
  17675. </field>
  17676. <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER" type="java.lang.String"
  17677. transient="false" volatile="false"
  17678. static="true" final="true" visibility="public"
  17679. deprecated="not deprecated">
  17680. <doc>
  17681. <![CDATA[The PlanFollower for the Reservation System.]]>
  17682. </doc>
  17683. </field>
  17684. <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="java.lang.String"
  17685. transient="false" volatile="false"
  17686. static="true" final="true" visibility="public"
  17687. deprecated="not deprecated">
  17688. <doc>
  17689. <![CDATA[The step size of the Reservation System.]]>
  17690. </doc>
  17691. </field>
  17692. <field name="DEFAULT_RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="long"
  17693. transient="false" volatile="false"
  17694. static="true" final="true" visibility="public"
  17695. deprecated="not deprecated">
  17696. </field>
  17697. <field name="RM_RESERVATION_SYSTEM_MAX_PERIODICITY" type="java.lang.String"
  17698. transient="false" volatile="false"
  17699. static="true" final="true" visibility="public"
  17700. deprecated="not deprecated">
  17701. <doc>
  17702. <![CDATA[The maximum periodicity for the Reservation System.]]>
  17703. </doc>
  17704. </field>
  17705. <field name="DEFAULT_RM_RESERVATION_SYSTEM_MAX_PERIODICITY" type="long"
  17706. transient="false" volatile="false"
  17707. static="true" final="true" visibility="public"
  17708. deprecated="not deprecated">
  17709. </field>
  17710. <field name="RM_SCHEDULER_ENABLE_MONITORS" type="java.lang.String"
  17711. transient="false" volatile="false"
  17712. static="true" final="true" visibility="public"
  17713. deprecated="not deprecated">
  17714. <doc>
  17715. <![CDATA[Enable periodic monitor threads.
  17716. @see #RM_SCHEDULER_MONITOR_POLICIES]]>
  17717. </doc>
  17718. </field>
  17719. <field name="DEFAULT_RM_SCHEDULER_ENABLE_MONITORS" type="boolean"
  17720. transient="false" volatile="false"
  17721. static="true" final="true" visibility="public"
  17722. deprecated="not deprecated">
  17723. </field>
  17724. <field name="RM_SCHEDULER_MONITOR_POLICIES" type="java.lang.String"
  17725. transient="false" volatile="false"
  17726. static="true" final="true" visibility="public"
  17727. deprecated="not deprecated">
  17728. <doc>
  17729. <![CDATA[List of SchedulingEditPolicy classes affecting the scheduler.]]>
  17730. </doc>
  17731. </field>
  17732. <field name="RM_WEBAPP_ADDRESS" 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 address of the RM web application.]]>
  17738. </doc>
  17739. </field>
  17740. <field name="DEFAULT_RM_WEBAPP_PORT" type="int"
  17741. transient="false" volatile="false"
  17742. static="true" final="true" visibility="public"
  17743. deprecated="not deprecated">
  17744. </field>
  17745. <field name="DEFAULT_RM_WEBAPP_ADDRESS" type="java.lang.String"
  17746. transient="false" volatile="false"
  17747. static="true" final="true" visibility="public"
  17748. deprecated="not deprecated">
  17749. </field>
  17750. <field name="RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  17751. transient="false" volatile="false"
  17752. static="true" final="true" visibility="public"
  17753. deprecated="not deprecated">
  17754. <doc>
  17755. <![CDATA[The https address of the RM web application.]]>
  17756. </doc>
  17757. </field>
  17758. <field name="YARN_SSL_CLIENT_HTTPS_NEED_AUTH_DEFAULT" type="boolean"
  17759. transient="false" volatile="false"
  17760. static="true" final="true" visibility="public"
  17761. deprecated="not deprecated">
  17762. </field>
  17763. <field name="YARN_SSL_SERVER_RESOURCE_DEFAULT" type="java.lang.String"
  17764. transient="false" volatile="false"
  17765. static="true" final="true" visibility="public"
  17766. deprecated="not deprecated">
  17767. </field>
  17768. <field name="DEFAULT_RM_WEBAPP_HTTPS_PORT" type="int"
  17769. transient="false" volatile="false"
  17770. static="true" final="true" visibility="public"
  17771. deprecated="not deprecated">
  17772. </field>
  17773. <field name="DEFAULT_RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  17774. transient="false" volatile="false"
  17775. static="true" final="true" visibility="public"
  17776. deprecated="not deprecated">
  17777. </field>
  17778. <field name="YARN_WEBAPP_UI2_ENABLE" type="java.lang.String"
  17779. transient="false" volatile="false"
  17780. static="true" final="true" visibility="public"
  17781. deprecated="not deprecated">
  17782. <doc>
  17783. <![CDATA[Enable YARN WebApp V2.]]>
  17784. </doc>
  17785. </field>
  17786. <field name="DEFAULT_YARN_WEBAPP_UI2_ENABLE" type="boolean"
  17787. transient="false" volatile="false"
  17788. static="true" final="true" visibility="public"
  17789. deprecated="not deprecated">
  17790. </field>
  17791. <field name="YARN_WEBAPP_UI2_WARFILE_PATH" type="java.lang.String"
  17792. transient="false" volatile="false"
  17793. static="true" final="true" visibility="public"
  17794. deprecated="not deprecated">
  17795. </field>
  17796. <field name="YARN_API_SERVICES_ENABLE" type="java.lang.String"
  17797. transient="false" volatile="false"
  17798. static="true" final="true" visibility="public"
  17799. deprecated="not deprecated">
  17800. </field>
  17801. <field name="DEFAULT_YARN_API_SYSTEM_SERVICES_CLASS" type="java.lang.String"
  17802. transient="false" volatile="false"
  17803. static="true" final="true" visibility="public"
  17804. deprecated="not deprecated">
  17805. </field>
  17806. <field name="RM_RESOURCE_TRACKER_ADDRESS" 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="DEFAULT_RM_RESOURCE_TRACKER_PORT" type="int"
  17812. transient="false" volatile="false"
  17813. static="true" final="true" visibility="public"
  17814. deprecated="not deprecated">
  17815. </field>
  17816. <field name="DEFAULT_RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
  17817. transient="false" volatile="false"
  17818. static="true" final="true" visibility="public"
  17819. deprecated="not deprecated">
  17820. </field>
  17821. <field name="RM_AM_EXPIRY_INTERVAL_MS" type="java.lang.String"
  17822. transient="false" volatile="false"
  17823. static="true" final="true" visibility="public"
  17824. deprecated="not deprecated">
  17825. <doc>
  17826. <![CDATA[The expiry interval for application master reporting.]]>
  17827. </doc>
  17828. </field>
  17829. <field name="DEFAULT_RM_AM_EXPIRY_INTERVAL_MS" type="int"
  17830. transient="false" volatile="false"
  17831. static="true" final="true" visibility="public"
  17832. deprecated="not deprecated">
  17833. </field>
  17834. <field name="RM_NM_EXPIRY_INTERVAL_MS" type="java.lang.String"
  17835. transient="false" volatile="false"
  17836. static="true" final="true" visibility="public"
  17837. deprecated="not deprecated">
  17838. <doc>
  17839. <![CDATA[How long to wait until a node manager is considered dead.]]>
  17840. </doc>
  17841. </field>
  17842. <field name="DEFAULT_RM_NM_EXPIRY_INTERVAL_MS" type="int"
  17843. transient="false" volatile="false"
  17844. static="true" final="true" visibility="public"
  17845. deprecated="not deprecated">
  17846. </field>
  17847. <field name="YARN_ACL_ENABLE" type="java.lang.String"
  17848. transient="false" volatile="false"
  17849. static="true" final="true" visibility="public"
  17850. deprecated="not deprecated">
  17851. <doc>
  17852. <![CDATA[Are acls enabled.]]>
  17853. </doc>
  17854. </field>
  17855. <field name="DEFAULT_YARN_ACL_ENABLE" type="boolean"
  17856. transient="false" volatile="false"
  17857. static="true" final="true" visibility="public"
  17858. deprecated="not deprecated">
  17859. </field>
  17860. <field name="YARN_RESERVATION_ACL_ENABLE" type="java.lang.String"
  17861. transient="false" volatile="false"
  17862. static="true" final="true" visibility="public"
  17863. deprecated="not deprecated">
  17864. <doc>
  17865. <![CDATA[Are reservation acls enabled.]]>
  17866. </doc>
  17867. </field>
  17868. <field name="DEFAULT_YARN_RESERVATION_ACL_ENABLE" type="boolean"
  17869. transient="false" volatile="false"
  17870. static="true" final="true" visibility="public"
  17871. deprecated="not deprecated">
  17872. </field>
  17873. <field name="YARN_ADMIN_ACL" type="java.lang.String"
  17874. transient="false" volatile="false"
  17875. static="true" final="true" visibility="public"
  17876. deprecated="not deprecated">
  17877. <doc>
  17878. <![CDATA[ACL of who can be admin of YARN cluster.]]>
  17879. </doc>
  17880. </field>
  17881. <field name="DEFAULT_YARN_ADMIN_ACL" type="java.lang.String"
  17882. transient="false" volatile="false"
  17883. static="true" final="true" visibility="public"
  17884. deprecated="not deprecated">
  17885. </field>
  17886. <field name="DEFAULT_YARN_APP_ACL" type="java.lang.String"
  17887. transient="false" volatile="false"
  17888. static="true" final="true" visibility="public"
  17889. deprecated="not deprecated">
  17890. <doc>
  17891. <![CDATA[ACL used in case none is found. Allows nothing.]]>
  17892. </doc>
  17893. </field>
  17894. <field name="OPPORTUNISTIC_CONTAINER_ALLOCATION_ENABLED" type="java.lang.String"
  17895. transient="false" volatile="false"
  17896. static="true" final="true" visibility="public"
  17897. deprecated="not deprecated">
  17898. <doc>
  17899. <![CDATA[Setting that controls whether opportunistic container allocation
  17900. is enabled or not.]]>
  17901. </doc>
  17902. </field>
  17903. <field name="DEFAULT_OPPORTUNISTIC_CONTAINER_ALLOCATION_ENABLED" type="boolean"
  17904. transient="false" volatile="false"
  17905. static="true" final="true" visibility="public"
  17906. deprecated="not deprecated">
  17907. </field>
  17908. <field name="OPP_CONTAINER_MAX_ALLOCATIONS_PER_AM_HEARTBEAT" type="java.lang.String"
  17909. transient="false" volatile="false"
  17910. static="true" final="true" visibility="public"
  17911. deprecated="not deprecated">
  17912. <doc>
  17913. <![CDATA[Maximum number of opportunistic containers to be allocated in
  17914. AM heartbeat.]]>
  17915. </doc>
  17916. </field>
  17917. <field name="DEFAULT_OPP_CONTAINER_MAX_ALLOCATIONS_PER_AM_HEARTBEAT" type="int"
  17918. transient="false" volatile="false"
  17919. static="true" final="true" visibility="public"
  17920. deprecated="not deprecated">
  17921. </field>
  17922. <field name="OPP_CONTAINER_ALLOCATION_NODES_NUMBER_USED" type="java.lang.String"
  17923. transient="false" volatile="false"
  17924. static="true" final="true" visibility="public"
  17925. deprecated="not deprecated">
  17926. <doc>
  17927. <![CDATA[Number of nodes to be used by the Opportunistic Container allocator for
  17928. dispatching containers during container allocation.]]>
  17929. </doc>
  17930. </field>
  17931. <field name="DEFAULT_OPP_CONTAINER_ALLOCATION_NODES_NUMBER_USED" type="int"
  17932. transient="false" volatile="false"
  17933. static="true" final="true" visibility="public"
  17934. deprecated="not deprecated">
  17935. </field>
  17936. <field name="NM_CONTAINER_QUEUING_SORTING_NODES_INTERVAL_MS" type="java.lang.String"
  17937. transient="false" volatile="false"
  17938. static="true" final="true" visibility="public"
  17939. deprecated="not deprecated">
  17940. <doc>
  17941. <![CDATA[Frequency for computing least loaded NMs.]]>
  17942. </doc>
  17943. </field>
  17944. <field name="DEFAULT_NM_CONTAINER_QUEUING_SORTING_NODES_INTERVAL_MS" type="long"
  17945. transient="false" volatile="false"
  17946. static="true" final="true" visibility="public"
  17947. deprecated="not deprecated">
  17948. </field>
  17949. <field name="NM_CONTAINER_QUEUING_LOAD_COMPARATOR" type="java.lang.String"
  17950. transient="false" volatile="false"
  17951. static="true" final="true" visibility="public"
  17952. deprecated="not deprecated">
  17953. <doc>
  17954. <![CDATA[Comparator for determining node load for scheduling of opportunistic
  17955. containers.]]>
  17956. </doc>
  17957. </field>
  17958. <field name="DEFAULT_NM_CONTAINER_QUEUING_LOAD_COMPARATOR" type="java.lang.String"
  17959. transient="false" volatile="false"
  17960. static="true" final="true" visibility="public"
  17961. deprecated="not deprecated">
  17962. </field>
  17963. <field name="NM_CONTAINER_QUEUING_LIMIT_STDEV" type="java.lang.String"
  17964. transient="false" volatile="false"
  17965. static="true" final="true" visibility="public"
  17966. deprecated="not deprecated">
  17967. <doc>
  17968. <![CDATA[Value of standard deviation used for calculation of queue limit
  17969. thresholds.]]>
  17970. </doc>
  17971. </field>
  17972. <field name="DEFAULT_NM_CONTAINER_QUEUING_LIMIT_STDEV" type="float"
  17973. transient="false" volatile="false"
  17974. static="true" final="true" visibility="public"
  17975. deprecated="not deprecated">
  17976. </field>
  17977. <field name="NM_CONTAINER_QUEUING_MIN_QUEUE_LENGTH" type="java.lang.String"
  17978. transient="false" volatile="false"
  17979. static="true" final="true" visibility="public"
  17980. deprecated="not deprecated">
  17981. <doc>
  17982. <![CDATA[Min length of container queue at NodeManager. This is a cluster-wide
  17983. configuration that acts as the lower-bound of optimal queue length
  17984. calculated by the NodeQueueLoadMonitor]]>
  17985. </doc>
  17986. </field>
  17987. <field name="DEFAULT_NM_CONTAINER_QUEUING_MIN_QUEUE_LENGTH" type="int"
  17988. transient="false" volatile="false"
  17989. static="true" final="true" visibility="public"
  17990. deprecated="not deprecated">
  17991. </field>
  17992. <field name="NM_CONTAINER_QUEUING_MAX_QUEUE_LENGTH" type="java.lang.String"
  17993. transient="false" volatile="false"
  17994. static="true" final="true" visibility="public"
  17995. deprecated="not deprecated">
  17996. <doc>
  17997. <![CDATA[Max length of container queue at NodeManager. This is a cluster-wide
  17998. configuration that acts as the upper-bound of optimal queue length
  17999. calculated by the NodeQueueLoadMonitor]]>
  18000. </doc>
  18001. </field>
  18002. <field name="DEFAULT_NM_CONTAINER_QUEUING_MAX_QUEUE_LENGTH" type="int"
  18003. transient="false" volatile="false"
  18004. static="true" final="true" visibility="public"
  18005. deprecated="not deprecated">
  18006. </field>
  18007. <field name="NM_CONTAINER_QUEUING_MIN_QUEUE_WAIT_TIME_MS" type="java.lang.String"
  18008. transient="false" volatile="false"
  18009. static="true" final="true" visibility="public"
  18010. deprecated="not deprecated">
  18011. <doc>
  18012. <![CDATA[Min queue wait time for a container at a NodeManager.]]>
  18013. </doc>
  18014. </field>
  18015. <field name="DEFAULT_NM_CONTAINER_QUEUING_MIN_QUEUE_WAIT_TIME_MS" type="int"
  18016. transient="false" volatile="false"
  18017. static="true" final="true" visibility="public"
  18018. deprecated="not deprecated">
  18019. </field>
  18020. <field name="NM_CONTAINER_QUEUING_MAX_QUEUE_WAIT_TIME_MS" type="java.lang.String"
  18021. transient="false" volatile="false"
  18022. static="true" final="true" visibility="public"
  18023. deprecated="not deprecated">
  18024. <doc>
  18025. <![CDATA[Max queue wait time for a container queue at a NodeManager.]]>
  18026. </doc>
  18027. </field>
  18028. <field name="DEFAULT_NM_CONTAINER_QUEUING_MAX_QUEUE_WAIT_TIME_MS" type="int"
  18029. transient="false" volatile="false"
  18030. static="true" final="true" visibility="public"
  18031. deprecated="not deprecated">
  18032. </field>
  18033. <field name="YARN_INTERMEDIATE_DATA_ENCRYPTION" type="java.lang.String"
  18034. transient="false" volatile="false"
  18035. static="true" final="true" visibility="public"
  18036. deprecated="not deprecated">
  18037. <doc>
  18038. <![CDATA[Enable/disable intermediate-data encryption at YARN level. For now, this
  18039. only is used by the FileSystemRMStateStore to setup right file-system
  18040. security attributes.]]>
  18041. </doc>
  18042. </field>
  18043. <field name="DEFAULT_YARN_INTERMEDIATE_DATA_ENCRYPTION" type="boolean"
  18044. transient="false" volatile="false"
  18045. static="true" final="true" visibility="public"
  18046. deprecated="not deprecated">
  18047. </field>
  18048. <field name="RM_ADMIN_ADDRESS" type="java.lang.String"
  18049. transient="false" volatile="false"
  18050. static="true" final="true" visibility="public"
  18051. deprecated="not deprecated">
  18052. <doc>
  18053. <![CDATA[The address of the RM admin interface.]]>
  18054. </doc>
  18055. </field>
  18056. <field name="DEFAULT_RM_ADMIN_PORT" type="int"
  18057. transient="false" volatile="false"
  18058. static="true" final="true" visibility="public"
  18059. deprecated="not deprecated">
  18060. </field>
  18061. <field name="DEFAULT_RM_ADMIN_ADDRESS" type="java.lang.String"
  18062. transient="false" volatile="false"
  18063. static="true" final="true" visibility="public"
  18064. deprecated="not deprecated">
  18065. </field>
  18066. <field name="RM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
  18067. transient="false" volatile="false"
  18068. static="true" final="true" visibility="public"
  18069. deprecated="not deprecated">
  18070. <doc>
  18071. <![CDATA[Number of threads used to handle RM admin interface.]]>
  18072. </doc>
  18073. </field>
  18074. <field name="DEFAULT_RM_ADMIN_CLIENT_THREAD_COUNT" type="int"
  18075. transient="false" volatile="false"
  18076. static="true" final="true" visibility="public"
  18077. deprecated="not deprecated">
  18078. </field>
  18079. <field name="RM_AM_MAX_ATTEMPTS" type="java.lang.String"
  18080. transient="false" volatile="false"
  18081. static="true" final="true" visibility="public"
  18082. deprecated="not deprecated">
  18083. <doc>
  18084. <![CDATA[The maximum number of application attempts for
  18085. an application, if unset by user.]]>
  18086. </doc>
  18087. </field>
  18088. <field name="DEFAULT_RM_AM_MAX_ATTEMPTS" type="int"
  18089. transient="false" volatile="false"
  18090. static="true" final="true" visibility="public"
  18091. deprecated="not deprecated">
  18092. </field>
  18093. <field name="GLOBAL_RM_AM_MAX_ATTEMPTS" type="java.lang.String"
  18094. transient="false" volatile="false"
  18095. static="true" final="true" visibility="public"
  18096. deprecated="not deprecated">
  18097. <doc>
  18098. <![CDATA[The maximum number of application attempts.
  18099. It's a global setting for all application masters.]]>
  18100. </doc>
  18101. </field>
  18102. <field name="RM_KEYTAB" type="java.lang.String"
  18103. transient="false" volatile="false"
  18104. static="true" final="true" visibility="public"
  18105. deprecated="not deprecated">
  18106. <doc>
  18107. <![CDATA[The keytab for the resource manager.]]>
  18108. </doc>
  18109. </field>
  18110. <field name="RM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
  18111. transient="false" volatile="false"
  18112. static="true" final="true" visibility="public"
  18113. deprecated="not deprecated">
  18114. <doc>
  18115. <![CDATA[The kerberos principal to be used for spnego filter for RM.]]>
  18116. </doc>
  18117. </field>
  18118. <field name="RM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
  18119. transient="false" volatile="false"
  18120. static="true" final="true" visibility="public"
  18121. deprecated="not deprecated">
  18122. <doc>
  18123. <![CDATA[The kerberos keytab to be used for spnego filter for RM.]]>
  18124. </doc>
  18125. </field>
  18126. <field name="RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="java.lang.String"
  18127. transient="false" volatile="false"
  18128. static="true" final="true" visibility="public"
  18129. deprecated="not deprecated">
  18130. <doc>
  18131. <![CDATA[Flag to enable override of the default kerberos authentication filter with
  18132. the RM authentication filter to allow authentication using delegation
  18133. tokens(fallback to kerberos if the tokens are missing). Only applicable
  18134. when the http authentication type is kerberos.]]>
  18135. </doc>
  18136. </field>
  18137. <field name="DEFAULT_RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="boolean"
  18138. transient="false" volatile="false"
  18139. static="true" final="true" visibility="public"
  18140. deprecated="not deprecated">
  18141. </field>
  18142. <field name="RM_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
  18143. transient="false" volatile="false"
  18144. static="true" final="true" visibility="public"
  18145. deprecated="not deprecated">
  18146. <doc>
  18147. <![CDATA[Enable cross origin (CORS) support.]]>
  18148. </doc>
  18149. </field>
  18150. <field name="DEFAULT_RM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
  18151. transient="false" volatile="false"
  18152. static="true" final="true" visibility="public"
  18153. deprecated="not deprecated">
  18154. </field>
  18155. <field name="RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="java.lang.String"
  18156. transient="false" volatile="false"
  18157. static="true" final="true" visibility="public"
  18158. deprecated="not deprecated">
  18159. <doc>
  18160. <![CDATA[How long to wait until a container is considered dead.]]>
  18161. </doc>
  18162. </field>
  18163. <field name="DEFAULT_RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="int"
  18164. transient="false" volatile="false"
  18165. static="true" final="true" visibility="public"
  18166. deprecated="not deprecated">
  18167. </field>
  18168. <field name="RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
  18169. transient="false" volatile="false"
  18170. static="true" final="true" visibility="public"
  18171. deprecated="not deprecated">
  18172. <doc>
  18173. <![CDATA[Path to file with nodes to include.]]>
  18174. </doc>
  18175. </field>
  18176. <field name="DEFAULT_RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
  18177. transient="false" volatile="false"
  18178. static="true" final="true" visibility="public"
  18179. deprecated="not deprecated">
  18180. </field>
  18181. <field name="RM_SUBMISSION_PREPROCESSOR_ENABLED" type="java.lang.String"
  18182. transient="false" volatile="false"
  18183. static="true" final="true" visibility="public"
  18184. deprecated="not deprecated">
  18185. <doc>
  18186. <![CDATA[Enable submission pre-processor.]]>
  18187. </doc>
  18188. </field>
  18189. <field name="DEFAULT_RM_SUBMISSION_PREPROCESSOR_ENABLED" type="boolean"
  18190. transient="false" volatile="false"
  18191. static="true" final="true" visibility="public"
  18192. deprecated="not deprecated">
  18193. </field>
  18194. <field name="RM_SUBMISSION_PREPROCESSOR_FILE_PATH" type="java.lang.String"
  18195. transient="false" volatile="false"
  18196. static="true" final="true" visibility="public"
  18197. deprecated="not deprecated">
  18198. <doc>
  18199. <![CDATA[Path to file with hosts for the submission processor to handle.]]>
  18200. </doc>
  18201. </field>
  18202. <field name="DEFAULT_RM_SUBMISSION_PREPROCESSOR_FILE_PATH" type="java.lang.String"
  18203. transient="false" volatile="false"
  18204. static="true" final="true" visibility="public"
  18205. deprecated="not deprecated">
  18206. </field>
  18207. <field name="RM_SUBMISSION_PREPROCESSOR_REFRESH_INTERVAL_MS" type="java.lang.String"
  18208. transient="false" volatile="false"
  18209. static="true" final="true" visibility="public"
  18210. deprecated="not deprecated">
  18211. <doc>
  18212. <![CDATA[Submission processor refresh interval.]]>
  18213. </doc>
  18214. </field>
  18215. <field name="DEFAULT_RM_SUBMISSION_PREPROCESSOR_REFRESH_INTERVAL_MS" type="int"
  18216. transient="false" volatile="false"
  18217. static="true" final="true" visibility="public"
  18218. deprecated="not deprecated">
  18219. </field>
  18220. <field name="RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
  18221. transient="false" volatile="false"
  18222. static="true" final="true" visibility="public"
  18223. deprecated="not deprecated">
  18224. <doc>
  18225. <![CDATA[Path to file with nodes to exclude.]]>
  18226. </doc>
  18227. </field>
  18228. <field name="DEFAULT_RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
  18229. transient="false" volatile="false"
  18230. static="true" final="true" visibility="public"
  18231. deprecated="not deprecated">
  18232. </field>
  18233. <field name="RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="java.lang.String"
  18234. transient="false" volatile="false"
  18235. static="true" final="true" visibility="public"
  18236. deprecated="not deprecated">
  18237. <doc>
  18238. <![CDATA[Number of threads to handle resource tracker calls.]]>
  18239. </doc>
  18240. </field>
  18241. <field name="DEFAULT_RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="int"
  18242. transient="false" volatile="false"
  18243. static="true" final="true" visibility="public"
  18244. deprecated="not deprecated">
  18245. </field>
  18246. <field name="RM_NM_REGISTRATION_IP_HOSTNAME_CHECK_KEY" type="java.lang.String"
  18247. transient="false" volatile="false"
  18248. static="true" final="true" visibility="public"
  18249. deprecated="not deprecated">
  18250. <doc>
  18251. <![CDATA[Check IP and hostname resolution during nodemanager registration.]]>
  18252. </doc>
  18253. </field>
  18254. <field name="DEFAULT_RM_NM_REGISTRATION_IP_HOSTNAME_CHECK_KEY" type="boolean"
  18255. transient="false" volatile="false"
  18256. static="true" final="true" visibility="public"
  18257. deprecated="not deprecated">
  18258. </field>
  18259. <field name="RM_SCHEDULER" type="java.lang.String"
  18260. transient="false" volatile="false"
  18261. static="true" final="true" visibility="public"
  18262. deprecated="not deprecated">
  18263. <doc>
  18264. <![CDATA[The class to use as the resource scheduler.]]>
  18265. </doc>
  18266. </field>
  18267. <field name="RM_PLACEMENT_CONSTRAINTS_HANDLER" type="java.lang.String"
  18268. transient="false" volatile="false"
  18269. static="true" final="true" visibility="public"
  18270. deprecated="not deprecated">
  18271. <doc>
  18272. <![CDATA[Specify which handler will be used to process PlacementConstraints.
  18273. For details on PlacementConstraints, please refer to
  18274. {@link org.apache.hadoop.yarn.api.resource.PlacementConstraint}]]>
  18275. </doc>
  18276. </field>
  18277. <field name="DISABLED_RM_PLACEMENT_CONSTRAINTS_HANDLER" type="java.lang.String"
  18278. transient="false" volatile="false"
  18279. static="true" final="true" visibility="public"
  18280. deprecated="not deprecated">
  18281. <doc>
  18282. <![CDATA[This handler rejects all allocate calls made by an application, if they
  18283. contain a {@link org.apache.hadoop.yarn.api.records.SchedulingRequest}.]]>
  18284. </doc>
  18285. </field>
  18286. <field name="PROCESSOR_RM_PLACEMENT_CONSTRAINTS_HANDLER" type="java.lang.String"
  18287. transient="false" volatile="false"
  18288. static="true" final="true" visibility="public"
  18289. deprecated="not deprecated">
  18290. <doc>
  18291. <![CDATA[Using this handler, the placement of containers with constraints is
  18292. determined as a pre-processing step before the capacity or the fair
  18293. scheduler is called. Once the placement is decided, the capacity/fair
  18294. scheduler is invoked to perform the actual allocation. The advantage of
  18295. this approach is that it supports all constraint types (affinity,
  18296. anti-affinity, cardinality). Moreover, it considers multiple containers at
  18297. a time, which allows to satisfy more constraints than a container-at-a-time
  18298. approach can achieve. As it sits outside the main scheduler, it can be used
  18299. by both the capacity and fair schedulers. Note that at the moment it does
  18300. not account for task priorities within an application, given that such
  18301. priorities might be conflicting with the placement constraints.]]>
  18302. </doc>
  18303. </field>
  18304. <field name="SCHEDULER_RM_PLACEMENT_CONSTRAINTS_HANDLER" type="java.lang.String"
  18305. transient="false" volatile="false"
  18306. static="true" final="true" visibility="public"
  18307. deprecated="not deprecated">
  18308. <doc>
  18309. <![CDATA[Using this handler, containers with constraints will be placed by the main
  18310. scheduler. If the configured RM scheduler
  18311. <pre>yarn.resourcemanager.scheduler.class</pre>
  18312. cannot handle placement constraints, the corresponding SchedulingRequests
  18313. will be rejected. As of now, only the capacity scheduler supports
  18314. SchedulingRequests. In particular, it currently supports anti-affinity
  18315. constraints (no affinity or cardinality) and places one container at a
  18316. time. The advantage of this handler compared to the placement-processor is
  18317. that it follows the same ordering rules for queues (sorted by utilization,
  18318. priority) and apps (sorted by FIFO/fairness/priority) as the ones followed
  18319. by the main scheduler.]]>
  18320. </doc>
  18321. </field>
  18322. <field name="RM_PLACEMENT_CONSTRAINTS_ALGORITHM_CLASS" type="java.lang.String"
  18323. transient="false" volatile="false"
  18324. static="true" final="true" visibility="public"
  18325. deprecated="not deprecated">
  18326. <doc>
  18327. <![CDATA[Placement Algorithm.]]>
  18328. </doc>
  18329. </field>
  18330. <field name="RM_PLACEMENT_CONSTRAINTS_ALGORITHM_ITERATOR" type="java.lang.String"
  18331. transient="false" volatile="false"
  18332. static="true" final="true" visibility="public"
  18333. deprecated="not deprecated">
  18334. <doc>
  18335. <![CDATA[Used for BasicPlacementAlgorithm - default SERIAL.]]>
  18336. </doc>
  18337. </field>
  18338. <field name="RM_PLACEMENT_CONSTRAINTS_RETRY_ATTEMPTS" type="java.lang.String"
  18339. transient="false" volatile="false"
  18340. static="true" final="true" visibility="public"
  18341. deprecated="not deprecated">
  18342. </field>
  18343. <field name="DEFAULT_RM_PLACEMENT_CONSTRAINTS_RETRY_ATTEMPTS" type="int"
  18344. transient="false" volatile="false"
  18345. static="true" final="true" visibility="public"
  18346. deprecated="not deprecated">
  18347. </field>
  18348. <field name="RM_PLACEMENT_CONSTRAINTS_ALGORITHM_POOL_SIZE" type="java.lang.String"
  18349. transient="false" volatile="false"
  18350. static="true" final="true" visibility="public"
  18351. deprecated="not deprecated">
  18352. </field>
  18353. <field name="DEFAULT_RM_PLACEMENT_CONSTRAINTS_ALGORITHM_POOL_SIZE" type="int"
  18354. transient="false" volatile="false"
  18355. static="true" final="true" visibility="public"
  18356. deprecated="not deprecated">
  18357. </field>
  18358. <field name="RM_PLACEMENT_CONSTRAINTS_SCHEDULER_POOL_SIZE" 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="DEFAULT_RM_PLACEMENT_CONSTRAINTS_SCHEDULER_POOL_SIZE" type="int"
  18364. transient="false" volatile="false"
  18365. static="true" final="true" visibility="public"
  18366. deprecated="not deprecated">
  18367. </field>
  18368. <field name="DEFAULT_RM_SCHEDULER" type="java.lang.String"
  18369. transient="false" volatile="false"
  18370. static="true" final="true" visibility="public"
  18371. deprecated="not deprecated">
  18372. </field>
  18373. <field name="RM_NM_HEARTBEAT_INTERVAL_MS" type="java.lang.String"
  18374. transient="false" volatile="false"
  18375. static="true" final="true" visibility="public"
  18376. deprecated="not deprecated">
  18377. <doc>
  18378. <![CDATA[RM set next Heartbeat interval for NM]]>
  18379. </doc>
  18380. </field>
  18381. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MS" type="long"
  18382. transient="false" volatile="false"
  18383. static="true" final="true" visibility="public"
  18384. deprecated="not deprecated">
  18385. </field>
  18386. <field name="RM_NM_HEARTBEAT_INTERVAL_SCALING_ENABLE" type="java.lang.String"
  18387. transient="false" volatile="false"
  18388. static="true" final="true" visibility="public"
  18389. deprecated="not deprecated">
  18390. <doc>
  18391. <![CDATA[Enable Heartbeat Interval Scaling based on cpu utilization.]]>
  18392. </doc>
  18393. </field>
  18394. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_SCALING_ENABLE" type="boolean"
  18395. transient="false" volatile="false"
  18396. static="true" final="true" visibility="public"
  18397. deprecated="not deprecated">
  18398. </field>
  18399. <field name="RM_NM_HEARTBEAT_INTERVAL_MIN_MS" type="java.lang.String"
  18400. transient="false" volatile="false"
  18401. static="true" final="true" visibility="public"
  18402. deprecated="not deprecated">
  18403. </field>
  18404. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MIN_MS" type="long"
  18405. transient="false" volatile="false"
  18406. static="true" final="true" visibility="public"
  18407. deprecated="not deprecated">
  18408. </field>
  18409. <field name="RM_NM_HEARTBEAT_INTERVAL_MAX_MS" type="java.lang.String"
  18410. transient="false" volatile="false"
  18411. static="true" final="true" visibility="public"
  18412. deprecated="not deprecated">
  18413. </field>
  18414. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MAX_MS" type="long"
  18415. transient="false" volatile="false"
  18416. static="true" final="true" visibility="public"
  18417. deprecated="not deprecated">
  18418. </field>
  18419. <field name="RM_NM_HEARTBEAT_INTERVAL_SPEEDUP_FACTOR" type="java.lang.String"
  18420. transient="false" volatile="false"
  18421. static="true" final="true" visibility="public"
  18422. deprecated="not deprecated">
  18423. </field>
  18424. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_SPEEDUP_FACTOR" type="float"
  18425. transient="false" volatile="false"
  18426. static="true" final="true" visibility="public"
  18427. deprecated="not deprecated">
  18428. </field>
  18429. <field name="RM_NM_HEARTBEAT_INTERVAL_SLOWDOWN_FACTOR" type="java.lang.String"
  18430. transient="false" volatile="false"
  18431. static="true" final="true" visibility="public"
  18432. deprecated="not deprecated">
  18433. </field>
  18434. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_SLOWDOWN_FACTOR" type="float"
  18435. transient="false" volatile="false"
  18436. static="true" final="true" visibility="public"
  18437. deprecated="not deprecated">
  18438. </field>
  18439. <field name="RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="java.lang.String"
  18440. transient="false" volatile="false"
  18441. static="true" final="true" visibility="public"
  18442. deprecated="not deprecated">
  18443. <doc>
  18444. <![CDATA[Number of worker threads that write the history data.]]>
  18445. </doc>
  18446. </field>
  18447. <field name="DEFAULT_RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="int"
  18448. transient="false" volatile="false"
  18449. static="true" final="true" visibility="public"
  18450. deprecated="not deprecated">
  18451. </field>
  18452. <field name="RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="java.lang.String"
  18453. transient="false" volatile="false"
  18454. static="true" final="true" visibility="public"
  18455. deprecated="not deprecated">
  18456. <doc>
  18457. <![CDATA[The setting that controls whether yarn system metrics is published on the
  18458. timeline server or not by RM. This configuration setting is for ATS V1.
  18459. This is now deprecated in favor of SYSTEM_METRICS_PUBLISHER_ENABLED.]]>
  18460. </doc>
  18461. </field>
  18462. <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="boolean"
  18463. transient="false" volatile="false"
  18464. static="true" final="true" visibility="public"
  18465. deprecated="not deprecated">
  18466. </field>
  18467. <field name="SYSTEM_METRICS_PUBLISHER_ENABLED" type="java.lang.String"
  18468. transient="false" volatile="false"
  18469. static="true" final="true" visibility="public"
  18470. deprecated="not deprecated">
  18471. <doc>
  18472. <![CDATA[The setting that controls whether yarn system metrics is published on the
  18473. timeline server or not by RM and NM. This configuration setting is for
  18474. ATS v2.]]>
  18475. </doc>
  18476. </field>
  18477. <field name="DEFAULT_SYSTEM_METRICS_PUBLISHER_ENABLED" type="boolean"
  18478. transient="false" volatile="false"
  18479. static="true" final="true" visibility="public"
  18480. deprecated="not deprecated">
  18481. </field>
  18482. <field name="RM_PUBLISH_CONTAINER_EVENTS_ENABLED" type="java.lang.String"
  18483. transient="false" volatile="false"
  18484. static="true" final="true" visibility="public"
  18485. deprecated="not deprecated">
  18486. <doc>
  18487. <![CDATA[The setting that controls whether yarn container events are published to
  18488. the timeline service or not by RM. This configuration setting is for ATS
  18489. V2]]>
  18490. </doc>
  18491. </field>
  18492. <field name="DEFAULT_RM_PUBLISH_CONTAINER_EVENTS_ENABLED" type="boolean"
  18493. transient="false" volatile="false"
  18494. static="true" final="true" visibility="public"
  18495. deprecated="not deprecated">
  18496. </field>
  18497. <field name="RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="java.lang.String"
  18498. transient="false" volatile="false"
  18499. static="true" final="true" visibility="public"
  18500. deprecated="not deprecated">
  18501. </field>
  18502. <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="int"
  18503. transient="false" volatile="false"
  18504. static="true" final="true" visibility="public"
  18505. deprecated="not deprecated">
  18506. </field>
  18507. <field name="RM_TIMELINE_SERVER_V1_PUBLISHER_DISPATCHER_BATCH_SIZE" type="java.lang.String"
  18508. transient="false" volatile="false"
  18509. static="true" final="true" visibility="public"
  18510. deprecated="not deprecated">
  18511. </field>
  18512. <field name="DEFAULT_RM_TIMELINE_SERVER_V1_PUBLISHER_DISPATCHER_BATCH_SIZE" type="int"
  18513. transient="false" volatile="false"
  18514. static="true" final="true" visibility="public"
  18515. deprecated="not deprecated">
  18516. </field>
  18517. <field name="RM_TIMELINE_SERVER_V1_PUBLISHER_INTERVAL" type="java.lang.String"
  18518. transient="false" volatile="false"
  18519. static="true" final="true" visibility="public"
  18520. deprecated="not deprecated">
  18521. </field>
  18522. <field name="DEFAULT_RM_TIMELINE_SERVER_V1_PUBLISHER_INTERVAL" type="int"
  18523. transient="false" volatile="false"
  18524. static="true" final="true" visibility="public"
  18525. deprecated="not deprecated">
  18526. </field>
  18527. <field name="RM_TIMELINE_SERVER_V1_PUBLISHER_BATCH_ENABLED" type="java.lang.String"
  18528. transient="false" volatile="false"
  18529. static="true" final="true" visibility="public"
  18530. deprecated="not deprecated">
  18531. </field>
  18532. <field name="DEFAULT_RM_TIMELINE_SERVER_V1_PUBLISHER_BATCH_ENABLED" type="boolean"
  18533. transient="false" volatile="false"
  18534. static="true" final="true" visibility="public"
  18535. deprecated="not deprecated">
  18536. </field>
  18537. <field name="RM_DELEGATION_KEY_UPDATE_INTERVAL_KEY" type="java.lang.String"
  18538. transient="false" volatile="false"
  18539. static="true" final="true" visibility="public"
  18540. deprecated="not deprecated">
  18541. </field>
  18542. <field name="RM_DELEGATION_KEY_UPDATE_INTERVAL_DEFAULT" type="long"
  18543. transient="false" volatile="false"
  18544. static="true" final="true" visibility="public"
  18545. deprecated="not deprecated">
  18546. </field>
  18547. <field name="RM_DELEGATION_TOKEN_RENEW_INTERVAL_KEY" type="java.lang.String"
  18548. transient="false" volatile="false"
  18549. static="true" final="true" visibility="public"
  18550. deprecated="not deprecated">
  18551. </field>
  18552. <field name="RM_DELEGATION_TOKEN_RENEW_INTERVAL_DEFAULT" type="long"
  18553. transient="false" volatile="false"
  18554. static="true" final="true" visibility="public"
  18555. deprecated="not deprecated">
  18556. </field>
  18557. <field name="RM_DELEGATION_TOKEN_MAX_LIFETIME_KEY" type="java.lang.String"
  18558. transient="false" volatile="false"
  18559. static="true" final="true" visibility="public"
  18560. deprecated="not deprecated">
  18561. </field>
  18562. <field name="RM_DELEGATION_TOKEN_MAX_LIFETIME_DEFAULT" type="long"
  18563. transient="false" volatile="false"
  18564. static="true" final="true" visibility="public"
  18565. deprecated="not deprecated">
  18566. </field>
  18567. <field name="RM_DELEGATION_TOKEN_MAX_CONF_SIZE" type="java.lang.String"
  18568. transient="false" volatile="false"
  18569. static="true" final="true" visibility="public"
  18570. deprecated="not deprecated">
  18571. </field>
  18572. <field name="DEFAULT_RM_DELEGATION_TOKEN_MAX_CONF_SIZE_BYTES" type="int"
  18573. transient="false" volatile="false"
  18574. static="true" final="true" visibility="public"
  18575. deprecated="not deprecated">
  18576. </field>
  18577. <field name="RM_DELEGATION_TOKEN_ALWAYS_CANCEL" type="java.lang.String"
  18578. transient="false" volatile="false"
  18579. static="true" final="true" visibility="public"
  18580. deprecated="not deprecated">
  18581. </field>
  18582. <field name="DEFAULT_RM_DELEGATION_TOKEN_ALWAYS_CANCEL" type="boolean"
  18583. transient="false" volatile="false"
  18584. static="true" final="true" visibility="public"
  18585. deprecated="not deprecated">
  18586. </field>
  18587. <field name="RM_DT_RENEWER_THREAD_TIMEOUT" type="java.lang.String"
  18588. transient="false" volatile="false"
  18589. static="true" final="true" visibility="public"
  18590. deprecated="not deprecated">
  18591. </field>
  18592. <field name="DEFAULT_RM_DT_RENEWER_THREAD_TIMEOUT" type="long"
  18593. transient="false" volatile="false"
  18594. static="true" final="true" visibility="public"
  18595. deprecated="not deprecated">
  18596. </field>
  18597. <field name="RM_DT_RENEWER_THREAD_RETRY_INTERVAL" type="java.lang.String"
  18598. transient="false" volatile="false"
  18599. static="true" final="true" visibility="public"
  18600. deprecated="not deprecated">
  18601. </field>
  18602. <field name="DEFAULT_RM_DT_RENEWER_THREAD_RETRY_INTERVAL" type="long"
  18603. transient="false" volatile="false"
  18604. static="true" final="true" visibility="public"
  18605. deprecated="not deprecated">
  18606. </field>
  18607. <field name="RM_DT_RENEWER_THREAD_RETRY_MAX_ATTEMPTS" type="java.lang.String"
  18608. transient="false" volatile="false"
  18609. static="true" final="true" visibility="public"
  18610. deprecated="not deprecated">
  18611. </field>
  18612. <field name="DEFAULT_RM_DT_RENEWER_THREAD_RETRY_MAX_ATTEMPTS" type="int"
  18613. transient="false" volatile="false"
  18614. static="true" final="true" visibility="public"
  18615. deprecated="not deprecated">
  18616. </field>
  18617. <field name="RECOVERY_ENABLED" type="java.lang.String"
  18618. transient="false" volatile="false"
  18619. static="true" final="true" visibility="public"
  18620. deprecated="not deprecated">
  18621. </field>
  18622. <field name="DEFAULT_RM_RECOVERY_ENABLED" type="boolean"
  18623. transient="false" volatile="false"
  18624. static="true" final="true" visibility="public"
  18625. deprecated="not deprecated">
  18626. </field>
  18627. <field name="YARN_FAIL_FAST" type="java.lang.String"
  18628. transient="false" volatile="false"
  18629. static="true" final="true" visibility="public"
  18630. deprecated="not deprecated">
  18631. </field>
  18632. <field name="DEFAULT_YARN_FAIL_FAST" type="boolean"
  18633. transient="false" volatile="false"
  18634. static="true" final="true" visibility="public"
  18635. deprecated="not deprecated">
  18636. </field>
  18637. <field name="RM_FAIL_FAST" type="java.lang.String"
  18638. transient="false" volatile="false"
  18639. static="true" final="true" visibility="public"
  18640. deprecated="not deprecated">
  18641. </field>
  18642. <field name="RM_WORK_PRESERVING_RECOVERY_ENABLED" type="java.lang.String"
  18643. transient="false" volatile="false"
  18644. static="true" final="true" visibility="public"
  18645. deprecated="not deprecated">
  18646. </field>
  18647. <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_ENABLED" type="boolean"
  18648. transient="false" volatile="false"
  18649. static="true" final="true" visibility="public"
  18650. deprecated="not deprecated">
  18651. </field>
  18652. <field name="RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="java.lang.String"
  18653. transient="false" volatile="false"
  18654. static="true" final="true" visibility="public"
  18655. deprecated="not deprecated">
  18656. </field>
  18657. <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="long"
  18658. transient="false" volatile="false"
  18659. static="true" final="true" visibility="public"
  18660. deprecated="not deprecated">
  18661. </field>
  18662. <field name="RM_ZK_PREFIX" type="java.lang.String"
  18663. transient="false" volatile="false"
  18664. static="true" final="true" visibility="public"
  18665. deprecated="not deprecated">
  18666. <doc>
  18667. <![CDATA[Zookeeper interaction configs]]>
  18668. </doc>
  18669. </field>
  18670. <field name="RM_ZK_ADDRESS" type="java.lang.String"
  18671. transient="false" volatile="false"
  18672. static="true" final="true" visibility="public"
  18673. deprecated="not deprecated">
  18674. </field>
  18675. <field name="RM_ZK_NUM_RETRIES" type="java.lang.String"
  18676. transient="false" volatile="false"
  18677. static="true" final="true" visibility="public"
  18678. deprecated="not deprecated">
  18679. </field>
  18680. <field name="DEFAULT_ZK_RM_NUM_RETRIES" type="int"
  18681. transient="false" volatile="false"
  18682. static="true" final="true" visibility="public"
  18683. deprecated="not deprecated">
  18684. </field>
  18685. <field name="RM_ZK_ZNODE_SIZE_LIMIT_BYTES" type="java.lang.String"
  18686. transient="false" volatile="false"
  18687. static="true" final="true" visibility="public"
  18688. deprecated="not deprecated">
  18689. <doc>
  18690. <![CDATA[Zookeeper znode limit]]>
  18691. </doc>
  18692. </field>
  18693. <field name="DEFAULT_RM_ZK_ZNODE_SIZE_LIMIT_BYTES" type="int"
  18694. transient="false" volatile="false"
  18695. static="true" final="true" visibility="public"
  18696. deprecated="not deprecated">
  18697. </field>
  18698. <field name="RM_ZK_RETRY_INTERVAL_MS" type="java.lang.String"
  18699. transient="false" volatile="false"
  18700. static="true" final="true" visibility="public"
  18701. deprecated="not deprecated">
  18702. </field>
  18703. <field name="DEFAULT_RM_ZK_RETRY_INTERVAL_MS" type="int"
  18704. transient="false" volatile="false"
  18705. static="true" final="true" visibility="public"
  18706. deprecated="not deprecated">
  18707. </field>
  18708. <field name="RM_ZK_TIMEOUT_MS" type="java.lang.String"
  18709. transient="false" volatile="false"
  18710. static="true" final="true" visibility="public"
  18711. deprecated="not deprecated">
  18712. </field>
  18713. <field name="DEFAULT_RM_ZK_TIMEOUT_MS" type="int"
  18714. transient="false" volatile="false"
  18715. static="true" final="true" visibility="public"
  18716. deprecated="not deprecated">
  18717. </field>
  18718. <field name="ZK_APPID_NODE_SPLIT_INDEX" type="java.lang.String"
  18719. transient="false" volatile="false"
  18720. static="true" final="true" visibility="public"
  18721. deprecated="not deprecated">
  18722. </field>
  18723. <field name="DEFAULT_ZK_APPID_NODE_SPLIT_INDEX" type="int"
  18724. transient="false" volatile="false"
  18725. static="true" final="true" visibility="public"
  18726. deprecated="not deprecated">
  18727. </field>
  18728. <field name="ZK_DELEGATION_TOKEN_NODE_SPLIT_INDEX" type="java.lang.String"
  18729. transient="false" volatile="false"
  18730. static="true" final="true" visibility="public"
  18731. deprecated="not deprecated">
  18732. <doc>
  18733. <![CDATA[Index at which the RM Delegation Token ids will be split so that the
  18734. delegation token znodes stored in the zookeeper RM state store will be
  18735. stored as two different znodes (parent-child).]]>
  18736. </doc>
  18737. </field>
  18738. <field name="DEFAULT_ZK_DELEGATION_TOKEN_NODE_SPLIT_INDEX" type="int"
  18739. transient="false" volatile="false"
  18740. static="true" final="true" visibility="public"
  18741. deprecated="not deprecated">
  18742. </field>
  18743. <field name="RM_ZK_ACL" type="java.lang.String"
  18744. transient="false" volatile="false"
  18745. static="true" final="true" visibility="public"
  18746. deprecated="not deprecated">
  18747. </field>
  18748. <field name="DEFAULT_RM_ZK_ACL" type="java.lang.String"
  18749. transient="false" volatile="false"
  18750. static="true" final="true" visibility="public"
  18751. deprecated="not deprecated">
  18752. </field>
  18753. <field name="RM_ZK_AUTH" type="java.lang.String"
  18754. transient="false" volatile="false"
  18755. static="true" final="true" visibility="public"
  18756. deprecated="not deprecated">
  18757. </field>
  18758. <field name="ZK_STATE_STORE_PREFIX" type="java.lang.String"
  18759. transient="false" volatile="false"
  18760. static="true" final="true" visibility="public"
  18761. deprecated="not deprecated">
  18762. </field>
  18763. <field name="ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
  18764. transient="false" volatile="false"
  18765. static="true" final="true" visibility="public"
  18766. deprecated="not deprecated">
  18767. <doc>
  18768. <![CDATA[Parent znode path under which ZKRMStateStore will create znodes]]>
  18769. </doc>
  18770. </field>
  18771. <field name="DEFAULT_ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
  18772. transient="false" volatile="false"
  18773. static="true" final="true" visibility="public"
  18774. deprecated="not deprecated">
  18775. </field>
  18776. <field name="ZK_RM_STATE_STORE_ROOT_NODE_ACL" type="java.lang.String"
  18777. transient="false" volatile="false"
  18778. static="true" final="true" visibility="public"
  18779. deprecated="not deprecated">
  18780. <doc>
  18781. <![CDATA[Root node ACLs for fencing]]>
  18782. </doc>
  18783. </field>
  18784. <field name="RM_HA_PREFIX" type="java.lang.String"
  18785. transient="false" volatile="false"
  18786. static="true" final="true" visibility="public"
  18787. deprecated="not deprecated">
  18788. <doc>
  18789. <![CDATA[HA related configs]]>
  18790. </doc>
  18791. </field>
  18792. <field name="RM_HA_ENABLED" type="java.lang.String"
  18793. transient="false" volatile="false"
  18794. static="true" final="true" visibility="public"
  18795. deprecated="not deprecated">
  18796. </field>
  18797. <field name="DEFAULT_RM_HA_ENABLED" type="boolean"
  18798. transient="false" volatile="false"
  18799. static="true" final="true" visibility="public"
  18800. deprecated="not deprecated">
  18801. </field>
  18802. <field name="RM_HA_IDS" type="java.lang.String"
  18803. transient="false" volatile="false"
  18804. static="true" final="true" visibility="public"
  18805. deprecated="not deprecated">
  18806. </field>
  18807. <field name="RM_HA_ID" type="java.lang.String"
  18808. transient="false" volatile="false"
  18809. static="true" final="true" visibility="public"
  18810. deprecated="not deprecated">
  18811. </field>
  18812. <field name="FS_BASED_RM_CONF_STORE" type="java.lang.String"
  18813. transient="false" volatile="false"
  18814. static="true" final="true" visibility="public"
  18815. deprecated="not deprecated">
  18816. <doc>
  18817. <![CDATA[Store the related configuration files in File System]]>
  18818. </doc>
  18819. </field>
  18820. <field name="DEFAULT_FS_BASED_RM_CONF_STORE" type="java.lang.String"
  18821. transient="false" volatile="false"
  18822. static="true" final="true" visibility="public"
  18823. deprecated="not deprecated">
  18824. </field>
  18825. <field name="RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
  18826. transient="false" volatile="false"
  18827. static="true" final="true" visibility="public"
  18828. deprecated="not deprecated">
  18829. </field>
  18830. <field name="DEFAULT_RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
  18831. transient="false" volatile="false"
  18832. static="true" final="true" visibility="public"
  18833. deprecated="not deprecated">
  18834. </field>
  18835. <field name="SCHEDULER_CONFIGURATION_STORE_CLASS" type="java.lang.String"
  18836. transient="false" volatile="false"
  18837. static="true" final="true" visibility="public"
  18838. deprecated="not deprecated">
  18839. </field>
  18840. <field name="FILE_CONFIGURATION_STORE" type="java.lang.String"
  18841. transient="false" volatile="false"
  18842. static="true" final="true" visibility="public"
  18843. deprecated="not deprecated">
  18844. </field>
  18845. <field name="MEMORY_CONFIGURATION_STORE" type="java.lang.String"
  18846. transient="false" volatile="false"
  18847. static="true" final="true" visibility="public"
  18848. deprecated="not deprecated">
  18849. </field>
  18850. <field name="FS_CONFIGURATION_STORE" type="java.lang.String"
  18851. transient="false" volatile="false"
  18852. static="true" final="true" visibility="public"
  18853. deprecated="not deprecated">
  18854. </field>
  18855. <field name="ZK_CONFIGURATION_STORE" type="java.lang.String"
  18856. transient="false" volatile="false"
  18857. static="true" final="true" visibility="public"
  18858. deprecated="not deprecated">
  18859. </field>
  18860. <field name="LEVELDB_CONFIGURATION_STORE" type="java.lang.String"
  18861. transient="false" volatile="false"
  18862. static="true" final="true" visibility="public"
  18863. deprecated="not deprecated">
  18864. </field>
  18865. <field name="DEFAULT_CONFIGURATION_STORE" type="java.lang.String"
  18866. transient="false" volatile="false"
  18867. static="true" final="true" visibility="public"
  18868. deprecated="not deprecated">
  18869. </field>
  18870. <field name="RM_SCHEDCONF_STORE_PATH" type="java.lang.String"
  18871. transient="false" volatile="false"
  18872. static="true" final="true" visibility="public"
  18873. deprecated="not deprecated">
  18874. </field>
  18875. <field name="RM_SCHEDCONF_LEVELDB_COMPACTION_INTERVAL_SECS" type="java.lang.String"
  18876. transient="false" volatile="false"
  18877. static="true" final="true" visibility="public"
  18878. deprecated="not deprecated">
  18879. </field>
  18880. <field name="DEFAULT_RM_SCHEDCONF_LEVELDB_COMPACTION_INTERVAL_SECS" type="long"
  18881. transient="false" volatile="false"
  18882. static="true" final="true" visibility="public"
  18883. deprecated="not deprecated">
  18884. </field>
  18885. <field name="RM_SCHEDCONF_MAX_LOGS" type="java.lang.String"
  18886. transient="false" volatile="false"
  18887. static="true" final="true" visibility="public"
  18888. deprecated="not deprecated">
  18889. </field>
  18890. <field name="DEFAULT_RM_SCHEDCONF_LEVELDB_MAX_LOGS" type="long"
  18891. transient="false" volatile="false"
  18892. static="true" final="true" visibility="public"
  18893. deprecated="not deprecated">
  18894. </field>
  18895. <field name="DEFAULT_RM_SCHEDCONF_ZK_MAX_LOGS" type="long"
  18896. transient="false" volatile="false"
  18897. static="true" final="true" visibility="public"
  18898. deprecated="not deprecated">
  18899. </field>
  18900. <field name="SCHEDULER_CONFIGURATION_FS_PATH" type="java.lang.String"
  18901. transient="false" volatile="false"
  18902. static="true" final="true" visibility="public"
  18903. deprecated="not deprecated">
  18904. </field>
  18905. <field name="SCHEDULER_CONFIGURATION_FS_MAX_VERSION" type="java.lang.String"
  18906. transient="false" volatile="false"
  18907. static="true" final="true" visibility="public"
  18908. deprecated="not deprecated">
  18909. </field>
  18910. <field name="DEFAULT_SCHEDULER_CONFIGURATION_FS_MAX_VERSION" type="int"
  18911. transient="false" volatile="false"
  18912. static="true" final="true" visibility="public"
  18913. deprecated="not deprecated">
  18914. </field>
  18915. <field name="RM_SCHEDCONF_STORE_ZK_PARENT_PATH" type="java.lang.String"
  18916. transient="false" volatile="false"
  18917. static="true" final="true" visibility="public"
  18918. deprecated="not deprecated">
  18919. <doc>
  18920. <![CDATA[Parent znode path under which ZKConfigurationStore will create znodes.]]>
  18921. </doc>
  18922. </field>
  18923. <field name="DEFAULT_RM_SCHEDCONF_STORE_ZK_PARENT_PATH" type="java.lang.String"
  18924. transient="false" volatile="false"
  18925. static="true" final="true" visibility="public"
  18926. deprecated="not deprecated">
  18927. </field>
  18928. <field name="RM_SCHEDULER_MUTATION_ACL_POLICY_CLASS" type="java.lang.String"
  18929. transient="false" volatile="false"
  18930. static="true" final="true" visibility="public"
  18931. deprecated="not deprecated">
  18932. </field>
  18933. <field name="YARN_AUTHORIZATION_PROVIDER" type="java.lang.String"
  18934. transient="false" volatile="false"
  18935. static="true" final="true" visibility="public"
  18936. deprecated="not deprecated">
  18937. </field>
  18938. <field name="AUTO_FAILOVER_PREFIX" type="java.lang.String"
  18939. transient="false" volatile="false"
  18940. static="true" final="true" visibility="public"
  18941. deprecated="not deprecated">
  18942. </field>
  18943. <field name="AUTO_FAILOVER_ENABLED" type="java.lang.String"
  18944. transient="false" volatile="false"
  18945. static="true" final="true" visibility="public"
  18946. deprecated="not deprecated">
  18947. </field>
  18948. <field name="DEFAULT_AUTO_FAILOVER_ENABLED" type="boolean"
  18949. transient="false" volatile="false"
  18950. static="true" final="true" visibility="public"
  18951. deprecated="not deprecated">
  18952. </field>
  18953. <field name="AUTO_FAILOVER_EMBEDDED" type="java.lang.String"
  18954. transient="false" volatile="false"
  18955. static="true" final="true" visibility="public"
  18956. deprecated="This property should never be set to {@code false}.">
  18957. <doc>
  18958. <![CDATA[This property controls whether {@link ActiveStandbyElector} leader
  18959. election should be used when {@link #CURATOR_LEADER_ELECTOR} is
  18960. {@code false}.
  18961. @deprecated This property should never be set to {@code false}.]]>
  18962. </doc>
  18963. </field>
  18964. <field name="DEFAULT_AUTO_FAILOVER_EMBEDDED" type="boolean"
  18965. transient="false" volatile="false"
  18966. static="true" final="true" visibility="public"
  18967. deprecated="The {@link #AUTO_FAILOVER_EMBEDDED} property is deprecated.">
  18968. <doc>
  18969. <![CDATA[The default value for {@link #AUTO_FAILOVER_EMBEDDED}.
  18970. @deprecated The {@link #AUTO_FAILOVER_EMBEDDED} property is deprecated.]]>
  18971. </doc>
  18972. </field>
  18973. <field name="AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
  18974. transient="false" volatile="false"
  18975. static="true" final="true" visibility="public"
  18976. deprecated="not deprecated">
  18977. </field>
  18978. <field name="DEFAULT_AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
  18979. transient="false" volatile="false"
  18980. static="true" final="true" visibility="public"
  18981. deprecated="not deprecated">
  18982. </field>
  18983. <field name="CLIENT_FAILOVER_PREFIX" type="java.lang.String"
  18984. transient="false" volatile="false"
  18985. static="true" final="true" visibility="public"
  18986. deprecated="not deprecated">
  18987. </field>
  18988. <field name="CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
  18989. transient="false" volatile="false"
  18990. static="true" final="true" visibility="public"
  18991. deprecated="not deprecated">
  18992. </field>
  18993. <field name="DEFAULT_CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
  18994. transient="false" volatile="false"
  18995. static="true" final="true" visibility="public"
  18996. deprecated="not deprecated">
  18997. </field>
  18998. <field name="CLIENT_FAILOVER_NO_HA_PROXY_PROVIDER" type="java.lang.String"
  18999. transient="false" volatile="false"
  19000. static="true" final="true" visibility="public"
  19001. deprecated="not deprecated">
  19002. </field>
  19003. <field name="DEFAULT_CLIENT_FAILOVER_NO_HA_PROXY_PROVIDER" type="java.lang.String"
  19004. transient="false" volatile="false"
  19005. static="true" final="true" visibility="public"
  19006. deprecated="not deprecated">
  19007. </field>
  19008. <field name="CLIENT_FAILOVER_MAX_ATTEMPTS" type="java.lang.String"
  19009. transient="false" volatile="false"
  19010. static="true" final="true" visibility="public"
  19011. deprecated="not deprecated">
  19012. </field>
  19013. <field name="CLIENT_FAILOVER_SLEEPTIME_BASE_MS" type="java.lang.String"
  19014. transient="false" volatile="false"
  19015. static="true" final="true" visibility="public"
  19016. deprecated="not deprecated">
  19017. </field>
  19018. <field name="CLIENT_FAILOVER_SLEEPTIME_MAX_MS" type="java.lang.String"
  19019. transient="false" volatile="false"
  19020. static="true" final="true" visibility="public"
  19021. deprecated="not deprecated">
  19022. </field>
  19023. <field name="CLIENT_FAILOVER_RETRIES" type="java.lang.String"
  19024. transient="false" volatile="false"
  19025. static="true" final="true" visibility="public"
  19026. deprecated="not deprecated">
  19027. </field>
  19028. <field name="DEFAULT_CLIENT_FAILOVER_RETRIES" type="int"
  19029. transient="false" volatile="false"
  19030. static="true" final="true" visibility="public"
  19031. deprecated="not deprecated">
  19032. </field>
  19033. <field name="CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="java.lang.String"
  19034. transient="false" volatile="false"
  19035. static="true" final="true" visibility="public"
  19036. deprecated="not deprecated">
  19037. </field>
  19038. <field name="DEFAULT_CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="int"
  19039. transient="false" volatile="false"
  19040. static="true" final="true" visibility="public"
  19041. deprecated="not deprecated">
  19042. </field>
  19043. <field name="RM_HA_FC_ELECTOR_ZK_RETRIES_KEY" type="java.lang.String"
  19044. transient="false" volatile="false"
  19045. static="true" final="true" visibility="public"
  19046. deprecated="not deprecated">
  19047. <doc>
  19048. <![CDATA[number of zookeeper operation retry times in ActiveStandbyElector]]>
  19049. </doc>
  19050. </field>
  19051. <field name="CURATOR_LEADER_ELECTOR" type="java.lang.String"
  19052. transient="false" volatile="false"
  19053. static="true" final="true" visibility="public"
  19054. deprecated="Eventually, we want to default to the curator-based
  19055. implementation and remove the {@link ActiveStandbyElector} based
  19056. implementation. We should remove this config then.">
  19057. <doc>
  19058. <![CDATA[Whether to use the Curator-based elector for leader election.
  19059. @deprecated Eventually, we want to default to the curator-based
  19060. implementation and remove the {@link ActiveStandbyElector} based
  19061. implementation. We should remove this config then.]]>
  19062. </doc>
  19063. </field>
  19064. <field name="DEFAULT_CURATOR_LEADER_ELECTOR_ENABLED" type="boolean"
  19065. transient="false" volatile="false"
  19066. static="true" final="true" visibility="public"
  19067. deprecated="not deprecated">
  19068. </field>
  19069. <field name="RM_STORE" type="java.lang.String"
  19070. transient="false" volatile="false"
  19071. static="true" final="true" visibility="public"
  19072. deprecated="not deprecated">
  19073. <doc>
  19074. <![CDATA[The class to use as the persistent store.]]>
  19075. </doc>
  19076. </field>
  19077. <field name="FS_RM_STATE_STORE_URI" type="java.lang.String"
  19078. transient="false" volatile="false"
  19079. static="true" final="true" visibility="public"
  19080. deprecated="not deprecated">
  19081. <doc>
  19082. <![CDATA[URI for FileSystemRMStateStore]]>
  19083. </doc>
  19084. </field>
  19085. <field name="FS_RM_STATE_STORE_NUM_RETRIES" type="java.lang.String"
  19086. transient="false" volatile="false"
  19087. static="true" final="true" visibility="public"
  19088. deprecated="not deprecated">
  19089. </field>
  19090. <field name="DEFAULT_FS_RM_STATE_STORE_NUM_RETRIES" type="int"
  19091. transient="false" volatile="false"
  19092. static="true" final="true" visibility="public"
  19093. deprecated="not deprecated">
  19094. </field>
  19095. <field name="FS_RM_STATE_STORE_RETRY_INTERVAL_MS" type="java.lang.String"
  19096. transient="false" volatile="false"
  19097. static="true" final="true" visibility="public"
  19098. deprecated="not deprecated">
  19099. </field>
  19100. <field name="DEFAULT_FS_RM_STATE_STORE_RETRY_INTERVAL_MS" type="long"
  19101. transient="false" volatile="false"
  19102. static="true" final="true" visibility="public"
  19103. deprecated="not deprecated">
  19104. </field>
  19105. <field name="RM_LEVELDB_STORE_PATH" type="java.lang.String"
  19106. transient="false" volatile="false"
  19107. static="true" final="true" visibility="public"
  19108. deprecated="not deprecated">
  19109. </field>
  19110. <field name="RM_LEVELDB_COMPACTION_INTERVAL_SECS" type="java.lang.String"
  19111. transient="false" volatile="false"
  19112. static="true" final="true" visibility="public"
  19113. deprecated="not deprecated">
  19114. <doc>
  19115. <![CDATA[The time in seconds between full compactions of the leveldb database.
  19116. Setting the interval to zero disables the full compaction cycles.]]>
  19117. </doc>
  19118. </field>
  19119. <field name="DEFAULT_RM_LEVELDB_COMPACTION_INTERVAL_SECS" type="long"
  19120. transient="false" volatile="false"
  19121. static="true" final="true" visibility="public"
  19122. deprecated="not deprecated">
  19123. </field>
  19124. <field name="RM_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
  19125. transient="false" volatile="false"
  19126. static="true" final="true" visibility="public"
  19127. deprecated="not deprecated">
  19128. <doc>
  19129. <![CDATA[The maximum number of completed applications RM keeps. By default equals
  19130. to {@link #DEFAULT_RM_MAX_COMPLETED_APPLICATIONS}.]]>
  19131. </doc>
  19132. </field>
  19133. <field name="DEFAULT_RM_MAX_COMPLETED_APPLICATIONS" type="int"
  19134. transient="false" volatile="false"
  19135. static="true" final="true" visibility="public"
  19136. deprecated="not deprecated">
  19137. </field>
  19138. <field name="RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
  19139. transient="false" volatile="false"
  19140. static="true" final="true" visibility="public"
  19141. deprecated="not deprecated">
  19142. <doc>
  19143. <![CDATA[The maximum number of completed applications RM state store keeps. By
  19144. default equals to value of {@link #RM_MAX_COMPLETED_APPLICATIONS}.]]>
  19145. </doc>
  19146. </field>
  19147. <field name="DEFAULT_RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="int"
  19148. transient="false" volatile="false"
  19149. static="true" final="true" visibility="public"
  19150. deprecated="This default value is ignored and will be removed in a future
  19151. release. The default value of
  19152. {@code yarn.resourcemanager.state-store.max-completed-applications} is the
  19153. value of {@link #RM_MAX_COMPLETED_APPLICATIONS}.">
  19154. <doc>
  19155. <![CDATA[The default value for
  19156. {@code yarn.resourcemanager.state-store.max-completed-applications}.
  19157. @deprecated This default value is ignored and will be removed in a future
  19158. release. The default value of
  19159. {@code yarn.resourcemanager.state-store.max-completed-applications} is the
  19160. value of {@link #RM_MAX_COMPLETED_APPLICATIONS}.]]>
  19161. </doc>
  19162. </field>
  19163. <field name="DEFAULT_APPLICATION_NAME" type="java.lang.String"
  19164. transient="false" volatile="false"
  19165. static="true" final="true" visibility="public"
  19166. deprecated="not deprecated">
  19167. <doc>
  19168. <![CDATA[Default application name]]>
  19169. </doc>
  19170. </field>
  19171. <field name="DEFAULT_APPLICATION_TYPE" type="java.lang.String"
  19172. transient="false" volatile="false"
  19173. static="true" final="true" visibility="public"
  19174. deprecated="not deprecated">
  19175. <doc>
  19176. <![CDATA[Default application type]]>
  19177. </doc>
  19178. </field>
  19179. <field name="APPLICATION_TYPE_LENGTH" type="int"
  19180. transient="false" volatile="false"
  19181. static="true" final="true" visibility="public"
  19182. deprecated="not deprecated">
  19183. <doc>
  19184. <![CDATA[Default application type length]]>
  19185. </doc>
  19186. </field>
  19187. <field name="DEFAULT_QUEUE_NAME" type="java.lang.String"
  19188. transient="false" volatile="false"
  19189. static="true" final="true" visibility="public"
  19190. deprecated="not deprecated">
  19191. <doc>
  19192. <![CDATA[Default queue name]]>
  19193. </doc>
  19194. </field>
  19195. <field name="RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
  19196. transient="false" volatile="false"
  19197. static="true" final="true" visibility="public"
  19198. deprecated="not deprecated">
  19199. <doc>
  19200. <![CDATA[Buckets (in minutes) for the number of apps running in each queue.]]>
  19201. </doc>
  19202. </field>
  19203. <field name="DEFAULT_RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
  19204. transient="false" volatile="false"
  19205. static="true" final="true" visibility="public"
  19206. deprecated="not deprecated">
  19207. <doc>
  19208. <![CDATA[Default sizes of the runtime metric buckets in minutes.]]>
  19209. </doc>
  19210. </field>
  19211. <field name="RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  19212. transient="false" volatile="false"
  19213. static="true" final="true" visibility="public"
  19214. deprecated="not deprecated">
  19215. </field>
  19216. <field name="DEFAULT_RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  19217. transient="false" volatile="false"
  19218. static="true" final="true" visibility="public"
  19219. deprecated="not deprecated">
  19220. </field>
  19221. <field name="RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  19222. transient="false" volatile="false"
  19223. static="true" final="true" visibility="public"
  19224. deprecated="not deprecated">
  19225. </field>
  19226. <field name="DEFAULT_RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  19227. transient="false" volatile="false"
  19228. static="true" final="true" visibility="public"
  19229. deprecated="not deprecated">
  19230. </field>
  19231. <field name="RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  19232. transient="false" volatile="false"
  19233. static="true" final="true" visibility="public"
  19234. deprecated="not deprecated">
  19235. </field>
  19236. <field name="DEFAULT_RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  19237. transient="false" volatile="false"
  19238. static="true" final="true" visibility="public"
  19239. deprecated="not deprecated">
  19240. </field>
  19241. <field name="RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  19242. transient="false" volatile="false"
  19243. static="true" final="true" visibility="public"
  19244. deprecated="not deprecated">
  19245. </field>
  19246. <field name="DEFAULT_RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  19247. transient="false" volatile="false"
  19248. static="true" final="true" visibility="public"
  19249. deprecated="not deprecated">
  19250. </field>
  19251. <field name="RM_NODEMANAGER_UNTRACKED_REMOVAL_TIMEOUT_MSEC" type="java.lang.String"
  19252. transient="false" volatile="false"
  19253. static="true" final="true" visibility="public"
  19254. deprecated="not deprecated">
  19255. <doc>
  19256. <![CDATA[Timeout(msec) for an untracked node to remain in shutdown or decommissioned
  19257. state.]]>
  19258. </doc>
  19259. </field>
  19260. <field name="DEFAULT_RM_NODEMANAGER_UNTRACKED_REMOVAL_TIMEOUT_MSEC" type="int"
  19261. transient="false" volatile="false"
  19262. static="true" final="true" visibility="public"
  19263. deprecated="not deprecated">
  19264. </field>
  19265. <field name="RM_PROXY_USER_PREFIX" type="java.lang.String"
  19266. transient="false" volatile="false"
  19267. static="true" final="true" visibility="public"
  19268. deprecated="not deprecated">
  19269. <doc>
  19270. <![CDATA[RM proxy users' prefix]]>
  19271. </doc>
  19272. </field>
  19273. <field name="RM_RESOURCE_PROFILES_ENABLED" type="java.lang.String"
  19274. transient="false" volatile="false"
  19275. static="true" final="true" visibility="public"
  19276. deprecated="not deprecated">
  19277. <doc>
  19278. <![CDATA[Enable/disable resource profiles.]]>
  19279. </doc>
  19280. </field>
  19281. <field name="DEFAULT_RM_RESOURCE_PROFILES_ENABLED" type="boolean"
  19282. transient="false" volatile="false"
  19283. static="true" final="true" visibility="public"
  19284. deprecated="not deprecated">
  19285. </field>
  19286. <field name="RM_RESOURCE_PROFILES_SOURCE_FILE" type="java.lang.String"
  19287. transient="false" volatile="false"
  19288. static="true" final="true" visibility="public"
  19289. deprecated="not deprecated">
  19290. <doc>
  19291. <![CDATA[File containing resource profiles.]]>
  19292. </doc>
  19293. </field>
  19294. <field name="DEFAULT_RM_RESOURCE_PROFILES_SOURCE_FILE" 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="YARN_CLIENT_LOAD_RESOURCETYPES_FROM_SERVER" type="java.lang.String"
  19300. transient="false" volatile="false"
  19301. static="true" final="true" visibility="public"
  19302. deprecated="not deprecated">
  19303. <doc>
  19304. <![CDATA[Enable/disable loading resource-types.xml at client side.]]>
  19305. </doc>
  19306. </field>
  19307. <field name="DEFAULT_YARN_CLIENT_LOAD_RESOURCETYPES_FROM_SERVER" type="boolean"
  19308. transient="false" volatile="false"
  19309. static="true" final="true" visibility="public"
  19310. deprecated="not deprecated">
  19311. </field>
  19312. <field name="RM_NODE_GRACEFUL_DECOMMISSION_TIMEOUT" type="java.lang.String"
  19313. transient="false" volatile="false"
  19314. static="true" final="true" visibility="public"
  19315. deprecated="not deprecated">
  19316. <doc>
  19317. <![CDATA[Timeout in seconds for YARN node graceful decommission.
  19318. This is the maximal time to wait for running containers and applications
  19319. to complete before transition a DECOMMISSIONING node into DECOMMISSIONED.]]>
  19320. </doc>
  19321. </field>
  19322. <field name="DEFAULT_RM_NODE_GRACEFUL_DECOMMISSION_TIMEOUT" type="int"
  19323. transient="false" volatile="false"
  19324. static="true" final="true" visibility="public"
  19325. deprecated="not deprecated">
  19326. </field>
  19327. <field name="RM_DECOMMISSIONING_NODES_WATCHER_POLL_INTERVAL" type="java.lang.String"
  19328. transient="false" volatile="false"
  19329. static="true" final="true" visibility="public"
  19330. deprecated="not deprecated">
  19331. <doc>
  19332. <![CDATA[Period in seconds of the poll timer task inside DecommissioningNodesWatcher
  19333. to identify and take care of DECOMMISSIONING nodes missing regular heart beat.]]>
  19334. </doc>
  19335. </field>
  19336. <field name="DEFAULT_RM_DECOMMISSIONING_NODES_WATCHER_POLL_INTERVAL" type="int"
  19337. transient="false" volatile="false"
  19338. static="true" final="true" visibility="public"
  19339. deprecated="not deprecated">
  19340. </field>
  19341. <field name="NM_PREFIX" type="java.lang.String"
  19342. transient="false" volatile="false"
  19343. static="true" final="true" visibility="public"
  19344. deprecated="not deprecated">
  19345. <doc>
  19346. <![CDATA[Prefix for all node manager configs.]]>
  19347. </doc>
  19348. </field>
  19349. <field name="NM_OPPORTUNISTIC_CONTAINERS_MAX_QUEUE_LENGTH" type="java.lang.String"
  19350. transient="false" volatile="false"
  19351. static="true" final="true" visibility="public"
  19352. deprecated="not deprecated">
  19353. <doc>
  19354. <![CDATA[Max Queue length of <code>OPPORTUNISTIC</code> containers on the NM.]]>
  19355. </doc>
  19356. </field>
  19357. <field name="DEFAULT_NM_OPPORTUNISTIC_CONTAINERS_MAX_QUEUE_LENGTH" type="int"
  19358. transient="false" volatile="false"
  19359. static="true" final="true" visibility="public"
  19360. deprecated="not deprecated">
  19361. </field>
  19362. <field name="DIST_SCHEDULING_ENABLED" type="java.lang.String"
  19363. transient="false" volatile="false"
  19364. static="true" final="true" visibility="public"
  19365. deprecated="not deprecated">
  19366. <doc>
  19367. <![CDATA[Setting that controls whether distributed scheduling is enabled or not.]]>
  19368. </doc>
  19369. </field>
  19370. <field name="DEFAULT_DIST_SCHEDULING_ENABLED" type="boolean"
  19371. transient="false" volatile="false"
  19372. static="true" final="true" visibility="public"
  19373. deprecated="not deprecated">
  19374. </field>
  19375. <field name="NM_ADMIN_USER_ENV" type="java.lang.String"
  19376. transient="false" volatile="false"
  19377. static="true" final="true" visibility="public"
  19378. deprecated="not deprecated">
  19379. <doc>
  19380. <![CDATA[Environment variables that will be sent to containers.]]>
  19381. </doc>
  19382. </field>
  19383. <field name="DEFAULT_NM_ADMIN_USER_ENV" type="java.lang.String"
  19384. transient="false" volatile="false"
  19385. static="true" final="true" visibility="public"
  19386. deprecated="not deprecated">
  19387. </field>
  19388. <field name="NM_ADMIN_FORCE_PATH" type="java.lang.String"
  19389. transient="false" volatile="false"
  19390. static="true" final="true" visibility="public"
  19391. deprecated="not deprecated">
  19392. <doc>
  19393. <![CDATA[PATH components that will be prepended to the user's path.
  19394. If this is defined and the user does not define PATH, NM will also
  19395. append ":$PATH" to prevent this from eclipsing the PATH defined in
  19396. the container. This feature is only available for Linux.]]>
  19397. </doc>
  19398. </field>
  19399. <field name="DEFAULT_NM_ADMIN_FORCE_PATH" type="java.lang.String"
  19400. transient="false" volatile="false"
  19401. static="true" final="true" visibility="public"
  19402. deprecated="not deprecated">
  19403. </field>
  19404. <field name="NM_ENV_WHITELIST" type="java.lang.String"
  19405. transient="false" volatile="false"
  19406. static="true" final="true" visibility="public"
  19407. deprecated="not deprecated">
  19408. <doc>
  19409. <![CDATA[Environment variables that containers may override rather than use NodeManager's default.]]>
  19410. </doc>
  19411. </field>
  19412. <field name="DEFAULT_NM_ENV_WHITELIST" type="java.lang.String"
  19413. transient="false" volatile="false"
  19414. static="true" final="true" visibility="public"
  19415. deprecated="not deprecated">
  19416. </field>
  19417. <field name="NM_ADDRESS" type="java.lang.String"
  19418. transient="false" volatile="false"
  19419. static="true" final="true" visibility="public"
  19420. deprecated="not deprecated">
  19421. <doc>
  19422. <![CDATA[address of node manager IPC.]]>
  19423. </doc>
  19424. </field>
  19425. <field name="DEFAULT_NM_PORT" type="int"
  19426. transient="false" volatile="false"
  19427. static="true" final="true" visibility="public"
  19428. deprecated="not deprecated">
  19429. </field>
  19430. <field name="DEFAULT_NM_ADDRESS" type="java.lang.String"
  19431. transient="false" volatile="false"
  19432. static="true" final="true" visibility="public"
  19433. deprecated="not deprecated">
  19434. </field>
  19435. <field name="NM_BIND_HOST" type="java.lang.String"
  19436. transient="false" volatile="false"
  19437. static="true" final="true" visibility="public"
  19438. deprecated="not deprecated">
  19439. <doc>
  19440. <![CDATA[The actual bind address for the NM.]]>
  19441. </doc>
  19442. </field>
  19443. <field name="NM_CONTAINER_EXECUTOR" type="java.lang.String"
  19444. transient="false" volatile="false"
  19445. static="true" final="true" visibility="public"
  19446. deprecated="not deprecated">
  19447. <doc>
  19448. <![CDATA[who will execute(launch) the containers.]]>
  19449. </doc>
  19450. </field>
  19451. <field name="NM_CONTAINER_STATE_TRANSITION_LISTENERS" type="java.lang.String"
  19452. transient="false" volatile="false"
  19453. static="true" final="true" visibility="public"
  19454. deprecated="not deprecated">
  19455. <doc>
  19456. <![CDATA[List of container state transition listeners.]]>
  19457. </doc>
  19458. </field>
  19459. <field name="NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="java.lang.String"
  19460. transient="false" volatile="false"
  19461. static="true" final="true" visibility="public"
  19462. deprecated="not deprecated">
  19463. <doc>
  19464. <![CDATA[Adjustment to make to the container os scheduling priority.
  19465. The valid values for this could vary depending on the platform.
  19466. On Linux, higher values mean run the containers at a less
  19467. favorable priority than the NM.
  19468. The value specified is an int.]]>
  19469. </doc>
  19470. </field>
  19471. <field name="DEFAULT_NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="int"
  19472. transient="false" volatile="false"
  19473. static="true" final="true" visibility="public"
  19474. deprecated="not deprecated">
  19475. </field>
  19476. <field name="NM_CONTAINER_MGR_THREAD_COUNT" type="java.lang.String"
  19477. transient="false" volatile="false"
  19478. static="true" final="true" visibility="public"
  19479. deprecated="not deprecated">
  19480. <doc>
  19481. <![CDATA[Number of threads container manager uses.]]>
  19482. </doc>
  19483. </field>
  19484. <field name="DEFAULT_NM_CONTAINER_MGR_THREAD_COUNT" type="int"
  19485. transient="false" volatile="false"
  19486. static="true" final="true" visibility="public"
  19487. deprecated="not deprecated">
  19488. </field>
  19489. <field name="NM_COLLECTOR_SERVICE_THREAD_COUNT" type="java.lang.String"
  19490. transient="false" volatile="false"
  19491. static="true" final="true" visibility="public"
  19492. deprecated="not deprecated">
  19493. <doc>
  19494. <![CDATA[Number of threads container manager uses.]]>
  19495. </doc>
  19496. </field>
  19497. <field name="DEFAULT_NM_COLLECTOR_SERVICE_THREAD_COUNT" type="int"
  19498. transient="false" volatile="false"
  19499. static="true" final="true" visibility="public"
  19500. deprecated="not deprecated">
  19501. </field>
  19502. <field name="NM_DELETE_THREAD_COUNT" type="java.lang.String"
  19503. transient="false" volatile="false"
  19504. static="true" final="true" visibility="public"
  19505. deprecated="not deprecated">
  19506. <doc>
  19507. <![CDATA[Number of threads used in cleanup.]]>
  19508. </doc>
  19509. </field>
  19510. <field name="DEFAULT_NM_DELETE_THREAD_COUNT" type="int"
  19511. transient="false" volatile="false"
  19512. static="true" final="true" visibility="public"
  19513. deprecated="not deprecated">
  19514. </field>
  19515. <field name="NM_CONTAINER_EXECUTOR_EXIT_FILE_TIMEOUT" type="java.lang.String"
  19516. transient="false" volatile="false"
  19517. static="true" final="true" visibility="public"
  19518. deprecated="not deprecated">
  19519. </field>
  19520. <field name="DEFAULT_NM_CONTAINER_EXECUTOR_EXIT_FILE_TIMEOUT" type="int"
  19521. transient="false" volatile="false"
  19522. static="true" final="true" visibility="public"
  19523. deprecated="not deprecated">
  19524. </field>
  19525. <field name="NM_KEYTAB" type="java.lang.String"
  19526. transient="false" volatile="false"
  19527. static="true" final="true" visibility="public"
  19528. deprecated="not deprecated">
  19529. <doc>
  19530. <![CDATA[Keytab for NM.]]>
  19531. </doc>
  19532. </field>
  19533. <field name="NM_LOCAL_DIRS" type="java.lang.String"
  19534. transient="false" volatile="false"
  19535. static="true" final="true" visibility="public"
  19536. deprecated="not deprecated">
  19537. <doc>
  19538. <![CDATA[List of directories to store localized files in.]]>
  19539. </doc>
  19540. </field>
  19541. <field name="DEFAULT_NM_LOCAL_DIRS" type="java.lang.String"
  19542. transient="false" volatile="false"
  19543. static="true" final="true" visibility="public"
  19544. deprecated="not deprecated">
  19545. </field>
  19546. <field name="NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="java.lang.String"
  19547. transient="false" volatile="false"
  19548. static="true" final="true" visibility="public"
  19549. deprecated="not deprecated">
  19550. <doc>
  19551. <![CDATA[Number of files in each localized directories
  19552. Avoid tuning this too low.]]>
  19553. </doc>
  19554. </field>
  19555. <field name="DEFAULT_NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="int"
  19556. transient="false" volatile="false"
  19557. static="true" final="true" visibility="public"
  19558. deprecated="not deprecated">
  19559. </field>
  19560. <field name="NM_LOCALIZER_ADDRESS" type="java.lang.String"
  19561. transient="false" volatile="false"
  19562. static="true" final="true" visibility="public"
  19563. deprecated="not deprecated">
  19564. <doc>
  19565. <![CDATA[Address where the localizer IPC is.]]>
  19566. </doc>
  19567. </field>
  19568. <field name="DEFAULT_NM_LOCALIZER_PORT" type="int"
  19569. transient="false" volatile="false"
  19570. static="true" final="true" visibility="public"
  19571. deprecated="not deprecated">
  19572. </field>
  19573. <field name="DEFAULT_NM_LOCALIZER_ADDRESS" type="java.lang.String"
  19574. transient="false" volatile="false"
  19575. static="true" final="true" visibility="public"
  19576. deprecated="not deprecated">
  19577. </field>
  19578. <field name="NM_COLLECTOR_SERVICE_ADDRESS" type="java.lang.String"
  19579. transient="false" volatile="false"
  19580. static="true" final="true" visibility="public"
  19581. deprecated="not deprecated">
  19582. <doc>
  19583. <![CDATA[Address where the collector service IPC is.]]>
  19584. </doc>
  19585. </field>
  19586. <field name="DEFAULT_NM_COLLECTOR_SERVICE_PORT" type="int"
  19587. transient="false" volatile="false"
  19588. static="true" final="true" visibility="public"
  19589. deprecated="not deprecated">
  19590. </field>
  19591. <field name="DEFAULT_NM_COLLECTOR_SERVICE_ADDRESS" 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="NM_PUBLISH_CONTAINER_EVENTS_ENABLED" type="java.lang.String"
  19597. transient="false" volatile="false"
  19598. static="true" final="true" visibility="public"
  19599. deprecated="not deprecated">
  19600. <doc>
  19601. <![CDATA[The setting that controls whether yarn container events are published to
  19602. the timeline service or not by NM. This configuration setting is for ATS
  19603. V2]]>
  19604. </doc>
  19605. </field>
  19606. <field name="DEFAULT_NM_PUBLISH_CONTAINER_EVENTS_ENABLED" type="boolean"
  19607. transient="false" volatile="false"
  19608. static="true" final="true" visibility="public"
  19609. deprecated="not deprecated">
  19610. </field>
  19611. <field name="NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="java.lang.String"
  19612. transient="false" volatile="false"
  19613. static="true" final="true" visibility="public"
  19614. deprecated="not deprecated">
  19615. <doc>
  19616. <![CDATA[Interval in between cache cleanups.]]>
  19617. </doc>
  19618. </field>
  19619. <field name="DEFAULT_NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="long"
  19620. transient="false" volatile="false"
  19621. static="true" final="true" visibility="public"
  19622. deprecated="not deprecated">
  19623. </field>
  19624. <field name="NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="java.lang.String"
  19625. transient="false" volatile="false"
  19626. static="true" final="true" visibility="public"
  19627. deprecated="not deprecated">
  19628. <doc>
  19629. <![CDATA[Target size of localizer cache in MB, per nodemanager. It is a target
  19630. retention size that only includes resources with PUBLIC and PRIVATE
  19631. visibility and excludes resources with APPLICATION visibility]]>
  19632. </doc>
  19633. </field>
  19634. <field name="DEFAULT_NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="long"
  19635. transient="false" volatile="false"
  19636. static="true" final="true" visibility="public"
  19637. deprecated="not deprecated">
  19638. </field>
  19639. <field name="NM_LOCALIZER_CLIENT_THREAD_COUNT" type="java.lang.String"
  19640. transient="false" volatile="false"
  19641. static="true" final="true" visibility="public"
  19642. deprecated="not deprecated">
  19643. <doc>
  19644. <![CDATA[Number of threads to handle localization requests.]]>
  19645. </doc>
  19646. </field>
  19647. <field name="DEFAULT_NM_LOCALIZER_CLIENT_THREAD_COUNT" type="int"
  19648. transient="false" volatile="false"
  19649. static="true" final="true" visibility="public"
  19650. deprecated="not deprecated">
  19651. </field>
  19652. <field name="NM_LOCALIZER_FETCH_THREAD_COUNT" type="java.lang.String"
  19653. transient="false" volatile="false"
  19654. static="true" final="true" visibility="public"
  19655. deprecated="not deprecated">
  19656. <doc>
  19657. <![CDATA[Number of threads to use for localization fetching.]]>
  19658. </doc>
  19659. </field>
  19660. <field name="DEFAULT_NM_LOCALIZER_FETCH_THREAD_COUNT" type="int"
  19661. transient="false" volatile="false"
  19662. static="true" final="true" visibility="public"
  19663. deprecated="not deprecated">
  19664. </field>
  19665. <field name="NM_LOG_DIRS" type="java.lang.String"
  19666. transient="false" volatile="false"
  19667. static="true" final="true" visibility="public"
  19668. deprecated="not deprecated">
  19669. <doc>
  19670. <![CDATA[Where to store container logs.]]>
  19671. </doc>
  19672. </field>
  19673. <field name="DEFAULT_NM_LOG_DIRS" type="java.lang.String"
  19674. transient="false" volatile="false"
  19675. static="true" final="true" visibility="public"
  19676. deprecated="not deprecated">
  19677. </field>
  19678. <field name="NM_LOG_AGGREGATION_THREAD_POOL_SIZE" type="java.lang.String"
  19679. transient="false" volatile="false"
  19680. static="true" final="true" visibility="public"
  19681. deprecated="not deprecated">
  19682. <doc>
  19683. <![CDATA[The number of threads to handle log aggregation in node manager.]]>
  19684. </doc>
  19685. </field>
  19686. <field name="DEFAULT_NM_LOG_AGGREGATION_THREAD_POOL_SIZE" type="int"
  19687. transient="false" volatile="false"
  19688. static="true" final="true" visibility="public"
  19689. deprecated="not deprecated">
  19690. </field>
  19691. <field name="NM_DEFAULT_CONTAINER_EXECUTOR_PREFIX" type="java.lang.String"
  19692. transient="false" volatile="false"
  19693. static="true" final="true" visibility="public"
  19694. deprecated="not deprecated">
  19695. <doc>
  19696. <![CDATA[Default permissions for container logs.]]>
  19697. </doc>
  19698. </field>
  19699. <field name="NM_DEFAULT_CONTAINER_EXECUTOR_LOG_DIRS_PERMISSIONS" type="java.lang.String"
  19700. transient="false" volatile="false"
  19701. static="true" final="true" visibility="public"
  19702. deprecated="not deprecated">
  19703. </field>
  19704. <field name="NM_DEFAULT_CONTAINER_EXECUTOR_LOG_DIRS_PERMISSIONS_DEFAULT" type="java.lang.String"
  19705. transient="false" volatile="false"
  19706. static="true" final="true" visibility="public"
  19707. deprecated="not deprecated">
  19708. </field>
  19709. <field name="NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  19710. transient="false" volatile="false"
  19711. static="true" final="true" visibility="public"
  19712. deprecated="not deprecated">
  19713. </field>
  19714. <field name="DEFAULT_NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  19715. transient="false" volatile="false"
  19716. static="true" final="true" visibility="public"
  19717. deprecated="not deprecated">
  19718. </field>
  19719. <field name="DISK_VALIDATOR" type="java.lang.String"
  19720. transient="false" volatile="false"
  19721. static="true" final="true" visibility="public"
  19722. deprecated="not deprecated">
  19723. <doc>
  19724. <![CDATA[Disk Validator.]]>
  19725. </doc>
  19726. </field>
  19727. <field name="DEFAULT_DISK_VALIDATOR" type="java.lang.String"
  19728. transient="false" volatile="false"
  19729. static="true" final="true" visibility="public"
  19730. deprecated="not deprecated">
  19731. </field>
  19732. <field name="NM_CONTAINER_DIAGNOSTICS_MAXIMUM_SIZE" type="java.lang.String"
  19733. transient="false" volatile="false"
  19734. static="true" final="true" visibility="public"
  19735. deprecated="not deprecated">
  19736. <doc>
  19737. <![CDATA[Maximum size of contain's diagnostics to keep for relaunching container
  19738. case.]]>
  19739. </doc>
  19740. </field>
  19741. <field name="DEFAULT_NM_CONTAINER_DIAGNOSTICS_MAXIMUM_SIZE" type="int"
  19742. transient="false" volatile="false"
  19743. static="true" final="true" visibility="public"
  19744. deprecated="not deprecated">
  19745. </field>
  19746. <field name="NM_CONTAINER_RETRY_MINIMUM_INTERVAL_MS" type="java.lang.String"
  19747. transient="false" volatile="false"
  19748. static="true" final="true" visibility="public"
  19749. deprecated="not deprecated">
  19750. <doc>
  19751. <![CDATA[Minimum container restart interval.]]>
  19752. </doc>
  19753. </field>
  19754. <field name="DEFAULT_NM_CONTAINER_RETRY_MINIMUM_INTERVAL_MS" type="int"
  19755. transient="false" volatile="false"
  19756. static="true" final="true" visibility="public"
  19757. deprecated="not deprecated">
  19758. </field>
  19759. <field name="NM_CONTAINER_QUEUING_USE_PAUSE_FOR_PREEMPTION" type="java.lang.String"
  19760. transient="false" volatile="false"
  19761. static="true" final="true" visibility="public"
  19762. deprecated="not deprecated">
  19763. <doc>
  19764. <![CDATA[Use container pause as the preemption policy over kill in the container
  19765. queue at a NodeManager.]]>
  19766. </doc>
  19767. </field>
  19768. <field name="DEFAULT_NM_CONTAINER_QUEUING_USE_PAUSE_FOR_PREEMPTION" type="boolean"
  19769. transient="false" volatile="false"
  19770. static="true" final="true" visibility="public"
  19771. deprecated="not deprecated">
  19772. </field>
  19773. <field name="RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="java.lang.String"
  19774. transient="false" volatile="false"
  19775. static="true" final="true" visibility="public"
  19776. deprecated="not deprecated">
  19777. <doc>
  19778. <![CDATA[Interval at which the delayed token removal thread runs]]>
  19779. </doc>
  19780. </field>
  19781. <field name="DEFAULT_RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="long"
  19782. transient="false" volatile="false"
  19783. static="true" final="true" visibility="public"
  19784. deprecated="not deprecated">
  19785. </field>
  19786. <field name="RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="java.lang.String"
  19787. transient="false" volatile="false"
  19788. static="true" final="true" visibility="public"
  19789. deprecated="not deprecated">
  19790. <doc>
  19791. <![CDATA[Delegation Token renewer thread count]]>
  19792. </doc>
  19793. </field>
  19794. <field name="DEFAULT_RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="int"
  19795. transient="false" volatile="false"
  19796. static="true" final="true" visibility="public"
  19797. deprecated="not deprecated">
  19798. </field>
  19799. <field name="RM_PROXY_USER_PRIVILEGES_ENABLED" type="java.lang.String"
  19800. transient="false" volatile="false"
  19801. static="true" final="true" visibility="public"
  19802. deprecated="not deprecated">
  19803. </field>
  19804. <field name="DEFAULT_RM_PROXY_USER_PRIVILEGES_ENABLED" type="boolean"
  19805. transient="false" volatile="false"
  19806. static="true" final="true" visibility="public"
  19807. deprecated="not deprecated">
  19808. </field>
  19809. <field name="RM_NODE_IP_CACHE_EXPIRY_INTERVAL_SECS" type="java.lang.String"
  19810. transient="false" volatile="false"
  19811. static="true" final="true" visibility="public"
  19812. deprecated="not deprecated">
  19813. <doc>
  19814. <![CDATA[The expiry interval for node IP caching. -1 disables the caching]]>
  19815. </doc>
  19816. </field>
  19817. <field name="DEFAULT_RM_NODE_IP_CACHE_EXPIRY_INTERVAL_SECS" type="int"
  19818. transient="false" volatile="false"
  19819. static="true" final="true" visibility="public"
  19820. deprecated="not deprecated">
  19821. </field>
  19822. <field name="RM_MAX_LOG_AGGREGATION_DIAGNOSTICS_IN_MEMORY" type="java.lang.String"
  19823. transient="false" volatile="false"
  19824. static="true" final="true" visibility="public"
  19825. deprecated="not deprecated">
  19826. <doc>
  19827. <![CDATA[How many diagnostics/failure messages can be saved in RM for
  19828. log aggregation. It also defines the number of diagnostics/failure
  19829. messages can be shown in log aggregation web ui.]]>
  19830. </doc>
  19831. </field>
  19832. <field name="DEFAULT_RM_MAX_LOG_AGGREGATION_DIAGNOSTICS_IN_MEMORY" type="int"
  19833. transient="false" volatile="false"
  19834. static="true" final="true" visibility="public"
  19835. deprecated="not deprecated">
  19836. </field>
  19837. <field name="LOG_AGGREGATION_ENABLED" type="java.lang.String"
  19838. transient="false" volatile="false"
  19839. static="true" final="true" visibility="public"
  19840. deprecated="not deprecated">
  19841. <doc>
  19842. <![CDATA[Whether to enable log aggregation]]>
  19843. </doc>
  19844. </field>
  19845. <field name="DEFAULT_LOG_AGGREGATION_ENABLED" type="boolean"
  19846. transient="false" volatile="false"
  19847. static="true" final="true" visibility="public"
  19848. deprecated="not deprecated">
  19849. </field>
  19850. <field name="LOG_AGGREGATION_FILE_FORMATS" type="java.lang.String"
  19851. transient="false" volatile="false"
  19852. static="true" final="true" visibility="public"
  19853. deprecated="not deprecated">
  19854. </field>
  19855. <field name="LOG_AGGREGATION_FILE_CONTROLLER_FMT" type="java.lang.String"
  19856. transient="false" volatile="false"
  19857. static="true" final="true" visibility="public"
  19858. deprecated="not deprecated">
  19859. </field>
  19860. <field name="LOG_AGGREGATION_REMOTE_APP_LOG_DIR_FMT" type="java.lang.String"
  19861. transient="false" volatile="false"
  19862. static="true" final="true" visibility="public"
  19863. deprecated="not deprecated">
  19864. </field>
  19865. <field name="LOG_AGGREGATION_REMOTE_APP_LOG_DIR_SUFFIX_FMT" type="java.lang.String"
  19866. transient="false" volatile="false"
  19867. static="true" final="true" visibility="public"
  19868. deprecated="not deprecated">
  19869. </field>
  19870. <field name="LOG_AGGREGATION_RETAIN_SECONDS" type="java.lang.String"
  19871. transient="false" volatile="false"
  19872. static="true" final="true" visibility="public"
  19873. deprecated="not deprecated">
  19874. <doc>
  19875. <![CDATA[How long to wait before deleting aggregated logs, -1 disables.
  19876. Be careful set this too small and you will spam the name node.]]>
  19877. </doc>
  19878. </field>
  19879. <field name="DEFAULT_LOG_AGGREGATION_RETAIN_SECONDS" type="long"
  19880. transient="false" volatile="false"
  19881. static="true" final="true" visibility="public"
  19882. deprecated="not deprecated">
  19883. </field>
  19884. <field name="LOG_AGGREGATION_DEBUG_FILESIZE" type="java.lang.String"
  19885. transient="false" volatile="false"
  19886. static="true" final="true" visibility="public"
  19887. deprecated="not deprecated">
  19888. </field>
  19889. <field name="DEFAULT_LOG_AGGREGATION_DEBUG_FILESIZE" type="long"
  19890. transient="false" volatile="false"
  19891. static="true" final="true" visibility="public"
  19892. deprecated="not deprecated">
  19893. </field>
  19894. <field name="LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="java.lang.String"
  19895. transient="false" volatile="false"
  19896. static="true" final="true" visibility="public"
  19897. deprecated="not deprecated">
  19898. <doc>
  19899. <![CDATA[How long to wait between aggregated log retention checks. If set to
  19900. a value {@literal <=} 0 then the value is computed as one-tenth of the
  19901. log retention setting. Be careful set this too small and you will spam
  19902. the name node.]]>
  19903. </doc>
  19904. </field>
  19905. <field name="DEFAULT_LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="long"
  19906. transient="false" volatile="false"
  19907. static="true" final="true" visibility="public"
  19908. deprecated="not deprecated">
  19909. </field>
  19910. <field name="LOG_AGGREGATION_STATUS_TIME_OUT_MS" type="java.lang.String"
  19911. transient="false" volatile="false"
  19912. static="true" final="true" visibility="public"
  19913. deprecated="not deprecated">
  19914. <doc>
  19915. <![CDATA[How long for ResourceManager to wait for NodeManager to report its
  19916. log aggregation status. If waiting time of which the log aggregation status
  19917. is reported from NodeManager exceeds the configured value, RM will report
  19918. log aggregation status for this NodeManager as TIME_OUT.
  19919. This configuration will be used in NodeManager as well to decide
  19920. whether and when to delete the cached log aggregation status.]]>
  19921. </doc>
  19922. </field>
  19923. <field name="DEFAULT_LOG_AGGREGATION_STATUS_TIME_OUT_MS" type="long"
  19924. transient="false" volatile="false"
  19925. static="true" final="true" visibility="public"
  19926. deprecated="not deprecated">
  19927. </field>
  19928. <field name="LOG_AGGREGATION_ENABLE_LOCAL_CLEANUP" type="java.lang.String"
  19929. transient="false" volatile="false"
  19930. static="true" final="true" visibility="public"
  19931. deprecated="not deprecated">
  19932. <doc>
  19933. <![CDATA[Whether to clean up nodemanager logs when log aggregation is enabled.]]>
  19934. </doc>
  19935. </field>
  19936. <field name="DEFAULT_LOG_AGGREGATION_ENABLE_LOCAL_CLEANUP" type="boolean"
  19937. transient="false" volatile="false"
  19938. static="true" final="true" visibility="public"
  19939. deprecated="not deprecated">
  19940. </field>
  19941. <field name="NM_LOG_RETAIN_SECONDS" type="java.lang.String"
  19942. transient="false" volatile="false"
  19943. static="true" final="true" visibility="public"
  19944. deprecated="not deprecated">
  19945. <doc>
  19946. <![CDATA[Number of seconds to retain logs on the NodeManager. Only applicable if Log
  19947. aggregation is disabled]]>
  19948. </doc>
  19949. </field>
  19950. <field name="DEFAULT_NM_LOG_RETAIN_SECONDS" type="long"
  19951. transient="false" volatile="false"
  19952. static="true" final="true" visibility="public"
  19953. deprecated="not deprecated">
  19954. </field>
  19955. <field name="NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="java.lang.String"
  19956. transient="false" volatile="false"
  19957. static="true" final="true" visibility="public"
  19958. deprecated="not deprecated">
  19959. <doc>
  19960. <![CDATA[Define how often NMs wake up and upload log files]]>
  19961. </doc>
  19962. </field>
  19963. <field name="DEFAULT_NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="long"
  19964. transient="false" volatile="false"
  19965. static="true" final="true" visibility="public"
  19966. deprecated="not deprecated">
  19967. </field>
  19968. <field name="MIN_LOG_ROLLING_INTERVAL_SECONDS" type="java.lang.String"
  19969. transient="false" volatile="false"
  19970. static="true" final="true" visibility="public"
  19971. deprecated="not deprecated">
  19972. <doc>
  19973. <![CDATA[The allowed hard minimum limit for {@link
  19974. YarnConfiguration#NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS}.]]>
  19975. </doc>
  19976. </field>
  19977. <field name="MIN_LOG_ROLLING_INTERVAL_SECONDS_DEFAULT" type="long"
  19978. transient="false" volatile="false"
  19979. static="true" final="true" visibility="public"
  19980. deprecated="not deprecated">
  19981. </field>
  19982. <field name="NM_LOG_AGGREGATION_NUM_LOG_FILES_SIZE_PER_APP" type="java.lang.String"
  19983. transient="false" volatile="false"
  19984. static="true" final="true" visibility="public"
  19985. deprecated="not deprecated">
  19986. <doc>
  19987. <![CDATA[Define how many aggregated log files per application per NM we can have
  19988. in remote file system.]]>
  19989. </doc>
  19990. </field>
  19991. <field name="DEFAULT_NM_LOG_AGGREGATION_NUM_LOG_FILES_SIZE_PER_APP" type="int"
  19992. transient="false" volatile="false"
  19993. static="true" final="true" visibility="public"
  19994. deprecated="not deprecated">
  19995. </field>
  19996. <field name="NM_LOG_DELETION_THREADS_COUNT" type="java.lang.String"
  19997. transient="false" volatile="false"
  19998. static="true" final="true" visibility="public"
  19999. deprecated="not deprecated">
  20000. <doc>
  20001. <![CDATA[Number of threads used in log cleanup. Only applicable if Log aggregation
  20002. is disabled]]>
  20003. </doc>
  20004. </field>
  20005. <field name="DEFAULT_NM_LOG_DELETE_THREAD_COUNT" type="int"
  20006. transient="false" volatile="false"
  20007. static="true" final="true" visibility="public"
  20008. deprecated="not deprecated">
  20009. </field>
  20010. <field name="NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
  20011. transient="false" volatile="false"
  20012. static="true" final="true" visibility="public"
  20013. deprecated="not deprecated">
  20014. <doc>
  20015. <![CDATA[Where to aggregate logs to.]]>
  20016. </doc>
  20017. </field>
  20018. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
  20019. transient="false" volatile="false"
  20020. static="true" final="true" visibility="public"
  20021. deprecated="not deprecated">
  20022. </field>
  20023. <field name="NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
  20024. transient="false" volatile="false"
  20025. static="true" final="true" visibility="public"
  20026. deprecated="not deprecated">
  20027. <doc>
  20028. <![CDATA[The remote log dir will be created at below location.
  20029. NM_REMOTE_APP_LOG_DIR/${user}/bucket_{NM_REMOTE_APP_LOG_DIR_SUFFIX}
  20030. /${bucketDir}/${appId}]]>
  20031. </doc>
  20032. </field>
  20033. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
  20034. transient="false" volatile="false"
  20035. static="true" final="true" visibility="public"
  20036. deprecated="not deprecated">
  20037. </field>
  20038. <field name="NM_REMOTE_APP_LOG_DIR_INCLUDE_OLDER" type="java.lang.String"
  20039. transient="false" volatile="false"
  20040. static="true" final="true" visibility="public"
  20041. deprecated="not deprecated">
  20042. <doc>
  20043. <![CDATA[Specifies whether Older Application Log Directory is included.]]>
  20044. </doc>
  20045. </field>
  20046. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR_INCLUDE_OLDER" type="boolean"
  20047. transient="false" volatile="false"
  20048. static="true" final="true" visibility="public"
  20049. deprecated="not deprecated">
  20050. </field>
  20051. <field name="NM_REMOTE_APP_LOG_DIR_GROUPNAME" type="java.lang.String"
  20052. transient="false" volatile="false"
  20053. static="true" final="true" visibility="public"
  20054. deprecated="not deprecated">
  20055. <doc>
  20056. <![CDATA[Specifies the group of the aggregated log directory.]]>
  20057. </doc>
  20058. </field>
  20059. <field name="YARN_LOG_SERVER_URL" type="java.lang.String"
  20060. transient="false" volatile="false"
  20061. static="true" final="true" visibility="public"
  20062. deprecated="not deprecated">
  20063. </field>
  20064. <field name="YARN_LOG_SERVER_WEBSERVICE_URL" type="java.lang.String"
  20065. transient="false" volatile="false"
  20066. static="true" final="true" visibility="public"
  20067. deprecated="not deprecated">
  20068. </field>
  20069. <field name="YARN_TRACKING_URL_GENERATOR" type="java.lang.String"
  20070. transient="false" volatile="false"
  20071. static="true" final="true" visibility="public"
  20072. deprecated="not deprecated">
  20073. </field>
  20074. <field name="NM_PMEM_MB" type="java.lang.String"
  20075. transient="false" volatile="false"
  20076. static="true" final="true" visibility="public"
  20077. deprecated="not deprecated">
  20078. <doc>
  20079. <![CDATA[Amount of memory in MB that can be allocated for containers.]]>
  20080. </doc>
  20081. </field>
  20082. <field name="DEFAULT_NM_PMEM_MB" type="int"
  20083. transient="false" volatile="false"
  20084. static="true" final="true" visibility="public"
  20085. deprecated="not deprecated">
  20086. </field>
  20087. <field name="NM_SYSTEM_RESERVED_PMEM_MB" type="java.lang.String"
  20088. transient="false" volatile="false"
  20089. static="true" final="true" visibility="public"
  20090. deprecated="not deprecated">
  20091. <doc>
  20092. <![CDATA[Amount of memory in MB that has been reserved for non-yarn use.]]>
  20093. </doc>
  20094. </field>
  20095. <field name="NM_PMEM_CHECK_ENABLED" type="java.lang.String"
  20096. transient="false" volatile="false"
  20097. static="true" final="true" visibility="public"
  20098. deprecated="not deprecated">
  20099. <doc>
  20100. <![CDATA[Specifies whether physical memory check is enabled.]]>
  20101. </doc>
  20102. </field>
  20103. <field name="DEFAULT_NM_PMEM_CHECK_ENABLED" type="boolean"
  20104. transient="false" volatile="false"
  20105. static="true" final="true" visibility="public"
  20106. deprecated="not deprecated">
  20107. </field>
  20108. <field name="NM_VMEM_CHECK_ENABLED" type="java.lang.String"
  20109. transient="false" volatile="false"
  20110. static="true" final="true" visibility="public"
  20111. deprecated="not deprecated">
  20112. <doc>
  20113. <![CDATA[Specifies whether virtual memory check is enabled.]]>
  20114. </doc>
  20115. </field>
  20116. <field name="DEFAULT_NM_VMEM_CHECK_ENABLED" type="boolean"
  20117. transient="false" volatile="false"
  20118. static="true" final="true" visibility="public"
  20119. deprecated="not deprecated">
  20120. </field>
  20121. <field name="NM_VMEM_PMEM_RATIO" type="java.lang.String"
  20122. transient="false" volatile="false"
  20123. static="true" final="true" visibility="public"
  20124. deprecated="not deprecated">
  20125. <doc>
  20126. <![CDATA[Conversion ratio for physical memory to virtual memory.]]>
  20127. </doc>
  20128. </field>
  20129. <field name="DEFAULT_NM_VMEM_PMEM_RATIO" type="float"
  20130. transient="false" volatile="false"
  20131. static="true" final="true" visibility="public"
  20132. deprecated="not deprecated">
  20133. </field>
  20134. <field name="NM_ELASTIC_MEMORY_CONTROL_ENABLED" type="java.lang.String"
  20135. transient="false" volatile="false"
  20136. static="true" final="true" visibility="public"
  20137. deprecated="not deprecated">
  20138. <doc>
  20139. <![CDATA[Specifies whether to do memory check on overall usage.]]>
  20140. </doc>
  20141. </field>
  20142. <field name="DEFAULT_NM_ELASTIC_MEMORY_CONTROL_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_ELASTIC_MEMORY_CONTROL_OOM_HANDLER" type="java.lang.String"
  20148. transient="false" volatile="false"
  20149. static="true" final="true" visibility="public"
  20150. deprecated="not deprecated">
  20151. <doc>
  20152. <![CDATA[Specifies the OOM handler code.]]>
  20153. </doc>
  20154. </field>
  20155. <field name="NM_ELASTIC_MEMORY_CONTROL_OOM_LISTENER_PATH" type="java.lang.String"
  20156. transient="false" volatile="false"
  20157. static="true" final="true" visibility="public"
  20158. deprecated="not deprecated">
  20159. <doc>
  20160. <![CDATA[The path to the OOM listener.]]>
  20161. </doc>
  20162. </field>
  20163. <field name="NM_ELASTIC_MEMORY_CONTROL_OOM_TIMEOUT_SEC" type="java.lang.String"
  20164. transient="false" volatile="false"
  20165. static="true" final="true" visibility="public"
  20166. deprecated="not deprecated">
  20167. <doc>
  20168. <![CDATA[Maximum time in seconds to resolve an OOM situation.]]>
  20169. </doc>
  20170. </field>
  20171. <field name="DEFAULT_NM_ELASTIC_MEMORY_CONTROL_OOM_TIMEOUT_SEC" type="java.lang.Integer"
  20172. transient="false" volatile="false"
  20173. static="true" final="true" visibility="public"
  20174. deprecated="not deprecated">
  20175. </field>
  20176. <field name="NM_VCORES" type="java.lang.String"
  20177. transient="false" volatile="false"
  20178. static="true" final="true" visibility="public"
  20179. deprecated="not deprecated">
  20180. <doc>
  20181. <![CDATA[Number of Virtual CPU Cores which can be allocated for containers.]]>
  20182. </doc>
  20183. </field>
  20184. <field name="DEFAULT_NM_VCORES" type="int"
  20185. transient="false" volatile="false"
  20186. static="true" final="true" visibility="public"
  20187. deprecated="not deprecated">
  20188. </field>
  20189. <field name="NM_COUNT_LOGICAL_PROCESSORS_AS_CORES" type="java.lang.String"
  20190. transient="false" volatile="false"
  20191. static="true" final="true" visibility="public"
  20192. deprecated="not deprecated">
  20193. <doc>
  20194. <![CDATA[Count logical processors(like hyperthreads) as cores.]]>
  20195. </doc>
  20196. </field>
  20197. <field name="DEFAULT_NM_COUNT_LOGICAL_PROCESSORS_AS_CORES" type="boolean"
  20198. transient="false" volatile="false"
  20199. static="true" final="true" visibility="public"
  20200. deprecated="not deprecated">
  20201. </field>
  20202. <field name="NM_PCORES_VCORES_MULTIPLIER" type="java.lang.String"
  20203. transient="false" volatile="false"
  20204. static="true" final="true" visibility="public"
  20205. deprecated="not deprecated">
  20206. <doc>
  20207. <![CDATA[Multiplier to convert physical cores to vcores.]]>
  20208. </doc>
  20209. </field>
  20210. <field name="DEFAULT_NM_PCORES_VCORES_MULTIPLIER" type="float"
  20211. transient="false" volatile="false"
  20212. static="true" final="true" visibility="public"
  20213. deprecated="not deprecated">
  20214. </field>
  20215. <field name="NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="java.lang.String"
  20216. transient="false" volatile="false"
  20217. static="true" final="true" visibility="public"
  20218. deprecated="not deprecated">
  20219. <doc>
  20220. <![CDATA[Percentage of overall CPU which can be allocated for containers.]]>
  20221. </doc>
  20222. </field>
  20223. <field name="DEFAULT_NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="int"
  20224. transient="false" volatile="false"
  20225. static="true" final="true" visibility="public"
  20226. deprecated="not deprecated">
  20227. </field>
  20228. <field name="NM_ENABLE_HARDWARE_CAPABILITY_DETECTION" type="java.lang.String"
  20229. transient="false" volatile="false"
  20230. static="true" final="true" visibility="public"
  20231. deprecated="not deprecated">
  20232. <doc>
  20233. <![CDATA[Enable or disable node hardware capability detection.]]>
  20234. </doc>
  20235. </field>
  20236. <field name="DEFAULT_NM_ENABLE_HARDWARE_CAPABILITY_DETECTION" type="boolean"
  20237. transient="false" volatile="false"
  20238. static="true" final="true" visibility="public"
  20239. deprecated="not deprecated">
  20240. </field>
  20241. <field name="NM_MEMORY_RESOURCE_PREFIX" type="java.lang.String"
  20242. transient="false" volatile="false"
  20243. static="true" final="true" visibility="public"
  20244. deprecated="not deprecated">
  20245. </field>
  20246. <field name="NM_MEMORY_RESOURCE_ENABLED" type="java.lang.String"
  20247. transient="false" volatile="false"
  20248. static="true" final="true" visibility="public"
  20249. deprecated="not deprecated">
  20250. </field>
  20251. <field name="DEFAULT_NM_MEMORY_RESOURCE_ENABLED" type="boolean"
  20252. transient="false" volatile="false"
  20253. static="true" final="true" visibility="public"
  20254. deprecated="not deprecated">
  20255. </field>
  20256. <field name="NM_MEMORY_RESOURCE_ENFORCED" type="java.lang.String"
  20257. transient="false" volatile="false"
  20258. static="true" final="true" visibility="public"
  20259. deprecated="not deprecated">
  20260. </field>
  20261. <field name="DEFAULT_NM_MEMORY_RESOURCE_ENFORCED" type="boolean"
  20262. transient="false" volatile="false"
  20263. static="true" final="true" visibility="public"
  20264. deprecated="not deprecated">
  20265. </field>
  20266. <field name="NM_MEMORY_RESOURCE_CGROUPS_SWAPPINESS" type="java.lang.String"
  20267. transient="false" volatile="false"
  20268. static="true" final="true" visibility="public"
  20269. deprecated="not deprecated">
  20270. </field>
  20271. <field name="DEFAULT_NM_MEMORY_RESOURCE_CGROUPS_SWAPPINESS" type="int"
  20272. transient="false" volatile="false"
  20273. static="true" final="true" visibility="public"
  20274. deprecated="not deprecated">
  20275. </field>
  20276. <field name="NM_MEMORY_RESOURCE_CGROUPS_SOFT_LIMIT_PERCENTAGE" type="java.lang.String"
  20277. transient="false" volatile="false"
  20278. static="true" final="true" visibility="public"
  20279. deprecated="not deprecated">
  20280. </field>
  20281. <field name="DEFAULT_NM_MEMORY_RESOURCE_CGROUPS_SOFT_LIMIT_PERCENTAGE" type="float"
  20282. transient="false" volatile="false"
  20283. static="true" final="true" visibility="public"
  20284. deprecated="not deprecated">
  20285. </field>
  20286. <field name="NM_CPU_RESOURCE_PREFIX" type="java.lang.String"
  20287. transient="false" volatile="false"
  20288. static="true" final="true" visibility="public"
  20289. deprecated="not deprecated">
  20290. </field>
  20291. <field name="NM_CPU_RESOURCE_ENABLED" type="java.lang.String"
  20292. transient="false" volatile="false"
  20293. static="true" final="true" visibility="public"
  20294. deprecated="not deprecated">
  20295. <doc>
  20296. <![CDATA[Enable cpu isolation.]]>
  20297. </doc>
  20298. </field>
  20299. <field name="DEFAULT_NM_CPU_RESOURCE_ENABLED" type="boolean"
  20300. transient="false" volatile="false"
  20301. static="true" final="true" visibility="public"
  20302. deprecated="not deprecated">
  20303. </field>
  20304. <field name="NM_DISK_RESOURCE_PREFIX" type="java.lang.String"
  20305. transient="false" volatile="false"
  20306. static="true" final="true" visibility="public"
  20307. deprecated="not deprecated">
  20308. <doc>
  20309. <![CDATA[Prefix for disk configurations. Work in progress: This configuration
  20310. parameter may be changed/removed in the future.]]>
  20311. </doc>
  20312. </field>
  20313. <field name="NM_DISK_RESOURCE_ENABLED" type="java.lang.String"
  20314. transient="false" volatile="false"
  20315. static="true" final="true" visibility="public"
  20316. deprecated="not deprecated">
  20317. <doc>
  20318. <![CDATA[This setting controls if resource handling for disk operations is enabled.
  20319. Work in progress: This configuration parameter may be changed/removed in
  20320. the future]]>
  20321. </doc>
  20322. </field>
  20323. <field name="DEFAULT_NM_DISK_RESOURCE_ENABLED" type="boolean"
  20324. transient="false" volatile="false"
  20325. static="true" final="true" visibility="public"
  20326. deprecated="not deprecated">
  20327. <doc>
  20328. <![CDATA[Disk as a resource is disabled by default.]]>
  20329. </doc>
  20330. </field>
  20331. <field name="NM_NETWORK_RESOURCE_PREFIX" type="java.lang.String"
  20332. transient="false" volatile="false"
  20333. static="true" final="true" visibility="public"
  20334. deprecated="not deprecated">
  20335. </field>
  20336. <field name="NM_NETWORK_RESOURCE_ENABLED" type="java.lang.String"
  20337. transient="false" volatile="false"
  20338. static="true" final="true" visibility="public"
  20339. deprecated="not deprecated">
  20340. <doc>
  20341. <![CDATA[This setting controls if resource handling for network bandwidth is
  20342. enabled. Work in progress: This configuration parameter may be
  20343. changed/removed in the future]]>
  20344. </doc>
  20345. </field>
  20346. <field name="DEFAULT_NM_NETWORK_RESOURCE_ENABLED" type="boolean"
  20347. transient="false" volatile="false"
  20348. static="true" final="true" visibility="public"
  20349. deprecated="not deprecated">
  20350. <doc>
  20351. <![CDATA[Network as a resource is disabled by default.]]>
  20352. </doc>
  20353. </field>
  20354. <field name="NM_NETWORK_RESOURCE_INTERFACE" type="java.lang.String"
  20355. transient="false" volatile="false"
  20356. static="true" final="true" visibility="public"
  20357. deprecated="not deprecated">
  20358. <doc>
  20359. <![CDATA[Specifies the interface to be used for applying network throttling rules.
  20360. Work in progress: This configuration parameter may be changed/removed in
  20361. the future]]>
  20362. </doc>
  20363. </field>
  20364. <field name="DEFAULT_NM_NETWORK_RESOURCE_INTERFACE" type="java.lang.String"
  20365. transient="false" volatile="false"
  20366. static="true" final="true" visibility="public"
  20367. deprecated="not deprecated">
  20368. </field>
  20369. <field name="NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT" type="java.lang.String"
  20370. transient="false" volatile="false"
  20371. static="true" final="true" visibility="public"
  20372. deprecated="not deprecated">
  20373. <doc>
  20374. <![CDATA[Specifies the total available outbound bandwidth on the node. Work in
  20375. progress: This configuration parameter may be changed/removed in the future]]>
  20376. </doc>
  20377. </field>
  20378. <field name="DEFAULT_NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT" type="int"
  20379. transient="false" volatile="false"
  20380. static="true" final="true" visibility="public"
  20381. deprecated="not deprecated">
  20382. </field>
  20383. <field name="NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_YARN_MBIT" type="java.lang.String"
  20384. transient="false" volatile="false"
  20385. static="true" final="true" visibility="public"
  20386. deprecated="not deprecated">
  20387. <doc>
  20388. <![CDATA[Specifies the total outbound bandwidth available to YARN containers.
  20389. defaults to NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT if not specified.
  20390. Work in progress: This configuration parameter may be changed/removed in
  20391. the future]]>
  20392. </doc>
  20393. </field>
  20394. <field name="NM_RESOURCE_PLUGINS" type="java.lang.String"
  20395. transient="false" volatile="false"
  20396. static="true" final="true" visibility="public"
  20397. deprecated="not deprecated">
  20398. <doc>
  20399. <![CDATA[Prefix for computation resources, example of computation resources like
  20400. GPU / FPGA / TPU, etc.]]>
  20401. </doc>
  20402. </field>
  20403. <field name="NM_RESOURCE_PLUGINS_FAIL_FAST" type="java.lang.String"
  20404. transient="false" volatile="false"
  20405. static="true" final="true" visibility="public"
  20406. deprecated="not deprecated">
  20407. <doc>
  20408. <![CDATA[Specifies whether the initialization of the Node Manager should continue
  20409. if a certain device (GPU, FPGA, etc) was not found in the system. If set
  20410. to "true", then an exception will be thrown if a device is missing or
  20411. an error occurred during discovery.]]>
  20412. </doc>
  20413. </field>
  20414. <field name="DEFAULT_NM_RESOURCE_PLUGINS_FAIL_FAST" type="boolean"
  20415. transient="false" volatile="false"
  20416. static="true" final="true" visibility="public"
  20417. deprecated="not deprecated">
  20418. </field>
  20419. <field name="NM_PLUGGABLE_DEVICE_FRAMEWORK_ENABLED" type="java.lang.String"
  20420. transient="false" volatile="false"
  20421. static="true" final="true" visibility="public"
  20422. deprecated="not deprecated">
  20423. <doc>
  20424. <![CDATA[This setting controls if pluggable device plugin framework is enabled.]]>
  20425. </doc>
  20426. </field>
  20427. <field name="DEFAULT_NM_PLUGGABLE_DEVICE_FRAMEWORK_ENABLED" type="boolean"
  20428. transient="false" volatile="false"
  20429. static="true" final="true" visibility="public"
  20430. deprecated="not deprecated">
  20431. <doc>
  20432. <![CDATA[The pluggable device plugin framework is disabled by default]]>
  20433. </doc>
  20434. </field>
  20435. <field name="NM_PLUGGABLE_DEVICE_FRAMEWORK_DEVICE_CLASSES" type="java.lang.String"
  20436. transient="false" volatile="false"
  20437. static="true" final="true" visibility="public"
  20438. deprecated="not deprecated">
  20439. <doc>
  20440. <![CDATA[This setting contains vendor plugin class names for
  20441. device plugin framework to load. Split by comma]]>
  20442. </doc>
  20443. </field>
  20444. <field name="NM_GPU_RESOURCE_PREFIX" type="java.lang.String"
  20445. transient="false" volatile="false"
  20446. static="true" final="true" visibility="public"
  20447. deprecated="not deprecated">
  20448. <doc>
  20449. <![CDATA[Prefix for gpu configurations. Work in progress: This configuration
  20450. parameter may be changed/removed in the future.]]>
  20451. </doc>
  20452. </field>
  20453. <field name="NM_GPU_ALLOWED_DEVICES" type="java.lang.String"
  20454. transient="false" volatile="false"
  20455. static="true" final="true" visibility="public"
  20456. deprecated="not deprecated">
  20457. </field>
  20458. <field name="AUTOMATICALLY_DISCOVER_GPU_DEVICES" type="java.lang.String"
  20459. transient="false" volatile="false"
  20460. static="true" final="true" visibility="public"
  20461. deprecated="not deprecated">
  20462. </field>
  20463. <field name="NM_GPU_PATH_TO_EXEC" type="java.lang.String"
  20464. transient="false" volatile="false"
  20465. static="true" final="true" visibility="public"
  20466. deprecated="not deprecated">
  20467. <doc>
  20468. <![CDATA[This setting controls where to how to invoke GPU binaries]]>
  20469. </doc>
  20470. </field>
  20471. <field name="NM_GPU_DOCKER_PLUGIN_IMPL" type="java.lang.String"
  20472. transient="false" volatile="false"
  20473. static="true" final="true" visibility="public"
  20474. deprecated="not deprecated">
  20475. <doc>
  20476. <![CDATA[Settings to control which implementation of docker plugin for GPU will be
  20477. used.
  20478. By default uses NVIDIA docker v1.]]>
  20479. </doc>
  20480. </field>
  20481. <field name="NVIDIA_DOCKER_V1" type="java.lang.String"
  20482. transient="false" volatile="false"
  20483. static="true" final="true" visibility="public"
  20484. deprecated="not deprecated">
  20485. </field>
  20486. <field name="NVIDIA_DOCKER_V2" type="java.lang.String"
  20487. transient="false" volatile="false"
  20488. static="true" final="true" visibility="public"
  20489. deprecated="not deprecated">
  20490. </field>
  20491. <field name="DEFAULT_NM_GPU_DOCKER_PLUGIN_IMPL" type="java.lang.String"
  20492. transient="false" volatile="false"
  20493. static="true" final="true" visibility="public"
  20494. deprecated="not deprecated">
  20495. </field>
  20496. <field name="NVIDIA_DOCKER_PLUGIN_V1_ENDPOINT" type="java.lang.String"
  20497. transient="false" volatile="false"
  20498. static="true" final="true" visibility="public"
  20499. deprecated="not deprecated">
  20500. <doc>
  20501. <![CDATA[This setting controls end point of nvidia-docker-v1 plugin.]]>
  20502. </doc>
  20503. </field>
  20504. <field name="DEFAULT_NVIDIA_DOCKER_PLUGIN_V1_ENDPOINT" type="java.lang.String"
  20505. transient="false" volatile="false"
  20506. static="true" final="true" visibility="public"
  20507. deprecated="not deprecated">
  20508. </field>
  20509. <field name="NM_FPGA_RESOURCE_PREFIX" type="java.lang.String"
  20510. transient="false" volatile="false"
  20511. static="true" final="true" visibility="public"
  20512. deprecated="not deprecated">
  20513. <doc>
  20514. <![CDATA[Prefix for FPGA configurations. Work in progress: This configuration
  20515. parameter may be changed/removed in the future.]]>
  20516. </doc>
  20517. </field>
  20518. <field name="NM_FPGA_ALLOWED_DEVICES" type="java.lang.String"
  20519. transient="false" volatile="false"
  20520. static="true" final="true" visibility="public"
  20521. deprecated="not deprecated">
  20522. </field>
  20523. <field name="NM_FPGA_PATH_TO_EXEC" type="java.lang.String"
  20524. transient="false" volatile="false"
  20525. static="true" final="true" visibility="public"
  20526. deprecated="not deprecated">
  20527. </field>
  20528. <field name="NM_FPGA_VENDOR_PLUGIN" type="java.lang.String"
  20529. transient="false" volatile="false"
  20530. static="true" final="true" visibility="public"
  20531. deprecated="not deprecated">
  20532. </field>
  20533. <field name="DEFAULT_NM_FPGA_VENDOR_PLUGIN" type="java.lang.String"
  20534. transient="false" volatile="false"
  20535. static="true" final="true" visibility="public"
  20536. deprecated="not deprecated">
  20537. </field>
  20538. <field name="NM_FPGA_DEVICE_DISCOVERY_SCRIPT" type="java.lang.String"
  20539. transient="false" volatile="false"
  20540. static="true" final="true" visibility="public"
  20541. deprecated="not deprecated">
  20542. </field>
  20543. <field name="NM_FPGA_AVAILABLE_DEVICES" type="java.lang.String"
  20544. transient="false" volatile="false"
  20545. static="true" final="true" visibility="public"
  20546. deprecated="not deprecated">
  20547. </field>
  20548. <field name="NM_NETWORK_TAG_PREFIX" type="java.lang.String"
  20549. transient="false" volatile="false"
  20550. static="true" final="true" visibility="public"
  20551. deprecated="not deprecated">
  20552. </field>
  20553. <field name="NM_NETWORK_TAG_HANDLER_ENABLED" type="java.lang.String"
  20554. transient="false" volatile="false"
  20555. static="true" final="true" visibility="public"
  20556. deprecated="not deprecated">
  20557. </field>
  20558. <field name="DEFAULT_NM_NETWORK_TAG_HANDLER_ENABLED" type="boolean"
  20559. transient="false" volatile="false"
  20560. static="true" final="true" visibility="public"
  20561. deprecated="not deprecated">
  20562. </field>
  20563. <field name="NM_NETWORK_TAG_MAPPING_MANAGER" type="java.lang.String"
  20564. transient="false" volatile="false"
  20565. static="true" final="true" visibility="public"
  20566. deprecated="not deprecated">
  20567. </field>
  20568. <field name="NM_NETWORK_TAG_MAPPING_FILE_PATH" type="java.lang.String"
  20569. transient="false" volatile="false"
  20570. static="true" final="true" visibility="public"
  20571. deprecated="not deprecated">
  20572. </field>
  20573. <field name="DEFAULT_NM_NETWORK_RESOURCE_TAG_MAPPING_FILE_PATH" type="java.lang.String"
  20574. transient="false" volatile="false"
  20575. static="true" final="true" visibility="public"
  20576. deprecated="not deprecated">
  20577. </field>
  20578. <field name="NM_WEBAPP_ADDRESS" type="java.lang.String"
  20579. transient="false" volatile="false"
  20580. static="true" final="true" visibility="public"
  20581. deprecated="not deprecated">
  20582. <doc>
  20583. <![CDATA[NM Webapp address.]]>
  20584. </doc>
  20585. </field>
  20586. <field name="DEFAULT_NM_WEBAPP_PORT" type="int"
  20587. transient="false" volatile="false"
  20588. static="true" final="true" visibility="public"
  20589. deprecated="not deprecated">
  20590. </field>
  20591. <field name="DEFAULT_NM_WEBAPP_ADDRESS" type="java.lang.String"
  20592. transient="false" volatile="false"
  20593. static="true" final="true" visibility="public"
  20594. deprecated="not deprecated">
  20595. </field>
  20596. <field name="NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  20597. transient="false" volatile="false"
  20598. static="true" final="true" visibility="public"
  20599. deprecated="not deprecated">
  20600. <doc>
  20601. <![CDATA[NM Webapp https address.]]>
  20602. </doc>
  20603. </field>
  20604. <field name="DEFAULT_NM_WEBAPP_HTTPS_PORT" type="int"
  20605. transient="false" volatile="false"
  20606. static="true" final="true" visibility="public"
  20607. deprecated="not deprecated">
  20608. </field>
  20609. <field name="DEFAULT_NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  20610. transient="false" volatile="false"
  20611. static="true" final="true" visibility="public"
  20612. deprecated="not deprecated">
  20613. </field>
  20614. <field name="NM_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
  20615. transient="false" volatile="false"
  20616. static="true" final="true" visibility="public"
  20617. deprecated="not deprecated">
  20618. <doc>
  20619. <![CDATA[Enable/disable CORS filter.]]>
  20620. </doc>
  20621. </field>
  20622. <field name="DEFAULT_NM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
  20623. transient="false" volatile="false"
  20624. static="true" final="true" visibility="public"
  20625. deprecated="not deprecated">
  20626. </field>
  20627. <field name="NM_RESOURCE_MON_INTERVAL_MS" type="java.lang.String"
  20628. transient="false" volatile="false"
  20629. static="true" final="true" visibility="public"
  20630. deprecated="not deprecated">
  20631. <doc>
  20632. <![CDATA[How often to monitor resource in a node.]]>
  20633. </doc>
  20634. </field>
  20635. <field name="DEFAULT_NM_RESOURCE_MON_INTERVAL_MS" type="int"
  20636. transient="false" volatile="false"
  20637. static="true" final="true" visibility="public"
  20638. deprecated="not deprecated">
  20639. </field>
  20640. <field name="NM_CONTAINER_MONITOR_ENABLED" type="java.lang.String"
  20641. transient="false" volatile="false"
  20642. static="true" final="true" visibility="public"
  20643. deprecated="not deprecated">
  20644. </field>
  20645. <field name="DEFAULT_NM_CONTAINER_MONITOR_ENABLED" type="boolean"
  20646. transient="false" volatile="false"
  20647. static="true" final="true" visibility="public"
  20648. deprecated="not deprecated">
  20649. </field>
  20650. <field name="NM_CONTAINER_MON_INTERVAL_MS" type="java.lang.String"
  20651. transient="false" volatile="false"
  20652. static="true" final="true" visibility="public"
  20653. deprecated="not deprecated">
  20654. <doc>
  20655. <![CDATA[How often to monitor containers.]]>
  20656. </doc>
  20657. </field>
  20658. <field name="DEFAULT_NM_CONTAINER_MON_INTERVAL_MS" type="int"
  20659. transient="false" volatile="false"
  20660. static="true" final="true" visibility="public"
  20661. deprecated="not deprecated">
  20662. </field>
  20663. <field name="NM_MON_RESOURCE_CALCULATOR" type="java.lang.String"
  20664. transient="false" volatile="false"
  20665. static="true" final="true" visibility="public"
  20666. deprecated="not deprecated">
  20667. <doc>
  20668. <![CDATA[Class that calculates current resource utilization.]]>
  20669. </doc>
  20670. </field>
  20671. <field name="NM_CONTAINER_MON_RESOURCE_CALCULATOR" type="java.lang.String"
  20672. transient="false" volatile="false"
  20673. static="true" final="true" visibility="public"
  20674. deprecated="not deprecated">
  20675. <doc>
  20676. <![CDATA[Class that calculates containers current resource utilization.]]>
  20677. </doc>
  20678. </field>
  20679. <field name="NM_CONTAINER_MON_PROCESS_TREE" type="java.lang.String"
  20680. transient="false" volatile="false"
  20681. static="true" final="true" visibility="public"
  20682. deprecated="not deprecated">
  20683. <doc>
  20684. <![CDATA[Class that calculates process tree resource utilization.]]>
  20685. </doc>
  20686. </field>
  20687. <field name="PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="java.lang.String"
  20688. transient="false" volatile="false"
  20689. static="true" final="true" visibility="public"
  20690. deprecated="not deprecated">
  20691. </field>
  20692. <field name="DEFAULT_PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="boolean"
  20693. transient="false" volatile="false"
  20694. static="true" final="true" visibility="public"
  20695. deprecated="not deprecated">
  20696. </field>
  20697. <field name="APPLICATION_TAG_BASED_PLACEMENT_ENABLED" type="java.lang.String"
  20698. transient="false" volatile="false"
  20699. static="true" final="true" visibility="public"
  20700. deprecated="not deprecated">
  20701. </field>
  20702. <field name="DEFAULT_APPLICATION_TAG_BASED_PLACEMENT_ENABLED" type="boolean"
  20703. transient="false" volatile="false"
  20704. static="true" final="true" visibility="public"
  20705. deprecated="not deprecated">
  20706. </field>
  20707. <field name="APPLICATION_TAG_BASED_PLACEMENT_USER_WHITELIST" type="java.lang.String"
  20708. transient="false" volatile="false"
  20709. static="true" final="true" visibility="public"
  20710. deprecated="not deprecated">
  20711. </field>
  20712. <field name="NM_CONTAINER_LOG_MONITOR_ENABLED" type="java.lang.String"
  20713. transient="false" volatile="false"
  20714. static="true" final="true" visibility="public"
  20715. deprecated="not deprecated">
  20716. <doc>
  20717. <![CDATA[Enable switch for container log monitoring.]]>
  20718. </doc>
  20719. </field>
  20720. <field name="DEFAULT_NM_CONTAINER_LOG_MONITOR_ENABLED" type="boolean"
  20721. transient="false" volatile="false"
  20722. static="true" final="true" visibility="public"
  20723. deprecated="not deprecated">
  20724. </field>
  20725. <field name="NM_CONTAINER_LOG_MON_INTERVAL_MS" type="java.lang.String"
  20726. transient="false" volatile="false"
  20727. static="true" final="true" visibility="public"
  20728. deprecated="not deprecated">
  20729. <doc>
  20730. <![CDATA[How often to monitor logs generated by containers.]]>
  20731. </doc>
  20732. </field>
  20733. <field name="DEFAULT_NM_CONTAINER_LOG_MON_INTERVAL_MS" type="int"
  20734. transient="false" volatile="false"
  20735. static="true" final="true" visibility="public"
  20736. deprecated="not deprecated">
  20737. </field>
  20738. <field name="NM_CONTAINER_LOG_DIR_SIZE_LIMIT_BYTES" type="java.lang.String"
  20739. transient="false" volatile="false"
  20740. static="true" final="true" visibility="public"
  20741. deprecated="not deprecated">
  20742. <doc>
  20743. <![CDATA[The disk space limit for a single container log directory.]]>
  20744. </doc>
  20745. </field>
  20746. <field name="DEFAULT_NM_CONTAINER_LOG_DIR_SIZE_LIMIT_BYTES" type="long"
  20747. transient="false" volatile="false"
  20748. static="true" final="true" visibility="public"
  20749. deprecated="not deprecated">
  20750. </field>
  20751. <field name="NM_CONTAINER_LOG_TOTAL_SIZE_LIMIT_BYTES" type="java.lang.String"
  20752. transient="false" volatile="false"
  20753. static="true" final="true" visibility="public"
  20754. deprecated="not deprecated">
  20755. <doc>
  20756. <![CDATA[The disk space limit for all of a container's logs.]]>
  20757. </doc>
  20758. </field>
  20759. <field name="DEFAULT_NM_CONTAINER_LOG_TOTAL_SIZE_LIMIT_BYTES" type="long"
  20760. transient="false" volatile="false"
  20761. static="true" final="true" visibility="public"
  20762. deprecated="not deprecated">
  20763. </field>
  20764. <field name="NM_CONTAINER_METRICS_ENABLE" type="java.lang.String"
  20765. transient="false" volatile="false"
  20766. static="true" final="true" visibility="public"
  20767. deprecated="not deprecated">
  20768. <doc>
  20769. <![CDATA[Enable/disable container metrics.]]>
  20770. </doc>
  20771. </field>
  20772. <field name="DEFAULT_NM_CONTAINER_METRICS_ENABLE" type="boolean"
  20773. transient="false" volatile="false"
  20774. static="true" final="true" visibility="public"
  20775. deprecated="not deprecated">
  20776. </field>
  20777. <field name="NM_CONTAINER_METRICS_PERIOD_MS" type="java.lang.String"
  20778. transient="false" volatile="false"
  20779. static="true" final="true" visibility="public"
  20780. deprecated="not deprecated">
  20781. <doc>
  20782. <![CDATA[Container metrics flush period. -1 for flush on completion.]]>
  20783. </doc>
  20784. </field>
  20785. <field name="DEFAULT_NM_CONTAINER_METRICS_PERIOD_MS" type="int"
  20786. transient="false" volatile="false"
  20787. static="true" final="true" visibility="public"
  20788. deprecated="not deprecated">
  20789. </field>
  20790. <field name="NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="java.lang.String"
  20791. transient="false" volatile="false"
  20792. static="true" final="true" visibility="public"
  20793. deprecated="not deprecated">
  20794. <doc>
  20795. <![CDATA[The delay time ms to unregister container metrics after completion.]]>
  20796. </doc>
  20797. </field>
  20798. <field name="DEFAULT_NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="int"
  20799. transient="false" volatile="false"
  20800. static="true" final="true" visibility="public"
  20801. deprecated="not deprecated">
  20802. </field>
  20803. <field name="NM_DISK_HEALTH_CHECK_ENABLE" type="java.lang.String"
  20804. transient="false" volatile="false"
  20805. static="true" final="true" visibility="public"
  20806. deprecated="not deprecated">
  20807. <doc>
  20808. <![CDATA[Enable/Disable disks' health checker. Default is true. An expert level
  20809. configuration property.]]>
  20810. </doc>
  20811. </field>
  20812. <field name="NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
  20813. transient="false" volatile="false"
  20814. static="true" final="true" visibility="public"
  20815. deprecated="not deprecated">
  20816. <doc>
  20817. <![CDATA[Frequency of running disks' health checker.]]>
  20818. </doc>
  20819. </field>
  20820. <field name="DEFAULT_NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="long"
  20821. transient="false" volatile="false"
  20822. static="true" final="true" visibility="public"
  20823. deprecated="not deprecated">
  20824. <doc>
  20825. <![CDATA[By default, disks' health is checked every 2 minutes.]]>
  20826. </doc>
  20827. </field>
  20828. <field name="NM_MIN_HEALTHY_DISKS_FRACTION" type="java.lang.String"
  20829. transient="false" volatile="false"
  20830. static="true" final="true" visibility="public"
  20831. deprecated="not deprecated">
  20832. <doc>
  20833. <![CDATA[The minimum fraction of number of disks to be healthy for the nodemanager
  20834. to launch new containers. This applies to nm-local-dirs and nm-log-dirs.]]>
  20835. </doc>
  20836. </field>
  20837. <field name="DEFAULT_NM_MIN_HEALTHY_DISKS_FRACTION" type="float"
  20838. transient="false" volatile="false"
  20839. static="true" final="true" visibility="public"
  20840. deprecated="not deprecated">
  20841. <doc>
  20842. <![CDATA[By default, at least 25% of disks are to be healthy to say that the node is
  20843. healthy in terms of disks.]]>
  20844. </doc>
  20845. </field>
  20846. <field name="NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="java.lang.String"
  20847. transient="false" volatile="false"
  20848. static="true" final="true" visibility="public"
  20849. deprecated="not deprecated">
  20850. <doc>
  20851. <![CDATA[The maximum percentage of disk space that can be used after which a disk is
  20852. marked as offline. Values can range from 0.0 to 100.0. If the value is
  20853. greater than or equal to 100, NM will check for full disk. This applies to
  20854. nm-local-dirs and nm-log-dirs.
  20855. This applies when disk-utilization-threshold.enabled is true.]]>
  20856. </doc>
  20857. </field>
  20858. <field name="DEFAULT_NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="float"
  20859. transient="false" volatile="false"
  20860. static="true" final="true" visibility="public"
  20861. deprecated="not deprecated">
  20862. <doc>
  20863. <![CDATA[By default, 90% of the disk can be used before it is marked as offline.]]>
  20864. </doc>
  20865. </field>
  20866. <field name="NM_DISK_UTILIZATION_THRESHOLD_ENABLED" type="java.lang.String"
  20867. transient="false" volatile="false"
  20868. static="true" final="true" visibility="public"
  20869. deprecated="not deprecated">
  20870. <doc>
  20871. <![CDATA[Enable/Disable the disk utilisation percentage
  20872. threshold for disk health checker.]]>
  20873. </doc>
  20874. </field>
  20875. <field name="DEFAULT_NM_DISK_UTILIZATION_THRESHOLD_ENABLED" type="boolean"
  20876. transient="false" volatile="false"
  20877. static="true" final="true" visibility="public"
  20878. deprecated="not deprecated">
  20879. </field>
  20880. <field name="NM_WM_LOW_PER_DISK_UTILIZATION_PERCENTAGE" type="java.lang.String"
  20881. transient="false" volatile="false"
  20882. static="true" final="true" visibility="public"
  20883. deprecated="not deprecated">
  20884. <doc>
  20885. <![CDATA[The low threshold percentage of disk space used when an offline disk is
  20886. marked as online. Values can range from 0.0 to 100.0. The value shouldn't
  20887. be more than NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE. If its value is
  20888. more than NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE or not set, it will be
  20889. set to the same value as NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE.
  20890. This applies to nm-local-dirs and nm-log-dirs.]]>
  20891. </doc>
  20892. </field>
  20893. <field name="NM_MIN_PER_DISK_FREE_SPACE_MB" type="java.lang.String"
  20894. transient="false" volatile="false"
  20895. static="true" final="true" visibility="public"
  20896. deprecated="not deprecated">
  20897. <doc>
  20898. <![CDATA[The minimum space that must be available on a local dir for it to be used.
  20899. This applies to nm-local-dirs and nm-log-dirs.
  20900. This applies when disk-free-space-threshold.enabled is true.]]>
  20901. </doc>
  20902. </field>
  20903. <field name="NM_DISK_FREE_SPACE_THRESHOLD_ENABLED" type="java.lang.String"
  20904. transient="false" volatile="false"
  20905. static="true" final="true" visibility="public"
  20906. deprecated="not deprecated">
  20907. <doc>
  20908. <![CDATA[Enable/Disable the minimum disk free
  20909. space threshold for disk health checker.]]>
  20910. </doc>
  20911. </field>
  20912. <field name="DEFAULT_NM_DISK_FREE_SPACE_THRESHOLD_ENABLED" type="boolean"
  20913. transient="false" volatile="false"
  20914. static="true" final="true" visibility="public"
  20915. deprecated="not deprecated">
  20916. </field>
  20917. <field name="NM_WM_HIGH_PER_DISK_FREE_SPACE_MB" type="java.lang.String"
  20918. transient="false" volatile="false"
  20919. static="true" final="true" visibility="public"
  20920. deprecated="not deprecated">
  20921. <doc>
  20922. <![CDATA[The minimum space that must be available on an offline
  20923. disk for it to be marked as online. The value should not be less
  20924. than NM_MIN_PER_DISK_FREE_SPACE_MB. If its value is less than
  20925. NM_MIN_PER_DISK_FREE_SPACE_MB or is not set, it will be set to the
  20926. same value as NM_MIN_PER_DISK_FREE_SPACE_MB.
  20927. This applies to nm-local-dirs and nm-log-dirs.]]>
  20928. </doc>
  20929. </field>
  20930. <field name="DEFAULT_NM_MIN_PER_DISK_FREE_SPACE_MB" type="long"
  20931. transient="false" volatile="false"
  20932. static="true" final="true" visibility="public"
  20933. deprecated="not deprecated">
  20934. <doc>
  20935. <![CDATA[By default, all of the disk can be used before it is marked as offline.]]>
  20936. </doc>
  20937. </field>
  20938. <field name="NM_HEALTH_CHECK_SCRIPTS" type="java.lang.String"
  20939. transient="false" volatile="false"
  20940. static="true" final="true" visibility="public"
  20941. deprecated="not deprecated">
  20942. <doc>
  20943. <![CDATA[The health checker scripts.]]>
  20944. </doc>
  20945. </field>
  20946. <field name="DEFAULT_NM_HEALTH_CHECK_SCRIPTS" type="java.lang.String[]"
  20947. transient="false" volatile="false"
  20948. static="true" final="true" visibility="public"
  20949. deprecated="not deprecated">
  20950. </field>
  20951. <field name="NM_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
  20952. transient="false" volatile="false"
  20953. static="true" final="true" visibility="public"
  20954. deprecated="not deprecated">
  20955. <doc>
  20956. <![CDATA[Frequency of running node health script.]]>
  20957. </doc>
  20958. </field>
  20959. <field name="DEFAULT_NM_HEALTH_CHECK_INTERVAL_MS" type="long"
  20960. transient="false" volatile="false"
  20961. static="true" final="true" visibility="public"
  20962. deprecated="not deprecated">
  20963. </field>
  20964. <field name="NM_HEALTH_CHECK_RUN_BEFORE_STARTUP" type="java.lang.String"
  20965. transient="false" volatile="false"
  20966. static="true" final="true" visibility="public"
  20967. deprecated="not deprecated">
  20968. <doc>
  20969. <![CDATA[Whether or not to run the node health script before the NM
  20970. starts up.]]>
  20971. </doc>
  20972. </field>
  20973. <field name="DEFAULT_NM_HEALTH_CHECK_RUN_BEFORE_STARTUP" type="boolean"
  20974. transient="false" volatile="false"
  20975. static="true" final="true" visibility="public"
  20976. deprecated="not deprecated">
  20977. </field>
  20978. <field name="NM_HEALTH_CHECK_TIMEOUT_MS" type="java.lang.String"
  20979. transient="false" volatile="false"
  20980. static="true" final="true" visibility="public"
  20981. deprecated="not deprecated">
  20982. <doc>
  20983. <![CDATA[Health check time out period for all scripts.]]>
  20984. </doc>
  20985. </field>
  20986. <field name="DEFAULT_NM_HEALTH_CHECK_TIMEOUT_MS" type="long"
  20987. transient="false" volatile="false"
  20988. static="true" final="true" visibility="public"
  20989. deprecated="not deprecated">
  20990. </field>
  20991. <field name="NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS_TEMPLATE" type="java.lang.String"
  20992. transient="false" volatile="false"
  20993. static="true" final="true" visibility="public"
  20994. deprecated="not deprecated">
  20995. <doc>
  20996. <![CDATA[Health check script time out period.]]>
  20997. </doc>
  20998. </field>
  20999. <field name="NM_HEALTH_CHECK_SCRIPT_PATH_TEMPLATE" type="java.lang.String"
  21000. transient="false" volatile="false"
  21001. static="true" final="true" visibility="public"
  21002. deprecated="not deprecated">
  21003. <doc>
  21004. <![CDATA[The health check script to run.]]>
  21005. </doc>
  21006. </field>
  21007. <field name="NM_HEALTH_CHECK_SCRIPT_OPTS_TEMPLATE" type="java.lang.String"
  21008. transient="false" volatile="false"
  21009. static="true" final="true" visibility="public"
  21010. deprecated="not deprecated">
  21011. <doc>
  21012. <![CDATA[The arguments to pass to the health check script.]]>
  21013. </doc>
  21014. </field>
  21015. <field name="NM_HEALTH_CHECK_SCRIPT_INTERVAL_MS_TEMPLATE" type="java.lang.String"
  21016. transient="false" volatile="false"
  21017. static="true" final="true" visibility="public"
  21018. deprecated="not deprecated">
  21019. <doc>
  21020. <![CDATA[Frequency of running node health script.]]>
  21021. </doc>
  21022. </field>
  21023. <field name="NM_CONTAINER_LOCALIZER_JAVA_OPTS_KEY" type="java.lang.String"
  21024. transient="false" volatile="false"
  21025. static="true" final="true" visibility="public"
  21026. deprecated="not deprecated">
  21027. <doc>
  21028. <![CDATA[The JVM options used on forking ContainerLocalizer process
  21029. by container executor.]]>
  21030. </doc>
  21031. </field>
  21032. <field name="NM_CONTAINER_LOCALIZER_JAVA_OPTS_DEFAULT" type="java.lang.String"
  21033. transient="false" volatile="false"
  21034. static="true" final="true" visibility="public"
  21035. deprecated="not deprecated">
  21036. </field>
  21037. <field name="NM_CONTAINER_LOCALIZER_LOG_LEVEL" type="java.lang.String"
  21038. transient="false" volatile="false"
  21039. static="true" final="true" visibility="public"
  21040. deprecated="not deprecated">
  21041. <doc>
  21042. <![CDATA[The log level of container localizer process.]]>
  21043. </doc>
  21044. </field>
  21045. <field name="NM_CONTAINER_LOCALIZER_LOG_LEVEL_DEFAULT" type="java.lang.String"
  21046. transient="false" volatile="false"
  21047. static="true" final="true" visibility="public"
  21048. deprecated="not deprecated">
  21049. </field>
  21050. <field name="LINUX_CONTAINER_RUNTIME_PREFIX" type="java.lang.String"
  21051. transient="false" volatile="false"
  21052. static="true" final="true" visibility="public"
  21053. deprecated="not deprecated">
  21054. <doc>
  21055. <![CDATA[Prefix for runtime configuration constants.]]>
  21056. </doc>
  21057. </field>
  21058. <field name="LINUX_CONTAINER_RUNTIME_ALLOWED_RUNTIMES" type="java.lang.String"
  21059. transient="false" volatile="false"
  21060. static="true" final="true" visibility="public"
  21061. deprecated="not deprecated">
  21062. <doc>
  21063. <![CDATA[Comma separated list of runtimes that are allowed when using
  21064. LinuxContainerExecutor. The standard values are:
  21065. <ul>
  21066. <li>default</li>
  21067. <li>docker</li>
  21068. <li>javasandbox</li>
  21069. <li>runc</li>
  21070. </ul>]]>
  21071. </doc>
  21072. </field>
  21073. <field name="LINUX_CONTAINER_RUNTIME_CLASS_FMT" type="java.lang.String"
  21074. transient="false" volatile="false"
  21075. static="true" final="true" visibility="public"
  21076. deprecated="not deprecated">
  21077. </field>
  21078. <field name="DEFAULT_LINUX_CONTAINER_RUNTIME_ALLOWED_RUNTIMES" type="java.lang.String[]"
  21079. transient="false" volatile="false"
  21080. static="true" final="true" visibility="public"
  21081. deprecated="not deprecated">
  21082. <doc>
  21083. <![CDATA[The default list of allowed runtimes when using LinuxContainerExecutor.]]>
  21084. </doc>
  21085. </field>
  21086. <field name="LINUX_CONTAINER_RUNTIME_TYPE" type="java.lang.String"
  21087. transient="false" volatile="false"
  21088. static="true" final="true" visibility="public"
  21089. deprecated="not deprecated">
  21090. <doc>
  21091. <![CDATA[Default runtime to be used.]]>
  21092. </doc>
  21093. </field>
  21094. <field name="RUNC_CONTAINER_RUNTIME_PREFIX" type="java.lang.String"
  21095. transient="false" volatile="false"
  21096. static="true" final="true" visibility="public"
  21097. deprecated="not deprecated">
  21098. </field>
  21099. <field name="NM_RUNC_IMAGE_TAG_TO_MANIFEST_PLUGIN" type="java.lang.String"
  21100. transient="false" volatile="false"
  21101. static="true" final="true" visibility="public"
  21102. deprecated="not deprecated">
  21103. <doc>
  21104. <![CDATA[The runc image tag to manifest plugin class that should be used.]]>
  21105. </doc>
  21106. </field>
  21107. <field name="DEFAULT_NM_RUNC_IMAGE_TAG_TO_MANIFEST_PLUGIN" type="java.lang.String"
  21108. transient="false" volatile="false"
  21109. static="true" final="true" visibility="public"
  21110. deprecated="not deprecated">
  21111. <doc>
  21112. <![CDATA[Default runc image tag to manifest plugin class.]]>
  21113. </doc>
  21114. </field>
  21115. <field name="NM_RUNC_MANIFEST_TO_RESOURCES_PLUGIN" type="java.lang.String"
  21116. transient="false" volatile="false"
  21117. static="true" final="true" visibility="public"
  21118. deprecated="not deprecated">
  21119. <doc>
  21120. <![CDATA[The runc manifest to resources plugin class that should be used.]]>
  21121. </doc>
  21122. </field>
  21123. <field name="DEFAULT_NM_RUNC_MANIFEST_TO_RESOURCES_PLUGIN" type="java.lang.String"
  21124. transient="false" volatile="false"
  21125. static="true" final="true" visibility="public"
  21126. deprecated="not deprecated">
  21127. <doc>
  21128. <![CDATA[Default runc manifest to resources plugin plugin class.]]>
  21129. </doc>
  21130. </field>
  21131. <field name="NM_RUNC_IMAGE_TOPLEVEL_DIR" type="java.lang.String"
  21132. transient="false" volatile="false"
  21133. static="true" final="true" visibility="public"
  21134. deprecated="not deprecated">
  21135. <doc>
  21136. <![CDATA[The HDFS location under which the oci image manifests, layers,
  21137. and configs directories exist.]]>
  21138. </doc>
  21139. </field>
  21140. <field name="DEFAULT_NM_RUNC_IMAGE_TOPLEVEL_DIR" type="java.lang.String"
  21141. transient="false" volatile="false"
  21142. static="true" final="true" visibility="public"
  21143. deprecated="not deprecated">
  21144. <doc>
  21145. <![CDATA[Default HDFS location under which the oci image manifests, layers,
  21146. and configs directories exist.]]>
  21147. </doc>
  21148. </field>
  21149. <field name="NM_RUNC_LAYER_MOUNTS_TO_KEEP" type="java.lang.String"
  21150. transient="false" volatile="false"
  21151. static="true" final="true" visibility="public"
  21152. deprecated="not deprecated">
  21153. <doc>
  21154. <![CDATA[Target count of layer mounts that we should keep on disk at one time.]]>
  21155. </doc>
  21156. </field>
  21157. <field name="DEFAULT_NM_RUNC_LAYER_MOUNTS_TO_KEEP" type="int"
  21158. transient="false" volatile="false"
  21159. static="true" final="true" visibility="public"
  21160. deprecated="not deprecated">
  21161. </field>
  21162. <field name="NM_REAP_RUNC_LAYER_MOUNTS_INTERVAL" type="java.lang.String"
  21163. transient="false" volatile="false"
  21164. static="true" final="true" visibility="public"
  21165. deprecated="not deprecated">
  21166. <doc>
  21167. <![CDATA[The interval in seconds between executions of reaping layer mounts.]]>
  21168. </doc>
  21169. </field>
  21170. <field name="DEFAULT_NM_REAP_RUNC_LAYER_MOUNTS_INTERVAL" type="int"
  21171. transient="false" volatile="false"
  21172. static="true" final="true" visibility="public"
  21173. deprecated="not deprecated">
  21174. </field>
  21175. <field name="NM_RUNC_IMAGE_NAME" type="java.lang.String"
  21176. transient="false" volatile="false"
  21177. static="true" final="true" visibility="public"
  21178. deprecated="not deprecated">
  21179. <doc>
  21180. <![CDATA[Default runc image to be used.]]>
  21181. </doc>
  21182. </field>
  21183. <field name="NM_RUNC_ALLOW_PRIVILEGED_CONTAINERS" type="java.lang.String"
  21184. transient="false" volatile="false"
  21185. static="true" final="true" visibility="public"
  21186. deprecated="not deprecated">
  21187. <doc>
  21188. <![CDATA[Allow privileged containers. Use with extreme care.]]>
  21189. </doc>
  21190. </field>
  21191. <field name="DEFAULT_NM_RUNC_ALLOW_PRIVILEGED_CONTAINERS" type="boolean"
  21192. transient="false" volatile="false"
  21193. static="true" final="true" visibility="public"
  21194. deprecated="not deprecated">
  21195. <doc>
  21196. <![CDATA[Privileged containers are disabled by default.]]>
  21197. </doc>
  21198. </field>
  21199. <field name="NM_RUNC_ALLOWED_CONTAINER_NETWORKS" type="java.lang.String"
  21200. transient="false" volatile="false"
  21201. static="true" final="true" visibility="public"
  21202. deprecated="not deprecated">
  21203. <doc>
  21204. <![CDATA[The set of networks allowed when launching containers using the
  21205. RuncContainerRuntime.]]>
  21206. </doc>
  21207. </field>
  21208. <field name="DEFAULT_NM_RUNC_ALLOWED_CONTAINER_NETWORKS" type="java.lang.String[]"
  21209. transient="false" volatile="false"
  21210. static="true" final="true" visibility="public"
  21211. deprecated="not deprecated">
  21212. <doc>
  21213. <![CDATA[The default set of networks allowed when launching containers using the
  21214. RuncContainerRuntime.]]>
  21215. </doc>
  21216. </field>
  21217. <field name="NM_RUNC_ALLOWED_CONTAINER_RUNTIMES" type="java.lang.String"
  21218. transient="false" volatile="false"
  21219. static="true" final="true" visibility="public"
  21220. deprecated="not deprecated">
  21221. <doc>
  21222. <![CDATA[The set of runtimes allowed when launching containers using the
  21223. RuncContainerRuntime.]]>
  21224. </doc>
  21225. </field>
  21226. <field name="DEFAULT_NM_RUNC_ALLOWED_CONTAINER_RUNTIMES" type="java.lang.String[]"
  21227. transient="false" volatile="false"
  21228. static="true" final="true" visibility="public"
  21229. deprecated="not deprecated">
  21230. <doc>
  21231. <![CDATA[The default set of runtimes allowed when launching containers using the
  21232. RuncContainerRuntime.]]>
  21233. </doc>
  21234. </field>
  21235. <field name="NM_RUNC_PRIVILEGED_CONTAINERS_ACL" type="java.lang.String"
  21236. transient="false" volatile="false"
  21237. static="true" final="true" visibility="public"
  21238. deprecated="not deprecated">
  21239. <doc>
  21240. <![CDATA[ACL list for users allowed to run privileged containers.]]>
  21241. </doc>
  21242. </field>
  21243. <field name="DEFAULT_NM_RUNC_PRIVILEGED_CONTAINERS_ACL" type="java.lang.String"
  21244. transient="false" volatile="false"
  21245. static="true" final="true" visibility="public"
  21246. deprecated="not deprecated">
  21247. <doc>
  21248. <![CDATA[Default list for users allowed to run privileged containers is empty.]]>
  21249. </doc>
  21250. </field>
  21251. <field name="NM_RUNC_ALLOW_HOST_PID_NAMESPACE" type="java.lang.String"
  21252. transient="false" volatile="false"
  21253. static="true" final="true" visibility="public"
  21254. deprecated="not deprecated">
  21255. <doc>
  21256. <![CDATA[Allow host pid namespace for containers. Use with care.]]>
  21257. </doc>
  21258. </field>
  21259. <field name="DEFAULT_NM_RUNC_ALLOW_HOST_PID_NAMESPACE" type="boolean"
  21260. transient="false" volatile="false"
  21261. static="true" final="true" visibility="public"
  21262. deprecated="not deprecated">
  21263. <doc>
  21264. <![CDATA[Host pid namespace for containers is disabled by default.]]>
  21265. </doc>
  21266. </field>
  21267. <field name="NM_RUNC_DEFAULT_RO_MOUNTS" type="java.lang.String"
  21268. transient="false" volatile="false"
  21269. static="true" final="true" visibility="public"
  21270. deprecated="not deprecated">
  21271. <doc>
  21272. <![CDATA[The default list of read-only mounts to be bind-mounted into all
  21273. runC containers that use RuncContainerRuntime.]]>
  21274. </doc>
  21275. </field>
  21276. <field name="NM_RUNC_DEFAULT_RW_MOUNTS" type="java.lang.String"
  21277. transient="false" volatile="false"
  21278. static="true" final="true" visibility="public"
  21279. deprecated="not deprecated">
  21280. <doc>
  21281. <![CDATA[The default list of read-write mounts to be bind-mounted into all
  21282. runC containers that use RuncContainerRuntime.]]>
  21283. </doc>
  21284. </field>
  21285. <field name="NM_RUNC_SECCOMP_PROFILE" type="java.lang.String"
  21286. transient="false" volatile="false"
  21287. static="true" final="true" visibility="public"
  21288. deprecated="not deprecated">
  21289. <doc>
  21290. <![CDATA[Path to the seccomp profile to use with Runc containers.]]>
  21291. </doc>
  21292. </field>
  21293. <field name="NM_HDFS_RUNC_IMAGE_TAG_TO_HASH_FILE" type="java.lang.String"
  21294. transient="false" volatile="false"
  21295. static="true" final="true" visibility="public"
  21296. deprecated="not deprecated">
  21297. <doc>
  21298. <![CDATA[The HDFS location where the runC image tag to hash file exists.]]>
  21299. </doc>
  21300. </field>
  21301. <field name="NM_LOCAL_RUNC_IMAGE_TAG_TO_HASH_FILE" type="java.lang.String"
  21302. transient="false" volatile="false"
  21303. static="true" final="true" visibility="public"
  21304. deprecated="not deprecated">
  21305. <doc>
  21306. <![CDATA[The local file system location where the runC image tag to hash file exists.]]>
  21307. </doc>
  21308. </field>
  21309. <field name="NM_RUNC_CACHE_REFRESH_INTERVAL" type="java.lang.String"
  21310. transient="false" volatile="false"
  21311. static="true" final="true" visibility="public"
  21312. deprecated="not deprecated">
  21313. <doc>
  21314. <![CDATA[The interval in seconds between refreshing the hdfs image tag to
  21315. hash cache.]]>
  21316. </doc>
  21317. </field>
  21318. <field name="DEFAULT_NM_RUNC_CACHE_REFRESH_INTERVAL" type="int"
  21319. transient="false" volatile="false"
  21320. static="true" final="true" visibility="public"
  21321. deprecated="not deprecated">
  21322. <doc>
  21323. <![CDATA[The default interval in seconds between refreshing the hdfs image tag to
  21324. hash cache.]]>
  21325. </doc>
  21326. </field>
  21327. <field name="NM_RUNC_NUM_MANIFESTS_TO_CACHE" type="java.lang.String"
  21328. transient="false" volatile="false"
  21329. static="true" final="true" visibility="public"
  21330. deprecated="not deprecated">
  21331. <doc>
  21332. <![CDATA[The number of manifests to cache in the image tag to hash cache.]]>
  21333. </doc>
  21334. </field>
  21335. <field name="DEFAULT_NUM_MANIFESTS_TO_CACHE" type="int"
  21336. transient="false" volatile="false"
  21337. static="true" final="true" visibility="public"
  21338. deprecated="not deprecated">
  21339. <doc>
  21340. <![CDATA[The default number of manifests to cache in the image tag to hash cache.]]>
  21341. </doc>
  21342. </field>
  21343. <field name="NM_RUNC_STAT_CACHE_TIMEOUT" type="java.lang.String"
  21344. transient="false" volatile="false"
  21345. static="true" final="true" visibility="public"
  21346. deprecated="not deprecated">
  21347. <doc>
  21348. <![CDATA[The timeout value in seconds for the values in the stat cache.]]>
  21349. </doc>
  21350. </field>
  21351. <field name="DEFAULT_NM_RUNC_STAT_CACHE_TIMEOUT" type="int"
  21352. transient="false" volatile="false"
  21353. static="true" final="true" visibility="public"
  21354. deprecated="not deprecated">
  21355. <doc>
  21356. <![CDATA[The default timeout value in seconds for the values in the stat cache.]]>
  21357. </doc>
  21358. </field>
  21359. <field name="NM_RUNC_STAT_CACHE_SIZE" type="java.lang.String"
  21360. transient="false" volatile="false"
  21361. static="true" final="true" visibility="public"
  21362. deprecated="not deprecated">
  21363. <doc>
  21364. <![CDATA[The size of the stat cache which stores stats of the layers and config.]]>
  21365. </doc>
  21366. </field>
  21367. <field name="DEFAULT_RUNC_STAT_CACHE_SIZE" type="int"
  21368. transient="false" volatile="false"
  21369. static="true" final="true" visibility="public"
  21370. deprecated="not deprecated">
  21371. <doc>
  21372. <![CDATA[The default size of the stat cache which stores stats of the
  21373. layers and config.]]>
  21374. </doc>
  21375. </field>
  21376. <field name="DOCKER_CONTAINER_RUNTIME_PREFIX" type="java.lang.String"
  21377. transient="false" volatile="false"
  21378. static="true" final="true" visibility="public"
  21379. deprecated="not deprecated">
  21380. </field>
  21381. <field name="NM_DOCKER_IMAGE_NAME" type="java.lang.String"
  21382. transient="false" volatile="false"
  21383. static="true" final="true" visibility="public"
  21384. deprecated="not deprecated">
  21385. <doc>
  21386. <![CDATA[Default docker image to be used.]]>
  21387. </doc>
  21388. </field>
  21389. <field name="NM_DOCKER_IMAGE_UPDATE" type="java.lang.String"
  21390. transient="false" volatile="false"
  21391. static="true" final="true" visibility="public"
  21392. deprecated="not deprecated">
  21393. <doc>
  21394. <![CDATA[Default option to decide whether to pull the latest image or not.]]>
  21395. </doc>
  21396. </field>
  21397. <field name="NM_DOCKER_CONTAINER_CAPABILITIES" type="java.lang.String"
  21398. transient="false" volatile="false"
  21399. static="true" final="true" visibility="public"
  21400. deprecated="not deprecated">
  21401. <doc>
  21402. <![CDATA[Capabilities allowed (and added by default) for docker containers.]]>
  21403. </doc>
  21404. </field>
  21405. <field name="DEFAULT_NM_DOCKER_CONTAINER_CAPABILITIES" type="java.lang.String[]"
  21406. transient="false" volatile="false"
  21407. static="true" final="true" visibility="public"
  21408. deprecated="not deprecated">
  21409. <doc>
  21410. <![CDATA[These are the default capabilities added by docker. We'll use the same
  21411. set here. While these may not be case-sensitive from a docker
  21412. perspective, it is best to keep these uppercase.]]>
  21413. </doc>
  21414. </field>
  21415. <field name="NM_DOCKER_ALLOW_PRIVILEGED_CONTAINERS" type="java.lang.String"
  21416. transient="false" volatile="false"
  21417. static="true" final="true" visibility="public"
  21418. deprecated="not deprecated">
  21419. <doc>
  21420. <![CDATA[Allow privileged containers. Use with extreme care.]]>
  21421. </doc>
  21422. </field>
  21423. <field name="DEFAULT_NM_DOCKER_ALLOW_PRIVILEGED_CONTAINERS" type="boolean"
  21424. transient="false" volatile="false"
  21425. static="true" final="true" visibility="public"
  21426. deprecated="not deprecated">
  21427. <doc>
  21428. <![CDATA[Privileged containers are disabled by default.]]>
  21429. </doc>
  21430. </field>
  21431. <field name="NM_DOCKER_ENABLE_USER_REMAPPING" type="java.lang.String"
  21432. transient="false" volatile="false"
  21433. static="true" final="true" visibility="public"
  21434. deprecated="not deprecated">
  21435. <doc>
  21436. <![CDATA[enable user remapping.]]>
  21437. </doc>
  21438. </field>
  21439. <field name="DEFAULT_NM_DOCKER_ENABLE_USER_REMAPPING" type="boolean"
  21440. transient="false" volatile="false"
  21441. static="true" final="true" visibility="public"
  21442. deprecated="not deprecated">
  21443. <doc>
  21444. <![CDATA[Set enable user remapping as false by default.]]>
  21445. </doc>
  21446. </field>
  21447. <field name="NM_DOCKER_USER_REMAPPING_UID_THRESHOLD" type="java.lang.String"
  21448. transient="false" volatile="false"
  21449. static="true" final="true" visibility="public"
  21450. deprecated="not deprecated">
  21451. <doc>
  21452. <![CDATA[lower limit for acceptable uids of user remapped user.]]>
  21453. </doc>
  21454. </field>
  21455. <field name="DEFAULT_NM_DOCKER_USER_REMAPPING_UID_THRESHOLD" type="int"
  21456. transient="false" volatile="false"
  21457. static="true" final="true" visibility="public"
  21458. deprecated="not deprecated">
  21459. <doc>
  21460. <![CDATA[Set user remapping lower uid limit to 1 by default.]]>
  21461. </doc>
  21462. </field>
  21463. <field name="NM_DOCKER_USER_REMAPPING_GID_THRESHOLD" type="java.lang.String"
  21464. transient="false" volatile="false"
  21465. static="true" final="true" visibility="public"
  21466. deprecated="not deprecated">
  21467. <doc>
  21468. <![CDATA[lower limit for acceptable gids of user remapped user.]]>
  21469. </doc>
  21470. </field>
  21471. <field name="DEFAULT_NM_DOCKER_USER_REMAPPING_GID_THRESHOLD" type="int"
  21472. transient="false" volatile="false"
  21473. static="true" final="true" visibility="public"
  21474. deprecated="not deprecated">
  21475. <doc>
  21476. <![CDATA[Set user remapping lower gid limit to 1 by default.]]>
  21477. </doc>
  21478. </field>
  21479. <field name="NM_DOCKER_PRIVILEGED_CONTAINERS_ACL" type="java.lang.String"
  21480. transient="false" volatile="false"
  21481. static="true" final="true" visibility="public"
  21482. deprecated="not deprecated">
  21483. <doc>
  21484. <![CDATA[ACL list for users allowed to run privileged containers.]]>
  21485. </doc>
  21486. </field>
  21487. <field name="DEFAULT_NM_DOCKER_PRIVILEGED_CONTAINERS_ACL" type="java.lang.String"
  21488. transient="false" volatile="false"
  21489. static="true" final="true" visibility="public"
  21490. deprecated="not deprecated">
  21491. <doc>
  21492. <![CDATA[Default list for users allowed to run privileged containers is empty.]]>
  21493. </doc>
  21494. </field>
  21495. <field name="NM_DOCKER_ALLOWED_CONTAINER_NETWORKS" type="java.lang.String"
  21496. transient="false" volatile="false"
  21497. static="true" final="true" visibility="public"
  21498. deprecated="not deprecated">
  21499. <doc>
  21500. <![CDATA[The set of networks allowed when launching containers using the
  21501. DockerContainerRuntime.]]>
  21502. </doc>
  21503. </field>
  21504. <field name="DEFAULT_NM_DOCKER_ALLOWED_CONTAINER_NETWORKS" type="java.lang.String[]"
  21505. transient="false" volatile="false"
  21506. static="true" final="true" visibility="public"
  21507. deprecated="not deprecated">
  21508. <doc>
  21509. <![CDATA[The set of networks allowed when launching containers using the
  21510. DockerContainerRuntime.]]>
  21511. </doc>
  21512. </field>
  21513. <field name="NM_DOCKER_DEFAULT_CONTAINER_NETWORK" type="java.lang.String"
  21514. transient="false" volatile="false"
  21515. static="true" final="true" visibility="public"
  21516. deprecated="not deprecated">
  21517. <doc>
  21518. <![CDATA[The network used when launching containers using the
  21519. DockerContainerRuntime when no network is specified in the request. This
  21520. network must be one of the (configurable) set of allowed container
  21521. networks.]]>
  21522. </doc>
  21523. </field>
  21524. <field name="DEFAULT_NM_DOCKER_DEFAULT_CONTAINER_NETWORK" type="java.lang.String"
  21525. transient="false" volatile="false"
  21526. static="true" final="true" visibility="public"
  21527. deprecated="not deprecated">
  21528. <doc>
  21529. <![CDATA[The network used when launching containers using the
  21530. DockerContainerRuntime when no network is specified in the request and
  21531. no default network is configured.
  21532. .]]>
  21533. </doc>
  21534. </field>
  21535. <field name="NM_DOCKER_ALLOWED_CONTAINER_RUNTIMES" type="java.lang.String"
  21536. transient="false" volatile="false"
  21537. static="true" final="true" visibility="public"
  21538. deprecated="not deprecated">
  21539. <doc>
  21540. <![CDATA[The set of runtimes allowed when launching containers using the
  21541. DockerContainerRuntime.]]>
  21542. </doc>
  21543. </field>
  21544. <field name="DEFAULT_NM_DOCKER_ALLOWED_CONTAINER_RUNTIMES" type="java.lang.String[]"
  21545. transient="false" volatile="false"
  21546. static="true" final="true" visibility="public"
  21547. deprecated="not deprecated">
  21548. <doc>
  21549. <![CDATA[The set of runtimes allowed when launching containers using the
  21550. DockerContainerRuntime.]]>
  21551. </doc>
  21552. </field>
  21553. <field name="NM_DOCKER_ALLOW_HOST_PID_NAMESPACE" type="java.lang.String"
  21554. transient="false" volatile="false"
  21555. static="true" final="true" visibility="public"
  21556. deprecated="not deprecated">
  21557. <doc>
  21558. <![CDATA[Allow host pid namespace for containers. Use with care.]]>
  21559. </doc>
  21560. </field>
  21561. <field name="DEFAULT_NM_DOCKER_ALLOW_HOST_PID_NAMESPACE" type="boolean"
  21562. transient="false" volatile="false"
  21563. static="true" final="true" visibility="public"
  21564. deprecated="not deprecated">
  21565. <doc>
  21566. <![CDATA[Host pid namespace for containers is disabled by default.]]>
  21567. </doc>
  21568. </field>
  21569. <field name="YARN_HTTP_WEBAPP_EXTERNAL_CLASSES" type="java.lang.String"
  21570. transient="false" volatile="false"
  21571. static="true" final="true" visibility="public"
  21572. deprecated="not deprecated">
  21573. </field>
  21574. <field name="HADOOP_HTTP_WEBAPP_SCHEDULER_PAGE" type="java.lang.String"
  21575. transient="false" volatile="false"
  21576. static="true" final="true" visibility="public"
  21577. deprecated="This field is deprecated for
  21578. {@link #YARN_HTTP_WEBAPP_SCHEDULER_PAGE}">
  21579. <doc>
  21580. <![CDATA[@deprecated This field is deprecated for
  21581. {@link #YARN_HTTP_WEBAPP_SCHEDULER_PAGE}]]>
  21582. </doc>
  21583. </field>
  21584. <field name="YARN_HTTP_WEBAPP_SCHEDULER_PAGE" type="java.lang.String"
  21585. transient="false" volatile="false"
  21586. static="true" final="true" visibility="public"
  21587. deprecated="not deprecated">
  21588. </field>
  21589. <field name="YARN_HTTP_WEBAPP_CUSTOM_DAO_CLASSES" type="java.lang.String"
  21590. transient="false" volatile="false"
  21591. static="true" final="true" visibility="public"
  21592. deprecated="not deprecated">
  21593. </field>
  21594. <field name="YARN_HTTP_WEBAPP_CUSTOM_UNWRAPPED_DAO_CLASSES" type="java.lang.String"
  21595. transient="false" volatile="false"
  21596. static="true" final="true" visibility="public"
  21597. deprecated="not deprecated">
  21598. </field>
  21599. <field name="NM_DOCKER_ALLOW_DELAYED_REMOVAL" type="java.lang.String"
  21600. transient="false" volatile="false"
  21601. static="true" final="true" visibility="public"
  21602. deprecated="not deprecated">
  21603. <doc>
  21604. <![CDATA[Whether or not users are allowed to request that Docker containers honor
  21605. the debug deletion delay. This is useful for troubleshooting Docker
  21606. container related launch failures.]]>
  21607. </doc>
  21608. </field>
  21609. <field name="DEFAULT_NM_DOCKER_ALLOW_DELAYED_REMOVAL" type="boolean"
  21610. transient="false" volatile="false"
  21611. static="true" final="true" visibility="public"
  21612. deprecated="not deprecated">
  21613. <doc>
  21614. <![CDATA[The default value on whether or not a user can request that Docker
  21615. containers honor the debug deletion delay.]]>
  21616. </doc>
  21617. </field>
  21618. <field name="NM_DOCKER_STOP_GRACE_PERIOD" type="java.lang.String"
  21619. transient="false" volatile="false"
  21620. static="true" final="true" visibility="public"
  21621. deprecated="use {@link YarnConfiguration#NM_SLEEP_DELAY_BEFORE_SIGKILL_MS}">
  21622. <doc>
  21623. <![CDATA[A configurable value to pass to the Docker Stop command. This value
  21624. defines the number of seconds between the docker stop command sending
  21625. a SIGTERM and a SIGKILL.
  21626. @deprecated use {@link YarnConfiguration#NM_SLEEP_DELAY_BEFORE_SIGKILL_MS}]]>
  21627. </doc>
  21628. </field>
  21629. <field name="DEFAULT_NM_DOCKER_STOP_GRACE_PERIOD" type="int"
  21630. transient="false" volatile="false"
  21631. static="true" final="true" visibility="public"
  21632. deprecated="not deprecated">
  21633. <doc>
  21634. <![CDATA[The default value for the grace period between the SIGTERM and the
  21635. SIGKILL in the Docker Stop command.]]>
  21636. </doc>
  21637. </field>
  21638. <field name="NM_DOCKER_DEFAULT_RO_MOUNTS" type="java.lang.String"
  21639. transient="false" volatile="false"
  21640. static="true" final="true" visibility="public"
  21641. deprecated="not deprecated">
  21642. <doc>
  21643. <![CDATA[The default list of read-only mounts to be bind-mounted into all
  21644. Docker containers that use DockerContainerRuntime.]]>
  21645. </doc>
  21646. </field>
  21647. <field name="NM_DOCKER_DEFAULT_RW_MOUNTS" type="java.lang.String"
  21648. transient="false" volatile="false"
  21649. static="true" final="true" visibility="public"
  21650. deprecated="not deprecated">
  21651. <doc>
  21652. <![CDATA[The default list of read-write mounts to be bind-mounted into all
  21653. Docker containers that use DockerContainerRuntime.]]>
  21654. </doc>
  21655. </field>
  21656. <field name="NM_DOCKER_DEFAULT_TMPFS_MOUNTS" type="java.lang.String"
  21657. transient="false" volatile="false"
  21658. static="true" final="true" visibility="public"
  21659. deprecated="not deprecated">
  21660. <doc>
  21661. <![CDATA[The default list of tmpfs mounts to be mounted into all
  21662. Docker containers that use DockerContainerRuntime.]]>
  21663. </doc>
  21664. </field>
  21665. <field name="YARN_CONTAINER_SANDBOX" type="java.lang.String"
  21666. transient="false" volatile="false"
  21667. static="true" final="true" visibility="public"
  21668. deprecated="not deprecated">
  21669. <doc>
  21670. <![CDATA[The mode in which the Java Container Sandbox should run detailed by
  21671. the JavaSandboxLinuxContainerRuntime.]]>
  21672. </doc>
  21673. </field>
  21674. <field name="DEFAULT_YARN_CONTAINER_SANDBOX" type="java.lang.String"
  21675. transient="false" volatile="false"
  21676. static="true" final="true" visibility="public"
  21677. deprecated="not deprecated">
  21678. </field>
  21679. <field name="YARN_CONTAINER_SANDBOX_FILE_PERMISSIONS" type="java.lang.String"
  21680. transient="false" volatile="false"
  21681. static="true" final="true" visibility="public"
  21682. deprecated="not deprecated">
  21683. <doc>
  21684. <![CDATA[Permissions for application local directories.]]>
  21685. </doc>
  21686. </field>
  21687. <field name="DEFAULT_YARN_CONTAINER_SANDBOX_FILE_PERMISSIONS" 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="YARN_CONTAINER_SANDBOX_POLICY" type="java.lang.String"
  21693. transient="false" volatile="false"
  21694. static="true" final="true" visibility="public"
  21695. deprecated="not deprecated">
  21696. <doc>
  21697. <![CDATA[Location for non-default java policy file.]]>
  21698. </doc>
  21699. </field>
  21700. <field name="YARN_CONTAINER_SANDBOX_POLICY_GROUP_PREFIX" type="java.lang.String"
  21701. transient="false" volatile="false"
  21702. static="true" final="true" visibility="public"
  21703. deprecated="not deprecated">
  21704. <doc>
  21705. <![CDATA[Prefix for group to policy file mapping.]]>
  21706. </doc>
  21707. </field>
  21708. <field name="YARN_CONTAINER_SANDBOX_WHITELIST_GROUP" type="java.lang.String"
  21709. transient="false" volatile="false"
  21710. static="true" final="true" visibility="public"
  21711. deprecated="not deprecated">
  21712. <doc>
  21713. <![CDATA[The group which will run by default without the java security manager.]]>
  21714. </doc>
  21715. </field>
  21716. <field name="NM_LINUX_CONTAINER_EXECUTOR_PATH" type="java.lang.String"
  21717. transient="false" volatile="false"
  21718. static="true" final="true" visibility="public"
  21719. deprecated="not deprecated">
  21720. <doc>
  21721. <![CDATA[The path to the Linux container executor.]]>
  21722. </doc>
  21723. </field>
  21724. <field name="NM_NONSECURE_MODE_LIMIT_USERS" type="java.lang.String"
  21725. transient="false" volatile="false"
  21726. static="true" final="true" visibility="public"
  21727. deprecated="not deprecated">
  21728. <doc>
  21729. <![CDATA[True if linux-container-executor should limit itself to one user
  21730. when running in non-secure mode.]]>
  21731. </doc>
  21732. </field>
  21733. <field name="DEFAULT_NM_NONSECURE_MODE_LIMIT_USERS" type="boolean"
  21734. transient="false" volatile="false"
  21735. static="true" final="true" visibility="public"
  21736. deprecated="not deprecated">
  21737. </field>
  21738. <field name="NM_NONSECURE_MODE_LOCAL_USER_KEY" type="java.lang.String"
  21739. transient="false" volatile="false"
  21740. static="true" final="true" visibility="public"
  21741. deprecated="not deprecated">
  21742. <doc>
  21743. <![CDATA[The UNIX user that containers will run as when Linux-container-executor
  21744. is used in nonsecure mode (a use case for this is using cgroups).]]>
  21745. </doc>
  21746. </field>
  21747. <field name="DEFAULT_NM_NONSECURE_MODE_LOCAL_USER" 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="NM_NONSECURE_MODE_USER_PATTERN_KEY" type="java.lang.String"
  21753. transient="false" volatile="false"
  21754. static="true" final="true" visibility="public"
  21755. deprecated="not deprecated">
  21756. <doc>
  21757. <![CDATA[The allowed pattern for UNIX user names enforced by
  21758. Linux-container-executor when used in nonsecure mode (use case for this
  21759. is using cgroups). The default value is taken from /usr/sbin/adduser]]>
  21760. </doc>
  21761. </field>
  21762. <field name="DEFAULT_NM_NONSECURE_MODE_USER_PATTERN" type="java.lang.String"
  21763. transient="false" volatile="false"
  21764. static="true" final="true" visibility="public"
  21765. deprecated="not deprecated">
  21766. </field>
  21767. <field name="NM_LINUX_CONTAINER_RESOURCES_HANDLER" type="java.lang.String"
  21768. transient="false" volatile="false"
  21769. static="true" final="true" visibility="public"
  21770. deprecated="not deprecated">
  21771. <doc>
  21772. <![CDATA[The type of resource enforcement to use with the
  21773. linux container executor.]]>
  21774. </doc>
  21775. </field>
  21776. <field name="NM_LINUX_CONTAINER_CGROUPS_HIERARCHY" type="java.lang.String"
  21777. transient="false" volatile="false"
  21778. static="true" final="true" visibility="public"
  21779. deprecated="not deprecated">
  21780. <doc>
  21781. <![CDATA[The path the linux container executor should use for cgroups]]>
  21782. </doc>
  21783. </field>
  21784. <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT" type="java.lang.String"
  21785. transient="false" volatile="false"
  21786. static="true" final="true" visibility="public"
  21787. deprecated="not deprecated">
  21788. <doc>
  21789. <![CDATA[Whether the linux container executor should mount cgroups if not found]]>
  21790. </doc>
  21791. </field>
  21792. <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT_PATH" type="java.lang.String"
  21793. transient="false" volatile="false"
  21794. static="true" final="true" visibility="public"
  21795. deprecated="not deprecated">
  21796. <doc>
  21797. <![CDATA[Where the linux container executor should mount cgroups if not found]]>
  21798. </doc>
  21799. </field>
  21800. <field name="NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="java.lang.String"
  21801. transient="false" volatile="false"
  21802. static="true" final="true" visibility="public"
  21803. deprecated="not deprecated">
  21804. <doc>
  21805. <![CDATA[Whether the apps should run in strict resource usage mode(not allowed to
  21806. use spare CPU)]]>
  21807. </doc>
  21808. </field>
  21809. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="boolean"
  21810. transient="false" volatile="false"
  21811. static="true" final="true" visibility="public"
  21812. deprecated="not deprecated">
  21813. </field>
  21814. <field name="RM_APPLICATION_MONITOR_INTERVAL_MS" type="java.lang.String"
  21815. transient="false" volatile="false"
  21816. static="true" final="true" visibility="public"
  21817. deprecated="not deprecated">
  21818. </field>
  21819. <field name="DEFAULT_RM_APPLICATION_MONITOR_INTERVAL_MS" type="long"
  21820. transient="false" volatile="false"
  21821. static="true" final="true" visibility="public"
  21822. deprecated="not deprecated">
  21823. </field>
  21824. <field name="RM_APPLICATION_HTTPS_POLICY" type="java.lang.String"
  21825. transient="false" volatile="false"
  21826. static="true" final="true" visibility="public"
  21827. deprecated="not deprecated">
  21828. <doc>
  21829. <![CDATA[Specifies what the RM does regarding HTTPS enforcement for communication
  21830. with AM Web Servers, as well as generating and providing certificates.
  21831. Possible values are:
  21832. <ul>
  21833. <li>NONE - the RM will do nothing special.</li>
  21834. <li>LENIENT - the RM will generate and provide a keystore and truststore
  21835. to the AM, which it is free to use for HTTPS in its tracking URL web
  21836. server. The RM proxy will still allow HTTP connections to AMs that opt
  21837. not to use HTTPS.</li>
  21838. <li>STRICT - this is the same as LENIENT, except that the RM proxy will
  21839. only allow HTTPS connections to AMs; HTTP connections will be blocked
  21840. and result in a warning page to the user.</li>
  21841. </ul>]]>
  21842. </doc>
  21843. </field>
  21844. <field name="DEFAULT_RM_APPLICATION_HTTPS_POLICY" type="java.lang.String"
  21845. transient="false" volatile="false"
  21846. static="true" final="true" visibility="public"
  21847. deprecated="not deprecated">
  21848. </field>
  21849. <field name="RM_PROXY_TIMEOUT_ENABLED" type="java.lang.String"
  21850. transient="false" volatile="false"
  21851. static="true" final="true" visibility="public"
  21852. deprecated="not deprecated">
  21853. </field>
  21854. <field name="DEFALUT_RM_PROXY_TIMEOUT_ENABLED" type="boolean"
  21855. transient="false" volatile="false"
  21856. static="true" final="true" visibility="public"
  21857. deprecated="not deprecated">
  21858. </field>
  21859. <field name="RM_PROXY_CONNECTION_TIMEOUT" type="java.lang.String"
  21860. transient="false" volatile="false"
  21861. static="true" final="true" visibility="public"
  21862. deprecated="not deprecated">
  21863. </field>
  21864. <field name="DEFAULT_RM_PROXY_CONNECTION_TIMEOUT" type="int"
  21865. transient="false" volatile="false"
  21866. static="true" final="true" visibility="public"
  21867. deprecated="not deprecated">
  21868. </field>
  21869. <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="java.lang.String"
  21870. transient="false" volatile="false"
  21871. static="true" final="true" visibility="public"
  21872. deprecated="not deprecated">
  21873. <doc>
  21874. <![CDATA[Interval of time the linux container executor should try cleaning up
  21875. cgroups entry when cleaning up a container. This is required due to what
  21876. it seems a race condition because the SIGTERM/SIGKILL is asynch.]]>
  21877. </doc>
  21878. </field>
  21879. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="long"
  21880. transient="false" volatile="false"
  21881. static="true" final="true" visibility="public"
  21882. deprecated="not deprecated">
  21883. </field>
  21884. <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="java.lang.String"
  21885. transient="false" volatile="false"
  21886. static="true" final="true" visibility="public"
  21887. deprecated="not deprecated">
  21888. <doc>
  21889. <![CDATA[Delay between attempts to remove linux cgroup.]]>
  21890. </doc>
  21891. </field>
  21892. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="long"
  21893. transient="false" volatile="false"
  21894. static="true" final="true" visibility="public"
  21895. deprecated="not deprecated">
  21896. </field>
  21897. <field name="NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="java.lang.String"
  21898. transient="false" volatile="false"
  21899. static="true" final="true" visibility="public"
  21900. deprecated="not deprecated">
  21901. <doc>
  21902. <![CDATA[Indicates if memory and CPU limits will be set for the Windows Job
  21903. Object for the containers launched by the default container executor.]]>
  21904. </doc>
  21905. </field>
  21906. <field name="DEFAULT_NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="boolean"
  21907. transient="false" volatile="false"
  21908. static="true" final="true" visibility="public"
  21909. deprecated="not deprecated">
  21910. </field>
  21911. <field name="NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="java.lang.String"
  21912. transient="false" volatile="false"
  21913. static="true" final="true" visibility="public"
  21914. deprecated="not deprecated">
  21915. </field>
  21916. <field name="DEFAULT_NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="boolean"
  21917. transient="false" volatile="false"
  21918. static="true" final="true" visibility="public"
  21919. deprecated="not deprecated">
  21920. </field>
  21921. <field name="NM_WINDOWS_SECURE_CONTAINER_GROUP" type="java.lang.String"
  21922. transient="false" volatile="false"
  21923. static="true" final="true" visibility="public"
  21924. deprecated="not deprecated">
  21925. <doc>
  21926. <![CDATA[/* The Windows group that the windows-secure-container-executor should run as.]]>
  21927. </doc>
  21928. </field>
  21929. <field name="NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
  21930. transient="false" volatile="false"
  21931. static="true" final="true" visibility="public"
  21932. deprecated="not deprecated">
  21933. <doc>
  21934. <![CDATA[T-file compression types used to compress aggregated logs.]]>
  21935. </doc>
  21936. </field>
  21937. <field name="DEFAULT_NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
  21938. transient="false" volatile="false"
  21939. static="true" final="true" visibility="public"
  21940. deprecated="not deprecated">
  21941. </field>
  21942. <field name="NM_PRINCIPAL" type="java.lang.String"
  21943. transient="false" volatile="false"
  21944. static="true" final="true" visibility="public"
  21945. deprecated="not deprecated">
  21946. <doc>
  21947. <![CDATA[The kerberos principal for the node manager.]]>
  21948. </doc>
  21949. </field>
  21950. <field name="NM_AUX_SERVICES" type="java.lang.String"
  21951. transient="false" volatile="false"
  21952. static="true" final="true" visibility="public"
  21953. deprecated="not deprecated">
  21954. </field>
  21955. <field name="NM_AUX_SERVICES_MANIFEST_ENABLED" type="java.lang.String"
  21956. transient="false" volatile="false"
  21957. static="true" final="true" visibility="public"
  21958. deprecated="not deprecated">
  21959. <doc>
  21960. <![CDATA[Boolean indicating whether loading aux services from a manifest is
  21961. enabled. If enabled, aux services may be dynamically modified through
  21962. reloading the manifest via filesystem changes or a REST API. When
  21963. enabled, aux services configuration properties unrelated to the manifest
  21964. will be ignored.]]>
  21965. </doc>
  21966. </field>
  21967. <field name="DEFAULT_NM_AUX_SERVICES_MANIFEST_ENABLED" type="boolean"
  21968. transient="false" volatile="false"
  21969. static="true" final="true" visibility="public"
  21970. deprecated="not deprecated">
  21971. </field>
  21972. <field name="NM_AUX_SERVICES_MANIFEST" type="java.lang.String"
  21973. transient="false" volatile="false"
  21974. static="true" final="true" visibility="public"
  21975. deprecated="not deprecated">
  21976. <doc>
  21977. <![CDATA[File containing auxiliary service specifications.]]>
  21978. </doc>
  21979. </field>
  21980. <field name="NM_AUX_SERVICES_MANIFEST_RELOAD_MS" type="java.lang.String"
  21981. transient="false" volatile="false"
  21982. static="true" final="true" visibility="public"
  21983. deprecated="not deprecated">
  21984. <doc>
  21985. <![CDATA[Interval at which manifest file will be reloaded when modifications are
  21986. found (0 or less means that the file will not be checked for modifications
  21987. and reloaded).]]>
  21988. </doc>
  21989. </field>
  21990. <field name="DEFAULT_NM_AUX_SERVICES_MANIFEST_RELOAD_MS" type="long"
  21991. transient="false" volatile="false"
  21992. static="true" final="true" visibility="public"
  21993. deprecated="not deprecated">
  21994. </field>
  21995. <field name="NM_AUX_SERVICE_FMT" type="java.lang.String"
  21996. transient="false" volatile="false"
  21997. static="true" final="true" visibility="public"
  21998. deprecated="not deprecated">
  21999. </field>
  22000. <field name="NM_AUX_SERVICES_CLASSPATH" type="java.lang.String"
  22001. transient="false" volatile="false"
  22002. static="true" final="true" visibility="public"
  22003. deprecated="not deprecated">
  22004. </field>
  22005. <field name="NM_AUX_SERVICE_REMOTE_CLASSPATH" type="java.lang.String"
  22006. transient="false" volatile="false"
  22007. static="true" final="true" visibility="public"
  22008. deprecated="not deprecated">
  22009. </field>
  22010. <field name="NM_AUX_SERVICES_SYSTEM_CLASSES" type="java.lang.String"
  22011. transient="false" volatile="false"
  22012. static="true" final="true" visibility="public"
  22013. deprecated="not deprecated">
  22014. </field>
  22015. <field name="NM_USER_HOME_DIR" type="java.lang.String"
  22016. transient="false" volatile="false"
  22017. static="true" final="true" visibility="public"
  22018. deprecated="not deprecated">
  22019. </field>
  22020. <field name="NM_CONTAINER_STDERR_PATTERN" 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="DEFAULT_NM_CONTAINER_STDERR_PATTERN" type="java.lang.String"
  22026. transient="false" volatile="false"
  22027. static="true" final="true" visibility="public"
  22028. deprecated="not deprecated">
  22029. </field>
  22030. <field name="NM_CONTAINER_STDERR_BYTES" type="java.lang.String"
  22031. transient="false" volatile="false"
  22032. static="true" final="true" visibility="public"
  22033. deprecated="not deprecated">
  22034. </field>
  22035. <field name="DEFAULT_NM_CONTAINER_STDERR_BYTES" type="long"
  22036. transient="false" volatile="false"
  22037. static="true" final="true" visibility="public"
  22038. deprecated="not deprecated">
  22039. </field>
  22040. <field name="NM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
  22041. transient="false" volatile="false"
  22042. static="true" final="true" visibility="public"
  22043. deprecated="not deprecated">
  22044. <doc>
  22045. <![CDATA[The kerberos principal to be used for spnego filter for NM.]]>
  22046. </doc>
  22047. </field>
  22048. <field name="NM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
  22049. transient="false" volatile="false"
  22050. static="true" final="true" visibility="public"
  22051. deprecated="not deprecated">
  22052. <doc>
  22053. <![CDATA[The kerberos keytab to be used for spnego filter for NM.]]>
  22054. </doc>
  22055. </field>
  22056. <field name="DEFAULT_NM_USER_HOME_DIR" type="java.lang.String"
  22057. transient="false" volatile="false"
  22058. static="true" final="true" visibility="public"
  22059. deprecated="not deprecated">
  22060. </field>
  22061. <field name="NM_RECOVERY_PREFIX" type="java.lang.String"
  22062. transient="false" volatile="false"
  22063. static="true" final="true" visibility="public"
  22064. deprecated="not deprecated">
  22065. </field>
  22066. <field name="NM_RECOVERY_ENABLED" type="java.lang.String"
  22067. transient="false" volatile="false"
  22068. static="true" final="true" visibility="public"
  22069. deprecated="not deprecated">
  22070. </field>
  22071. <field name="DEFAULT_NM_RECOVERY_ENABLED" type="boolean"
  22072. transient="false" volatile="false"
  22073. static="true" final="true" visibility="public"
  22074. deprecated="not deprecated">
  22075. </field>
  22076. <field name="NM_RECOVERY_DIR" 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="NM_RECOVERY_COMPACTION_INTERVAL_SECS" 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 time in seconds between full compactions of the NM state database.
  22087. Setting the interval to zero disables the full compaction cycles.]]>
  22088. </doc>
  22089. </field>
  22090. <field name="DEFAULT_NM_RECOVERY_COMPACTION_INTERVAL_SECS" type="int"
  22091. transient="false" volatile="false"
  22092. static="true" final="true" visibility="public"
  22093. deprecated="not deprecated">
  22094. </field>
  22095. <field name="NM_RECOVERY_SUPERVISED" type="java.lang.String"
  22096. transient="false" volatile="false"
  22097. static="true" final="true" visibility="public"
  22098. deprecated="not deprecated">
  22099. </field>
  22100. <field name="DEFAULT_NM_RECOVERY_SUPERVISED" type="boolean"
  22101. transient="false" volatile="false"
  22102. static="true" final="true" visibility="public"
  22103. deprecated="not deprecated">
  22104. </field>
  22105. <field name="NM_LOG_AGG_POLICY_CLASS" type="java.lang.String"
  22106. transient="false" volatile="false"
  22107. static="true" final="true" visibility="public"
  22108. deprecated="not deprecated">
  22109. </field>
  22110. <field name="NM_LOG_AGG_POLICY_CLASS_PARAMETERS" type="java.lang.String"
  22111. transient="false" volatile="false"
  22112. static="true" final="true" visibility="public"
  22113. deprecated="not deprecated">
  22114. </field>
  22115. <field name="PROXY_PREFIX" type="java.lang.String"
  22116. transient="false" volatile="false"
  22117. static="true" final="true" visibility="public"
  22118. deprecated="not deprecated">
  22119. </field>
  22120. <field name="PROXY_PRINCIPAL" type="java.lang.String"
  22121. transient="false" volatile="false"
  22122. static="true" final="true" visibility="public"
  22123. deprecated="not deprecated">
  22124. <doc>
  22125. <![CDATA[The kerberos principal for the proxy.]]>
  22126. </doc>
  22127. </field>
  22128. <field name="PROXY_KEYTAB" type="java.lang.String"
  22129. transient="false" volatile="false"
  22130. static="true" final="true" visibility="public"
  22131. deprecated="not deprecated">
  22132. <doc>
  22133. <![CDATA[Keytab for Proxy.]]>
  22134. </doc>
  22135. </field>
  22136. <field name="PROXY_ADDRESS" type="java.lang.String"
  22137. transient="false" volatile="false"
  22138. static="true" final="true" visibility="public"
  22139. deprecated="not deprecated">
  22140. <doc>
  22141. <![CDATA[The address for the web proxy.]]>
  22142. </doc>
  22143. </field>
  22144. <field name="DEFAULT_PROXY_PORT" type="int"
  22145. transient="false" volatile="false"
  22146. static="true" final="true" visibility="public"
  22147. deprecated="not deprecated">
  22148. </field>
  22149. <field name="DEFAULT_PROXY_ADDRESS" type="java.lang.String"
  22150. transient="false" volatile="false"
  22151. static="true" final="true" visibility="public"
  22152. deprecated="not deprecated">
  22153. </field>
  22154. <field name="PROXY_BIND_HOST" type="java.lang.String"
  22155. transient="false" volatile="false"
  22156. static="true" final="true" visibility="public"
  22157. deprecated="not deprecated">
  22158. <doc>
  22159. <![CDATA[Binding address for the web proxy.]]>
  22160. </doc>
  22161. </field>
  22162. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCETRACKER_PROTOCOL" type="java.lang.String"
  22163. transient="false" volatile="false"
  22164. static="true" final="true" visibility="public"
  22165. deprecated="not deprecated">
  22166. <doc>
  22167. <![CDATA[YARN Service Level Authorization]]>
  22168. </doc>
  22169. </field>
  22170. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONCLIENT_PROTOCOL" type="java.lang.String"
  22171. transient="false" volatile="false"
  22172. static="true" final="true" visibility="public"
  22173. deprecated="not deprecated">
  22174. </field>
  22175. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCEMANAGER_ADMINISTRATION_PROTOCOL" type="java.lang.String"
  22176. transient="false" volatile="false"
  22177. static="true" final="true" visibility="public"
  22178. deprecated="not deprecated">
  22179. </field>
  22180. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONMASTER_PROTOCOL" type="java.lang.String"
  22181. transient="false" volatile="false"
  22182. static="true" final="true" visibility="public"
  22183. deprecated="not deprecated">
  22184. </field>
  22185. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_DISTRIBUTEDSCHEDULING_PROTOCOL" type="java.lang.String"
  22186. transient="false" volatile="false"
  22187. static="true" final="true" visibility="public"
  22188. deprecated="not deprecated">
  22189. </field>
  22190. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_CONTAINER_MANAGEMENT_PROTOCOL" type="java.lang.String"
  22191. transient="false" volatile="false"
  22192. static="true" final="true" visibility="public"
  22193. deprecated="not deprecated">
  22194. </field>
  22195. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCE_LOCALIZER" type="java.lang.String"
  22196. transient="false" volatile="false"
  22197. static="true" final="true" visibility="public"
  22198. deprecated="not deprecated">
  22199. </field>
  22200. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONHISTORY_PROTOCOL" type="java.lang.String"
  22201. transient="false" volatile="false"
  22202. static="true" final="true" visibility="public"
  22203. deprecated="not deprecated">
  22204. </field>
  22205. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_COLLECTOR_NODEMANAGER_PROTOCOL" type="java.lang.String"
  22206. transient="false" volatile="false"
  22207. static="true" final="true" visibility="public"
  22208. deprecated="not deprecated">
  22209. </field>
  22210. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONMASTER_NODEMANAGER_PROTOCOL" type="java.lang.String"
  22211. transient="false" volatile="false"
  22212. static="true" final="true" visibility="public"
  22213. deprecated="not deprecated">
  22214. </field>
  22215. <field name="NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="java.lang.String"
  22216. transient="false" volatile="false"
  22217. static="true" final="true" visibility="public"
  22218. deprecated="not deprecated">
  22219. <doc>
  22220. <![CDATA[No. of milliseconds to wait between sending a SIGTERM and SIGKILL
  22221. to a running container]]>
  22222. </doc>
  22223. </field>
  22224. <field name="DEFAULT_NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="long"
  22225. transient="false" volatile="false"
  22226. static="true" final="true" visibility="public"
  22227. deprecated="not deprecated">
  22228. </field>
  22229. <field name="NM_PROCESS_KILL_WAIT_MS" type="java.lang.String"
  22230. transient="false" volatile="false"
  22231. static="true" final="true" visibility="public"
  22232. deprecated="not deprecated">
  22233. <doc>
  22234. <![CDATA[Max time to wait for a process to come up when trying to cleanup
  22235. container resources]]>
  22236. </doc>
  22237. </field>
  22238. <field name="DEFAULT_NM_PROCESS_KILL_WAIT_MS" type="long"
  22239. transient="false" volatile="false"
  22240. static="true" final="true" visibility="public"
  22241. deprecated="not deprecated">
  22242. </field>
  22243. <field name="RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  22244. transient="false" volatile="false"
  22245. static="true" final="true" visibility="public"
  22246. deprecated="not deprecated">
  22247. <doc>
  22248. <![CDATA[Max time to wait to establish a connection to RM]]>
  22249. </doc>
  22250. </field>
  22251. <field name="DEFAULT_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="long"
  22252. transient="false" volatile="false"
  22253. static="true" final="true" visibility="public"
  22254. deprecated="not deprecated">
  22255. </field>
  22256. <field name="RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  22257. transient="false" volatile="false"
  22258. static="true" final="true" visibility="public"
  22259. deprecated="not deprecated">
  22260. <doc>
  22261. <![CDATA[Time interval between each attempt to connect to RM]]>
  22262. </doc>
  22263. </field>
  22264. <field name="DEFAULT_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="long"
  22265. transient="false" volatile="false"
  22266. static="true" final="true" visibility="public"
  22267. deprecated="not deprecated">
  22268. </field>
  22269. <field name="DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="java.lang.String"
  22270. transient="false" volatile="false"
  22271. static="true" final="true" visibility="public"
  22272. deprecated="not deprecated">
  22273. </field>
  22274. <field name="DEFAULT_DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="long"
  22275. transient="false" volatile="false"
  22276. static="true" final="true" visibility="public"
  22277. deprecated="not deprecated">
  22278. </field>
  22279. <field name="YARN_DISPATCHER_PRINT_EVENTS_INFO_THRESHOLD" type="java.lang.String"
  22280. transient="false" volatile="false"
  22281. static="true" final="true" visibility="public"
  22282. deprecated="not deprecated">
  22283. <doc>
  22284. <![CDATA[The threshold used to trigger the logging of event types and counts
  22285. in RM's main event dispatcher. Default value is 5000,
  22286. which means RM will print events info when the queue size cumulatively
  22287. reaches 5000 every time. Such info can be used to reveal what
  22288. kind of events that RM is stuck at processing mostly,
  22289. it can help to narrow down certain performance issues.]]>
  22290. </doc>
  22291. </field>
  22292. <field name="DEFAULT_YARN_DISPATCHER_PRINT_EVENTS_INFO_THRESHOLD" type="int"
  22293. transient="false" volatile="false"
  22294. static="true" final="true" visibility="public"
  22295. deprecated="not deprecated">
  22296. </field>
  22297. <field name="YARN_DISPATCHER_CPU_MONITOR_SAMPLES_PER_MIN" type="java.lang.String"
  22298. transient="false" volatile="false"
  22299. static="true" final="true" visibility="public"
  22300. deprecated="not deprecated">
  22301. <doc>
  22302. <![CDATA[Resource manager dispatcher thread monitor sampling rate.
  22303. Units are samples per minute. This controls how often to sample
  22304. the cpu utilization of the resource manager dispatcher thread.
  22305. The cpu utilization is displayed on the RM UI as scheduler busy %.
  22306. Set to zero to disable the dispatcher thread monitor.]]>
  22307. </doc>
  22308. </field>
  22309. <field name="DEFAULT_YARN_DISPATCHER_CPU_MONITOR_SAMPLES_PER_MIN" type="int"
  22310. transient="false" volatile="false"
  22311. static="true" final="true" visibility="public"
  22312. deprecated="not deprecated">
  22313. </field>
  22314. <field name="YARN_APPLICATION_CLASSPATH" type="java.lang.String"
  22315. transient="false" volatile="false"
  22316. static="true" final="true" visibility="public"
  22317. deprecated="not deprecated">
  22318. <doc>
  22319. <![CDATA[CLASSPATH for YARN applications. A comma-separated list of CLASSPATH
  22320. entries]]>
  22321. </doc>
  22322. </field>
  22323. <field name="AMRM_PROXY_ENABLED" type="java.lang.String"
  22324. transient="false" volatile="false"
  22325. static="true" final="true" visibility="public"
  22326. deprecated="not deprecated">
  22327. <doc>
  22328. <![CDATA[The setting that controls whether AMRMProxy is enabled or not.]]>
  22329. </doc>
  22330. </field>
  22331. <field name="DEFAULT_AMRM_PROXY_ENABLED" type="boolean"
  22332. transient="false" volatile="false"
  22333. static="true" final="true" visibility="public"
  22334. deprecated="not deprecated">
  22335. </field>
  22336. <field name="AMRM_PROXY_ADDRESS" type="java.lang.String"
  22337. transient="false" volatile="false"
  22338. static="true" final="true" visibility="public"
  22339. deprecated="not deprecated">
  22340. </field>
  22341. <field name="DEFAULT_AMRM_PROXY_PORT" type="int"
  22342. transient="false" volatile="false"
  22343. static="true" final="true" visibility="public"
  22344. deprecated="not deprecated">
  22345. </field>
  22346. <field name="DEFAULT_AMRM_PROXY_ADDRESS" type="java.lang.String"
  22347. transient="false" volatile="false"
  22348. static="true" final="true" visibility="public"
  22349. deprecated="not deprecated">
  22350. </field>
  22351. <field name="AMRM_PROXY_CLIENT_THREAD_COUNT" type="java.lang.String"
  22352. transient="false" volatile="false"
  22353. static="true" final="true" visibility="public"
  22354. deprecated="not deprecated">
  22355. </field>
  22356. <field name="DEFAULT_AMRM_PROXY_CLIENT_THREAD_COUNT" type="int"
  22357. transient="false" volatile="false"
  22358. static="true" final="true" visibility="public"
  22359. deprecated="not deprecated">
  22360. </field>
  22361. <field name="AMRM_PROXY_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  22362. transient="false" volatile="false"
  22363. static="true" final="true" visibility="public"
  22364. deprecated="not deprecated">
  22365. </field>
  22366. <field name="DEFAULT_AMRM_PROXY_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  22367. transient="false" volatile="false"
  22368. static="true" final="true" visibility="public"
  22369. deprecated="not deprecated">
  22370. </field>
  22371. <field name="AMRM_PROXY_HA_ENABLED" type="java.lang.String"
  22372. transient="false" volatile="false"
  22373. static="true" final="true" visibility="public"
  22374. deprecated="not deprecated">
  22375. </field>
  22376. <field name="DEFAULT_AMRM_PROXY_HA_ENABLED" type="boolean"
  22377. transient="false" volatile="false"
  22378. static="true" final="true" visibility="public"
  22379. deprecated="not deprecated">
  22380. </field>
  22381. <field name="DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH" type="java.lang.String[]"
  22382. transient="false" volatile="false"
  22383. static="true" final="true" visibility="public"
  22384. deprecated="not deprecated">
  22385. <doc>
  22386. <![CDATA[Default platform-agnostic CLASSPATH for YARN applications. A
  22387. comma-separated list of CLASSPATH entries. The parameter expansion marker
  22388. will be replaced with real parameter expansion marker ('%' for Windows and
  22389. '$' for Linux) by NodeManager on container launch. For example: {{VAR}}
  22390. will be replaced as $VAR on Linux, and %VAR% on Windows.]]>
  22391. </doc>
  22392. </field>
  22393. <field name="DEFAULT_YARN_APPLICATION_CLASSPATH" type="java.lang.String[]"
  22394. transient="false" volatile="false"
  22395. static="true" final="true" visibility="public"
  22396. deprecated="not deprecated">
  22397. <doc>
  22398. <![CDATA[<p>
  22399. Default platform-specific CLASSPATH for YARN applications. A
  22400. comma-separated list of CLASSPATH entries constructed based on the client
  22401. OS environment expansion syntax.
  22402. </p>
  22403. <p>
  22404. Note: Use {@link #DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH} for
  22405. cross-platform practice i.e. submit an application from a Windows client to
  22406. a Linux/Unix server or vice versa.
  22407. </p>]]>
  22408. </doc>
  22409. </field>
  22410. <field name="DEFAULT_CONTAINER_TEMP_DIR" type="java.lang.String"
  22411. transient="false" volatile="false"
  22412. static="true" final="true" visibility="public"
  22413. deprecated="not deprecated">
  22414. <doc>
  22415. <![CDATA[Container temp directory]]>
  22416. </doc>
  22417. </field>
  22418. <field name="IS_MINI_YARN_CLUSTER" type="java.lang.String"
  22419. transient="false" volatile="false"
  22420. static="true" final="true" visibility="public"
  22421. deprecated="not deprecated">
  22422. </field>
  22423. <field name="YARN_MC_PREFIX" type="java.lang.String"
  22424. transient="false" volatile="false"
  22425. static="true" final="true" visibility="public"
  22426. deprecated="not deprecated">
  22427. </field>
  22428. <field name="YARN_MINICLUSTER_FIXED_PORTS" type="java.lang.String"
  22429. transient="false" volatile="false"
  22430. static="true" final="true" visibility="public"
  22431. deprecated="not deprecated">
  22432. <doc>
  22433. <![CDATA[Whether to use fixed ports with the minicluster.]]>
  22434. </doc>
  22435. </field>
  22436. <field name="DEFAULT_YARN_MINICLUSTER_FIXED_PORTS" type="boolean"
  22437. transient="false" volatile="false"
  22438. static="true" final="true" visibility="public"
  22439. deprecated="not deprecated">
  22440. <doc>
  22441. <![CDATA[Default is false to be able to run tests concurrently without port
  22442. conflicts.]]>
  22443. </doc>
  22444. </field>
  22445. <field name="YARN_MINICLUSTER_USE_RPC" type="java.lang.String"
  22446. transient="false" volatile="false"
  22447. static="true" final="true" visibility="public"
  22448. deprecated="not deprecated">
  22449. <doc>
  22450. <![CDATA[Whether the NM should use RPC to connect to the RM. Default is false.
  22451. Can be set to true only when using fixed ports.]]>
  22452. </doc>
  22453. </field>
  22454. <field name="DEFAULT_YARN_MINICLUSTER_USE_RPC" type="boolean"
  22455. transient="false" volatile="false"
  22456. static="true" final="true" visibility="public"
  22457. deprecated="not deprecated">
  22458. </field>
  22459. <field name="YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="java.lang.String"
  22460. transient="false" volatile="false"
  22461. static="true" final="true" visibility="public"
  22462. deprecated="not deprecated">
  22463. <doc>
  22464. <![CDATA[Whether users are explicitly trying to control resource monitoring
  22465. configuration for the MiniYARNCluster. Disabled by default.]]>
  22466. </doc>
  22467. </field>
  22468. <field name="DEFAULT_YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="boolean"
  22469. transient="false" volatile="false"
  22470. static="true" final="true" visibility="public"
  22471. deprecated="not deprecated">
  22472. </field>
  22473. <field name="YARN_MINICLUSTER_NM_PMEM_MB" type="java.lang.String"
  22474. transient="false" volatile="false"
  22475. static="true" final="true" visibility="public"
  22476. deprecated="not deprecated">
  22477. <doc>
  22478. <![CDATA[Allow changing the memory for the NodeManager in the MiniYARNCluster]]>
  22479. </doc>
  22480. </field>
  22481. <field name="DEFAULT_YARN_MINICLUSTER_NM_PMEM_MB" type="int"
  22482. transient="false" volatile="false"
  22483. static="true" final="true" visibility="public"
  22484. deprecated="not deprecated">
  22485. </field>
  22486. <field name="YARN_APP_CONTAINER_LOG_DIR" type="java.lang.String"
  22487. transient="false" volatile="false"
  22488. static="true" final="true" visibility="public"
  22489. deprecated="not deprecated">
  22490. <doc>
  22491. <![CDATA[The log directory for the containers]]>
  22492. </doc>
  22493. </field>
  22494. <field name="YARN_APP_CONTAINER_LOG_SIZE" type="java.lang.String"
  22495. transient="false" volatile="false"
  22496. static="true" final="true" visibility="public"
  22497. deprecated="not deprecated">
  22498. </field>
  22499. <field name="YARN_APP_CONTAINER_LOG_BACKUPS" type="java.lang.String"
  22500. transient="false" volatile="false"
  22501. static="true" final="true" visibility="public"
  22502. deprecated="not deprecated">
  22503. </field>
  22504. <field name="TIMELINE_SERVICE_PREFIX" type="java.lang.String"
  22505. transient="false" volatile="false"
  22506. static="true" final="true" visibility="public"
  22507. deprecated="not deprecated">
  22508. </field>
  22509. <field name="TIMELINE_SERVICE_VERSION" type="java.lang.String"
  22510. transient="false" volatile="false"
  22511. static="true" final="true" visibility="public"
  22512. deprecated="not deprecated">
  22513. </field>
  22514. <field name="DEFAULT_TIMELINE_SERVICE_VERSION" type="float"
  22515. transient="false" volatile="false"
  22516. static="true" final="true" visibility="public"
  22517. deprecated="not deprecated">
  22518. </field>
  22519. <field name="TIMELINE_SERVICE_VERSIONS" type="java.lang.String"
  22520. transient="false" volatile="false"
  22521. static="true" final="true" visibility="public"
  22522. deprecated="not deprecated">
  22523. </field>
  22524. <field name="TIMELINE_SERVICE_UI_NAMES" type="java.lang.String"
  22525. transient="false" volatile="false"
  22526. static="true" final="true" visibility="public"
  22527. deprecated="not deprecated">
  22528. <doc>
  22529. <![CDATA[Comma separated list of names for UIs hosted in the timeline server
  22530. (For pluggable UIs).]]>
  22531. </doc>
  22532. </field>
  22533. <field name="TIMELINE_SERVICE_UI_WEB_PATH_PREFIX" type="java.lang.String"
  22534. transient="false" volatile="false"
  22535. static="true" final="true" visibility="public"
  22536. deprecated="not deprecated">
  22537. <doc>
  22538. <![CDATA[Relative web path that will serve up this UI (For pluggable UIs).]]>
  22539. </doc>
  22540. </field>
  22541. <field name="TIMELINE_SERVICE_CLIENT_PREFIX" type="java.lang.String"
  22542. transient="false" volatile="false"
  22543. static="true" final="true" visibility="public"
  22544. deprecated="not deprecated">
  22545. <doc>
  22546. <![CDATA[Timeline client settings.]]>
  22547. </doc>
  22548. </field>
  22549. <field name="TIMELINE_SERVICE_UI_ON_DISK_PATH_PREFIX" type="java.lang.String"
  22550. transient="false" volatile="false"
  22551. static="true" final="true" visibility="public"
  22552. deprecated="not deprecated">
  22553. <doc>
  22554. <![CDATA[Path to war file or static content directory for this UI
  22555. (For pluggable UIs).]]>
  22556. </doc>
  22557. </field>
  22558. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX" type="java.lang.String"
  22559. transient="false" volatile="false"
  22560. static="true" final="true" visibility="public"
  22561. deprecated="not deprecated">
  22562. <doc>
  22563. <![CDATA[The setting for timeline service v1.5]]>
  22564. </doc>
  22565. </field>
  22566. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CACHE_STORE" type="java.lang.String"
  22567. transient="false" volatile="false"
  22568. static="true" final="true" visibility="public"
  22569. deprecated="not deprecated">
  22570. </field>
  22571. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_ACTIVE_DIR" type="java.lang.String"
  22572. transient="false" volatile="false"
  22573. static="true" final="true" visibility="public"
  22574. deprecated="not deprecated">
  22575. </field>
  22576. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_ACTIVE_DIR_DEFAULT" type="java.lang.String"
  22577. transient="false" volatile="false"
  22578. static="true" final="true" visibility="public"
  22579. deprecated="not deprecated">
  22580. </field>
  22581. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_DONE_DIR" type="java.lang.String"
  22582. transient="false" volatile="false"
  22583. static="true" final="true" visibility="public"
  22584. deprecated="not deprecated">
  22585. </field>
  22586. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_DONE_DIR_DEFAULT" type="java.lang.String"
  22587. transient="false" volatile="false"
  22588. static="true" final="true" visibility="public"
  22589. deprecated="not deprecated">
  22590. </field>
  22591. <field name="TIMELINE_SERVICE_ENTITY_GROUP_PLUGIN_CLASSES" type="java.lang.String"
  22592. transient="false" volatile="false"
  22593. static="true" final="true" visibility="public"
  22594. deprecated="not deprecated">
  22595. </field>
  22596. <field name="TIMELINE_SERVICE_ENTITY_GROUP_PLUGIN_CLASSPATH" type="java.lang.String"
  22597. transient="false" volatile="false"
  22598. static="true" final="true" visibility="public"
  22599. deprecated="not deprecated">
  22600. </field>
  22601. <field name="TIMELINE_SERVICE_ENTITY_GROUP_PLUGIN_SYSTEM_CLASSES" type="java.lang.String"
  22602. transient="false" volatile="false"
  22603. static="true" final="true" visibility="public"
  22604. deprecated="not deprecated">
  22605. </field>
  22606. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SUMMARY_STORE" type="java.lang.String"
  22607. transient="false" volatile="false"
  22608. static="true" final="true" visibility="public"
  22609. deprecated="not deprecated">
  22610. </field>
  22611. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SUMMARY_ENTITY_TYPES" type="java.lang.String"
  22612. transient="false" volatile="false"
  22613. static="true" final="true" visibility="public"
  22614. deprecated="not deprecated">
  22615. </field>
  22616. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SCAN_INTERVAL_SECONDS" type="java.lang.String"
  22617. transient="false" volatile="false"
  22618. static="true" final="true" visibility="public"
  22619. deprecated="not deprecated">
  22620. </field>
  22621. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SCAN_INTERVAL_SECONDS_DEFAULT" type="long"
  22622. transient="false" volatile="false"
  22623. static="true" final="true" visibility="public"
  22624. deprecated="not deprecated">
  22625. </field>
  22626. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_THREADS" 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="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_THREADS_DEFAULT" type="int"
  22632. transient="false" volatile="false"
  22633. static="true" final="true" visibility="public"
  22634. deprecated="not deprecated">
  22635. </field>
  22636. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_APP_CACHE_SIZE" type="java.lang.String"
  22637. transient="false" volatile="false"
  22638. static="true" final="true" visibility="public"
  22639. deprecated="not deprecated">
  22640. </field>
  22641. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_APP_CACHE_SIZE_DEFAULT" type="int"
  22642. transient="false" volatile="false"
  22643. static="true" final="true" visibility="public"
  22644. deprecated="not deprecated">
  22645. </field>
  22646. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CLEANER_INTERVAL_SECONDS" type="java.lang.String"
  22647. transient="false" volatile="false"
  22648. static="true" final="true" visibility="public"
  22649. deprecated="not deprecated">
  22650. </field>
  22651. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CLEANER_INTERVAL_SECONDS_DEFAULT" type="int"
  22652. transient="false" volatile="false"
  22653. static="true" final="true" visibility="public"
  22654. deprecated="not deprecated">
  22655. </field>
  22656. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETAIN_SECONDS" type="java.lang.String"
  22657. transient="false" volatile="false"
  22658. static="true" final="true" visibility="public"
  22659. deprecated="not deprecated">
  22660. </field>
  22661. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETAIN_SECONDS_DEFAULT" type="int"
  22662. transient="false" volatile="false"
  22663. static="true" final="true" visibility="public"
  22664. deprecated="not deprecated">
  22665. </field>
  22666. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_UNKNOWN_ACTIVE_SECONDS" type="java.lang.String"
  22667. transient="false" volatile="false"
  22668. static="true" final="true" visibility="public"
  22669. deprecated="not deprecated">
  22670. </field>
  22671. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_UNKNOWN_ACTIVE_SECONDS_DEFAULT" type="int"
  22672. transient="false" volatile="false"
  22673. static="true" final="true" visibility="public"
  22674. deprecated="not deprecated">
  22675. </field>
  22676. <field name="TIMELINE_SERVICE_LEVELDB_CACHE_READ_CACHE_SIZE" type="java.lang.String"
  22677. transient="false" volatile="false"
  22678. static="true" final="true" visibility="public"
  22679. deprecated="not deprecated">
  22680. </field>
  22681. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_CACHE_READ_CACHE_SIZE" type="long"
  22682. transient="false" volatile="false"
  22683. static="true" final="true" visibility="public"
  22684. deprecated="not deprecated">
  22685. </field>
  22686. <field name="TIMELINE_SERVICE_CLIENT_FD_FLUSH_INTERVAL_SECS" type="java.lang.String"
  22687. transient="false" volatile="false"
  22688. static="true" final="true" visibility="public"
  22689. deprecated="not deprecated">
  22690. </field>
  22691. <field name="TIMELINE_SERVICE_CLIENT_FD_FLUSH_INTERVAL_SECS_DEFAULT" type="long"
  22692. transient="false" volatile="false"
  22693. static="true" final="true" visibility="public"
  22694. deprecated="not deprecated">
  22695. </field>
  22696. <field name="TIMELINE_SERVICE_CLIENT_FD_CLEAN_INTERVAL_SECS" type="java.lang.String"
  22697. transient="false" volatile="false"
  22698. static="true" final="true" visibility="public"
  22699. deprecated="not deprecated">
  22700. </field>
  22701. <field name="TIMELINE_SERVICE_CLIENT_FD_CLEAN_INTERVAL_SECS_DEFAULT" type="long"
  22702. transient="false" volatile="false"
  22703. static="true" final="true" visibility="public"
  22704. deprecated="not deprecated">
  22705. </field>
  22706. <field name="TIMELINE_SERVICE_CLIENT_FD_RETAIN_SECS" type="java.lang.String"
  22707. transient="false" volatile="false"
  22708. static="true" final="true" visibility="public"
  22709. deprecated="not deprecated">
  22710. </field>
  22711. <field name="TIMELINE_SERVICE_CLIENT_FD_RETAIN_SECS_DEFAULT" type="long"
  22712. transient="false" volatile="false"
  22713. static="true" final="true" visibility="public"
  22714. deprecated="not deprecated">
  22715. </field>
  22716. <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_TIMERS_TTL_SECS" type="java.lang.String"
  22717. transient="false" volatile="false"
  22718. static="true" final="true" visibility="public"
  22719. deprecated="not deprecated">
  22720. </field>
  22721. <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_TIMERS_TTL_SECS_DEFAULT" type="long"
  22722. transient="false" volatile="false"
  22723. static="true" final="true" visibility="public"
  22724. deprecated="not deprecated">
  22725. </field>
  22726. <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_ATTEMPT_DIR_CACHE_SIZE" type="java.lang.String"
  22727. transient="false" volatile="false"
  22728. static="true" final="true" visibility="public"
  22729. deprecated="not deprecated">
  22730. </field>
  22731. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_INTERNAL_ATTEMPT_DIR_CACHE_SIZE" type="int"
  22732. transient="false" volatile="false"
  22733. static="true" final="true" visibility="public"
  22734. deprecated="not deprecated">
  22735. </field>
  22736. <field name="TIMELINE_SERVICE_ENTITYFILE_FS_SUPPORT_APPEND" type="java.lang.String"
  22737. transient="false" volatile="false"
  22738. static="true" final="true" visibility="public"
  22739. deprecated="not deprecated">
  22740. </field>
  22741. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_WITH_USER_DIR" type="java.lang.String"
  22742. transient="false" volatile="false"
  22743. static="true" final="true" visibility="public"
  22744. deprecated="not deprecated">
  22745. </field>
  22746. <field name="TIMELINE_SERVICE_READER_PREFIX" type="java.lang.String"
  22747. transient="false" volatile="false"
  22748. static="true" final="true" visibility="public"
  22749. deprecated="not deprecated">
  22750. <doc>
  22751. <![CDATA[Settings for timeline service v2.0.]]>
  22752. </doc>
  22753. </field>
  22754. <field name="TIMELINE_SERVICE_WRITER_CLASS" type="java.lang.String"
  22755. transient="false" volatile="false"
  22756. static="true" final="true" visibility="public"
  22757. deprecated="not deprecated">
  22758. </field>
  22759. <field name="DEFAULT_TIMELINE_SERVICE_WRITER_CLASS" type="java.lang.String"
  22760. transient="false" volatile="false"
  22761. static="true" final="true" visibility="public"
  22762. deprecated="not deprecated">
  22763. </field>
  22764. <field name="TIMELINE_SERVICE_READER_CLASS" type="java.lang.String"
  22765. transient="false" volatile="false"
  22766. static="true" final="true" visibility="public"
  22767. deprecated="not deprecated">
  22768. </field>
  22769. <field name="DEFAULT_TIMELINE_SERVICE_READER_CLASS" type="java.lang.String"
  22770. transient="false" volatile="false"
  22771. static="true" final="true" visibility="public"
  22772. deprecated="not deprecated">
  22773. </field>
  22774. <field name="TIMELINE_SERVICE_SCHEMA_CREATOR_CLASS" type="java.lang.String"
  22775. transient="false" volatile="false"
  22776. static="true" final="true" visibility="public"
  22777. deprecated="not deprecated">
  22778. </field>
  22779. <field name="DEFAULT_TIMELINE_SERVICE_SCHEMA_CREATOR_CLASS" type="java.lang.String"
  22780. transient="false" volatile="false"
  22781. static="true" final="true" visibility="public"
  22782. deprecated="not deprecated">
  22783. </field>
  22784. <field name="DEFAULT_TIMELINE_SERVICE_HBASE_SCHEMA_PREFIX" type="java.lang.String"
  22785. transient="false" volatile="false"
  22786. static="true" final="true" visibility="public"
  22787. deprecated="not deprecated">
  22788. <doc>
  22789. <![CDATA[default schema prefix for hbase tables.]]>
  22790. </doc>
  22791. </field>
  22792. <field name="TIMELINE_SERVICE_HBASE_SCHEMA_PREFIX_NAME" type="java.lang.String"
  22793. transient="false" volatile="false"
  22794. static="true" final="true" visibility="public"
  22795. deprecated="not deprecated">
  22796. <doc>
  22797. <![CDATA[config param name to override schema prefix.]]>
  22798. </doc>
  22799. </field>
  22800. <field name="TIMELINE_SERVICE_WRITER_FLUSH_INTERVAL_SECONDS" type="java.lang.String"
  22801. transient="false" volatile="false"
  22802. static="true" final="true" visibility="public"
  22803. deprecated="not deprecated">
  22804. <doc>
  22805. <![CDATA[The setting that controls how often the timeline collector flushes the
  22806. timeline writer.]]>
  22807. </doc>
  22808. </field>
  22809. <field name="DEFAULT_TIMELINE_SERVICE_WRITER_FLUSH_INTERVAL_SECONDS" type="int"
  22810. transient="false" volatile="false"
  22811. static="true" final="true" visibility="public"
  22812. deprecated="not deprecated">
  22813. </field>
  22814. <field name="TIMELINE_SERVICE_WRITER_ASYNC_QUEUE_CAPACITY" type="java.lang.String"
  22815. transient="false" volatile="false"
  22816. static="true" final="true" visibility="public"
  22817. deprecated="not deprecated">
  22818. <doc>
  22819. <![CDATA[The setting that controls the capacity of the queue for async writes
  22820. to timeline collector.]]>
  22821. </doc>
  22822. </field>
  22823. <field name="DEFAULT_TIMELINE_SERVICE_WRITER_ASYNC_QUEUE_CAPACITY" type="int"
  22824. transient="false" volatile="false"
  22825. static="true" final="true" visibility="public"
  22826. deprecated="not deprecated">
  22827. </field>
  22828. <field name="APP_FINAL_VALUE_RETENTION_THRESHOLD" type="java.lang.String"
  22829. transient="false" volatile="false"
  22830. static="true" final="true" visibility="public"
  22831. deprecated="not deprecated">
  22832. <doc>
  22833. <![CDATA[The name for setting that controls how long the final value of
  22834. a metric of a completed app is retained before merging
  22835. into the flow sum.]]>
  22836. </doc>
  22837. </field>
  22838. <field name="FLOW_RUN_COPROCESSOR_JAR_HDFS_LOCATION" type="java.lang.String"
  22839. transient="false" volatile="false"
  22840. static="true" final="true" visibility="public"
  22841. deprecated="not deprecated">
  22842. <doc>
  22843. <![CDATA[The name of the setting for the location of the coprocessor
  22844. jar on hdfs.]]>
  22845. </doc>
  22846. </field>
  22847. <field name="DEFAULT_HDFS_LOCATION_FLOW_RUN_COPROCESSOR_JAR" type="java.lang.String"
  22848. transient="false" volatile="false"
  22849. static="true" final="true" visibility="public"
  22850. deprecated="not deprecated">
  22851. <doc>
  22852. <![CDATA[default hdfs location for flowrun coprocessor jar.]]>
  22853. </doc>
  22854. </field>
  22855. <field name="FLOW_NAME_MAX_SIZE" type="java.lang.String"
  22856. transient="false" volatile="false"
  22857. static="true" final="true" visibility="public"
  22858. deprecated="not deprecated">
  22859. <doc>
  22860. <![CDATA[This setting controls the max size of the flow name getting generated
  22861. in ATSv2 after removing UUID if present.]]>
  22862. </doc>
  22863. </field>
  22864. <field name="FLOW_NAME_DEFAULT_MAX_SIZE" type="int"
  22865. transient="false" volatile="false"
  22866. static="true" final="true" visibility="public"
  22867. deprecated="not deprecated">
  22868. <doc>
  22869. <![CDATA[Default setting for flow name size has no size restriction
  22870. after removing UUID if present.]]>
  22871. </doc>
  22872. </field>
  22873. <field name="TIMELINE_SERVICE_HBASE_CONFIGURATION_FILE" type="java.lang.String"
  22874. transient="false" volatile="false"
  22875. static="true" final="true" visibility="public"
  22876. deprecated="not deprecated">
  22877. <doc>
  22878. <![CDATA[The name for setting that points to an optional HBase configuration
  22879. (hbase-site.xml file) with settings that will override the ones found on
  22880. the classpath.]]>
  22881. </doc>
  22882. </field>
  22883. <field name="TIMELINE_SERVICE_READ_AUTH_ENABLED" type="java.lang.String"
  22884. transient="false" volatile="false"
  22885. static="true" final="true" visibility="public"
  22886. deprecated="not deprecated">
  22887. <doc>
  22888. <![CDATA[The name for setting that enables or disables authentication checks
  22889. for reading timeline service v2 data.]]>
  22890. </doc>
  22891. </field>
  22892. <field name="TIMELINE_SERVICE_AGGREGATION_INTERVAL_SECS" type="java.lang.String"
  22893. transient="false" volatile="false"
  22894. static="true" final="true" visibility="public"
  22895. deprecated="not deprecated">
  22896. <doc>
  22897. <![CDATA[The name for setting that controls how often in-memory app level
  22898. aggregation is kicked off in timeline collector.]]>
  22899. </doc>
  22900. </field>
  22901. <field name="DEFAULT_TIMELINE_SERVICE_AGGREGATION_INTERVAL_SECS" type="int"
  22902. transient="false" volatile="false"
  22903. static="true" final="true" visibility="public"
  22904. deprecated="not deprecated">
  22905. </field>
  22906. <field name="DEFAULT_TIMELINE_SERVICE_READ_AUTH_ENABLED" type="java.lang.Boolean"
  22907. transient="false" volatile="false"
  22908. static="true" final="true" visibility="public"
  22909. deprecated="not deprecated">
  22910. <doc>
  22911. <![CDATA[The default setting for authentication checks for reading timeline
  22912. service v2 data.]]>
  22913. </doc>
  22914. </field>
  22915. <field name="TIMELINE_SERVICE_READ_ALLOWED_USERS" type="java.lang.String"
  22916. transient="false" volatile="false"
  22917. static="true" final="true" visibility="public"
  22918. deprecated="not deprecated">
  22919. <doc>
  22920. <![CDATA[The name for setting that lists the users and groups who are allowed
  22921. to read timeline service v2 data. It is a comma separated list of
  22922. user, followed by space, then comma separated list of groups.
  22923. It will allow this list of users and groups to read the data
  22924. and reject everyone else.]]>
  22925. </doc>
  22926. </field>
  22927. <field name="DEFAULT_TIMELINE_SERVICE_READ_ALLOWED_USERS" type="java.lang.String"
  22928. transient="false" volatile="false"
  22929. static="true" final="true" visibility="public"
  22930. deprecated="not deprecated">
  22931. <doc>
  22932. <![CDATA[The default value for list of the users who are allowed to read
  22933. timeline service v2 data.]]>
  22934. </doc>
  22935. </field>
  22936. <field name="DEFAULT_APP_FINAL_VALUE_RETENTION_THRESHOLD" type="long"
  22937. transient="false" volatile="false"
  22938. static="true" final="true" visibility="public"
  22939. deprecated="not deprecated">
  22940. <doc>
  22941. <![CDATA[The setting that controls how long the final value of a metric of a
  22942. completed app is retained before merging into the flow sum. Up to this time
  22943. after an application is completed out-of-order values that arrive can be
  22944. recognized and discarded at the cost of increased storage.]]>
  22945. </doc>
  22946. </field>
  22947. <field name="ATS_APP_COLLECTOR_LINGER_PERIOD_IN_MS" type="java.lang.String"
  22948. transient="false" volatile="false"
  22949. static="true" final="true" visibility="public"
  22950. deprecated="not deprecated">
  22951. </field>
  22952. <field name="DEFAULT_ATS_APP_COLLECTOR_LINGER_PERIOD_IN_MS" type="int"
  22953. transient="false" volatile="false"
  22954. static="true" final="true" visibility="public"
  22955. deprecated="not deprecated">
  22956. </field>
  22957. <field name="NUMBER_OF_ASYNC_ENTITIES_TO_MERGE" type="java.lang.String"
  22958. transient="false" volatile="false"
  22959. static="true" final="true" visibility="public"
  22960. deprecated="not deprecated">
  22961. </field>
  22962. <field name="DEFAULT_NUMBER_OF_ASYNC_ENTITIES_TO_MERGE" type="int"
  22963. transient="false" volatile="false"
  22964. static="true" final="true" visibility="public"
  22965. deprecated="not deprecated">
  22966. </field>
  22967. <field name="DEFAULT_FLOW_VERSION" type="java.lang.String"
  22968. transient="false" volatile="false"
  22969. static="true" final="true" visibility="public"
  22970. deprecated="not deprecated">
  22971. <doc>
  22972. <![CDATA[default version for any flow.]]>
  22973. </doc>
  22974. </field>
  22975. <field name="TIMELINE_V2_CLIENT_DRAIN_TIME_MILLIS" type="java.lang.String"
  22976. transient="false" volatile="false"
  22977. static="true" final="true" visibility="public"
  22978. deprecated="not deprecated">
  22979. <doc>
  22980. <![CDATA[The time period for which timeline v2 client will wait for draining
  22981. leftover entities after stop.]]>
  22982. </doc>
  22983. </field>
  22984. <field name="DEFAULT_TIMELINE_V2_CLIENT_DRAIN_TIME_MILLIS" type="long"
  22985. transient="false" volatile="false"
  22986. static="true" final="true" visibility="public"
  22987. deprecated="not deprecated">
  22988. </field>
  22989. <field name="APPLICATION_HISTORY_PREFIX" type="java.lang.String"
  22990. transient="false" volatile="false"
  22991. static="true" final="true" visibility="public"
  22992. deprecated="not deprecated">
  22993. </field>
  22994. <field name="APPLICATION_HISTORY_ENABLED" type="java.lang.String"
  22995. transient="false" volatile="false"
  22996. static="true" final="true" visibility="public"
  22997. deprecated="not deprecated">
  22998. <doc>
  22999. <![CDATA[The setting that controls whether application history service is
  23000. enabled or not.]]>
  23001. </doc>
  23002. </field>
  23003. <field name="DEFAULT_APPLICATION_HISTORY_ENABLED" type="boolean"
  23004. transient="false" volatile="false"
  23005. static="true" final="true" visibility="public"
  23006. deprecated="not deprecated">
  23007. </field>
  23008. <field name="APPLICATION_HISTORY_STORE" type="java.lang.String"
  23009. transient="false" volatile="false"
  23010. static="true" final="true" visibility="public"
  23011. deprecated="not deprecated">
  23012. <doc>
  23013. <![CDATA[Application history store class]]>
  23014. </doc>
  23015. </field>
  23016. <field name="APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="java.lang.String"
  23017. transient="false" volatile="false"
  23018. static="true" final="true" visibility="public"
  23019. deprecated="not deprecated">
  23020. <doc>
  23021. <![CDATA[Save container meta-info in the application history store.]]>
  23022. </doc>
  23023. </field>
  23024. <field name="DEFAULT_APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="boolean"
  23025. transient="false" volatile="false"
  23026. static="true" final="true" visibility="public"
  23027. deprecated="not deprecated">
  23028. </field>
  23029. <field name="FS_APPLICATION_HISTORY_STORE_URI" type="java.lang.String"
  23030. transient="false" volatile="false"
  23031. static="true" final="true" visibility="public"
  23032. deprecated="not deprecated">
  23033. <doc>
  23034. <![CDATA[URI for FileSystemApplicationHistoryStore]]>
  23035. </doc>
  23036. </field>
  23037. <field name="FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
  23038. transient="false" volatile="false"
  23039. static="true" final="true" visibility="public"
  23040. deprecated="not deprecated">
  23041. <doc>
  23042. <![CDATA[T-file compression types used to compress history data.]]>
  23043. </doc>
  23044. </field>
  23045. <field name="DEFAULT_FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
  23046. transient="false" volatile="false"
  23047. static="true" final="true" visibility="public"
  23048. deprecated="not deprecated">
  23049. </field>
  23050. <field name="TIMELINE_SERVICE_ENABLED" type="java.lang.String"
  23051. transient="false" volatile="false"
  23052. static="true" final="true" visibility="public"
  23053. deprecated="not deprecated">
  23054. <doc>
  23055. <![CDATA[The setting that controls whether timeline service is enabled or not.]]>
  23056. </doc>
  23057. </field>
  23058. <field name="DEFAULT_TIMELINE_SERVICE_ENABLED" type="boolean"
  23059. transient="false" volatile="false"
  23060. static="true" final="true" visibility="public"
  23061. deprecated="not deprecated">
  23062. </field>
  23063. <field name="TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
  23064. transient="false" volatile="false"
  23065. static="true" final="true" visibility="public"
  23066. deprecated="not deprecated">
  23067. <doc>
  23068. <![CDATA[host:port address for timeline service RPC APIs.]]>
  23069. </doc>
  23070. </field>
  23071. <field name="DEFAULT_TIMELINE_SERVICE_PORT" type="int"
  23072. transient="false" volatile="false"
  23073. static="true" final="true" visibility="public"
  23074. deprecated="not deprecated">
  23075. </field>
  23076. <field name="DEFAULT_TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
  23077. transient="false" volatile="false"
  23078. static="true" final="true" visibility="public"
  23079. deprecated="not deprecated">
  23080. </field>
  23081. <field name="TIMELINE_SERVICE_BIND_HOST" type="java.lang.String"
  23082. transient="false" volatile="false"
  23083. static="true" final="true" visibility="public"
  23084. deprecated="not deprecated">
  23085. <doc>
  23086. <![CDATA[The listening endpoint for the timeline service application.]]>
  23087. </doc>
  23088. </field>
  23089. <field name="DEFAULT_TIMELINE_SERVICE_BIND_HOST" type="java.lang.String"
  23090. transient="false" volatile="false"
  23091. static="true" final="true" visibility="public"
  23092. deprecated="not deprecated">
  23093. </field>
  23094. <field name="TIMELINE_SERVICE_HANDLER_THREAD_COUNT" type="java.lang.String"
  23095. transient="false" volatile="false"
  23096. static="true" final="true" visibility="public"
  23097. deprecated="not deprecated">
  23098. <doc>
  23099. <![CDATA[The number of threads to handle client RPC API requests.]]>
  23100. </doc>
  23101. </field>
  23102. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_THREAD_COUNT" type="int"
  23103. transient="false" volatile="false"
  23104. static="true" final="true" visibility="public"
  23105. deprecated="not deprecated">
  23106. </field>
  23107. <field name="TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
  23108. transient="false" volatile="false"
  23109. static="true" final="true" visibility="public"
  23110. deprecated="not deprecated">
  23111. <doc>
  23112. <![CDATA[The address of the timeline service web application.]]>
  23113. </doc>
  23114. </field>
  23115. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_PORT" type="int"
  23116. transient="false" volatile="false"
  23117. static="true" final="true" visibility="public"
  23118. deprecated="not deprecated">
  23119. </field>
  23120. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
  23121. transient="false" volatile="false"
  23122. static="true" final="true" visibility="public"
  23123. deprecated="not deprecated">
  23124. </field>
  23125. <field name="TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  23126. transient="false" volatile="false"
  23127. static="true" final="true" visibility="public"
  23128. deprecated="not deprecated">
  23129. <doc>
  23130. <![CDATA[The https address of the timeline service web application.]]>
  23131. </doc>
  23132. </field>
  23133. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_PORT" type="int"
  23134. transient="false" volatile="false"
  23135. static="true" final="true" visibility="public"
  23136. deprecated="not deprecated">
  23137. </field>
  23138. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  23139. transient="false" volatile="false"
  23140. static="true" final="true" visibility="public"
  23141. deprecated="not deprecated">
  23142. </field>
  23143. <field name="APPLICATION_HISTORY_MAX_APPS" type="java.lang.String"
  23144. transient="false" volatile="false"
  23145. static="true" final="true" visibility="public"
  23146. deprecated="not deprecated">
  23147. <doc>
  23148. <![CDATA[Defines the max number of applications could be fetched using
  23149. REST API or application history protocol and shown in timeline
  23150. server web ui.]]>
  23151. </doc>
  23152. </field>
  23153. <field name="DEFAULT_APPLICATION_HISTORY_MAX_APPS" type="long"
  23154. transient="false" volatile="false"
  23155. static="true" final="true" visibility="public"
  23156. deprecated="not deprecated">
  23157. </field>
  23158. <field name="TIMELINE_SERVICE_STORE" type="java.lang.String"
  23159. transient="false" volatile="false"
  23160. static="true" final="true" visibility="public"
  23161. deprecated="not deprecated">
  23162. <doc>
  23163. <![CDATA[Timeline service store class.]]>
  23164. </doc>
  23165. </field>
  23166. <field name="TIMELINE_SERVICE_TTL_ENABLE" type="java.lang.String"
  23167. transient="false" volatile="false"
  23168. static="true" final="true" visibility="public"
  23169. deprecated="not deprecated">
  23170. <doc>
  23171. <![CDATA[Timeline service enable data age off]]>
  23172. </doc>
  23173. </field>
  23174. <field name="TIMELINE_SERVICE_TTL_MS" type="java.lang.String"
  23175. transient="false" volatile="false"
  23176. static="true" final="true" visibility="public"
  23177. deprecated="not deprecated">
  23178. <doc>
  23179. <![CDATA[Timeline service length of time to retain data]]>
  23180. </doc>
  23181. </field>
  23182. <field name="DEFAULT_TIMELINE_SERVICE_TTL_MS" type="long"
  23183. transient="false" volatile="false"
  23184. static="true" final="true" visibility="public"
  23185. deprecated="not deprecated">
  23186. </field>
  23187. <field name="TIMELINE_SERVICE_ROLLING_PERIOD" type="java.lang.String"
  23188. transient="false" volatile="false"
  23189. static="true" final="true" visibility="public"
  23190. deprecated="not deprecated">
  23191. <doc>
  23192. <![CDATA[Timeline service rolling period. Valid values are daily, half_daily,
  23193. quarter_daily, and hourly.]]>
  23194. </doc>
  23195. </field>
  23196. <field name="DEFAULT_TIMELINE_SERVICE_ROLLING_PERIOD" type="java.lang.String"
  23197. transient="false" volatile="false"
  23198. static="true" final="true" visibility="public"
  23199. deprecated="not deprecated">
  23200. <doc>
  23201. <![CDATA[Roll a new database each hour.]]>
  23202. </doc>
  23203. </field>
  23204. <field name="TIMELINE_SERVICE_LEVELDB_PREFIX" type="java.lang.String"
  23205. transient="false" volatile="false"
  23206. static="true" final="true" visibility="public"
  23207. deprecated="not deprecated">
  23208. <doc>
  23209. <![CDATA[Implementation specific configuration prefix for Timeline Service
  23210. leveldb.]]>
  23211. </doc>
  23212. </field>
  23213. <field name="TIMELINE_SERVICE_LEVELDB_PATH" type="java.lang.String"
  23214. transient="false" volatile="false"
  23215. static="true" final="true" visibility="public"
  23216. deprecated="not deprecated">
  23217. <doc>
  23218. <![CDATA[Timeline service leveldb path]]>
  23219. </doc>
  23220. </field>
  23221. <field name="TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="java.lang.String"
  23222. transient="false" volatile="false"
  23223. static="true" final="true" visibility="public"
  23224. deprecated="not deprecated">
  23225. <doc>
  23226. <![CDATA[Timeline service leveldb read cache (uncompressed blocks). This is
  23227. per rolling instance so should be tuned if using rolling leveldb
  23228. timeline store]]>
  23229. </doc>
  23230. </field>
  23231. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="long"
  23232. transient="false" volatile="false"
  23233. static="true" final="true" visibility="public"
  23234. deprecated="not deprecated">
  23235. <doc>
  23236. <![CDATA[Default leveldb read cache size if no configuration is specified.]]>
  23237. </doc>
  23238. </field>
  23239. <field name="TIMELINE_SERVICE_LEVELDB_WRITE_BUFFER_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[Timeline service leveldb write buffer size.]]>
  23245. </doc>
  23246. </field>
  23247. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_WRITE_BUFFER_SIZE" type="int"
  23248. transient="false" volatile="false"
  23249. static="true" final="true" visibility="public"
  23250. deprecated="not deprecated">
  23251. <doc>
  23252. <![CDATA[Default leveldb write buffer size if no configuration is specified. This
  23253. is per rolling instance so should be tuned if using rolling leveldb
  23254. timeline store.]]>
  23255. </doc>
  23256. </field>
  23257. <field name="TIMELINE_SERVICE_LEVELDB_WRITE_BATCH_SIZE" type="java.lang.String"
  23258. transient="false" volatile="false"
  23259. static="true" final="true" visibility="public"
  23260. deprecated="not deprecated">
  23261. <doc>
  23262. <![CDATA[Timeline service leveldb write batch size. This value can be tuned down
  23263. to reduce lock time for ttl eviction.]]>
  23264. </doc>
  23265. </field>
  23266. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_WRITE_BATCH_SIZE" type="int"
  23267. transient="false" volatile="false"
  23268. static="true" final="true" visibility="public"
  23269. deprecated="not deprecated">
  23270. <doc>
  23271. <![CDATA[Default leveldb write batch size is no configuration is specified]]>
  23272. </doc>
  23273. </field>
  23274. <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="java.lang.String"
  23275. transient="false" volatile="false"
  23276. static="true" final="true" visibility="public"
  23277. deprecated="not deprecated">
  23278. <doc>
  23279. <![CDATA[Timeline service leveldb start time read cache (number of entities)]]>
  23280. </doc>
  23281. </field>
  23282. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="int"
  23283. transient="false" volatile="false"
  23284. static="true" final="true" visibility="public"
  23285. deprecated="not deprecated">
  23286. </field>
  23287. <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="java.lang.String"
  23288. transient="false" volatile="false"
  23289. static="true" final="true" visibility="public"
  23290. deprecated="not deprecated">
  23291. <doc>
  23292. <![CDATA[Timeline service leveldb start time write cache (number of entities)]]>
  23293. </doc>
  23294. </field>
  23295. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="int"
  23296. transient="false" volatile="false"
  23297. static="true" final="true" visibility="public"
  23298. deprecated="not deprecated">
  23299. </field>
  23300. <field name="TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="java.lang.String"
  23301. transient="false" volatile="false"
  23302. static="true" final="true" visibility="public"
  23303. deprecated="not deprecated">
  23304. <doc>
  23305. <![CDATA[Timeline service leveldb interval to wait between deletion rounds]]>
  23306. </doc>
  23307. </field>
  23308. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="long"
  23309. transient="false" volatile="false"
  23310. static="true" final="true" visibility="public"
  23311. deprecated="not deprecated">
  23312. </field>
  23313. <field name="TIMELINE_SERVICE_LEVELDB_MAX_OPEN_FILES" type="java.lang.String"
  23314. transient="false" volatile="false"
  23315. static="true" final="true" visibility="public"
  23316. deprecated="not deprecated">
  23317. <doc>
  23318. <![CDATA[Timeline service leveldb number of concurrent open files. Tuned this
  23319. configuration to stay within system limits. This is per rolling instance
  23320. so should be tuned if using rolling leveldb timeline store.]]>
  23321. </doc>
  23322. </field>
  23323. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_MAX_OPEN_FILES" type="int"
  23324. transient="false" volatile="false"
  23325. static="true" final="true" visibility="public"
  23326. deprecated="not deprecated">
  23327. <doc>
  23328. <![CDATA[Default leveldb max open files if no configuration is specified.]]>
  23329. </doc>
  23330. </field>
  23331. <field name="TIMELINE_SERVICE_PRINCIPAL" type="java.lang.String"
  23332. transient="false" volatile="false"
  23333. static="true" final="true" visibility="public"
  23334. deprecated="not deprecated">
  23335. <doc>
  23336. <![CDATA[The Kerberos principal for the timeline server.]]>
  23337. </doc>
  23338. </field>
  23339. <field name="TIMELINE_SERVICE_KEYTAB" type="java.lang.String"
  23340. transient="false" volatile="false"
  23341. static="true" final="true" visibility="public"
  23342. deprecated="not deprecated">
  23343. <doc>
  23344. <![CDATA[The Kerberos keytab for the timeline server.]]>
  23345. </doc>
  23346. </field>
  23347. <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED" type="java.lang.String"
  23348. transient="false" volatile="false"
  23349. static="true" final="true" visibility="public"
  23350. deprecated="not deprecated">
  23351. <doc>
  23352. <![CDATA[Enables cross origin support for timeline server.]]>
  23353. </doc>
  23354. </field>
  23355. <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED_DEFAULT" type="boolean"
  23356. transient="false" volatile="false"
  23357. static="true" final="true" visibility="public"
  23358. deprecated="not deprecated">
  23359. <doc>
  23360. <![CDATA[Default value for cross origin support for timeline server.]]>
  23361. </doc>
  23362. </field>
  23363. <field name="TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="java.lang.String"
  23364. transient="false" volatile="false"
  23365. static="true" final="true" visibility="public"
  23366. deprecated="not deprecated">
  23367. <doc>
  23368. <![CDATA[Timeline client call, max retries (-1 means no limit)]]>
  23369. </doc>
  23370. </field>
  23371. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="int"
  23372. transient="false" volatile="false"
  23373. static="true" final="true" visibility="public"
  23374. deprecated="not deprecated">
  23375. </field>
  23376. <field name="TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="java.lang.String"
  23377. transient="false" volatile="false"
  23378. static="true" final="true" visibility="public"
  23379. deprecated="not deprecated">
  23380. <doc>
  23381. <![CDATA[Timeline client call, retry interval]]>
  23382. </doc>
  23383. </field>
  23384. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="long"
  23385. transient="false" volatile="false"
  23386. static="true" final="true" visibility="public"
  23387. deprecated="not deprecated">
  23388. </field>
  23389. <field name="TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="java.lang.String"
  23390. transient="false" volatile="false"
  23391. static="true" final="true" visibility="public"
  23392. deprecated="not deprecated">
  23393. <doc>
  23394. <![CDATA[Timeline client policy for whether connections are fatal]]>
  23395. </doc>
  23396. </field>
  23397. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="boolean"
  23398. transient="false" volatile="false"
  23399. static="true" final="true" visibility="public"
  23400. deprecated="not deprecated">
  23401. </field>
  23402. <field name="TIMELINE_SERVICE_RECOVERY_ENABLED" type="java.lang.String"
  23403. transient="false" volatile="false"
  23404. static="true" final="true" visibility="public"
  23405. deprecated="not deprecated">
  23406. <doc>
  23407. <![CDATA[Flag to enable recovery of timeline service]]>
  23408. </doc>
  23409. </field>
  23410. <field name="DEFAULT_TIMELINE_SERVICE_RECOVERY_ENABLED" type="boolean"
  23411. transient="false" volatile="false"
  23412. static="true" final="true" visibility="public"
  23413. deprecated="not deprecated">
  23414. </field>
  23415. <field name="TIMELINE_SERVICE_STATE_STORE_CLASS" type="java.lang.String"
  23416. transient="false" volatile="false"
  23417. static="true" final="true" visibility="public"
  23418. deprecated="not deprecated">
  23419. <doc>
  23420. <![CDATA[Timeline service state store class]]>
  23421. </doc>
  23422. </field>
  23423. <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PREFIX" type="java.lang.String"
  23424. transient="false" volatile="false"
  23425. static="true" final="true" visibility="public"
  23426. deprecated="not deprecated">
  23427. </field>
  23428. <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PATH" type="java.lang.String"
  23429. transient="false" volatile="false"
  23430. static="true" final="true" visibility="public"
  23431. deprecated="not deprecated">
  23432. <doc>
  23433. <![CDATA[Timeline service state store leveldb path]]>
  23434. </doc>
  23435. </field>
  23436. <field name="TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="java.lang.String"
  23437. transient="false" volatile="false"
  23438. static="true" final="true" visibility="public"
  23439. deprecated="not deprecated">
  23440. </field>
  23441. <field name="DEFAULT_TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="long"
  23442. transient="false" volatile="false"
  23443. static="true" final="true" visibility="public"
  23444. deprecated="not deprecated">
  23445. </field>
  23446. <field name="TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="java.lang.String"
  23447. transient="false" volatile="false"
  23448. static="true" final="true" visibility="public"
  23449. deprecated="not deprecated">
  23450. </field>
  23451. <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="long"
  23452. transient="false" volatile="false"
  23453. static="true" final="true" visibility="public"
  23454. deprecated="not deprecated">
  23455. </field>
  23456. <field name="TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="java.lang.String"
  23457. transient="false" volatile="false"
  23458. static="true" final="true" visibility="public"
  23459. deprecated="not deprecated">
  23460. </field>
  23461. <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="long"
  23462. transient="false" volatile="false"
  23463. static="true" final="true" visibility="public"
  23464. deprecated="not deprecated">
  23465. </field>
  23466. <field name="TIMELINE_OFFLINE_AGGREGATION_PREFIX" type="java.lang.String"
  23467. transient="false" volatile="false"
  23468. static="true" final="true" visibility="public"
  23469. deprecated="not deprecated">
  23470. </field>
  23471. <field name="PHOENIX_OFFLINE_STORAGE_CONN_STR" type="java.lang.String"
  23472. transient="false" volatile="false"
  23473. static="true" final="true" visibility="public"
  23474. deprecated="not deprecated">
  23475. </field>
  23476. <field name="PHOENIX_OFFLINE_STORAGE_CONN_STR_DEFAULT" type="java.lang.String"
  23477. transient="false" volatile="false"
  23478. static="true" final="true" visibility="public"
  23479. deprecated="not deprecated">
  23480. </field>
  23481. <field name="SHARED_CACHE_PREFIX" type="java.lang.String"
  23482. transient="false" volatile="false"
  23483. static="true" final="true" visibility="public"
  23484. deprecated="not deprecated">
  23485. </field>
  23486. <field name="SHARED_CACHE_ENABLED" type="java.lang.String"
  23487. transient="false" volatile="false"
  23488. static="true" final="true" visibility="public"
  23489. deprecated="not deprecated">
  23490. <doc>
  23491. <![CDATA[whether the shared cache is enabled/disabled]]>
  23492. </doc>
  23493. </field>
  23494. <field name="DEFAULT_SHARED_CACHE_ENABLED" type="boolean"
  23495. transient="false" volatile="false"
  23496. static="true" final="true" visibility="public"
  23497. deprecated="not deprecated">
  23498. </field>
  23499. <field name="SHARED_CACHE_ROOT" type="java.lang.String"
  23500. transient="false" volatile="false"
  23501. static="true" final="true" visibility="public"
  23502. deprecated="not deprecated">
  23503. <doc>
  23504. <![CDATA[The config key for the shared cache root directory.]]>
  23505. </doc>
  23506. </field>
  23507. <field name="DEFAULT_SHARED_CACHE_ROOT" type="java.lang.String"
  23508. transient="false" volatile="false"
  23509. static="true" final="true" visibility="public"
  23510. deprecated="not deprecated">
  23511. </field>
  23512. <field name="SHARED_CACHE_NESTED_LEVEL" type="java.lang.String"
  23513. transient="false" volatile="false"
  23514. static="true" final="true" visibility="public"
  23515. deprecated="not deprecated">
  23516. <doc>
  23517. <![CDATA[The config key for the level of nested directories before getting to the
  23518. checksum directory.]]>
  23519. </doc>
  23520. </field>
  23521. <field name="DEFAULT_SHARED_CACHE_NESTED_LEVEL" type="int"
  23522. transient="false" volatile="false"
  23523. static="true" final="true" visibility="public"
  23524. deprecated="not deprecated">
  23525. </field>
  23526. <field name="SCM_STORE_PREFIX" type="java.lang.String"
  23527. transient="false" volatile="false"
  23528. static="true" final="true" visibility="public"
  23529. deprecated="not deprecated">
  23530. </field>
  23531. <field name="SCM_STORE_CLASS" type="java.lang.String"
  23532. transient="false" volatile="false"
  23533. static="true" final="true" visibility="public"
  23534. deprecated="not deprecated">
  23535. </field>
  23536. <field name="DEFAULT_SCM_STORE_CLASS" type="java.lang.String"
  23537. transient="false" volatile="false"
  23538. static="true" final="true" visibility="public"
  23539. deprecated="not deprecated">
  23540. </field>
  23541. <field name="SCM_APP_CHECKER_CLASS" type="java.lang.String"
  23542. transient="false" volatile="false"
  23543. static="true" final="true" visibility="public"
  23544. deprecated="not deprecated">
  23545. </field>
  23546. <field name="DEFAULT_SCM_APP_CHECKER_CLASS" type="java.lang.String"
  23547. transient="false" volatile="false"
  23548. static="true" final="true" visibility="public"
  23549. deprecated="not deprecated">
  23550. </field>
  23551. <field name="SCM_ADMIN_ADDRESS" type="java.lang.String"
  23552. transient="false" volatile="false"
  23553. static="true" final="true" visibility="public"
  23554. deprecated="not deprecated">
  23555. <doc>
  23556. <![CDATA[The address of the SCM admin interface.]]>
  23557. </doc>
  23558. </field>
  23559. <field name="DEFAULT_SCM_ADMIN_PORT" type="int"
  23560. transient="false" volatile="false"
  23561. static="true" final="true" visibility="public"
  23562. deprecated="not deprecated">
  23563. </field>
  23564. <field name="DEFAULT_SCM_ADMIN_ADDRESS" type="java.lang.String"
  23565. transient="false" volatile="false"
  23566. static="true" final="true" visibility="public"
  23567. deprecated="not deprecated">
  23568. </field>
  23569. <field name="SCM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
  23570. transient="false" volatile="false"
  23571. static="true" final="true" visibility="public"
  23572. deprecated="not deprecated">
  23573. <doc>
  23574. <![CDATA[Number of threads used to handle SCM admin interface.]]>
  23575. </doc>
  23576. </field>
  23577. <field name="DEFAULT_SCM_ADMIN_CLIENT_THREAD_COUNT" type="int"
  23578. transient="false" volatile="false"
  23579. static="true" final="true" visibility="public"
  23580. deprecated="not deprecated">
  23581. </field>
  23582. <field name="SCM_WEBAPP_ADDRESS" type="java.lang.String"
  23583. transient="false" volatile="false"
  23584. static="true" final="true" visibility="public"
  23585. deprecated="not deprecated">
  23586. <doc>
  23587. <![CDATA[The address of the SCM web application.]]>
  23588. </doc>
  23589. </field>
  23590. <field name="DEFAULT_SCM_WEBAPP_PORT" type="int"
  23591. transient="false" volatile="false"
  23592. static="true" final="true" visibility="public"
  23593. deprecated="not deprecated">
  23594. </field>
  23595. <field name="DEFAULT_SCM_WEBAPP_ADDRESS" type="java.lang.String"
  23596. transient="false" volatile="false"
  23597. static="true" final="true" visibility="public"
  23598. deprecated="not deprecated">
  23599. </field>
  23600. <field name="IN_MEMORY_STORE_PREFIX" type="java.lang.String"
  23601. transient="false" volatile="false"
  23602. static="true" final="true" visibility="public"
  23603. deprecated="not deprecated">
  23604. </field>
  23605. <field name="IN_MEMORY_STALENESS_PERIOD_MINS" type="java.lang.String"
  23606. transient="false" volatile="false"
  23607. static="true" final="true" visibility="public"
  23608. deprecated="not deprecated">
  23609. <doc>
  23610. <![CDATA[A resource in the InMemorySCMStore is considered stale if the time since
  23611. the last reference exceeds the staleness period. This value is specified in
  23612. minutes.]]>
  23613. </doc>
  23614. </field>
  23615. <field name="DEFAULT_IN_MEMORY_STALENESS_PERIOD_MINS" type="int"
  23616. transient="false" volatile="false"
  23617. static="true" final="true" visibility="public"
  23618. deprecated="not deprecated">
  23619. </field>
  23620. <field name="IN_MEMORY_INITIAL_DELAY_MINS" type="java.lang.String"
  23621. transient="false" volatile="false"
  23622. static="true" final="true" visibility="public"
  23623. deprecated="not deprecated">
  23624. <doc>
  23625. <![CDATA[Initial delay before the in-memory store runs its first check to remove
  23626. dead initial applications. Specified in minutes.]]>
  23627. </doc>
  23628. </field>
  23629. <field name="DEFAULT_IN_MEMORY_INITIAL_DELAY_MINS" type="int"
  23630. transient="false" volatile="false"
  23631. static="true" final="true" visibility="public"
  23632. deprecated="not deprecated">
  23633. </field>
  23634. <field name="IN_MEMORY_CHECK_PERIOD_MINS" type="java.lang.String"
  23635. transient="false" volatile="false"
  23636. static="true" final="true" visibility="public"
  23637. deprecated="not deprecated">
  23638. <doc>
  23639. <![CDATA[The frequency at which the in-memory store checks to remove dead initial
  23640. applications. Specified in minutes.]]>
  23641. </doc>
  23642. </field>
  23643. <field name="DEFAULT_IN_MEMORY_CHECK_PERIOD_MINS" type="int"
  23644. transient="false" volatile="false"
  23645. static="true" final="true" visibility="public"
  23646. deprecated="not deprecated">
  23647. </field>
  23648. <field name="SCM_CLEANER_PERIOD_MINS" type="java.lang.String"
  23649. transient="false" volatile="false"
  23650. static="true" final="true" visibility="public"
  23651. deprecated="not deprecated">
  23652. <doc>
  23653. <![CDATA[The frequency at which a cleaner task runs. Specified in minutes.]]>
  23654. </doc>
  23655. </field>
  23656. <field name="DEFAULT_SCM_CLEANER_PERIOD_MINS" type="int"
  23657. transient="false" volatile="false"
  23658. static="true" final="true" visibility="public"
  23659. deprecated="not deprecated">
  23660. </field>
  23661. <field name="SCM_CLEANER_INITIAL_DELAY_MINS" type="java.lang.String"
  23662. transient="false" volatile="false"
  23663. static="true" final="true" visibility="public"
  23664. deprecated="not deprecated">
  23665. <doc>
  23666. <![CDATA[Initial delay before the first cleaner task is scheduled. Specified in
  23667. minutes.]]>
  23668. </doc>
  23669. </field>
  23670. <field name="DEFAULT_SCM_CLEANER_INITIAL_DELAY_MINS" type="int"
  23671. transient="false" volatile="false"
  23672. static="true" final="true" visibility="public"
  23673. deprecated="not deprecated">
  23674. </field>
  23675. <field name="SCM_CLEANER_RESOURCE_SLEEP_MS" type="java.lang.String"
  23676. transient="false" volatile="false"
  23677. static="true" final="true" visibility="public"
  23678. deprecated="not deprecated">
  23679. <doc>
  23680. <![CDATA[The time to sleep between processing each shared cache resource. Specified
  23681. in milliseconds.]]>
  23682. </doc>
  23683. </field>
  23684. <field name="DEFAULT_SCM_CLEANER_RESOURCE_SLEEP_MS" type="long"
  23685. transient="false" volatile="false"
  23686. static="true" final="true" visibility="public"
  23687. deprecated="not deprecated">
  23688. </field>
  23689. <field name="SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
  23690. transient="false" volatile="false"
  23691. static="true" final="true" visibility="public"
  23692. deprecated="not deprecated">
  23693. <doc>
  23694. <![CDATA[The address of the node manager interface in the SCM.]]>
  23695. </doc>
  23696. </field>
  23697. <field name="DEFAULT_SCM_UPLOADER_SERVER_PORT" type="int"
  23698. transient="false" volatile="false"
  23699. static="true" final="true" visibility="public"
  23700. deprecated="not deprecated">
  23701. </field>
  23702. <field name="DEFAULT_SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
  23703. transient="false" volatile="false"
  23704. static="true" final="true" visibility="public"
  23705. deprecated="not deprecated">
  23706. </field>
  23707. <field name="SCM_UPLOADER_SERVER_THREAD_COUNT" type="java.lang.String"
  23708. transient="false" volatile="false"
  23709. static="true" final="true" visibility="public"
  23710. deprecated="not deprecated">
  23711. <doc>
  23712. <![CDATA[The number of SCM threads used to handle notify requests from the node
  23713. manager.]]>
  23714. </doc>
  23715. </field>
  23716. <field name="DEFAULT_SCM_UPLOADER_SERVER_THREAD_COUNT" type="int"
  23717. transient="false" volatile="false"
  23718. static="true" final="true" visibility="public"
  23719. deprecated="not deprecated">
  23720. </field>
  23721. <field name="SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
  23722. transient="false" volatile="false"
  23723. static="true" final="true" visibility="public"
  23724. deprecated="not deprecated">
  23725. <doc>
  23726. <![CDATA[The address of the client interface in the SCM.]]>
  23727. </doc>
  23728. </field>
  23729. <field name="DEFAULT_SCM_CLIENT_SERVER_PORT" type="int"
  23730. transient="false" volatile="false"
  23731. static="true" final="true" visibility="public"
  23732. deprecated="not deprecated">
  23733. </field>
  23734. <field name="DEFAULT_SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
  23735. transient="false" volatile="false"
  23736. static="true" final="true" visibility="public"
  23737. deprecated="not deprecated">
  23738. </field>
  23739. <field name="SCM_CLIENT_SERVER_THREAD_COUNT" type="java.lang.String"
  23740. transient="false" volatile="false"
  23741. static="true" final="true" visibility="public"
  23742. deprecated="not deprecated">
  23743. <doc>
  23744. <![CDATA[The number of threads used to handle shared cache manager requests.]]>
  23745. </doc>
  23746. </field>
  23747. <field name="DEFAULT_SCM_CLIENT_SERVER_THREAD_COUNT" type="int"
  23748. transient="false" volatile="false"
  23749. static="true" final="true" visibility="public"
  23750. deprecated="not deprecated">
  23751. </field>
  23752. <field name="SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
  23753. transient="false" volatile="false"
  23754. static="true" final="true" visibility="public"
  23755. deprecated="not deprecated">
  23756. <doc>
  23757. <![CDATA[the checksum algorithm implementation]]>
  23758. </doc>
  23759. </field>
  23760. <field name="DEFAULT_SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
  23761. transient="false" volatile="false"
  23762. static="true" final="true" visibility="public"
  23763. deprecated="not deprecated">
  23764. </field>
  23765. <field name="SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="java.lang.String"
  23766. transient="false" volatile="false"
  23767. static="true" final="true" visibility="public"
  23768. deprecated="not deprecated">
  23769. <doc>
  23770. <![CDATA[The replication factor for the node manager uploader for the shared cache.]]>
  23771. </doc>
  23772. </field>
  23773. <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="int"
  23774. transient="false" volatile="false"
  23775. static="true" final="true" visibility="public"
  23776. deprecated="not deprecated">
  23777. </field>
  23778. <field name="SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="java.lang.String"
  23779. transient="false" volatile="false"
  23780. static="true" final="true" visibility="public"
  23781. deprecated="not deprecated">
  23782. </field>
  23783. <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="int"
  23784. transient="false" volatile="false"
  23785. static="true" final="true" visibility="public"
  23786. deprecated="not deprecated">
  23787. </field>
  23788. <field name="FEDERATION_PREFIX" type="java.lang.String"
  23789. transient="false" volatile="false"
  23790. static="true" final="true" visibility="public"
  23791. deprecated="not deprecated">
  23792. </field>
  23793. <field name="FEDERATION_ENABLED" type="java.lang.String"
  23794. transient="false" volatile="false"
  23795. static="true" final="true" visibility="public"
  23796. deprecated="not deprecated">
  23797. </field>
  23798. <field name="DEFAULT_FEDERATION_ENABLED" type="boolean"
  23799. transient="false" volatile="false"
  23800. static="true" final="true" visibility="public"
  23801. deprecated="not deprecated">
  23802. </field>
  23803. <field name="FEDERATION_FAILOVER_ENABLED" type="java.lang.String"
  23804. transient="false" volatile="false"
  23805. static="true" final="true" visibility="public"
  23806. deprecated="not deprecated">
  23807. </field>
  23808. <field name="DEFAULT_FEDERATION_FAILOVER_ENABLED" type="boolean"
  23809. transient="false" volatile="false"
  23810. static="true" final="true" visibility="public"
  23811. deprecated="not deprecated">
  23812. </field>
  23813. <field name="FEDERATION_STATESTORE_CLIENT_CLASS" type="java.lang.String"
  23814. transient="false" volatile="false"
  23815. static="true" final="true" visibility="public"
  23816. deprecated="not deprecated">
  23817. </field>
  23818. <field name="DEFAULT_FEDERATION_STATESTORE_CLIENT_CLASS" type="java.lang.String"
  23819. transient="false" volatile="false"
  23820. static="true" final="true" visibility="public"
  23821. deprecated="not deprecated">
  23822. </field>
  23823. <field name="FEDERATION_CACHE_TIME_TO_LIVE_SECS" type="java.lang.String"
  23824. transient="false" volatile="false"
  23825. static="true" final="true" visibility="public"
  23826. deprecated="not deprecated">
  23827. </field>
  23828. <field name="DEFAULT_FEDERATION_CACHE_TIME_TO_LIVE_SECS" type="int"
  23829. transient="false" volatile="false"
  23830. static="true" final="true" visibility="public"
  23831. deprecated="not deprecated">
  23832. </field>
  23833. <field name="FEDERATION_FLUSH_CACHE_FOR_RM_ADDR" type="java.lang.String"
  23834. transient="false" volatile="false"
  23835. static="true" final="true" visibility="public"
  23836. deprecated="not deprecated">
  23837. </field>
  23838. <field name="DEFAULT_FEDERATION_FLUSH_CACHE_FOR_RM_ADDR" type="boolean"
  23839. transient="false" volatile="false"
  23840. static="true" final="true" visibility="public"
  23841. deprecated="not deprecated">
  23842. </field>
  23843. <field name="FEDERATION_REGISTRY_BASE_KEY" type="java.lang.String"
  23844. transient="false" volatile="false"
  23845. static="true" final="true" visibility="public"
  23846. deprecated="not deprecated">
  23847. </field>
  23848. <field name="DEFAULT_FEDERATION_REGISTRY_BASE_KEY" type="java.lang.String"
  23849. transient="false" volatile="false"
  23850. static="true" final="true" visibility="public"
  23851. deprecated="not deprecated">
  23852. </field>
  23853. <field name="FEDERATION_STATESTORE_HEARTBEAT_INTERVAL_SECS" type="java.lang.String"
  23854. transient="false" volatile="false"
  23855. static="true" final="true" visibility="public"
  23856. deprecated="not deprecated">
  23857. </field>
  23858. <field name="DEFAULT_FEDERATION_STATESTORE_HEARTBEAT_INTERVAL_SECS" type="int"
  23859. transient="false" volatile="false"
  23860. static="true" final="true" visibility="public"
  23861. deprecated="not deprecated">
  23862. </field>
  23863. <field name="FEDERATION_MACHINE_LIST" type="java.lang.String"
  23864. transient="false" volatile="false"
  23865. static="true" final="true" visibility="public"
  23866. deprecated="not deprecated">
  23867. </field>
  23868. <field name="FEDERATION_CLUSTER_RESOLVER_CLASS" type="java.lang.String"
  23869. transient="false" volatile="false"
  23870. static="true" final="true" visibility="public"
  23871. deprecated="not deprecated">
  23872. </field>
  23873. <field name="DEFAULT_FEDERATION_CLUSTER_RESOLVER_CLASS" type="java.lang.String"
  23874. transient="false" volatile="false"
  23875. static="true" final="true" visibility="public"
  23876. deprecated="not deprecated">
  23877. </field>
  23878. <field name="FEDERATION_AMRMPROXY_HB_MAX_WAIT_MS" type="java.lang.String"
  23879. transient="false" volatile="false"
  23880. static="true" final="true" visibility="public"
  23881. deprecated="not deprecated">
  23882. </field>
  23883. <field name="DEFAULT_FEDERATION_AMRMPROXY_HB_MAX_WAIT_MS" type="long"
  23884. transient="false" volatile="false"
  23885. static="true" final="true" visibility="public"
  23886. deprecated="not deprecated">
  23887. </field>
  23888. <field name="FEDERATION_AMRMPROXY_SUBCLUSTER_TIMEOUT" type="java.lang.String"
  23889. transient="false" volatile="false"
  23890. static="true" final="true" visibility="public"
  23891. deprecated="not deprecated">
  23892. </field>
  23893. <field name="DEFAULT_FEDERATION_AMRMPROXY_SUBCLUSTER_TIMEOUT" type="long"
  23894. transient="false" volatile="false"
  23895. static="true" final="true" visibility="public"
  23896. deprecated="not deprecated">
  23897. </field>
  23898. <field name="DEFAULT_FEDERATION_POLICY_KEY" type="java.lang.String"
  23899. transient="false" volatile="false"
  23900. static="true" final="true" visibility="public"
  23901. deprecated="not deprecated">
  23902. </field>
  23903. <field name="FEDERATION_POLICY_MANAGER" type="java.lang.String"
  23904. transient="false" volatile="false"
  23905. static="true" final="true" visibility="public"
  23906. deprecated="not deprecated">
  23907. </field>
  23908. <field name="DEFAULT_FEDERATION_POLICY_MANAGER" type="java.lang.String"
  23909. transient="false" volatile="false"
  23910. static="true" final="true" visibility="public"
  23911. deprecated="not deprecated">
  23912. </field>
  23913. <field name="FEDERATION_POLICY_MANAGER_PARAMS" type="java.lang.String"
  23914. transient="false" volatile="false"
  23915. static="true" final="true" visibility="public"
  23916. deprecated="not deprecated">
  23917. </field>
  23918. <field name="DEFAULT_FEDERATION_POLICY_MANAGER_PARAMS" type="java.lang.String"
  23919. transient="false" volatile="false"
  23920. static="true" final="true" visibility="public"
  23921. deprecated="not deprecated">
  23922. </field>
  23923. <field name="FEDERATION_STATESTORE_ZK_PREFIX" type="java.lang.String"
  23924. transient="false" volatile="false"
  23925. static="true" final="true" visibility="public"
  23926. deprecated="not deprecated">
  23927. </field>
  23928. <field name="FEDERATION_STATESTORE_ZK_PARENT_PATH" type="java.lang.String"
  23929. transient="false" volatile="false"
  23930. static="true" final="true" visibility="public"
  23931. deprecated="not deprecated">
  23932. <doc>
  23933. <![CDATA[Parent znode path under which ZKRMStateStore will create znodes.]]>
  23934. </doc>
  23935. </field>
  23936. <field name="DEFAULT_FEDERATION_STATESTORE_ZK_PARENT_PATH" type="java.lang.String"
  23937. transient="false" volatile="false"
  23938. static="true" final="true" visibility="public"
  23939. deprecated="not deprecated">
  23940. </field>
  23941. <field name="FEDERATION_STATESTORE_SQL_USERNAME" type="java.lang.String"
  23942. transient="false" volatile="false"
  23943. static="true" final="true" visibility="public"
  23944. deprecated="not deprecated">
  23945. </field>
  23946. <field name="FEDERATION_STATESTORE_SQL_PASSWORD" type="java.lang.String"
  23947. transient="false" volatile="false"
  23948. static="true" final="true" visibility="public"
  23949. deprecated="not deprecated">
  23950. </field>
  23951. <field name="FEDERATION_STATESTORE_SQL_URL" type="java.lang.String"
  23952. transient="false" volatile="false"
  23953. static="true" final="true" visibility="public"
  23954. deprecated="not deprecated">
  23955. </field>
  23956. <field name="FEDERATION_STATESTORE_SQL_JDBC_CLASS" type="java.lang.String"
  23957. transient="false" volatile="false"
  23958. static="true" final="true" visibility="public"
  23959. deprecated="not deprecated">
  23960. </field>
  23961. <field name="DEFAULT_FEDERATION_STATESTORE_SQL_JDBC_CLASS" type="java.lang.String"
  23962. transient="false" volatile="false"
  23963. static="true" final="true" visibility="public"
  23964. deprecated="not deprecated">
  23965. </field>
  23966. <field name="FEDERATION_STATESTORE_SQL_MAXCONNECTIONS" type="java.lang.String"
  23967. transient="false" volatile="false"
  23968. static="true" final="true" visibility="public"
  23969. deprecated="not deprecated">
  23970. </field>
  23971. <field name="DEFAULT_FEDERATION_STATESTORE_SQL_MAXCONNECTIONS" type="int"
  23972. transient="false" volatile="false"
  23973. static="true" final="true" visibility="public"
  23974. deprecated="not deprecated">
  23975. </field>
  23976. <field name="ROUTER_PREFIX" type="java.lang.String"
  23977. transient="false" volatile="false"
  23978. static="true" final="true" visibility="public"
  23979. deprecated="not deprecated">
  23980. </field>
  23981. <field name="ROUTER_BIND_HOST" type="java.lang.String"
  23982. transient="false" volatile="false"
  23983. static="true" final="true" visibility="public"
  23984. deprecated="not deprecated">
  23985. </field>
  23986. <field name="ROUTER_CLIENTRM_PREFIX" type="java.lang.String"
  23987. transient="false" volatile="false"
  23988. static="true" final="true" visibility="public"
  23989. deprecated="not deprecated">
  23990. </field>
  23991. <field name="ROUTER_CLIENTRM_ADDRESS" type="java.lang.String"
  23992. transient="false" volatile="false"
  23993. static="true" final="true" visibility="public"
  23994. deprecated="not deprecated">
  23995. </field>
  23996. <field name="DEFAULT_ROUTER_CLIENTRM_PORT" type="int"
  23997. transient="false" volatile="false"
  23998. static="true" final="true" visibility="public"
  23999. deprecated="not deprecated">
  24000. </field>
  24001. <field name="DEFAULT_ROUTER_CLIENTRM_ADDRESS" type="java.lang.String"
  24002. transient="false" volatile="false"
  24003. static="true" final="true" visibility="public"
  24004. deprecated="not deprecated">
  24005. </field>
  24006. <field name="ROUTER_CLIENTRM_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  24007. transient="false" volatile="false"
  24008. static="true" final="true" visibility="public"
  24009. deprecated="not deprecated">
  24010. </field>
  24011. <field name="DEFAULT_ROUTER_CLIENTRM_INTERCEPTOR_CLASS" type="java.lang.String"
  24012. transient="false" volatile="false"
  24013. static="true" final="true" visibility="public"
  24014. deprecated="not deprecated">
  24015. </field>
  24016. <field name="ROUTER_PIPELINE_CACHE_MAX_SIZE" type="java.lang.String"
  24017. transient="false" volatile="false"
  24018. static="true" final="true" visibility="public"
  24019. deprecated="not deprecated">
  24020. </field>
  24021. <field name="DEFAULT_ROUTER_PIPELINE_CACHE_MAX_SIZE" type="int"
  24022. transient="false" volatile="false"
  24023. static="true" final="true" visibility="public"
  24024. deprecated="not deprecated">
  24025. </field>
  24026. <field name="ROUTER_RMADMIN_PREFIX" type="java.lang.String"
  24027. transient="false" volatile="false"
  24028. static="true" final="true" visibility="public"
  24029. deprecated="not deprecated">
  24030. </field>
  24031. <field name="ROUTER_RMADMIN_ADDRESS" type="java.lang.String"
  24032. transient="false" volatile="false"
  24033. static="true" final="true" visibility="public"
  24034. deprecated="not deprecated">
  24035. </field>
  24036. <field name="DEFAULT_ROUTER_RMADMIN_PORT" type="int"
  24037. transient="false" volatile="false"
  24038. static="true" final="true" visibility="public"
  24039. deprecated="not deprecated">
  24040. </field>
  24041. <field name="DEFAULT_ROUTER_RMADMIN_ADDRESS" type="java.lang.String"
  24042. transient="false" volatile="false"
  24043. static="true" final="true" visibility="public"
  24044. deprecated="not deprecated">
  24045. </field>
  24046. <field name="ROUTER_RMADMIN_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  24047. transient="false" volatile="false"
  24048. static="true" final="true" visibility="public"
  24049. deprecated="not deprecated">
  24050. </field>
  24051. <field name="DEFAULT_ROUTER_RMADMIN_INTERCEPTOR_CLASS" type="java.lang.String"
  24052. transient="false" volatile="false"
  24053. static="true" final="true" visibility="public"
  24054. deprecated="not deprecated">
  24055. </field>
  24056. <field name="ROUTER_CLIENTRM_SUBMIT_RETRY" type="java.lang.String"
  24057. transient="false" volatile="false"
  24058. static="true" final="true" visibility="public"
  24059. deprecated="not deprecated">
  24060. <doc>
  24061. <![CDATA[The number of retries for GetNewApplication and SubmitApplication in
  24062. {@code FederationClientInterceptor}.]]>
  24063. </doc>
  24064. </field>
  24065. <field name="DEFAULT_ROUTER_CLIENTRM_SUBMIT_RETRY" type="int"
  24066. transient="false" volatile="false"
  24067. static="true" final="true" visibility="public"
  24068. deprecated="not deprecated">
  24069. </field>
  24070. <field name="ROUTER_WEBAPP_PREFIX" type="java.lang.String"
  24071. transient="false" volatile="false"
  24072. static="true" final="true" visibility="public"
  24073. deprecated="not deprecated">
  24074. </field>
  24075. <field name="ROUTER_USER_CLIENT_THREADS_SIZE" type="java.lang.String"
  24076. transient="false" volatile="false"
  24077. static="true" final="true" visibility="public"
  24078. deprecated="not deprecated">
  24079. </field>
  24080. <field name="DEFAULT_ROUTER_USER_CLIENT_THREADS_SIZE" type="int"
  24081. transient="false" volatile="false"
  24082. static="true" final="true" visibility="public"
  24083. deprecated="not deprecated">
  24084. </field>
  24085. <field name="ROUTER_WEBAPP_ADDRESS" type="java.lang.String"
  24086. transient="false" volatile="false"
  24087. static="true" final="true" visibility="public"
  24088. deprecated="not deprecated">
  24089. <doc>
  24090. <![CDATA[The address of the Router web application.]]>
  24091. </doc>
  24092. </field>
  24093. <field name="DEFAULT_ROUTER_WEBAPP_PORT" type="int"
  24094. transient="false" volatile="false"
  24095. static="true" final="true" visibility="public"
  24096. deprecated="not deprecated">
  24097. </field>
  24098. <field name="DEFAULT_ROUTER_WEBAPP_ADDRESS" type="java.lang.String"
  24099. transient="false" volatile="false"
  24100. static="true" final="true" visibility="public"
  24101. deprecated="not deprecated">
  24102. </field>
  24103. <field name="ROUTER_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  24104. transient="false" volatile="false"
  24105. static="true" final="true" visibility="public"
  24106. deprecated="not deprecated">
  24107. <doc>
  24108. <![CDATA[The https address of the Router web application.]]>
  24109. </doc>
  24110. </field>
  24111. <field name="DEFAULT_ROUTER_WEBAPP_HTTPS_PORT" type="int"
  24112. transient="false" volatile="false"
  24113. static="true" final="true" visibility="public"
  24114. deprecated="not deprecated">
  24115. </field>
  24116. <field name="DEFAULT_ROUTER_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  24117. transient="false" volatile="false"
  24118. static="true" final="true" visibility="public"
  24119. deprecated="not deprecated">
  24120. </field>
  24121. <field name="ROUTER_WEBAPP_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  24122. transient="false" volatile="false"
  24123. static="true" final="true" visibility="public"
  24124. deprecated="not deprecated">
  24125. </field>
  24126. <field name="DEFAULT_ROUTER_WEBAPP_INTERCEPTOR_CLASS" type="java.lang.String"
  24127. transient="false" volatile="false"
  24128. static="true" final="true" visibility="public"
  24129. deprecated="not deprecated">
  24130. </field>
  24131. <field name="ROUTER_WEBAPP_DEFAULT_INTERCEPTOR_CLASS" type="java.lang.String"
  24132. transient="false" volatile="false"
  24133. static="true" final="true" visibility="public"
  24134. deprecated="not deprecated">
  24135. <doc>
  24136. <![CDATA[The interceptor class used in FederationInterceptorREST to communicate with
  24137. each SubCluster.]]>
  24138. </doc>
  24139. </field>
  24140. <field name="DEFAULT_ROUTER_WEBAPP_DEFAULT_INTERCEPTOR_CLASS" type="java.lang.String"
  24141. transient="false" volatile="false"
  24142. static="true" final="true" visibility="public"
  24143. deprecated="not deprecated">
  24144. </field>
  24145. <field name="ROUTER_WEBAPP_PARTIAL_RESULTS_ENABLED" type="java.lang.String"
  24146. transient="false" volatile="false"
  24147. static="true" final="true" visibility="public"
  24148. deprecated="not deprecated">
  24149. <doc>
  24150. <![CDATA[The interceptor class used in FederationInterceptorREST should return
  24151. partial AppReports.]]>
  24152. </doc>
  24153. </field>
  24154. <field name="DEFAULT_ROUTER_WEBAPP_PARTIAL_RESULTS_ENABLED" type="boolean"
  24155. transient="false" volatile="false"
  24156. static="true" final="true" visibility="public"
  24157. deprecated="not deprecated">
  24158. </field>
  24159. <field name="NM_CSI_ADAPTOR_PREFIX" type="java.lang.String"
  24160. transient="false" volatile="false"
  24161. static="true" final="true" visibility="public"
  24162. deprecated="not deprecated">
  24163. <doc>
  24164. <![CDATA[TERMS:
  24165. csi-driver: a 3rd party CSI driver which implements the CSI protocol.
  24166. It is provided by the storage system.
  24167. csi-driver-adaptor: this is an internal RPC service working
  24168. as a bridge between YARN and a csi-driver.]]>
  24169. </doc>
  24170. </field>
  24171. <field name="NM_CSI_DRIVER_PREFIX" type="java.lang.String"
  24172. transient="false" volatile="false"
  24173. static="true" final="true" visibility="public"
  24174. deprecated="not deprecated">
  24175. </field>
  24176. <field name="NM_CSI_DRIVER_ENDPOINT_SUFFIX" type="java.lang.String"
  24177. transient="false" volatile="false"
  24178. static="true" final="true" visibility="public"
  24179. deprecated="not deprecated">
  24180. </field>
  24181. <field name="NM_CSI_ADAPTOR_ADDRESS_SUFFIX" type="java.lang.String"
  24182. transient="false" volatile="false"
  24183. static="true" final="true" visibility="public"
  24184. deprecated="not deprecated">
  24185. </field>
  24186. <field name="NM_CSI_ADAPTOR_CLASS" type="java.lang.String"
  24187. transient="false" volatile="false"
  24188. static="true" final="true" visibility="public"
  24189. deprecated="not deprecated">
  24190. </field>
  24191. <field name="NM_CSI_ADAPTOR_ADDRESSES" type="java.lang.String"
  24192. transient="false" volatile="false"
  24193. static="true" final="true" visibility="public"
  24194. deprecated="not deprecated">
  24195. <doc>
  24196. <![CDATA[One or more socket addresses for csi-adaptor.
  24197. Multiple addresses are delimited by ",".]]>
  24198. </doc>
  24199. </field>
  24200. <field name="NM_CSI_DRIVER_NAMES" type="java.lang.String"
  24201. transient="false" volatile="false"
  24202. static="true" final="true" visibility="public"
  24203. deprecated="not deprecated">
  24204. </field>
  24205. <field name="YARN_REGISTRY_CLASS" type="java.lang.String"
  24206. transient="false" volatile="false"
  24207. static="true" final="true" visibility="public"
  24208. deprecated="not deprecated">
  24209. </field>
  24210. <field name="DEFAULT_YARN_REGISTRY_CLASS" type="java.lang.String"
  24211. transient="false" volatile="false"
  24212. static="true" final="true" visibility="public"
  24213. deprecated="not deprecated">
  24214. </field>
  24215. <field name="YARN_CLIENT_APP_SUBMISSION_POLL_INTERVAL_MS" type="java.lang.String"
  24216. transient="false" volatile="false"
  24217. static="true" final="true" visibility="public"
  24218. deprecated="not deprecated">
  24219. <doc>
  24220. <![CDATA[Use YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS instead.
  24221. The interval of the yarn client's querying application state after
  24222. application submission. The unit is millisecond.]]>
  24223. </doc>
  24224. </field>
  24225. <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="java.lang.String"
  24226. transient="false" volatile="false"
  24227. static="true" final="true" visibility="public"
  24228. deprecated="not deprecated">
  24229. <doc>
  24230. <![CDATA[The interval that the yarn client library uses to poll the completion
  24231. status of the asynchronous API of application client protocol.]]>
  24232. </doc>
  24233. </field>
  24234. <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="long"
  24235. transient="false" volatile="false"
  24236. static="true" final="true" visibility="public"
  24237. deprecated="not deprecated">
  24238. </field>
  24239. <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="java.lang.String"
  24240. transient="false" volatile="false"
  24241. static="true" final="true" visibility="public"
  24242. deprecated="not deprecated">
  24243. <doc>
  24244. <![CDATA[The duration that the yarn client library waits, cumulatively across polls,
  24245. for an expected state change to occur. Defaults to -1, which indicates no
  24246. limit.]]>
  24247. </doc>
  24248. </field>
  24249. <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="long"
  24250. transient="false" volatile="false"
  24251. static="true" final="true" visibility="public"
  24252. deprecated="not deprecated">
  24253. </field>
  24254. <field name="NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="java.lang.String"
  24255. transient="false" volatile="false"
  24256. static="true" final="true" visibility="public"
  24257. deprecated="not deprecated">
  24258. <doc>
  24259. <![CDATA[Max number of threads in NMClientAsync to process container management
  24260. events]]>
  24261. </doc>
  24262. </field>
  24263. <field name="DEFAULT_NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="int"
  24264. transient="false" volatile="false"
  24265. static="true" final="true" visibility="public"
  24266. deprecated="not deprecated">
  24267. </field>
  24268. <field name="NM_CLIENT_MAX_NM_PROXIES" type="java.lang.String"
  24269. transient="false" volatile="false"
  24270. static="true" final="true" visibility="public"
  24271. deprecated="not deprecated">
  24272. <doc>
  24273. <![CDATA[Maximum number of proxy connections to cache for node managers. If set
  24274. to a value greater than zero then the cache is enabled and the NMClient
  24275. and MRAppMaster will cache the specified number of node manager proxies.
  24276. There will be at max one proxy per node manager. Ex. configuring it to a
  24277. value of 5 will make sure that client will at max have 5 proxies cached
  24278. with 5 different node managers. These connections for these proxies will
  24279. be timed out if idle for more than the system wide idle timeout period.
  24280. Note that this could cause issues on large clusters as many connections
  24281. could linger simultaneously and lead to a large number of connection
  24282. threads. The token used for authentication will be used only at
  24283. connection creation time. If a new token is received then the earlier
  24284. connection should be closed in order to use the new token. This and
  24285. {@link YarnConfiguration#NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE} are related
  24286. and should be in sync (no need for them to be equal).
  24287. If the value of this property is zero then the connection cache is
  24288. disabled and connections will use a zero idle timeout to prevent too
  24289. many connection threads on large clusters.]]>
  24290. </doc>
  24291. </field>
  24292. <field name="DEFAULT_NM_CLIENT_MAX_NM_PROXIES" type="int"
  24293. transient="false" volatile="false"
  24294. static="true" final="true" visibility="public"
  24295. deprecated="not deprecated">
  24296. </field>
  24297. <field name="CLIENT_NM_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  24298. transient="false" volatile="false"
  24299. static="true" final="true" visibility="public"
  24300. deprecated="not deprecated">
  24301. <doc>
  24302. <![CDATA[Max time to wait to establish a connection to NM]]>
  24303. </doc>
  24304. </field>
  24305. <field name="DEFAULT_CLIENT_NM_CONNECT_MAX_WAIT_MS" type="long"
  24306. transient="false" volatile="false"
  24307. static="true" final="true" visibility="public"
  24308. deprecated="not deprecated">
  24309. </field>
  24310. <field name="CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  24311. transient="false" volatile="false"
  24312. static="true" final="true" visibility="public"
  24313. deprecated="not deprecated">
  24314. <doc>
  24315. <![CDATA[Time interval between each attempt to connect to NM]]>
  24316. </doc>
  24317. </field>
  24318. <field name="DEFAULT_CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="long"
  24319. transient="false" volatile="false"
  24320. static="true" final="true" visibility="public"
  24321. deprecated="not deprecated">
  24322. </field>
  24323. <field name="YARN_HTTP_POLICY_KEY" type="java.lang.String"
  24324. transient="false" volatile="false"
  24325. static="true" final="true" visibility="public"
  24326. deprecated="not deprecated">
  24327. </field>
  24328. <field name="YARN_HTTP_POLICY_DEFAULT" type="java.lang.String"
  24329. transient="false" volatile="false"
  24330. static="true" final="true" visibility="public"
  24331. deprecated="not deprecated">
  24332. </field>
  24333. <field name="NM_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  24334. transient="false" volatile="false"
  24335. static="true" final="true" visibility="public"
  24336. deprecated="not deprecated">
  24337. <doc>
  24338. <![CDATA[Max time to wait for NM to connection to RM.
  24339. When not set, proxy will fall back to use value of
  24340. RESOURCEMANAGER_CONNECT_MAX_WAIT_MS.]]>
  24341. </doc>
  24342. </field>
  24343. <field name="NM_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  24344. transient="false" volatile="false"
  24345. static="true" final="true" visibility="public"
  24346. deprecated="not deprecated">
  24347. <doc>
  24348. <![CDATA[Time interval between each NM attempt to connection to RM.
  24349. When not set, proxy will fall back to use value of
  24350. RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS.]]>
  24351. </doc>
  24352. </field>
  24353. <field name="NODE_LABELS_PREFIX" type="java.lang.String"
  24354. transient="false" volatile="false"
  24355. static="true" final="true" visibility="public"
  24356. deprecated="not deprecated">
  24357. <doc>
  24358. <![CDATA[Node-labels configurations]]>
  24359. </doc>
  24360. </field>
  24361. <field name="FS_NODE_LABELS_STORE_IMPL_CLASS" type="java.lang.String"
  24362. transient="false" volatile="false"
  24363. static="true" final="true" visibility="public"
  24364. deprecated="not deprecated">
  24365. <doc>
  24366. <![CDATA[Node label store implementation class]]>
  24367. </doc>
  24368. </field>
  24369. <field name="DEFAULT_FS_NODE_LABELS_STORE_IMPL_CLASS" type="java.lang.String"
  24370. transient="false" volatile="false"
  24371. static="true" final="true" visibility="public"
  24372. deprecated="not deprecated">
  24373. </field>
  24374. <field name="FS_NODE_LABELS_STORE_ROOT_DIR" type="java.lang.String"
  24375. transient="false" volatile="false"
  24376. static="true" final="true" visibility="public"
  24377. deprecated="not deprecated">
  24378. <doc>
  24379. <![CDATA[URI for NodeLabelManager]]>
  24380. </doc>
  24381. </field>
  24382. <field name="NODE_ATTRIBUTE_PREFIX" type="java.lang.String"
  24383. transient="false" volatile="false"
  24384. static="true" final="true" visibility="public"
  24385. deprecated="not deprecated">
  24386. <doc>
  24387. <![CDATA[Node-attribute configurations.]]>
  24388. </doc>
  24389. </field>
  24390. <field name="FS_NODE_ATTRIBUTE_STORE_IMPL_CLASS" type="java.lang.String"
  24391. transient="false" volatile="false"
  24392. static="true" final="true" visibility="public"
  24393. deprecated="not deprecated">
  24394. <doc>
  24395. <![CDATA[Node attribute store implementation class.]]>
  24396. </doc>
  24397. </field>
  24398. <field name="FS_NODE_ATTRIBUTE_STORE_ROOT_DIR" type="java.lang.String"
  24399. transient="false" volatile="false"
  24400. static="true" final="true" visibility="public"
  24401. deprecated="not deprecated">
  24402. <doc>
  24403. <![CDATA[File system node attribute store directory.]]>
  24404. </doc>
  24405. </field>
  24406. <field name="NODE_LABELS_ENABLED" type="java.lang.String"
  24407. transient="false" volatile="false"
  24408. static="true" final="true" visibility="public"
  24409. deprecated="not deprecated">
  24410. <doc>
  24411. <![CDATA[Flag to indicate if the node labels feature enabled, by default it's
  24412. disabled]]>
  24413. </doc>
  24414. </field>
  24415. <field name="DEFAULT_NODE_LABELS_ENABLED" type="boolean"
  24416. transient="false" volatile="false"
  24417. static="true" final="true" visibility="public"
  24418. deprecated="not deprecated">
  24419. </field>
  24420. <field name="NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  24421. transient="false" volatile="false"
  24422. static="true" final="true" visibility="public"
  24423. deprecated="not deprecated">
  24424. </field>
  24425. <field name="CENTRALIZED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  24426. transient="false" volatile="false"
  24427. static="true" final="true" visibility="public"
  24428. deprecated="not deprecated">
  24429. </field>
  24430. <field name="DELEGATED_CENTALIZED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  24431. transient="false" volatile="false"
  24432. static="true" final="true" visibility="public"
  24433. deprecated="not deprecated">
  24434. </field>
  24435. <field name="DISTRIBUTED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  24436. transient="false" volatile="false"
  24437. static="true" final="true" visibility="public"
  24438. deprecated="not deprecated">
  24439. </field>
  24440. <field name="DEFAULT_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  24441. transient="false" volatile="false"
  24442. static="true" final="true" visibility="public"
  24443. deprecated="not deprecated">
  24444. </field>
  24445. <field name="EXCLUSIVE_ENFORCED_PARTITIONS_SUFFIX" type="java.lang.String"
  24446. transient="false" volatile="false"
  24447. static="true" final="true" visibility="public"
  24448. deprecated="not deprecated">
  24449. </field>
  24450. <field name="EXCLUSIVE_ENFORCED_PARTITIONS" type="java.lang.String"
  24451. transient="false" volatile="false"
  24452. static="true" final="true" visibility="public"
  24453. deprecated="not deprecated">
  24454. </field>
  24455. <field name="MAX_CLUSTER_LEVEL_APPLICATION_PRIORITY" type="java.lang.String"
  24456. transient="false" volatile="false"
  24457. static="true" final="true" visibility="public"
  24458. deprecated="not deprecated">
  24459. </field>
  24460. <field name="DEFAULT_CLUSTER_LEVEL_APPLICATION_PRIORITY" type="int"
  24461. transient="false" volatile="false"
  24462. static="true" final="true" visibility="public"
  24463. deprecated="not deprecated">
  24464. </field>
  24465. <field name="APP_ATTEMPT_DIAGNOSTICS_LIMIT_KC" type="java.lang.String"
  24466. transient="false" volatile="false"
  24467. static="true" final="true" visibility="public"
  24468. deprecated="not deprecated">
  24469. </field>
  24470. <field name="DEFAULT_APP_ATTEMPT_DIAGNOSTICS_LIMIT_KC" type="int"
  24471. transient="false" volatile="false"
  24472. static="true" final="true" visibility="public"
  24473. deprecated="not deprecated">
  24474. </field>
  24475. <field name="NM_NODE_LABELS_PROVIDER_CONFIG" type="java.lang.String"
  24476. transient="false" volatile="false"
  24477. static="true" final="true" visibility="public"
  24478. deprecated="not deprecated">
  24479. </field>
  24480. <field name="NM_NODE_ATTRIBUTES_PROVIDER_CONFIG" type="java.lang.String"
  24481. transient="false" volatile="false"
  24482. static="true" final="true" visibility="public"
  24483. deprecated="not deprecated">
  24484. </field>
  24485. <field name="CONFIG_NODE_DESCRIPTOR_PROVIDER" type="java.lang.String"
  24486. transient="false" volatile="false"
  24487. static="true" final="true" visibility="public"
  24488. deprecated="not deprecated">
  24489. </field>
  24490. <field name="SCRIPT_NODE_DESCRIPTOR_PROVIDER" type="java.lang.String"
  24491. transient="false" volatile="false"
  24492. static="true" final="true" visibility="public"
  24493. deprecated="not deprecated">
  24494. </field>
  24495. <field name="NM_NODE_LABELS_RESYNC_INTERVAL" type="java.lang.String"
  24496. transient="false" volatile="false"
  24497. static="true" final="true" visibility="public"
  24498. deprecated="not deprecated">
  24499. </field>
  24500. <field name="DEFAULT_NM_NODE_LABELS_RESYNC_INTERVAL" type="long"
  24501. transient="false" volatile="false"
  24502. static="true" final="true" visibility="public"
  24503. deprecated="not deprecated">
  24504. </field>
  24505. <field name="NM_NODE_ATTRIBUTES_RESYNC_INTERVAL" type="java.lang.String"
  24506. transient="false" volatile="false"
  24507. static="true" final="true" visibility="public"
  24508. deprecated="not deprecated">
  24509. </field>
  24510. <field name="DEFAULT_NM_NODE_ATTRIBUTES_RESYNC_INTERVAL" type="long"
  24511. transient="false" volatile="false"
  24512. static="true" final="true" visibility="public"
  24513. deprecated="not deprecated">
  24514. </field>
  24515. <field name="NM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="java.lang.String"
  24516. transient="false" volatile="false"
  24517. static="true" final="true" visibility="public"
  24518. deprecated="not deprecated">
  24519. </field>
  24520. <field name="NM_NODE_LABELS_PROVIDER_FETCH_TIMEOUT_MS" type="java.lang.String"
  24521. transient="false" volatile="false"
  24522. static="true" final="true" visibility="public"
  24523. deprecated="not deprecated">
  24524. </field>
  24525. <field name="DEFAULT_NM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="long"
  24526. transient="false" volatile="false"
  24527. static="true" final="true" visibility="public"
  24528. deprecated="not deprecated">
  24529. </field>
  24530. <field name="DEFAULT_NM_NODE_LABELS_PROVIDER_FETCH_TIMEOUT_MS" type="long"
  24531. transient="false" volatile="false"
  24532. static="true" final="true" visibility="public"
  24533. deprecated="not deprecated">
  24534. </field>
  24535. <field name="NM_PROVIDER_CONFIGURED_NODE_PARTITION" type="java.lang.String"
  24536. transient="false" volatile="false"
  24537. static="true" final="true" visibility="public"
  24538. deprecated="not deprecated">
  24539. </field>
  24540. <field name="NM_PROVIDER_CONFIGURED_NODE_ATTRIBUTES" type="java.lang.String"
  24541. transient="false" volatile="false"
  24542. static="true" final="true" visibility="public"
  24543. deprecated="not deprecated">
  24544. </field>
  24545. <field name="RM_NODE_LABELS_PROVIDER_CONFIG" type="java.lang.String"
  24546. transient="false" volatile="false"
  24547. static="true" final="true" visibility="public"
  24548. deprecated="not deprecated">
  24549. </field>
  24550. <field name="RM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="java.lang.String"
  24551. transient="false" volatile="false"
  24552. static="true" final="true" visibility="public"
  24553. deprecated="not deprecated">
  24554. </field>
  24555. <field name="DEFAULT_RM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="long"
  24556. transient="false" volatile="false"
  24557. static="true" final="true" visibility="public"
  24558. deprecated="not deprecated">
  24559. </field>
  24560. <field name="AM_SCHEDULING_NODE_BLACKLISTING_ENABLED" type="java.lang.String"
  24561. transient="false" volatile="false"
  24562. static="true" final="true" visibility="public"
  24563. deprecated="not deprecated">
  24564. </field>
  24565. <field name="DEFAULT_AM_SCHEDULING_NODE_BLACKLISTING_ENABLED" type="boolean"
  24566. transient="false" volatile="false"
  24567. static="true" final="true" visibility="public"
  24568. deprecated="not deprecated">
  24569. </field>
  24570. <field name="AM_SCHEDULING_NODE_BLACKLISTING_DISABLE_THRESHOLD" type="java.lang.String"
  24571. transient="false" volatile="false"
  24572. static="true" final="true" visibility="public"
  24573. deprecated="not deprecated">
  24574. </field>
  24575. <field name="DEFAULT_AM_SCHEDULING_NODE_BLACKLISTING_DISABLE_THRESHOLD" type="float"
  24576. transient="false" volatile="false"
  24577. static="true" final="true" visibility="public"
  24578. deprecated="not deprecated">
  24579. </field>
  24580. <field name="NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_PATH" type="java.lang.String"
  24581. transient="false" volatile="false"
  24582. static="true" final="true" visibility="public"
  24583. deprecated="not deprecated">
  24584. </field>
  24585. <field name="NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_SCRIPT_OPTS" type="java.lang.String"
  24586. transient="false" volatile="false"
  24587. static="true" final="true" visibility="public"
  24588. deprecated="not deprecated">
  24589. </field>
  24590. <field name="NM_NODE_ATTRIBUTES_PROVIDER_FETCH_INTERVAL_MS" type="java.lang.String"
  24591. transient="false" volatile="false"
  24592. static="true" final="true" visibility="public"
  24593. deprecated="not deprecated">
  24594. <doc>
  24595. <![CDATA[Node attribute provider fetch attributes interval and timeout.]]>
  24596. </doc>
  24597. </field>
  24598. <field name="DEFAULT_NM_NODE_ATTRIBUTES_PROVIDER_FETCH_INTERVAL_MS" type="long"
  24599. transient="false" volatile="false"
  24600. static="true" final="true" visibility="public"
  24601. deprecated="not deprecated">
  24602. </field>
  24603. <field name="NM_NODE_ATTRIBUTES_PROVIDER_FETCH_TIMEOUT_MS" type="java.lang.String"
  24604. transient="false" volatile="false"
  24605. static="true" final="true" visibility="public"
  24606. deprecated="not deprecated">
  24607. </field>
  24608. <field name="DEFAULT_NM_NODE_ATTRIBUTES_PROVIDER_FETCH_TIMEOUT_MS" type="long"
  24609. transient="false" volatile="false"
  24610. static="true" final="true" visibility="public"
  24611. deprecated="not deprecated">
  24612. </field>
  24613. <field name="NM_SCRIPT_BASED_NODE_ATTRIBUTES_PROVIDER_PATH" type="java.lang.String"
  24614. transient="false" volatile="false"
  24615. static="true" final="true" visibility="public"
  24616. deprecated="not deprecated">
  24617. </field>
  24618. <field name="NM_SCRIPT_BASED_NODE_ATTRIBUTES_PROVIDER_OPTS" type="java.lang.String"
  24619. transient="false" volatile="false"
  24620. static="true" final="true" visibility="public"
  24621. deprecated="not deprecated">
  24622. </field>
  24623. <field name="DISPLAY_APPS_FOR_LOGGED_IN_USER" type="java.lang.String"
  24624. transient="false" volatile="false"
  24625. static="true" final="true" visibility="public"
  24626. deprecated="not deprecated">
  24627. </field>
  24628. <field name="FILTER_ENTITY_LIST_BY_USER" type="java.lang.String"
  24629. transient="false" volatile="false"
  24630. static="true" final="true" visibility="public"
  24631. deprecated="not deprecated">
  24632. </field>
  24633. <field name="DEFAULT_DISPLAY_APPS_FOR_LOGGED_IN_USER" type="boolean"
  24634. transient="false" volatile="false"
  24635. static="true" final="true" visibility="public"
  24636. deprecated="not deprecated">
  24637. </field>
  24638. <field name="FILTER_INVALID_XML_CHARS" type="java.lang.String"
  24639. transient="false" volatile="false"
  24640. static="true" final="true" visibility="public"
  24641. deprecated="not deprecated">
  24642. </field>
  24643. <field name="DEFAULT_FILTER_INVALID_XML_CHARS" type="boolean"
  24644. transient="false" volatile="false"
  24645. static="true" final="true" visibility="public"
  24646. deprecated="not deprecated">
  24647. </field>
  24648. <field name="ENABLE_REST_APP_SUBMISSIONS" type="java.lang.String"
  24649. transient="false" volatile="false"
  24650. static="true" final="true" visibility="public"
  24651. deprecated="not deprecated">
  24652. </field>
  24653. <field name="DEFAULT_ENABLE_REST_APP_SUBMISSIONS" type="boolean"
  24654. transient="false" volatile="false"
  24655. static="true" final="true" visibility="public"
  24656. deprecated="not deprecated">
  24657. </field>
  24658. <field name="REST_CSRF" type="java.lang.String"
  24659. transient="false" volatile="false"
  24660. static="true" final="true" visibility="public"
  24661. deprecated="not deprecated">
  24662. </field>
  24663. <field name="RM_CSRF_PREFIX" type="java.lang.String"
  24664. transient="false" volatile="false"
  24665. static="true" final="true" visibility="public"
  24666. deprecated="not deprecated">
  24667. </field>
  24668. <field name="NM_CSRF_PREFIX" type="java.lang.String"
  24669. transient="false" volatile="false"
  24670. static="true" final="true" visibility="public"
  24671. deprecated="not deprecated">
  24672. </field>
  24673. <field name="TIMELINE_CSRF_PREFIX" type="java.lang.String"
  24674. transient="false" volatile="false"
  24675. static="true" final="true" visibility="public"
  24676. deprecated="not deprecated">
  24677. </field>
  24678. <field name="RM_CSRF_ENABLED" type="java.lang.String"
  24679. transient="false" volatile="false"
  24680. static="true" final="true" visibility="public"
  24681. deprecated="not deprecated">
  24682. </field>
  24683. <field name="NM_CSRF_ENABLED" type="java.lang.String"
  24684. transient="false" volatile="false"
  24685. static="true" final="true" visibility="public"
  24686. deprecated="not deprecated">
  24687. </field>
  24688. <field name="TIMELINE_CSRF_ENABLED" type="java.lang.String"
  24689. transient="false" volatile="false"
  24690. static="true" final="true" visibility="public"
  24691. deprecated="not deprecated">
  24692. </field>
  24693. <field name="RM_CSRF_CUSTOM_HEADER" type="java.lang.String"
  24694. transient="false" volatile="false"
  24695. static="true" final="true" visibility="public"
  24696. deprecated="not deprecated">
  24697. </field>
  24698. <field name="NM_CSRF_CUSTOM_HEADER" type="java.lang.String"
  24699. transient="false" volatile="false"
  24700. static="true" final="true" visibility="public"
  24701. deprecated="not deprecated">
  24702. </field>
  24703. <field name="TIMELINE_CSRF_CUSTOM_HEADER" type="java.lang.String"
  24704. transient="false" volatile="false"
  24705. static="true" final="true" visibility="public"
  24706. deprecated="not deprecated">
  24707. </field>
  24708. <field name="RM_CSRF_METHODS_TO_IGNORE" type="java.lang.String"
  24709. transient="false" volatile="false"
  24710. static="true" final="true" visibility="public"
  24711. deprecated="not deprecated">
  24712. </field>
  24713. <field name="NM_CSRF_METHODS_TO_IGNORE" type="java.lang.String"
  24714. transient="false" volatile="false"
  24715. static="true" final="true" visibility="public"
  24716. deprecated="not deprecated">
  24717. </field>
  24718. <field name="TIMELINE_CSRF_METHODS_TO_IGNORE" type="java.lang.String"
  24719. transient="false" volatile="false"
  24720. static="true" final="true" visibility="public"
  24721. deprecated="not deprecated">
  24722. </field>
  24723. <field name="XFS" type="java.lang.String"
  24724. transient="false" volatile="false"
  24725. static="true" final="true" visibility="public"
  24726. deprecated="not deprecated">
  24727. </field>
  24728. <field name="YARN_XFS_ENABLED" type="java.lang.String"
  24729. transient="false" volatile="false"
  24730. static="true" final="true" visibility="public"
  24731. deprecated="not deprecated">
  24732. </field>
  24733. <field name="RM_XFS_PREFIX" type="java.lang.String"
  24734. transient="false" volatile="false"
  24735. static="true" final="true" visibility="public"
  24736. deprecated="not deprecated">
  24737. </field>
  24738. <field name="NM_XFS_PREFIX" type="java.lang.String"
  24739. transient="false" volatile="false"
  24740. static="true" final="true" visibility="public"
  24741. deprecated="not deprecated">
  24742. </field>
  24743. <field name="TIMELINE_XFS_PREFIX" type="java.lang.String"
  24744. transient="false" volatile="false"
  24745. static="true" final="true" visibility="public"
  24746. deprecated="not deprecated">
  24747. </field>
  24748. <field name="RM_XFS_OPTIONS" type="java.lang.String"
  24749. transient="false" volatile="false"
  24750. static="true" final="true" visibility="public"
  24751. deprecated="not deprecated">
  24752. </field>
  24753. <field name="NM_XFS_OPTIONS" type="java.lang.String"
  24754. transient="false" volatile="false"
  24755. static="true" final="true" visibility="public"
  24756. deprecated="not deprecated">
  24757. </field>
  24758. <field name="TIMELINE_XFS_OPTIONS" type="java.lang.String"
  24759. transient="false" volatile="false"
  24760. static="true" final="true" visibility="public"
  24761. deprecated="not deprecated">
  24762. </field>
  24763. <field name="TIMELINE_SERVICE_READER_BIND_HOST" type="java.lang.String"
  24764. transient="false" volatile="false"
  24765. static="true" final="true" visibility="public"
  24766. deprecated="not deprecated">
  24767. <doc>
  24768. <![CDATA[Settings for timeline reader.]]>
  24769. </doc>
  24770. </field>
  24771. <field name="TIMELINE_SERVICE_READER_WEBAPP_ADDRESS" type="java.lang.String"
  24772. transient="false" volatile="false"
  24773. static="true" final="true" visibility="public"
  24774. deprecated="not deprecated">
  24775. </field>
  24776. <field name="DEFAULT_TIMELINE_SERVICE_READER_WEBAPP_ADDRESS" type="java.lang.String"
  24777. transient="false" volatile="false"
  24778. static="true" final="true" visibility="public"
  24779. deprecated="not deprecated">
  24780. </field>
  24781. <field name="TIMELINE_SERVICE_READER_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  24782. transient="false" volatile="false"
  24783. static="true" final="true" visibility="public"
  24784. deprecated="not deprecated">
  24785. </field>
  24786. <field name="DEFAULT_TIMELINE_SERVICE_READER_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  24787. transient="false" volatile="false"
  24788. static="true" final="true" visibility="public"
  24789. deprecated="not deprecated">
  24790. </field>
  24791. <field name="TIMELINE_SERVICE_READER_STORAGE_MONITOR_INTERVAL_MS" type="java.lang.String"
  24792. transient="false" volatile="false"
  24793. static="true" final="true" visibility="public"
  24794. deprecated="not deprecated">
  24795. </field>
  24796. <field name="DEFAULT_TIMELINE_SERVICE_STORAGE_MONITOR_INTERVAL_MS" type="long"
  24797. transient="false" volatile="false"
  24798. static="true" final="true" visibility="public"
  24799. deprecated="not deprecated">
  24800. </field>
  24801. <field name="TIMELINE_SERVICE_COLLECTOR_PREFIX" type="java.lang.String"
  24802. transient="false" volatile="false"
  24803. static="true" final="true" visibility="public"
  24804. deprecated="not deprecated">
  24805. <doc>
  24806. <![CDATA[Marked collector properties as Private since it run as auxillary service.]]>
  24807. </doc>
  24808. </field>
  24809. <field name="TIMELINE_SERVICE_COLLECTOR_BIND_HOST" type="java.lang.String"
  24810. transient="false" volatile="false"
  24811. static="true" final="true" visibility="public"
  24812. deprecated="not deprecated">
  24813. </field>
  24814. <field name="TIMELINE_SERVICE_COLLECTOR_BIND_PORT_RANGES" type="java.lang.String"
  24815. transient="false" volatile="false"
  24816. static="true" final="true" visibility="public"
  24817. deprecated="not deprecated">
  24818. </field>
  24819. <field name="TIMELINE_SERVICE_COLLECTOR_WEBAPP_ADDRESS" type="java.lang.String"
  24820. transient="false" volatile="false"
  24821. static="true" final="true" visibility="public"
  24822. deprecated="not deprecated">
  24823. </field>
  24824. <field name="DEFAULT_TIMELINE_SERVICE_COLLECTOR_WEBAPP_ADDRESS" type="java.lang.String"
  24825. transient="false" volatile="false"
  24826. static="true" final="true" visibility="public"
  24827. deprecated="not deprecated">
  24828. </field>
  24829. <field name="TIMELINE_SERVICE_COLLECTOR_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  24830. transient="false" volatile="false"
  24831. static="true" final="true" visibility="public"
  24832. deprecated="not deprecated">
  24833. </field>
  24834. <field name="DEFAULT_TIMELINE_SERVICE_COLLECTOR_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  24835. transient="false" volatile="false"
  24836. static="true" final="true" visibility="public"
  24837. deprecated="not deprecated">
  24838. </field>
  24839. <field name="NM_NUMA_AWARENESS_ENABLED" type="java.lang.String"
  24840. transient="false" volatile="false"
  24841. static="true" final="true" visibility="public"
  24842. deprecated="not deprecated">
  24843. <doc>
  24844. <![CDATA[Settings for NUMA awareness.]]>
  24845. </doc>
  24846. </field>
  24847. <field name="DEFAULT_NM_NUMA_AWARENESS_ENABLED" type="boolean"
  24848. transient="false" volatile="false"
  24849. static="true" final="true" visibility="public"
  24850. deprecated="not deprecated">
  24851. </field>
  24852. <field name="NM_NUMA_AWARENESS_READ_TOPOLOGY" type="java.lang.String"
  24853. transient="false" volatile="false"
  24854. static="true" final="true" visibility="public"
  24855. deprecated="not deprecated">
  24856. </field>
  24857. <field name="DEFAULT_NM_NUMA_AWARENESS_READ_TOPOLOGY" type="boolean"
  24858. transient="false" volatile="false"
  24859. static="true" final="true" visibility="public"
  24860. deprecated="not deprecated">
  24861. </field>
  24862. <field name="NM_NUMA_AWARENESS_NODE_IDS" type="java.lang.String"
  24863. transient="false" volatile="false"
  24864. static="true" final="true" visibility="public"
  24865. deprecated="not deprecated">
  24866. </field>
  24867. <field name="NM_NUMA_AWARENESS_NUMACTL_CMD" type="java.lang.String"
  24868. transient="false" volatile="false"
  24869. static="true" final="true" visibility="public"
  24870. deprecated="not deprecated">
  24871. </field>
  24872. <field name="DEFAULT_NM_NUMA_AWARENESS_NUMACTL_CMD" type="java.lang.String"
  24873. transient="false" volatile="false"
  24874. static="true" final="true" visibility="public"
  24875. deprecated="not deprecated">
  24876. </field>
  24877. <field name="RM_ACTIVITIES_MANAGER_PREFIX" type="java.lang.String"
  24878. transient="false" volatile="false"
  24879. static="true" final="true" visibility="public"
  24880. deprecated="not deprecated">
  24881. <doc>
  24882. <![CDATA[Settings for activities manager.]]>
  24883. </doc>
  24884. </field>
  24885. <field name="RM_ACTIVITIES_MANAGER_SCHEDULER_ACTIVITIES_PREFIX" type="java.lang.String"
  24886. transient="false" volatile="false"
  24887. static="true" final="true" visibility="public"
  24888. deprecated="not deprecated">
  24889. </field>
  24890. <field name="RM_ACTIVITIES_MANAGER_APP_ACTIVITIES_PREFIX" type="java.lang.String"
  24891. transient="false" volatile="false"
  24892. static="true" final="true" visibility="public"
  24893. deprecated="not deprecated">
  24894. </field>
  24895. <field name="RM_ACTIVITIES_MANAGER_CLEANUP_INTERVAL_MS" type="java.lang.String"
  24896. transient="false" volatile="false"
  24897. static="true" final="true" visibility="public"
  24898. deprecated="not deprecated">
  24899. <doc>
  24900. <![CDATA[The cleanup interval for activities in milliseconds.]]>
  24901. </doc>
  24902. </field>
  24903. <field name="DEFAULT_RM_ACTIVITIES_MANAGER_CLEANUP_INTERVAL_MS" type="long"
  24904. transient="false" volatile="false"
  24905. static="true" final="true" visibility="public"
  24906. deprecated="not deprecated">
  24907. </field>
  24908. <field name="RM_ACTIVITIES_MANAGER_SCHEDULER_ACTIVITIES_TTL_MS" type="java.lang.String"
  24909. transient="false" volatile="false"
  24910. static="true" final="true" visibility="public"
  24911. deprecated="not deprecated">
  24912. <doc>
  24913. <![CDATA[Time to live for scheduler activities in milliseconds.]]>
  24914. </doc>
  24915. </field>
  24916. <field name="DEFAULT_RM_ACTIVITIES_MANAGER_SCHEDULER_ACTIVITIES_TTL_MS" type="long"
  24917. transient="false" volatile="false"
  24918. static="true" final="true" visibility="public"
  24919. deprecated="not deprecated">
  24920. </field>
  24921. <field name="RM_ACTIVITIES_MANAGER_APP_ACTIVITIES_TTL_MS" type="java.lang.String"
  24922. transient="false" volatile="false"
  24923. static="true" final="true" visibility="public"
  24924. deprecated="not deprecated">
  24925. <doc>
  24926. <![CDATA[Time to live for app activities in milliseconds.]]>
  24927. </doc>
  24928. </field>
  24929. <field name="DEFAULT_RM_ACTIVITIES_MANAGER_APP_ACTIVITIES_TTL_MS" type="long"
  24930. transient="false" volatile="false"
  24931. static="true" final="true" visibility="public"
  24932. deprecated="not deprecated">
  24933. </field>
  24934. <field name="RM_ACTIVITIES_MANAGER_APP_ACTIVITIES_MAX_QUEUE_LENGTH" type="java.lang.String"
  24935. transient="false" volatile="false"
  24936. static="true" final="true" visibility="public"
  24937. deprecated="not deprecated">
  24938. <doc>
  24939. <![CDATA[Max queue length for app activities.]]>
  24940. </doc>
  24941. </field>
  24942. <field name="DEFAULT_RM_ACTIVITIES_MANAGER_APP_ACTIVITIES_MAX_QUEUE_LENGTH" type="int"
  24943. transient="false" volatile="false"
  24944. static="true" final="true" visibility="public"
  24945. deprecated="not deprecated">
  24946. </field>
  24947. <field name="NM_CONTAINERS_LAUNCHER_CLASS" type="java.lang.String"
  24948. transient="false" volatile="false"
  24949. static="true" final="true" visibility="public"
  24950. deprecated="not deprecated">
  24951. <doc>
  24952. <![CDATA[Containers launcher implementation to use.]]>
  24953. </doc>
  24954. </field>
  24955. <field name="YARN_WORKFLOW_ID_TAG_PREFIX" type="java.lang.String"
  24956. transient="false" volatile="false"
  24957. static="true" final="true" visibility="public"
  24958. deprecated="not deprecated">
  24959. </field>
  24960. <field name="DEFAULT_YARN_WORKFLOW_ID_TAG_PREFIX" type="java.lang.String"
  24961. transient="false" volatile="false"
  24962. static="true" final="true" visibility="public"
  24963. deprecated="not deprecated">
  24964. </field>
  24965. </class>
  24966. <!-- end class org.apache.hadoop.yarn.conf.YarnConfiguration -->
  24967. </package>
  24968. <package name="org.apache.hadoop.yarn.exceptions">
  24969. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
  24970. <class name="ApplicationAttemptNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  24971. abstract="false"
  24972. static="false" final="false" visibility="public"
  24973. deprecated="not deprecated">
  24974. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.Throwable"
  24975. static="false" final="false" visibility="public"
  24976. deprecated="not deprecated">
  24977. </constructor>
  24978. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String"
  24979. static="false" final="false" visibility="public"
  24980. deprecated="not deprecated">
  24981. </constructor>
  24982. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String, java.lang.Throwable"
  24983. static="false" final="false" visibility="public"
  24984. deprecated="not deprecated">
  24985. </constructor>
  24986. <doc>
  24987. <![CDATA[This exception is thrown on
  24988. {@link ApplicationHistoryProtocol#getApplicationAttemptReport (GetApplicationAttemptReportRequest)}
  24989. API when the Application Attempt doesn't exist in Application History Server or
  24990. {@link ApplicationMasterProtocol#allocate(AllocateRequest)} if application
  24991. doesn't exist in RM.]]>
  24992. </doc>
  24993. </class>
  24994. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
  24995. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
  24996. <class name="ApplicationIdNotProvidedException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  24997. abstract="false"
  24998. static="false" final="false" visibility="public"
  24999. deprecated="not deprecated">
  25000. <constructor name="ApplicationIdNotProvidedException" type="java.lang.Throwable"
  25001. static="false" final="false" visibility="public"
  25002. deprecated="not deprecated">
  25003. </constructor>
  25004. <constructor name="ApplicationIdNotProvidedException" type="java.lang.String"
  25005. static="false" final="false" visibility="public"
  25006. deprecated="not deprecated">
  25007. </constructor>
  25008. <constructor name="ApplicationIdNotProvidedException" type="java.lang.String, java.lang.Throwable"
  25009. static="false" final="false" visibility="public"
  25010. deprecated="not deprecated">
  25011. </constructor>
  25012. <doc>
  25013. <![CDATA[Exception to be thrown when Client submit an application without
  25014. providing {@link ApplicationId} in {@link ApplicationSubmissionContext}.]]>
  25015. </doc>
  25016. </class>
  25017. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
  25018. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
  25019. <class name="ApplicationNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  25020. abstract="false"
  25021. static="false" final="false" visibility="public"
  25022. deprecated="not deprecated">
  25023. <constructor name="ApplicationNotFoundException" type="java.lang.Throwable"
  25024. static="false" final="false" visibility="public"
  25025. deprecated="not deprecated">
  25026. </constructor>
  25027. <constructor name="ApplicationNotFoundException" type="java.lang.String"
  25028. static="false" final="false" visibility="public"
  25029. deprecated="not deprecated">
  25030. </constructor>
  25031. <constructor name="ApplicationNotFoundException" type="java.lang.String, java.lang.Throwable"
  25032. static="false" final="false" visibility="public"
  25033. deprecated="not deprecated">
  25034. </constructor>
  25035. <doc>
  25036. <![CDATA[This exception is thrown on
  25037. {@link ApplicationClientProtocol#getApplicationReport
  25038. (GetApplicationReportRequest)} API
  25039. when the Application doesn't exist in RM and AHS]]>
  25040. </doc>
  25041. </class>
  25042. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
  25043. <!-- start class org.apache.hadoop.yarn.exceptions.ConfigurationException -->
  25044. <class name="ConfigurationException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  25045. abstract="false"
  25046. static="false" final="false" visibility="public"
  25047. deprecated="not deprecated">
  25048. <constructor name="ConfigurationException" type="java.lang.Throwable"
  25049. static="false" final="false" visibility="public"
  25050. deprecated="not deprecated">
  25051. </constructor>
  25052. <constructor name="ConfigurationException" type="java.lang.String"
  25053. static="false" final="false" visibility="public"
  25054. deprecated="not deprecated">
  25055. </constructor>
  25056. <constructor name="ConfigurationException" type="java.lang.String, java.lang.Throwable"
  25057. static="false" final="false" visibility="public"
  25058. deprecated="not deprecated">
  25059. </constructor>
  25060. <doc>
  25061. <![CDATA[This exception is thrown on unrecoverable configuration errors.
  25062. An example is container launch error due to configuration.]]>
  25063. </doc>
  25064. </class>
  25065. <!-- end class org.apache.hadoop.yarn.exceptions.ConfigurationException -->
  25066. <!-- start class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
  25067. <class name="ContainerNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  25068. abstract="false"
  25069. static="false" final="false" visibility="public"
  25070. deprecated="not deprecated">
  25071. <constructor name="ContainerNotFoundException" type="java.lang.Throwable"
  25072. static="false" final="false" visibility="public"
  25073. deprecated="not deprecated">
  25074. </constructor>
  25075. <constructor name="ContainerNotFoundException" type="java.lang.String"
  25076. static="false" final="false" visibility="public"
  25077. deprecated="not deprecated">
  25078. </constructor>
  25079. <constructor name="ContainerNotFoundException" type="java.lang.String, java.lang.Throwable"
  25080. static="false" final="false" visibility="public"
  25081. deprecated="not deprecated">
  25082. </constructor>
  25083. <doc>
  25084. <![CDATA[This exception is thrown on
  25085. {@link ApplicationHistoryProtocol#getContainerReport (GetContainerReportRequest)}
  25086. API when the container doesn't exist in AHS]]>
  25087. </doc>
  25088. </class>
  25089. <!-- end class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
  25090. <!-- start class org.apache.hadoop.yarn.exceptions.ResourceNotFoundException -->
  25091. <class name="ResourceNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnRuntimeException"
  25092. abstract="false"
  25093. static="false" final="false" visibility="public"
  25094. deprecated="not deprecated">
  25095. <constructor name="ResourceNotFoundException" type="org.apache.hadoop.yarn.api.records.Resource, java.lang.String"
  25096. static="false" final="false" visibility="public"
  25097. deprecated="not deprecated">
  25098. </constructor>
  25099. <constructor name="ResourceNotFoundException" type="org.apache.hadoop.yarn.api.records.Resource, java.lang.String, java.lang.Throwable"
  25100. static="false" final="false" visibility="public"
  25101. deprecated="not deprecated">
  25102. </constructor>
  25103. <constructor name="ResourceNotFoundException" type="java.lang.String"
  25104. static="false" final="false" visibility="public"
  25105. deprecated="not deprecated">
  25106. </constructor>
  25107. <doc>
  25108. <![CDATA[This exception is thrown when details of an unknown resource type
  25109. are requested.]]>
  25110. </doc>
  25111. </class>
  25112. <!-- end class org.apache.hadoop.yarn.exceptions.ResourceNotFoundException -->
  25113. <!-- start class org.apache.hadoop.yarn.exceptions.YarnException -->
  25114. <class name="YarnException" extends="java.lang.Exception"
  25115. abstract="false"
  25116. static="false" final="false" visibility="public"
  25117. deprecated="not deprecated">
  25118. <constructor name="YarnException"
  25119. static="false" final="false" visibility="public"
  25120. deprecated="not deprecated">
  25121. </constructor>
  25122. <constructor name="YarnException" type="java.lang.String"
  25123. static="false" final="false" visibility="public"
  25124. deprecated="not deprecated">
  25125. </constructor>
  25126. <constructor name="YarnException" type="java.lang.Throwable"
  25127. static="false" final="false" visibility="public"
  25128. deprecated="not deprecated">
  25129. </constructor>
  25130. <constructor name="YarnException" type="java.lang.String, java.lang.Throwable"
  25131. static="false" final="false" visibility="public"
  25132. deprecated="not deprecated">
  25133. </constructor>
  25134. <doc>
  25135. <![CDATA[YarnException indicates exceptions from yarn servers. On the other hand,
  25136. IOExceptions indicates exceptions from RPC layer.]]>
  25137. </doc>
  25138. </class>
  25139. <!-- end class org.apache.hadoop.yarn.exceptions.YarnException -->
  25140. <!-- start class org.apache.hadoop.yarn.exceptions.YARNFeatureNotEnabledException -->
  25141. <class name="YARNFeatureNotEnabledException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  25142. abstract="false"
  25143. static="false" final="false" visibility="public"
  25144. deprecated="not deprecated">
  25145. <constructor name="YARNFeatureNotEnabledException" type="java.lang.Throwable"
  25146. static="false" final="false" visibility="public"
  25147. deprecated="not deprecated">
  25148. </constructor>
  25149. <constructor name="YARNFeatureNotEnabledException" type="java.lang.String"
  25150. static="false" final="false" visibility="public"
  25151. deprecated="not deprecated">
  25152. </constructor>
  25153. <constructor name="YARNFeatureNotEnabledException" type="java.lang.String, java.lang.Throwable"
  25154. static="false" final="false" visibility="public"
  25155. deprecated="not deprecated">
  25156. </constructor>
  25157. <doc>
  25158. <![CDATA[This exception is thrown when a feature is being used which is not enabled
  25159. yet.]]>
  25160. </doc>
  25161. </class>
  25162. <!-- end class org.apache.hadoop.yarn.exceptions.YARNFeatureNotEnabledException -->
  25163. </package>
  25164. <package name="org.apache.hadoop.yarn.server.api">
  25165. <!-- start class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
  25166. <class name="ApplicationInitializationContext" extends="java.lang.Object"
  25167. abstract="false"
  25168. static="false" final="false" visibility="public"
  25169. deprecated="not deprecated">
  25170. <constructor name="ApplicationInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ApplicationId, java.nio.ByteBuffer"
  25171. static="false" final="false" visibility="public"
  25172. deprecated="not deprecated">
  25173. </constructor>
  25174. <method name="getUser" return="java.lang.String"
  25175. abstract="false" native="false" synchronized="false"
  25176. static="false" final="false" visibility="public"
  25177. deprecated="not deprecated">
  25178. <doc>
  25179. <![CDATA[Get the user-name of the application-submitter
  25180. @return user-name]]>
  25181. </doc>
  25182. </method>
  25183. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  25184. abstract="false" native="false" synchronized="false"
  25185. static="false" final="false" visibility="public"
  25186. deprecated="not deprecated">
  25187. <doc>
  25188. <![CDATA[Get {@link ApplicationId} of the application
  25189. @return applications ID]]>
  25190. </doc>
  25191. </method>
  25192. <method name="getApplicationDataForService" return="java.nio.ByteBuffer"
  25193. abstract="false" native="false" synchronized="false"
  25194. static="false" final="false" visibility="public"
  25195. deprecated="not deprecated">
  25196. <doc>
  25197. <![CDATA[Get the data sent to the NodeManager via
  25198. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  25199. as part of {@link ContainerLaunchContext#getServiceData()}
  25200. @return the servicesData for this application.]]>
  25201. </doc>
  25202. </method>
  25203. <doc>
  25204. <![CDATA[Initialization context for {@link AuxiliaryService} when starting an
  25205. application.]]>
  25206. </doc>
  25207. </class>
  25208. <!-- end class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
  25209. <!-- start class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
  25210. <class name="ApplicationTerminationContext" extends="java.lang.Object"
  25211. abstract="false"
  25212. static="false" final="false" visibility="public"
  25213. deprecated="not deprecated">
  25214. <constructor name="ApplicationTerminationContext" type="org.apache.hadoop.yarn.api.records.ApplicationId"
  25215. static="false" final="false" visibility="public"
  25216. deprecated="not deprecated">
  25217. </constructor>
  25218. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  25219. abstract="false" native="false" synchronized="false"
  25220. static="false" final="false" visibility="public"
  25221. deprecated="not deprecated">
  25222. <doc>
  25223. <![CDATA[Get {@link ApplicationId} of the application being stopped.
  25224. @return applications ID]]>
  25225. </doc>
  25226. </method>
  25227. <doc>
  25228. <![CDATA[Initialization context for {@link AuxiliaryService} when stopping an
  25229. application.]]>
  25230. </doc>
  25231. </class>
  25232. <!-- end class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
  25233. <!-- start interface org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler -->
  25234. <interface name="AuxiliaryLocalPathHandler" abstract="true"
  25235. static="false" final="false" visibility="public"
  25236. deprecated="not deprecated">
  25237. <method name="getLocalPathForRead" return="org.apache.hadoop.fs.Path"
  25238. abstract="true" native="false" synchronized="false"
  25239. static="false" final="false" visibility="public"
  25240. deprecated="not deprecated">
  25241. <param name="path" type="java.lang.String"/>
  25242. <exception name="IOException" type="java.io.IOException"/>
  25243. <doc>
  25244. <![CDATA[Get a path from the local FS for reading for a given Auxiliary Service.
  25245. @param path the requested path
  25246. @return the complete path to the file on a local disk
  25247. @throws IOException if the file read encounters a problem]]>
  25248. </doc>
  25249. </method>
  25250. <method name="getLocalPathForWrite" return="org.apache.hadoop.fs.Path"
  25251. abstract="true" native="false" synchronized="false"
  25252. static="false" final="false" visibility="public"
  25253. deprecated="not deprecated">
  25254. <param name="path" type="java.lang.String"/>
  25255. <exception name="IOException" type="java.io.IOException"/>
  25256. <doc>
  25257. <![CDATA[Get a path from the local FS for writing for a given Auxiliary Service.
  25258. @param path the requested path
  25259. @return the complete path to the file on a local disk
  25260. @throws IOException if the path creations fails]]>
  25261. </doc>
  25262. </method>
  25263. <method name="getLocalPathForWrite" return="org.apache.hadoop.fs.Path"
  25264. abstract="true" native="false" synchronized="false"
  25265. static="false" final="false" visibility="public"
  25266. deprecated="not deprecated">
  25267. <param name="path" type="java.lang.String"/>
  25268. <param name="size" type="long"/>
  25269. <exception name="IOException" type="java.io.IOException"/>
  25270. <doc>
  25271. <![CDATA[Get a path from the local FS for writing a file of an estimated size
  25272. for a given Auxiliary Service.
  25273. @param path the requested path
  25274. @param size the size of the file that is going to be written
  25275. @return the complete path to the file on a local disk
  25276. @throws IOException if the path creations fails]]>
  25277. </doc>
  25278. </method>
  25279. <method name="getAllLocalPathsForRead" return="java.lang.Iterable"
  25280. abstract="true" native="false" synchronized="false"
  25281. static="false" final="false" visibility="public"
  25282. deprecated="not deprecated">
  25283. <param name="path" type="java.lang.String"/>
  25284. <exception name="IOException" type="java.io.IOException"/>
  25285. <doc>
  25286. <![CDATA[Get all paths from the local FS for reading for a given Auxiliary Service.
  25287. @param path the requested path
  25288. @return the complete path list to the file on a local disk as an Iterable
  25289. @throws IOException if the file read encounters a problem]]>
  25290. </doc>
  25291. </method>
  25292. <doc>
  25293. <![CDATA[An Interface that can retrieve local directories to read from or write to.
  25294. Components can implement this interface to link it to
  25295. their own Directory Handler Service]]>
  25296. </doc>
  25297. </interface>
  25298. <!-- end interface org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler -->
  25299. <!-- start class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
  25300. <class name="AuxiliaryService" extends="org.apache.hadoop.service.AbstractService"
  25301. abstract="true"
  25302. static="false" final="false" visibility="public"
  25303. deprecated="not deprecated">
  25304. <constructor name="AuxiliaryService" type="java.lang.String"
  25305. static="false" final="false" visibility="protected"
  25306. deprecated="not deprecated">
  25307. </constructor>
  25308. <method name="getRecoveryPath" return="org.apache.hadoop.fs.Path"
  25309. abstract="false" native="false" synchronized="false"
  25310. static="false" final="false" visibility="protected"
  25311. deprecated="not deprecated">
  25312. <doc>
  25313. <![CDATA[Get the path specific to this auxiliary service to use for recovery.
  25314. @return state storage path or null if recovery is not enabled]]>
  25315. </doc>
  25316. </method>
  25317. <method name="initializeApplication"
  25318. abstract="true" native="false" synchronized="false"
  25319. static="false" final="false" visibility="public"
  25320. deprecated="not deprecated">
  25321. <param name="initAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationInitializationContext"/>
  25322. <doc>
  25323. <![CDATA[A new application is started on this NodeManager. This is a signal to
  25324. this {@link AuxiliaryService} about the application initialization.
  25325. @param initAppContext context for the application's initialization]]>
  25326. </doc>
  25327. </method>
  25328. <method name="stopApplication"
  25329. abstract="true" native="false" synchronized="false"
  25330. static="false" final="false" visibility="public"
  25331. deprecated="not deprecated">
  25332. <param name="stopAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationTerminationContext"/>
  25333. <doc>
  25334. <![CDATA[An application is finishing on this NodeManager. This is a signal to this
  25335. {@link AuxiliaryService} about the same.
  25336. @param stopAppContext context for the application termination]]>
  25337. </doc>
  25338. </method>
  25339. <method name="getMetaData" return="java.nio.ByteBuffer"
  25340. abstract="true" native="false" synchronized="false"
  25341. static="false" final="false" visibility="public"
  25342. deprecated="not deprecated">
  25343. <doc>
  25344. <![CDATA[Retrieve meta-data for this {@link AuxiliaryService}. Applications using
  25345. this {@link AuxiliaryService} SHOULD know the format of the meta-data -
  25346. ideally each service should provide a method to parse out the information
  25347. to the applications. One example of meta-data is contact information so
  25348. that applications can access the service remotely. This will only be called
  25349. after the service's {@link #start()} method has finished. the result may be
  25350. cached.
  25351. <p>
  25352. The information is passed along to applications via
  25353. {@link StartContainersResponse#getAllServicesMetaData()} that is returned by
  25354. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  25355. </p>
  25356. @return meta-data for this service that should be made available to
  25357. applications.]]>
  25358. </doc>
  25359. </method>
  25360. <method name="initializeContainer"
  25361. abstract="false" native="false" synchronized="false"
  25362. static="false" final="false" visibility="public"
  25363. deprecated="not deprecated">
  25364. <param name="initContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerInitializationContext"/>
  25365. <doc>
  25366. <![CDATA[A new container is started on this NodeManager. This is a signal to
  25367. this {@link AuxiliaryService} about the container initialization.
  25368. This method is called when the NodeManager receives the container launch
  25369. command from the ApplicationMaster and before the container process is
  25370. launched.
  25371. @param initContainerContext context for the container's initialization]]>
  25372. </doc>
  25373. </method>
  25374. <method name="stopContainer"
  25375. abstract="false" native="false" synchronized="false"
  25376. static="false" final="false" visibility="public"
  25377. deprecated="not deprecated">
  25378. <param name="stopContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerTerminationContext"/>
  25379. <doc>
  25380. <![CDATA[A container is finishing on this NodeManager. This is a signal to this
  25381. {@link AuxiliaryService} about the same.
  25382. @param stopContainerContext context for the container termination]]>
  25383. </doc>
  25384. </method>
  25385. <method name="setRecoveryPath"
  25386. abstract="false" native="false" synchronized="false"
  25387. static="false" final="false" visibility="public"
  25388. deprecated="not deprecated">
  25389. <param name="recoveryPath" type="org.apache.hadoop.fs.Path"/>
  25390. <doc>
  25391. <![CDATA[Set the path for this auxiliary service to use for storing state
  25392. that will be used during recovery.
  25393. @param recoveryPath where recoverable state should be stored]]>
  25394. </doc>
  25395. </method>
  25396. <method name="getAuxiliaryLocalPathHandler" return="org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler"
  25397. abstract="false" native="false" synchronized="false"
  25398. static="false" final="false" visibility="public"
  25399. deprecated="not deprecated">
  25400. <doc>
  25401. <![CDATA[Method that gets the local dirs path handler for this Auxiliary Service.
  25402. @return auxiliaryPathHandler object that is used to read from and write to
  25403. valid local Dirs.]]>
  25404. </doc>
  25405. </method>
  25406. <method name="setAuxiliaryLocalPathHandler"
  25407. abstract="false" native="false" synchronized="false"
  25408. static="false" final="false" visibility="public"
  25409. deprecated="not deprecated">
  25410. <param name="auxiliaryLocalPathHandler" type="org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler"/>
  25411. <doc>
  25412. <![CDATA[Method that sets the local dirs path handler for this Auxiliary Service.
  25413. @param auxiliaryLocalPathHandler the pathHandler for this auxiliary service]]>
  25414. </doc>
  25415. </method>
  25416. <doc>
  25417. <![CDATA[A generic service that will be started by the NodeManager. This is a service
  25418. that administrators have to configure on each node by setting
  25419. {@link YarnConfiguration#NM_AUX_SERVICES}.]]>
  25420. </doc>
  25421. </class>
  25422. <!-- end class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
  25423. <!-- start class org.apache.hadoop.yarn.server.api.ContainerContext -->
  25424. <class name="ContainerContext" extends="java.lang.Object"
  25425. abstract="false"
  25426. static="false" final="false" visibility="public"
  25427. deprecated="not deprecated">
  25428. <constructor name="ContainerContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  25429. static="false" final="false" visibility="public"
  25430. deprecated="not deprecated">
  25431. </constructor>
  25432. <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"
  25433. static="false" final="false" visibility="public"
  25434. deprecated="not deprecated">
  25435. </constructor>
  25436. <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"
  25437. static="false" final="false" visibility="public"
  25438. deprecated="not deprecated">
  25439. </constructor>
  25440. <method name="getUser" return="java.lang.String"
  25441. abstract="false" native="false" synchronized="false"
  25442. static="false" final="false" visibility="public"
  25443. deprecated="not deprecated">
  25444. <doc>
  25445. <![CDATA[Get user of the container being initialized or stopped.
  25446. @return the user]]>
  25447. </doc>
  25448. </method>
  25449. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  25450. abstract="false" native="false" synchronized="false"
  25451. static="false" final="false" visibility="public"
  25452. deprecated="not deprecated">
  25453. <doc>
  25454. <![CDATA[Get {@link ContainerId} of the container being initialized or stopped.
  25455. @return the container ID]]>
  25456. </doc>
  25457. </method>
  25458. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  25459. abstract="false" native="false" synchronized="false"
  25460. static="false" final="false" visibility="public"
  25461. deprecated="not deprecated">
  25462. <doc>
  25463. <![CDATA[Get {@link Resource} the resource capability allocated to the container
  25464. being initialized or stopped.
  25465. @return the resource capability.]]>
  25466. </doc>
  25467. </method>
  25468. <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
  25469. abstract="false" native="false" synchronized="false"
  25470. static="false" final="false" visibility="public"
  25471. deprecated="not deprecated">
  25472. <doc>
  25473. <![CDATA[Get {@link ContainerType} the type of the container
  25474. being initialized or stopped.
  25475. @return the type of the container]]>
  25476. </doc>
  25477. </method>
  25478. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  25479. abstract="false" native="false" synchronized="false"
  25480. static="false" final="false" visibility="public"
  25481. deprecated="not deprecated">
  25482. <doc>
  25483. <![CDATA[Get {@link ExecutionType} the execution type of the container
  25484. being initialized or stopped.
  25485. @return the execution type of the container]]>
  25486. </doc>
  25487. </method>
  25488. <doc>
  25489. <![CDATA[Base context class for {@link AuxiliaryService} initializing and stopping a
  25490. container.]]>
  25491. </doc>
  25492. </class>
  25493. <!-- end class org.apache.hadoop.yarn.server.api.ContainerContext -->
  25494. <!-- start class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
  25495. <class name="ContainerInitializationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
  25496. abstract="false"
  25497. static="false" final="false" visibility="public"
  25498. deprecated="not deprecated">
  25499. <constructor name="ContainerInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  25500. static="false" final="false" visibility="public"
  25501. deprecated="not deprecated">
  25502. </constructor>
  25503. <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"
  25504. static="false" final="false" visibility="public"
  25505. deprecated="not deprecated">
  25506. </constructor>
  25507. <doc>
  25508. <![CDATA[Initialization context for {@link AuxiliaryService} when starting a
  25509. container.]]>
  25510. </doc>
  25511. </class>
  25512. <!-- end class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
  25513. <!-- start interface org.apache.hadoop.yarn.server.api.ContainerLogAggregationPolicy -->
  25514. <interface name="ContainerLogAggregationPolicy" abstract="true"
  25515. static="false" final="false" visibility="public"
  25516. deprecated="not deprecated">
  25517. <method name="parseParameters"
  25518. abstract="true" native="false" synchronized="false"
  25519. static="false" final="false" visibility="public"
  25520. deprecated="not deprecated">
  25521. <param name="parameters" type="java.lang.String"/>
  25522. <doc>
  25523. <![CDATA[<p>
  25524. The method used by the NodeManager log aggregation service
  25525. to initial the policy object with parameters specified by the application
  25526. or the cluster-wide setting.
  25527. </p>
  25528. @param parameters parameters with scheme defined by the policy class.]]>
  25529. </doc>
  25530. </method>
  25531. <method name="shouldDoLogAggregation" return="boolean"
  25532. abstract="true" native="false" synchronized="false"
  25533. static="false" final="false" visibility="public"
  25534. deprecated="not deprecated">
  25535. <param name="logContext" type="org.apache.hadoop.yarn.server.api.ContainerLogContext"/>
  25536. <doc>
  25537. <![CDATA[<p>
  25538. The method used by the NodeManager log aggregation service
  25539. to ask the policy object if a given container's logs should be aggregated.
  25540. </p>
  25541. @param logContext ContainerLogContext
  25542. @return Whether or not the container's logs should be aggregated.]]>
  25543. </doc>
  25544. </method>
  25545. <doc>
  25546. <![CDATA[This API is used by NodeManager to decide if a given container's logs
  25547. should be aggregated at run time.]]>
  25548. </doc>
  25549. </interface>
  25550. <!-- end interface org.apache.hadoop.yarn.server.api.ContainerLogAggregationPolicy -->
  25551. <!-- start class org.apache.hadoop.yarn.server.api.ContainerLogContext -->
  25552. <class name="ContainerLogContext" extends="java.lang.Object"
  25553. abstract="false"
  25554. static="false" final="false" visibility="public"
  25555. deprecated="not deprecated">
  25556. <constructor name="ContainerLogContext" type="org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.server.api.ContainerType, int"
  25557. static="false" final="false" visibility="public"
  25558. deprecated="not deprecated">
  25559. </constructor>
  25560. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  25561. abstract="false" native="false" synchronized="false"
  25562. static="false" final="false" visibility="public"
  25563. deprecated="not deprecated">
  25564. <doc>
  25565. <![CDATA[Get {@link ContainerId} of the container.
  25566. @return the container ID]]>
  25567. </doc>
  25568. </method>
  25569. <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
  25570. abstract="false" native="false" synchronized="false"
  25571. static="false" final="false" visibility="public"
  25572. deprecated="not deprecated">
  25573. <doc>
  25574. <![CDATA[Get {@link ContainerType} the type of the container.
  25575. @return the type of the container]]>
  25576. </doc>
  25577. </method>
  25578. <method name="getExitCode" return="int"
  25579. abstract="false" native="false" synchronized="false"
  25580. static="false" final="false" visibility="public"
  25581. deprecated="not deprecated">
  25582. <doc>
  25583. <![CDATA[Get the exit code of the container.
  25584. @return the exit code]]>
  25585. </doc>
  25586. </method>
  25587. <doc>
  25588. <![CDATA[Context class for {@link ContainerLogAggregationPolicy}.]]>
  25589. </doc>
  25590. </class>
  25591. <!-- end class org.apache.hadoop.yarn.server.api.ContainerLogContext -->
  25592. <!-- start class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
  25593. <class name="ContainerTerminationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
  25594. abstract="false"
  25595. static="false" final="false" visibility="public"
  25596. deprecated="not deprecated">
  25597. <constructor name="ContainerTerminationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  25598. static="false" final="false" visibility="public"
  25599. deprecated="not deprecated">
  25600. </constructor>
  25601. <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"
  25602. static="false" final="false" visibility="public"
  25603. deprecated="not deprecated">
  25604. </constructor>
  25605. <doc>
  25606. <![CDATA[Termination context for {@link AuxiliaryService} when stopping a
  25607. container.]]>
  25608. </doc>
  25609. </class>
  25610. <!-- end class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
  25611. <!-- start interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
  25612. <interface name="SCMAdminProtocol" abstract="true"
  25613. static="false" final="false" visibility="public"
  25614. deprecated="not deprecated">
  25615. <method name="runCleanerTask" return="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskResponse"
  25616. abstract="true" native="false" synchronized="false"
  25617. static="false" final="false" visibility="public"
  25618. deprecated="not deprecated">
  25619. <param name="request" type="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskRequest"/>
  25620. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  25621. <exception name="IOException" type="java.io.IOException"/>
  25622. <doc>
  25623. <![CDATA[<p>
  25624. The method used by administrators to ask SCM to run cleaner task right away
  25625. </p>
  25626. @param request request <code>SharedCacheManager</code> to run a cleaner task
  25627. @return <code>SharedCacheManager</code> returns an empty response
  25628. on success and throws an exception on rejecting the request
  25629. @throws YarnException
  25630. @throws IOException]]>
  25631. </doc>
  25632. </method>
  25633. <doc>
  25634. <![CDATA[<p>
  25635. The protocol between administrators and the <code>SharedCacheManager</code>
  25636. </p>]]>
  25637. </doc>
  25638. </interface>
  25639. <!-- end interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
  25640. </package>
  25641. <package name="org.apache.hadoop.yarn.util">
  25642. </package>
  25643. <package name="org.apache.hadoop.yarn.util.constraint">
  25644. <!-- start class org.apache.hadoop.yarn.util.constraint.PlacementConstraintParser -->
  25645. <class name="PlacementConstraintParser" extends="java.lang.Object"
  25646. abstract="false"
  25647. static="false" final="true" visibility="public"
  25648. deprecated="not deprecated">
  25649. <method name="parseExpression" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
  25650. abstract="false" native="false" synchronized="false"
  25651. static="true" final="false" visibility="public"
  25652. deprecated="not deprecated">
  25653. <param name="constraintStr" type="java.lang.String"/>
  25654. <exception name="PlacementConstraintParseException" type="org.apache.hadoop.yarn.util.constraint.PlacementConstraintParseException"/>
  25655. <doc>
  25656. <![CDATA[Parses a given constraint expression to a {@link AbstractConstraint},
  25657. this expression can be any valid form of constraint expressions.
  25658. @param constraintStr expression string
  25659. @return a parsed {@link AbstractConstraint}
  25660. @throws PlacementConstraintParseException when given expression
  25661. is malformed]]>
  25662. </doc>
  25663. </method>
  25664. <method name="parsePlacementSpec" return="java.util.Map"
  25665. abstract="false" native="false" synchronized="false"
  25666. static="true" final="false" visibility="public"
  25667. deprecated="not deprecated">
  25668. <param name="expression" type="java.lang.String"/>
  25669. <exception name="PlacementConstraintParseException" type="org.apache.hadoop.yarn.util.constraint.PlacementConstraintParseException"/>
  25670. <doc>
  25671. <![CDATA[Parses a placement constraint specification. A placement constraint spec
  25672. is a composite expression which is composed by multiple sub constraint
  25673. expressions delimited by ":". With following syntax:
  25674. <p>Tag1(N1),P1:Tag2(N2),P2:...:TagN(Nn),Pn</p>
  25675. where <b>TagN(Nn)</b> is a key value pair to determine the source
  25676. allocation tag and the number of allocations, such as:
  25677. <p>foo(3)</p>
  25678. Optional when using NodeAttribute Constraint.
  25679. and where <b>Pn</b> can be any form of a valid constraint expression,
  25680. such as:
  25681. <ul>
  25682. <li>in,node,foo,bar</li>
  25683. <li>notin,node,foo,bar,1,2</li>
  25684. <li>and(notin,node,foo:notin,node,bar)</li>
  25685. </ul>
  25686. and NodeAttribute Constraint such as
  25687. <ul>
  25688. <li>yarn.rm.io/foo=true</li>
  25689. <li>java=1.7,1.8</li>
  25690. </ul>
  25691. @param expression expression string.
  25692. @return a map of source tags to placement constraint mapping.
  25693. @throws PlacementConstraintParseException]]>
  25694. </doc>
  25695. </method>
  25696. <field name="EXPRESSION_VAL_DELIM" type="char"
  25697. transient="false" volatile="false"
  25698. static="true" final="true" visibility="public"
  25699. deprecated="not deprecated">
  25700. </field>
  25701. <doc>
  25702. <![CDATA[Placement constraint expression parser.]]>
  25703. </doc>
  25704. </class>
  25705. <!-- end class org.apache.hadoop.yarn.util.constraint.PlacementConstraintParser -->
  25706. </package>
  25707. <package name="org.apache.hadoop.yarn.util.csi">
  25708. </package>
  25709. <package name="org.apache.hadoop.yarn.util.resource">
  25710. </package>
  25711. </api>