Apache_Hadoop_YARN_API_2.7.2.xml 549 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220
  1. <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
  2. <!-- Generated by the JDiff Javadoc doclet -->
  3. <!-- (http://www.jdiff.org) -->
  4. <!-- on Wed Aug 24 13:54:38 PDT 2016 -->
  5. <api
  6. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  7. xsi:noNamespaceSchemaLocation='api.xsd'
  8. name="hadoop-yarn-api 2.7.2"
  9. jdversion="1.0.9">
  10. <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-annotations.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/jdiff.jar -verbose -classpath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/classes:/Users/vinodkv/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/Users/vinodkv/.m2/repository/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/Users/vinodkv/.m2/repository/com/google/code/findbugs/jsr305/3.0.0/jsr305-3.0.0.jar:/Users/vinodkv/.m2/repository/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-common/target/hadoop-common-2.7.2.jar:/Users/vinodkv/.m2/repository/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/Users/vinodkv/.m2/repository/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/Users/vinodkv/.m2/repository/xmlenc/xmlenc/0.52/xmlenc-0.52.jar:/Users/vinodkv/.m2/repository/commons-httpclient/commons-httpclient/3.1/commons-httpclient-3.1.jar:/Users/vinodkv/.m2/repository/commons-codec/commons-codec/1.4/commons-codec-1.4.jar:/Users/vinodkv/.m2/repository/commons-io/commons-io/2.4/commons-io-2.4.jar:/Users/vinodkv/.m2/repository/commons-net/commons-net/3.1/commons-net-3.1.jar:/Users/vinodkv/.m2/repository/commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar:/Users/vinodkv/.m2/repository/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar:/Users/vinodkv/.m2/repository/org/mortbay/jetty/jetty/6.1.26/jetty-6.1.26.jar:/Users/vinodkv/.m2/repository/org/mortbay/jetty/jetty-util/6.1.26/jetty-util-6.1.26.jar:/Users/vinodkv/.m2/repository/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-core/1.9/jersey-core-1.9.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-json/1.9/jersey-json-1.9.jar:/Users/vinodkv/.m2/repository/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/Users/vinodkv/.m2/repository/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/Users/vinodkv/.m2/repository/javax/xml/bind/jaxb-api/2.2.2/jaxb-api-2.2.2.jar:/Users/vinodkv/.m2/repository/javax/xml/stream/stax-api/1.0-2/stax-api-1.0-2.jar:/Users/vinodkv/.m2/repository/javax/activation/activation/1.1/activation-1.1.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-server/1.9/jersey-server-1.9.jar:/Users/vinodkv/.m2/repository/asm/asm/3.2/asm-3.2.jar:/Users/vinodkv/.m2/repository/log4j/log4j/1.2.17/log4j-1.2.17.jar:/Users/vinodkv/.m2/repository/net/java/dev/jets3t/jets3t/0.9.0/jets3t-0.9.0.jar:/Users/vinodkv/.m2/repository/org/apache/httpcomponents/httpclient/4.2.5/httpclient-4.2.5.jar:/Users/vinodkv/.m2/repository/org/apache/httpcomponents/httpcore/4.2.5/httpcore-4.2.5.jar:/Users/vinodkv/.m2/repository/com/jamesmurty/utils/java-xmlbuilder/0.4/java-xmlbuilder-0.4.jar:/Users/vinodkv/.m2/repository/commons-configuration/commons-configuration/1.6/commons-configuration-1.6.jar:/Users/vinodkv/.m2/repository/commons-digester/commons-digester/1.8/commons-digester-1.8.jar:/Users/vinodkv/.m2/repository/commons-beanutils/commons-beanutils/1.7.0/commons-beanutils-1.7.0.jar:/Users/vinodkv/.m2/repository/commons-beanutils/commons-beanutils-core/1.8.0/commons-beanutils-core-1.8.0.jar:/Users/vinodkv/.m2/repository/org/slf4j/slf4j-api/1.7.10/slf4j-api-1.7.10.jar:/Users/vinodkv/.m2/repository/org/slf4j/slf4j-log4j12/1.7.10/slf4j-log4j12-1.7.10.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/Users/vinodkv/.m2/repository/org/apache/avro/avro/1.7.4/avro-1.7.4.jar:/Users/vinodkv/.m2/repository/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/Users/vinodkv/.m2/repository/org/xerial/snappy/snappy-java/1.0.4.1/snappy-java-1.0.4.1.jar:/Users/vinodkv/.m2/repository/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-auth/target/hadoop-auth-2.7.2.jar:/Users/vinodkv/.m2/repository/org/apache/directory/server/apacheds-kerberos-codec/2.0.0-M15/apacheds-kerberos-codec-2.0.0-M15.jar:/Users/vinodkv/.m2/repository/org/apache/directory/server/apacheds-i18n/2.0.0-M15/apacheds-i18n-2.0.0-M15.jar:/Users/vinodkv/.m2/repository/org/apache/directory/api/api-asn1-api/1.0.0-M20/api-asn1-api-1.0.0-M20.jar:/Users/vinodkv/.m2/repository/org/apache/directory/api/api-util/1.0.0-M20/api-util-1.0.0-M20.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-framework/2.7.1/curator-framework-2.7.1.jar:/Users/vinodkv/.m2/repository/com/jcraft/jsch/0.1.42/jsch-0.1.42.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-client/2.7.1/curator-client-2.7.1.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-recipes/2.7.1/curator-recipes-2.7.1.jar:/Users/vinodkv/.m2/repository/org/apache/htrace/htrace-core/3.1.0-incubating/htrace-core-3.1.0-incubating.jar:/Users/vinodkv/.m2/repository/org/apache/zookeeper/zookeeper/3.4.6/zookeeper-3.4.6.jar:/Users/vinodkv/.m2/repository/io/netty/netty/3.6.2.Final/netty-3.6.2.Final.jar:/Users/vinodkv/.m2/repository/org/apache/commons/commons-compress/1.4.1/commons-compress-1.4.1.jar:/Users/vinodkv/.m2/repository/org/tukaani/xz/1.0/xz-1.0.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-2.7.2.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_40.jdk/Contents/Home/lib/tools.jar:/Users/vinodkv/.m2/repository/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar -sourcepath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-annotations.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/jdiff.jar -apidir /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/jdiff/xml -apiname hadoop-yarn-api 2.7.2 -->
  11. <package name="org.apache.hadoop.yarn.api">
  12. <!-- start interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
  13. <interface name="ApplicationClientProtocol" abstract="true"
  14. static="false" final="false" visibility="public"
  15. deprecated="not deprecated">
  16. <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
  17. <method name="getNewApplication" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse"
  18. abstract="true" native="false" synchronized="false"
  19. static="false" final="false" visibility="public"
  20. deprecated="not deprecated">
  21. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"/>
  22. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  23. <exception name="IOException" type="java.io.IOException"/>
  24. <doc>
  25. <![CDATA[<p>The interface used by clients to obtain a new {@link ApplicationId} for
  26. submitting new applications.</p>
  27. <p>The <code>ResourceManager</code> responds with a new, monotonically
  28. increasing, {@link ApplicationId} which is used by the client to submit
  29. a new application.</p>
  30. <p>The <code>ResourceManager</code> also responds with details such
  31. as maximum resource capabilities in the cluster as specified in
  32. {@link GetNewApplicationResponse}.</p>
  33. @param request request to get a new <code>ApplicationId</code>
  34. @return response containing the new <code>ApplicationId</code> to be used
  35. to submit an application
  36. @throws YarnException
  37. @throws IOException
  38. @see #submitApplication(SubmitApplicationRequest)]]>
  39. </doc>
  40. </method>
  41. <method name="submitApplication" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse"
  42. abstract="true" native="false" synchronized="false"
  43. static="false" final="false" visibility="public"
  44. deprecated="not deprecated">
  45. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"/>
  46. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  47. <exception name="IOException" type="java.io.IOException"/>
  48. <doc>
  49. <![CDATA[<p>The interface used by clients to submit a new application to the
  50. <code>ResourceManager.</code></p>
  51. <p>The client is required to provide details such as queue,
  52. {@link Resource} required to run the <code>ApplicationMaster</code>,
  53. the equivalent of {@link ContainerLaunchContext} for launching
  54. the <code>ApplicationMaster</code> etc. via the
  55. {@link SubmitApplicationRequest}.</p>
  56. <p>Currently the <code>ResourceManager</code> sends an immediate (empty)
  57. {@link SubmitApplicationResponse} on accepting the submission and throws
  58. an exception if it rejects the submission. However, this call needs to be
  59. followed by {@link #getApplicationReport(GetApplicationReportRequest)}
  60. to make sure that the application gets properly submitted - obtaining a
  61. {@link SubmitApplicationResponse} from ResourceManager doesn't guarantee
  62. that RM 'remembers' this application beyond failover or restart. If RM
  63. failover or RM restart happens before ResourceManager saves the
  64. application's state successfully, the subsequent
  65. {@link #getApplicationReport(GetApplicationReportRequest)} will throw
  66. a {@link ApplicationNotFoundException}. The Clients need to re-submit
  67. the application with the same {@link ApplicationSubmissionContext} when
  68. it encounters the {@link ApplicationNotFoundException} on the
  69. {@link #getApplicationReport(GetApplicationReportRequest)} call.</p>
  70. <p>During the submission process, it checks whether the application
  71. already exists. If the application exists, it will simply return
  72. SubmitApplicationResponse</p>
  73. <p> In secure mode,the <code>ResourceManager</code> verifies access to
  74. queues etc. before accepting the application submission.</p>
  75. @param request request to submit a new application
  76. @return (empty) response on accepting the submission
  77. @throws YarnException
  78. @throws IOException
  79. @see #getNewApplication(GetNewApplicationRequest)]]>
  80. </doc>
  81. </method>
  82. <method name="forceKillApplication" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse"
  83. abstract="true" native="false" synchronized="false"
  84. static="false" final="false" visibility="public"
  85. deprecated="not deprecated">
  86. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"/>
  87. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  88. <exception name="IOException" type="java.io.IOException"/>
  89. <doc>
  90. <![CDATA[<p>The interface used by clients to request the
  91. <code>ResourceManager</code> to abort submitted application.</p>
  92. <p>The client, via {@link KillApplicationRequest} provides the
  93. {@link ApplicationId} of the application to be aborted.</p>
  94. <p> In secure mode,the <code>ResourceManager</code> verifies access to the
  95. application, queue etc. before terminating the application.</p>
  96. <p>Currently, the <code>ResourceManager</code> returns an empty response
  97. on success and throws an exception on rejecting the request.</p>
  98. @param request request to abort a submitted application
  99. @return <code>ResourceManager</code> returns an empty response
  100. on success and throws an exception on rejecting the request
  101. @throws YarnException
  102. @throws IOException
  103. @see #getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  104. </doc>
  105. </method>
  106. <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse"
  107. abstract="true" native="false" synchronized="false"
  108. static="false" final="false" visibility="public"
  109. deprecated="not deprecated">
  110. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"/>
  111. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  112. <exception name="IOException" type="java.io.IOException"/>
  113. <doc>
  114. <![CDATA[<p>The interface used by clients to get metrics about the cluster from
  115. the <code>ResourceManager</code>.</p>
  116. <p>The <code>ResourceManager</code> responds with a
  117. {@link GetClusterMetricsResponse} which includes the
  118. {@link YarnClusterMetrics} with details such as number of current
  119. nodes in the cluster.</p>
  120. @param request request for cluster metrics
  121. @return cluster metrics
  122. @throws YarnException
  123. @throws IOException]]>
  124. </doc>
  125. </method>
  126. <method name="getClusterNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse"
  127. abstract="true" native="false" synchronized="false"
  128. static="false" final="false" visibility="public"
  129. deprecated="not deprecated">
  130. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"/>
  131. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  132. <exception name="IOException" type="java.io.IOException"/>
  133. <doc>
  134. <![CDATA[<p>The interface used by clients to get a report of all nodes
  135. in the cluster from the <code>ResourceManager</code>.</p>
  136. <p>The <code>ResourceManager</code> responds with a
  137. {@link GetClusterNodesResponse} which includes the
  138. {@link NodeReport} for all the nodes in the cluster.</p>
  139. @param request request for report on all nodes
  140. @return report on all nodes
  141. @throws YarnException
  142. @throws IOException]]>
  143. </doc>
  144. </method>
  145. <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse"
  146. abstract="true" native="false" synchronized="false"
  147. static="false" final="false" visibility="public"
  148. deprecated="not deprecated">
  149. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"/>
  150. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  151. <exception name="IOException" type="java.io.IOException"/>
  152. <doc>
  153. <![CDATA[<p>The interface used by clients to get information about <em>queues</em>
  154. from the <code>ResourceManager</code>.</p>
  155. <p>The client, via {@link GetQueueInfoRequest}, can ask for details such
  156. as used/total resources, child queues, running applications etc.</p>
  157. <p> In secure mode,the <code>ResourceManager</code> verifies access before
  158. providing the information.</p>
  159. @param request request to get queue information
  160. @return queue information
  161. @throws YarnException
  162. @throws IOException]]>
  163. </doc>
  164. </method>
  165. <method name="getQueueUserAcls" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse"
  166. abstract="true" native="false" synchronized="false"
  167. static="false" final="false" visibility="public"
  168. deprecated="not deprecated">
  169. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"/>
  170. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  171. <exception name="IOException" type="java.io.IOException"/>
  172. <doc>
  173. <![CDATA[<p>The interface used by clients to get information about <em>queue
  174. acls</em> for <em>current user</em> from the <code>ResourceManager</code>.
  175. </p>
  176. <p>The <code>ResourceManager</code> responds with queue acls for all
  177. existing queues.</p>
  178. @param request request to get queue acls for <em>current user</em>
  179. @return queue acls for <em>current user</em>
  180. @throws YarnException
  181. @throws IOException]]>
  182. </doc>
  183. </method>
  184. <method name="moveApplicationAcrossQueues" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse"
  185. abstract="true" native="false" synchronized="false"
  186. static="false" final="false" visibility="public"
  187. deprecated="not deprecated">
  188. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"/>
  189. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  190. <exception name="IOException" type="java.io.IOException"/>
  191. <doc>
  192. <![CDATA[Move an application to a new queue.
  193. @param request the application ID and the target queue
  194. @return an empty response
  195. @throws YarnException
  196. @throws IOException]]>
  197. </doc>
  198. </method>
  199. <method name="submitReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse"
  200. abstract="true" native="false" synchronized="false"
  201. static="false" final="false" visibility="public"
  202. deprecated="not deprecated">
  203. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"/>
  204. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  205. <exception name="IOException" type="java.io.IOException"/>
  206. <doc>
  207. <![CDATA[<p>
  208. The interface used by clients to submit a new reservation to the
  209. {@code ResourceManager}.
  210. </p>
  211. <p>
  212. The client packages all details of its request in a
  213. {@link ReservationSubmissionRequest} object. This contains information
  214. about the amount of capacity, temporal constraints, and concurrency needs.
  215. Furthermore, the reservation might be composed of multiple stages, with
  216. ordering dependencies among them.
  217. </p>
  218. <p>
  219. In order to respond, a new admission control component in the
  220. {@code ResourceManager} performs an analysis of the resources that have
  221. been committed over the period of time the user is requesting, verify that
  222. the user requests can be fulfilled, and that it respect a sharing policy
  223. (e.g., {@code CapacityOverTimePolicy}). Once it has positively determined
  224. that the ReservationSubmissionRequest is satisfiable the
  225. {@code ResourceManager} answers with a
  226. {@link ReservationSubmissionResponse} that include a non-null
  227. {@link ReservationId}. Upon failure to find a valid allocation the response
  228. is an exception with the reason.
  229. On application submission the client can use this {@link ReservationId} to
  230. obtain access to the reserved resources.
  231. </p>
  232. <p>
  233. The system guarantees that during the time-range specified by the user, the
  234. reservationID will be corresponding to a valid reservation. The amount of
  235. capacity dedicated to such queue can vary overtime, depending of the
  236. allocation that has been determined. But it is guaranteed to satisfy all
  237. the constraint expressed by the user in the
  238. {@link ReservationSubmissionRequest}.
  239. </p>
  240. @param request the request to submit a new Reservation
  241. @return response the {@link ReservationId} on accepting the submission
  242. @throws YarnException if the request is invalid or reservation cannot be
  243. created successfully
  244. @throws IOException]]>
  245. </doc>
  246. </method>
  247. <method name="updateReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse"
  248. abstract="true" native="false" synchronized="false"
  249. static="false" final="false" visibility="public"
  250. deprecated="not deprecated">
  251. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"/>
  252. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  253. <exception name="IOException" type="java.io.IOException"/>
  254. <doc>
  255. <![CDATA[<p>
  256. The interface used by clients to update an existing Reservation. This is
  257. referred to as a re-negotiation process, in which a user that has
  258. previously submitted a Reservation.
  259. </p>
  260. <p>
  261. The allocation is attempted by virtually substituting all previous
  262. allocations related to this Reservation with new ones, that satisfy the new
  263. {@link ReservationUpdateRequest}. Upon success the previous allocation is
  264. substituted by the new one, and on failure (i.e., if the system cannot find
  265. a valid allocation for the updated request), the previous allocation
  266. remains valid.
  267. The {@link ReservationId} is not changed, and applications currently
  268. running within this reservation will automatically receive the resources
  269. based on the new allocation.
  270. </p>
  271. @param request to update an existing Reservation (the ReservationRequest
  272. should refer to an existing valid {@link ReservationId})
  273. @return response empty on successfully updating the existing reservation
  274. @throws YarnException if the request is invalid or reservation cannot be
  275. updated successfully
  276. @throws IOException]]>
  277. </doc>
  278. </method>
  279. <method name="deleteReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse"
  280. abstract="true" native="false" synchronized="false"
  281. static="false" final="false" visibility="public"
  282. deprecated="not deprecated">
  283. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"/>
  284. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  285. <exception name="IOException" type="java.io.IOException"/>
  286. <doc>
  287. <![CDATA[<p>
  288. The interface used by clients to remove an existing Reservation.
  289. Upon deletion of a reservation applications running with this reservation,
  290. are automatically downgraded to normal jobs running without any dedicated
  291. reservation.
  292. </p>
  293. @param request to remove an existing Reservation (the ReservationRequest
  294. should refer to an existing valid {@link ReservationId})
  295. @return response empty on successfully deleting the existing reservation
  296. @throws YarnException if the request is invalid or reservation cannot be
  297. deleted successfully
  298. @throws IOException]]>
  299. </doc>
  300. </method>
  301. <method name="getNodeToLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse"
  302. abstract="true" native="false" synchronized="false"
  303. static="false" final="false" visibility="public"
  304. deprecated="not deprecated">
  305. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest"/>
  306. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  307. <exception name="IOException" type="java.io.IOException"/>
  308. <doc>
  309. <![CDATA[<p>
  310. The interface used by client to get node to labels mappings in existing cluster
  311. </p>
  312. @param request
  313. @return node to labels mappings
  314. @throws YarnException
  315. @throws IOException]]>
  316. </doc>
  317. </method>
  318. <method name="getLabelsToNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesResponse"
  319. abstract="true" native="false" synchronized="false"
  320. static="false" final="false" visibility="public"
  321. deprecated="not deprecated">
  322. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest"/>
  323. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  324. <exception name="IOException" type="java.io.IOException"/>
  325. <doc>
  326. <![CDATA[<p>
  327. The interface used by client to get labels to nodes mappings
  328. in existing cluster
  329. </p>
  330. @param request
  331. @return labels to nodes mappings
  332. @throws YarnException
  333. @throws IOException]]>
  334. </doc>
  335. </method>
  336. <method name="getClusterNodeLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  337. abstract="true" native="false" synchronized="false"
  338. static="false" final="false" visibility="public"
  339. deprecated="not deprecated">
  340. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"/>
  341. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  342. <exception name="IOException" type="java.io.IOException"/>
  343. <doc>
  344. <![CDATA[<p>
  345. The interface used by client to get node labels in the cluster
  346. </p>
  347. @param request to get node labels collection of this cluster
  348. @return node labels collection of this cluster
  349. @throws YarnException
  350. @throws IOException]]>
  351. </doc>
  352. </method>
  353. <doc>
  354. <![CDATA[<p>The protocol between clients and the <code>ResourceManager</code>
  355. to submit/abort jobs and to get information on applications, cluster metrics,
  356. nodes, queues and ACLs.</p>]]>
  357. </doc>
  358. </interface>
  359. <!-- end interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
  360. <!-- start interface org.apache.hadoop.yarn.api.ApplicationConstants -->
  361. <interface name="ApplicationConstants" abstract="true"
  362. static="false" final="false" visibility="public"
  363. deprecated="not deprecated">
  364. <field name="APP_SUBMIT_TIME_ENV" type="java.lang.String"
  365. transient="false" volatile="false"
  366. static="true" final="true" visibility="public"
  367. deprecated="not deprecated">
  368. <doc>
  369. <![CDATA[The environment variable for APP_SUBMIT_TIME. Set in AppMaster environment
  370. only]]>
  371. </doc>
  372. </field>
  373. <field name="CONTAINER_TOKEN_FILE_ENV_NAME" type="java.lang.String"
  374. transient="false" volatile="false"
  375. static="true" final="true" visibility="public"
  376. deprecated="not deprecated">
  377. <doc>
  378. <![CDATA[The cache file into which container token is written]]>
  379. </doc>
  380. </field>
  381. <field name="APPLICATION_WEB_PROXY_BASE_ENV" type="java.lang.String"
  382. transient="false" volatile="false"
  383. static="true" final="true" visibility="public"
  384. deprecated="not deprecated">
  385. <doc>
  386. <![CDATA[The environmental variable for APPLICATION_WEB_PROXY_BASE. Set in
  387. ApplicationMaster's environment only. This states that for all non-relative
  388. web URLs in the app masters web UI what base should they have.]]>
  389. </doc>
  390. </field>
  391. <field name="LOG_DIR_EXPANSION_VAR" type="java.lang.String"
  392. transient="false" volatile="false"
  393. static="true" final="true" visibility="public"
  394. deprecated="not deprecated">
  395. <doc>
  396. <![CDATA[The temporary environmental variable for container log directory. This
  397. should be replaced by real container log directory on container launch.]]>
  398. </doc>
  399. </field>
  400. <field name="CLASS_PATH_SEPARATOR" type="java.lang.String"
  401. transient="false" volatile="false"
  402. static="true" final="true" visibility="public"
  403. deprecated="not deprecated">
  404. <doc>
  405. <![CDATA[This constant is used to construct class path and it will be replaced with
  406. real class path separator(':' for Linux and ';' for Windows) by
  407. NodeManager on container launch. User has to use this constant to construct
  408. class path if user wants cross-platform practice i.e. submit an application
  409. from a Windows client to a Linux/Unix server or vice versa.]]>
  410. </doc>
  411. </field>
  412. <field name="PARAMETER_EXPANSION_LEFT" type="java.lang.String"
  413. transient="false" volatile="false"
  414. static="true" final="true" visibility="public"
  415. deprecated="not deprecated">
  416. <doc>
  417. <![CDATA[The following two constants are used to expand parameter and it will be
  418. replaced with real parameter expansion marker ('%' for Windows and '$' for
  419. Linux) by NodeManager on container launch. For example: {{VAR}} will be
  420. replaced as $VAR on Linux, and %VAR% on Windows. User has to use this
  421. constant to construct class path if user wants cross-platform practice i.e.
  422. submit an application from a Windows client to a Linux/Unix server or vice
  423. versa.]]>
  424. </doc>
  425. </field>
  426. <field name="PARAMETER_EXPANSION_RIGHT" type="java.lang.String"
  427. transient="false" volatile="false"
  428. static="true" final="true" visibility="public"
  429. deprecated="not deprecated">
  430. <doc>
  431. <![CDATA[User has to use this constant to construct class path if user wants
  432. cross-platform practice i.e. submit an application from a Windows client to
  433. a Linux/Unix server or vice versa.]]>
  434. </doc>
  435. </field>
  436. <field name="STDERR" type="java.lang.String"
  437. transient="false" volatile="false"
  438. static="true" final="true" visibility="public"
  439. deprecated="not deprecated">
  440. </field>
  441. <field name="STDOUT" type="java.lang.String"
  442. transient="false" volatile="false"
  443. static="true" final="true" visibility="public"
  444. deprecated="not deprecated">
  445. </field>
  446. <field name="MAX_APP_ATTEMPTS_ENV" type="java.lang.String"
  447. transient="false" volatile="false"
  448. static="true" final="true" visibility="public"
  449. deprecated="not deprecated">
  450. <doc>
  451. <![CDATA[The environment variable for MAX_APP_ATTEMPTS. Set in AppMaster environment
  452. only]]>
  453. </doc>
  454. </field>
  455. <doc>
  456. <![CDATA[This is the API for the applications comprising of constants that YARN sets
  457. up for the applications and the containers.
  458. TODO: Investigate the semantics and security of each cross-boundary refs.]]>
  459. </doc>
  460. </interface>
  461. <!-- end interface org.apache.hadoop.yarn.api.ApplicationConstants -->
  462. <!-- start interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
  463. <interface name="ApplicationHistoryProtocol" abstract="true"
  464. static="false" final="false" visibility="public"
  465. deprecated="not deprecated">
  466. <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
  467. <doc>
  468. <![CDATA[<p>
  469. The protocol between clients and the <code>ApplicationHistoryServer</code> to
  470. get the information of completed applications etc.
  471. </p>]]>
  472. </doc>
  473. </interface>
  474. <!-- end interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
  475. <!-- start interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
  476. <interface name="ApplicationMasterProtocol" abstract="true"
  477. static="false" final="false" visibility="public"
  478. deprecated="not deprecated">
  479. <method name="registerApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse"
  480. abstract="true" native="false" synchronized="false"
  481. static="false" final="false" visibility="public"
  482. deprecated="not deprecated">
  483. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"/>
  484. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  485. <exception name="IOException" type="java.io.IOException"/>
  486. <doc>
  487. <![CDATA[<p>
  488. The interface used by a new <code>ApplicationMaster</code> to register with
  489. the <code>ResourceManager</code>.
  490. </p>
  491. <p>
  492. The <code>ApplicationMaster</code> needs to provide details such as RPC
  493. Port, HTTP tracking url etc. as specified in
  494. {@link RegisterApplicationMasterRequest}.
  495. </p>
  496. <p>
  497. The <code>ResourceManager</code> responds with critical details such as
  498. maximum resource capabilities in the cluster as specified in
  499. {@link RegisterApplicationMasterResponse}.
  500. </p>
  501. @param request
  502. registration request
  503. @return registration respose
  504. @throws YarnException
  505. @throws IOException
  506. @throws InvalidApplicationMasterRequestException
  507. The exception is thrown when an ApplicationMaster tries to
  508. register more then once.
  509. @see RegisterApplicationMasterRequest
  510. @see RegisterApplicationMasterResponse]]>
  511. </doc>
  512. </method>
  513. <method name="finishApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse"
  514. abstract="true" native="false" synchronized="false"
  515. static="false" final="false" visibility="public"
  516. deprecated="not deprecated">
  517. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"/>
  518. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  519. <exception name="IOException" type="java.io.IOException"/>
  520. <doc>
  521. <![CDATA[<p>The interface used by an <code>ApplicationMaster</code> to notify the
  522. <code>ResourceManager</code> about its completion (success or failed).</p>
  523. <p>The <code>ApplicationMaster</code> has to provide details such as
  524. final state, diagnostics (in case of failures) etc. as specified in
  525. {@link FinishApplicationMasterRequest}.</p>
  526. <p>The <code>ResourceManager</code> responds with
  527. {@link FinishApplicationMasterResponse}.</p>
  528. @param request completion request
  529. @return completion response
  530. @throws YarnException
  531. @throws IOException
  532. @see FinishApplicationMasterRequest
  533. @see FinishApplicationMasterResponse]]>
  534. </doc>
  535. </method>
  536. <method name="allocate" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  537. abstract="true" native="false" synchronized="false"
  538. static="false" final="false" visibility="public"
  539. deprecated="not deprecated">
  540. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"/>
  541. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  542. <exception name="IOException" type="java.io.IOException"/>
  543. <doc>
  544. <![CDATA[<p>
  545. The main interface between an <code>ApplicationMaster</code> and the
  546. <code>ResourceManager</code>.
  547. </p>
  548. <p>
  549. The <code>ApplicationMaster</code> uses this interface to provide a list of
  550. {@link ResourceRequest} and returns unused {@link Container} allocated to
  551. it via {@link AllocateRequest}. Optionally, the
  552. <code>ApplicationMaster</code> can also <em>blacklist</em> resources which
  553. it doesn't want to use.
  554. </p>
  555. <p>
  556. This also doubles up as a <em>heartbeat</em> to let the
  557. <code>ResourceManager</code> know that the <code>ApplicationMaster</code>
  558. is alive. Thus, applications should periodically make this call to be kept
  559. alive. The frequency depends on
  560. {@link YarnConfiguration#RM_AM_EXPIRY_INTERVAL_MS} which defaults to
  561. {@link YarnConfiguration#DEFAULT_RM_AM_EXPIRY_INTERVAL_MS}.
  562. </p>
  563. <p>
  564. The <code>ResourceManager</code> responds with list of allocated
  565. {@link Container}, status of completed containers and headroom information
  566. for the application.
  567. </p>
  568. <p>
  569. The <code>ApplicationMaster</code> can use the available headroom
  570. (resources) to decide how to utilized allocated resources and make informed
  571. decisions about future resource requests.
  572. </p>
  573. @param request
  574. allocation request
  575. @return allocation response
  576. @throws YarnException
  577. @throws IOException
  578. @throws InvalidApplicationMasterRequestException
  579. This exception is thrown when an ApplicationMaster calls allocate
  580. without registering first.
  581. @throws InvalidResourceBlacklistRequestException
  582. This exception is thrown when an application provides an invalid
  583. specification for blacklist of resources.
  584. @throws InvalidResourceRequestException
  585. This exception is thrown when a {@link ResourceRequest} is out of
  586. the range of the configured lower and upper limits on the
  587. resources.
  588. @see AllocateRequest
  589. @see AllocateResponse]]>
  590. </doc>
  591. </method>
  592. <doc>
  593. <![CDATA[<p>The protocol between a live instance of <code>ApplicationMaster</code>
  594. and the <code>ResourceManager</code>.</p>
  595. <p>This is used by the <code>ApplicationMaster</code> to register/unregister
  596. and to request and obtain resources in the cluster from the
  597. <code>ResourceManager</code>.</p>]]>
  598. </doc>
  599. </interface>
  600. <!-- end interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
  601. <!-- start interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
  602. <interface name="ClientSCMProtocol" abstract="true"
  603. static="false" final="false" visibility="public"
  604. deprecated="not deprecated">
  605. <method name="use" return="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse"
  606. abstract="true" native="false" synchronized="false"
  607. static="false" final="false" visibility="public"
  608. deprecated="not deprecated">
  609. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest"/>
  610. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  611. <exception name="IOException" type="java.io.IOException"/>
  612. <doc>
  613. <![CDATA[<p>
  614. The interface used by clients to claim a resource with the
  615. <code>SharedCacheManager.</code> The client uses a checksum to identify the
  616. resource and an {@link ApplicationId} to identify which application will be
  617. using the resource.
  618. </p>
  619. <p>
  620. The <code>SharedCacheManager</code> responds with whether or not the
  621. resource exists in the cache. If the resource exists, a <code>Path</code>
  622. to the resource in the shared cache is returned. If the resource does not
  623. exist, the response is empty.
  624. </p>
  625. @param request request to claim a resource in the shared cache
  626. @return response indicating if the resource is already in the cache
  627. @throws YarnException
  628. @throws IOException]]>
  629. </doc>
  630. </method>
  631. <method name="release" return="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse"
  632. abstract="true" native="false" synchronized="false"
  633. static="false" final="false" visibility="public"
  634. deprecated="not deprecated">
  635. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest"/>
  636. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  637. <exception name="IOException" type="java.io.IOException"/>
  638. <doc>
  639. <![CDATA[<p>
  640. The interface used by clients to release a resource with the
  641. <code>SharedCacheManager.</code> This method is called once an application
  642. is no longer using a claimed resource in the shared cache. The client uses
  643. a checksum to identify the resource and an {@link ApplicationId} to
  644. identify which application is releasing the resource.
  645. </p>
  646. <p>
  647. Note: This method is an optimization and the client is not required to call
  648. it for correctness.
  649. </p>
  650. <p>
  651. Currently the <code>SharedCacheManager</code> sends an empty response.
  652. </p>
  653. @param request request to release a resource in the shared cache
  654. @return (empty) response on releasing the resource
  655. @throws YarnException
  656. @throws IOException]]>
  657. </doc>
  658. </method>
  659. <doc>
  660. <![CDATA[<p>
  661. The protocol between clients and the <code>SharedCacheManager</code> to claim
  662. and release resources in the shared cache.
  663. </p>]]>
  664. </doc>
  665. </interface>
  666. <!-- end interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
  667. <!-- start interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
  668. <interface name="ContainerManagementProtocol" abstract="true"
  669. static="false" final="false" visibility="public"
  670. deprecated="not deprecated">
  671. <method name="startContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse"
  672. abstract="true" native="false" synchronized="false"
  673. static="false" final="false" visibility="public"
  674. deprecated="not deprecated">
  675. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"/>
  676. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  677. <exception name="IOException" type="java.io.IOException"/>
  678. <doc>
  679. <![CDATA[<p>
  680. The <code>ApplicationMaster</code> provides a list of
  681. {@link StartContainerRequest}s to a <code>NodeManager</code> to
  682. <em>start</em> {@link Container}s allocated to it using this interface.
  683. </p>
  684. <p>
  685. The <code>ApplicationMaster</code> has to provide details such as allocated
  686. resource capability, security tokens (if enabled), command to be executed
  687. to start the container, environment for the process, necessary
  688. binaries/jar/shared-objects etc. via the {@link ContainerLaunchContext} in
  689. the {@link StartContainerRequest}.
  690. </p>
  691. <p>
  692. The <code>NodeManager</code> sends a response via
  693. {@link StartContainersResponse} which includes a list of
  694. {@link Container}s of successfully launched {@link Container}s, a
  695. containerId-to-exception map for each failed {@link StartContainerRequest} in
  696. which the exception indicates errors from per container and a
  697. allServicesMetaData map between the names of auxiliary services and their
  698. corresponding meta-data. Note: None-container-specific exceptions will
  699. still be thrown by the API method itself.
  700. </p>
  701. <p>
  702. The <code>ApplicationMaster</code> can use
  703. {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
  704. statuses of the to-be-launched or launched containers.
  705. </p>
  706. @param request
  707. request to start a list of containers
  708. @return response including conatinerIds of all successfully launched
  709. containers, a containerId-to-exception map for failed requests and
  710. a allServicesMetaData map.
  711. @throws YarnException
  712. @throws IOException
  713. @throws NMNotYetReadyException
  714. This exception is thrown when NM starts from scratch but has not
  715. yet connected with RM.]]>
  716. </doc>
  717. </method>
  718. <method name="stopContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse"
  719. abstract="true" native="false" synchronized="false"
  720. static="false" final="false" visibility="public"
  721. deprecated="not deprecated">
  722. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"/>
  723. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  724. <exception name="IOException" type="java.io.IOException"/>
  725. <doc>
  726. <![CDATA[<p>
  727. The <code>ApplicationMaster</code> requests a <code>NodeManager</code> to
  728. <em>stop</em> a list of {@link Container}s allocated to it using this
  729. interface.
  730. </p>
  731. <p>
  732. The <code>ApplicationMaster</code> sends a {@link StopContainersRequest}
  733. which includes the {@link ContainerId}s of the containers to be stopped.
  734. </p>
  735. <p>
  736. The <code>NodeManager</code> sends a response via
  737. {@link StopContainersResponse} which includes a list of {@link ContainerId}
  738. s of successfully stopped containers, a containerId-to-exception map for
  739. each failed request in which the exception indicates errors from per
  740. container. Note: None-container-specific exceptions will still be thrown by
  741. the API method itself. <code>ApplicationMaster</code> can use
  742. {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
  743. statuses of the containers.
  744. </p>
  745. @param request
  746. request to stop a list of containers
  747. @return response which includes a list of containerIds of successfully
  748. stopped containers, a containerId-to-exception map for failed
  749. requests.
  750. @throws YarnException
  751. @throws IOException]]>
  752. </doc>
  753. </method>
  754. <method name="getContainerStatuses" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse"
  755. abstract="true" native="false" synchronized="false"
  756. static="false" final="false" visibility="public"
  757. deprecated="not deprecated">
  758. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"/>
  759. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  760. <exception name="IOException" type="java.io.IOException"/>
  761. <doc>
  762. <![CDATA[<p>
  763. The API used by the <code>ApplicationMaster</code> to request for current
  764. statuses of <code>Container</code>s from the <code>NodeManager</code>.
  765. </p>
  766. <p>
  767. The <code>ApplicationMaster</code> sends a
  768. {@link GetContainerStatusesRequest} which includes the {@link ContainerId}s
  769. of all containers whose statuses are needed.
  770. </p>
  771. <p>
  772. The <code>NodeManager</code> responds with
  773. {@link GetContainerStatusesResponse} which includes a list of
  774. {@link ContainerStatus} of the successfully queried containers and a
  775. containerId-to-exception map for each failed request in which the exception
  776. indicates errors from per container. Note: None-container-specific
  777. exceptions will still be thrown by the API method itself.
  778. </p>
  779. @param request
  780. request to get <code>ContainerStatus</code>es of containers with
  781. the specified <code>ContainerId</code>s
  782. @return response containing the list of <code>ContainerStatus</code> of the
  783. successfully queried containers and a containerId-to-exception map
  784. for failed requests.
  785. @throws YarnException
  786. @throws IOException]]>
  787. </doc>
  788. </method>
  789. <doc>
  790. <![CDATA[<p>The protocol between an <code>ApplicationMaster</code> and a
  791. <code>NodeManager</code> to start/stop containers and to get status
  792. of running containers.</p>
  793. <p>If security is enabled the <code>NodeManager</code> verifies that the
  794. <code>ApplicationMaster</code> has truly been allocated the container
  795. by the <code>ResourceManager</code> and also verifies all interactions such
  796. as stopping the container or obtaining status information for the container.
  797. </p>]]>
  798. </doc>
  799. </interface>
  800. <!-- end interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
  801. </package>
  802. <package name="org.apache.hadoop.yarn.api.protocolrecords">
  803. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
  804. <class name="AllocateRequest" extends="java.lang.Object"
  805. abstract="true"
  806. static="false" final="false" visibility="public"
  807. deprecated="not deprecated">
  808. <constructor name="AllocateRequest"
  809. static="false" final="false" visibility="public"
  810. deprecated="not deprecated">
  811. </constructor>
  812. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  813. abstract="false" native="false" synchronized="false"
  814. static="true" final="false" visibility="public"
  815. deprecated="not deprecated">
  816. <param name="responseID" type="int"/>
  817. <param name="appProgress" type="float"/>
  818. <param name="resourceAsk" type="java.util.List"/>
  819. <param name="containersToBeReleased" type="java.util.List"/>
  820. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  821. </method>
  822. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  823. abstract="false" native="false" synchronized="false"
  824. static="true" final="false" visibility="public"
  825. deprecated="not deprecated">
  826. <param name="responseID" type="int"/>
  827. <param name="appProgress" type="float"/>
  828. <param name="resourceAsk" type="java.util.List"/>
  829. <param name="containersToBeReleased" type="java.util.List"/>
  830. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  831. <param name="increaseRequests" type="java.util.List"/>
  832. </method>
  833. <method name="getResponseId" return="int"
  834. abstract="true" native="false" synchronized="false"
  835. static="false" final="false" visibility="public"
  836. deprecated="not deprecated">
  837. <doc>
  838. <![CDATA[Get the <em>response id</em> used to track duplicate responses.
  839. @return <em>response id</em>]]>
  840. </doc>
  841. </method>
  842. <method name="setResponseId"
  843. abstract="true" native="false" synchronized="false"
  844. static="false" final="false" visibility="public"
  845. deprecated="not deprecated">
  846. <param name="id" type="int"/>
  847. <doc>
  848. <![CDATA[Set the <em>response id</em> used to track duplicate responses.
  849. @param id <em>response id</em>]]>
  850. </doc>
  851. </method>
  852. <method name="getProgress" return="float"
  853. abstract="true" native="false" synchronized="false"
  854. static="false" final="false" visibility="public"
  855. deprecated="not deprecated">
  856. <doc>
  857. <![CDATA[Get the <em>current progress</em> of application.
  858. @return <em>current progress</em> of application]]>
  859. </doc>
  860. </method>
  861. <method name="setProgress"
  862. abstract="true" native="false" synchronized="false"
  863. static="false" final="false" visibility="public"
  864. deprecated="not deprecated">
  865. <param name="progress" type="float"/>
  866. <doc>
  867. <![CDATA[Set the <em>current progress</em> of application
  868. @param progress <em>current progress</em> of application]]>
  869. </doc>
  870. </method>
  871. <method name="getAskList" return="java.util.List"
  872. abstract="true" native="false" synchronized="false"
  873. static="false" final="false" visibility="public"
  874. deprecated="not deprecated">
  875. <doc>
  876. <![CDATA[Get the list of <code>ResourceRequest</code> to update the
  877. <code>ResourceManager</code> about the application's resource requirements.
  878. @return the list of <code>ResourceRequest</code>
  879. @see ResourceRequest]]>
  880. </doc>
  881. </method>
  882. <method name="setAskList"
  883. abstract="true" native="false" synchronized="false"
  884. static="false" final="false" visibility="public"
  885. deprecated="not deprecated">
  886. <param name="resourceRequests" type="java.util.List"/>
  887. <doc>
  888. <![CDATA[Set list of <code>ResourceRequest</code> to update the
  889. <code>ResourceManager</code> about the application's resource requirements.
  890. @param resourceRequests list of <code>ResourceRequest</code> to update the
  891. <code>ResourceManager</code> about the application's
  892. resource requirements
  893. @see ResourceRequest]]>
  894. </doc>
  895. </method>
  896. <method name="getReleaseList" return="java.util.List"
  897. abstract="true" native="false" synchronized="false"
  898. static="false" final="false" visibility="public"
  899. deprecated="not deprecated">
  900. <doc>
  901. <![CDATA[Get the list of <code>ContainerId</code> of containers being
  902. released by the <code>ApplicationMaster</code>.
  903. @return list of <code>ContainerId</code> of containers being
  904. released by the <code>ApplicationMaster</code>]]>
  905. </doc>
  906. </method>
  907. <method name="setReleaseList"
  908. abstract="true" native="false" synchronized="false"
  909. static="false" final="false" visibility="public"
  910. deprecated="not deprecated">
  911. <param name="releaseContainers" type="java.util.List"/>
  912. <doc>
  913. <![CDATA[Set the list of <code>ContainerId</code> of containers being
  914. released by the <code>ApplicationMaster</code>
  915. @param releaseContainers list of <code>ContainerId</code> of
  916. containers being released by the
  917. <code>ApplicationMaster</code>]]>
  918. </doc>
  919. </method>
  920. <method name="getResourceBlacklistRequest" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
  921. abstract="true" native="false" synchronized="false"
  922. static="false" final="false" visibility="public"
  923. deprecated="not deprecated">
  924. <doc>
  925. <![CDATA[Get the <code>ResourceBlacklistRequest</code> being sent by the
  926. <code>ApplicationMaster</code>.
  927. @return the <code>ResourceBlacklistRequest</code> being sent by the
  928. <code>ApplicationMaster</code>
  929. @see ResourceBlacklistRequest]]>
  930. </doc>
  931. </method>
  932. <method name="setResourceBlacklistRequest"
  933. abstract="true" native="false" synchronized="false"
  934. static="false" final="false" visibility="public"
  935. deprecated="not deprecated">
  936. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  937. <doc>
  938. <![CDATA[Set the <code>ResourceBlacklistRequest</code> to inform the
  939. <code>ResourceManager</code> about the blacklist additions and removals
  940. per the <code>ApplicationMaster</code>.
  941. @param resourceBlacklistRequest the <code>ResourceBlacklistRequest</code>
  942. to inform the <code>ResourceManager</code> about
  943. the blacklist additions and removals
  944. per the <code>ApplicationMaster</code>
  945. @see ResourceBlacklistRequest]]>
  946. </doc>
  947. </method>
  948. <method name="getIncreaseRequests" return="java.util.List"
  949. abstract="true" native="false" synchronized="false"
  950. static="false" final="false" visibility="public"
  951. deprecated="not deprecated">
  952. <doc>
  953. <![CDATA[Get the <code>ContainerResourceIncreaseRequest</code> being sent by the
  954. <code>ApplicationMaster</code>]]>
  955. </doc>
  956. </method>
  957. <method name="setIncreaseRequests"
  958. abstract="true" native="false" synchronized="false"
  959. static="false" final="false" visibility="public"
  960. deprecated="not deprecated">
  961. <param name="increaseRequests" type="java.util.List"/>
  962. <doc>
  963. <![CDATA[Set the <code>ContainerResourceIncreaseRequest</code> to inform the
  964. <code>ResourceManager</code> about some container's resources need to be
  965. increased]]>
  966. </doc>
  967. </method>
  968. <doc>
  969. <![CDATA[<p>The core request sent by the <code>ApplicationMaster</code> to the
  970. <code>ResourceManager</code> to obtain resources in the cluster.</p>
  971. <p>The request includes:
  972. <ul>
  973. <li>A response id to track duplicate responses.</li>
  974. <li>Progress information.</li>
  975. <li>
  976. A list of {@link ResourceRequest} to inform the
  977. <code>ResourceManager</code> about the application's
  978. resource requirements.
  979. </li>
  980. <li>
  981. A list of unused {@link Container} which are being returned.
  982. </li>
  983. </ul>
  984. @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
  985. </doc>
  986. </class>
  987. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
  988. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
  989. <class name="AllocateResponse" extends="java.lang.Object"
  990. abstract="true"
  991. static="false" final="false" visibility="public"
  992. deprecated="not deprecated">
  993. <constructor name="AllocateResponse"
  994. static="false" final="false" visibility="public"
  995. deprecated="not deprecated">
  996. </constructor>
  997. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  998. abstract="false" native="false" synchronized="false"
  999. static="true" final="false" visibility="public"
  1000. deprecated="not deprecated">
  1001. <param name="responseId" type="int"/>
  1002. <param name="completedContainers" type="java.util.List"/>
  1003. <param name="allocatedContainers" type="java.util.List"/>
  1004. <param name="updatedNodes" type="java.util.List"/>
  1005. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1006. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1007. <param name="numClusterNodes" type="int"/>
  1008. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1009. <param name="nmTokens" type="java.util.List"/>
  1010. </method>
  1011. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1012. abstract="false" native="false" synchronized="false"
  1013. static="true" final="false" visibility="public"
  1014. deprecated="not deprecated">
  1015. <param name="responseId" type="int"/>
  1016. <param name="completedContainers" type="java.util.List"/>
  1017. <param name="allocatedContainers" type="java.util.List"/>
  1018. <param name="updatedNodes" type="java.util.List"/>
  1019. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1020. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1021. <param name="numClusterNodes" type="int"/>
  1022. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1023. <param name="nmTokens" type="java.util.List"/>
  1024. <param name="increasedContainers" type="java.util.List"/>
  1025. <param name="decreasedContainers" type="java.util.List"/>
  1026. </method>
  1027. <method name="getAMCommand" return="org.apache.hadoop.yarn.api.records.AMCommand"
  1028. abstract="true" native="false" synchronized="false"
  1029. static="false" final="false" visibility="public"
  1030. deprecated="not deprecated">
  1031. <doc>
  1032. <![CDATA[If the <code>ResourceManager</code> needs the
  1033. <code>ApplicationMaster</code> to take some action then it will send an
  1034. AMCommand to the <code>ApplicationMaster</code>. See <code>AMCommand</code>
  1035. for details on commands and actions for them.
  1036. @return <code>AMCommand</code> if the <code>ApplicationMaster</code> should
  1037. take action, <code>null</code> otherwise
  1038. @see AMCommand]]>
  1039. </doc>
  1040. </method>
  1041. <method name="getResponseId" return="int"
  1042. abstract="true" native="false" synchronized="false"
  1043. static="false" final="false" visibility="public"
  1044. deprecated="not deprecated">
  1045. <doc>
  1046. <![CDATA[Get the <em>last response id</em>.
  1047. @return <em>last response id</em>]]>
  1048. </doc>
  1049. </method>
  1050. <method name="getAllocatedContainers" return="java.util.List"
  1051. abstract="true" native="false" synchronized="false"
  1052. static="false" final="false" visibility="public"
  1053. deprecated="not deprecated">
  1054. <doc>
  1055. <![CDATA[Get the list of <em>newly allocated</em> <code>Container</code> by the
  1056. <code>ResourceManager</code>.
  1057. @return list of <em>newly allocated</em> <code>Container</code>]]>
  1058. </doc>
  1059. </method>
  1060. <method name="getAvailableResources" return="org.apache.hadoop.yarn.api.records.Resource"
  1061. abstract="true" native="false" synchronized="false"
  1062. static="false" final="false" visibility="public"
  1063. deprecated="not deprecated">
  1064. <doc>
  1065. <![CDATA[Get the <em>available headroom</em> for resources in the cluster for the
  1066. application.
  1067. @return limit of available headroom for resources in the cluster for the
  1068. application]]>
  1069. </doc>
  1070. </method>
  1071. <method name="getCompletedContainersStatuses" return="java.util.List"
  1072. abstract="true" native="false" synchronized="false"
  1073. static="false" final="false" visibility="public"
  1074. deprecated="not deprecated">
  1075. <doc>
  1076. <![CDATA[Get the list of <em>completed containers' statuses</em>.
  1077. @return the list of <em>completed containers' statuses</em>]]>
  1078. </doc>
  1079. </method>
  1080. <method name="getUpdatedNodes" return="java.util.List"
  1081. abstract="true" native="false" synchronized="false"
  1082. static="false" final="false" visibility="public"
  1083. deprecated="not deprecated">
  1084. <doc>
  1085. <![CDATA[Get the list of <em>updated <code>NodeReport</code>s</em>. Updates could
  1086. be changes in health, availability etc of the nodes.
  1087. @return The delta of updated nodes since the last response]]>
  1088. </doc>
  1089. </method>
  1090. <method name="getNumClusterNodes" return="int"
  1091. abstract="true" native="false" synchronized="false"
  1092. static="false" final="false" visibility="public"
  1093. deprecated="not deprecated">
  1094. <doc>
  1095. <![CDATA[Get the number of hosts available on the cluster.
  1096. @return the available host count.]]>
  1097. </doc>
  1098. </method>
  1099. <method name="getPreemptionMessage" return="org.apache.hadoop.yarn.api.records.PreemptionMessage"
  1100. abstract="true" native="false" synchronized="false"
  1101. static="false" final="false" visibility="public"
  1102. deprecated="not deprecated">
  1103. <doc>
  1104. <![CDATA[Get the description of containers owned by the AM, but requested back by
  1105. the cluster. Note that the RM may have an inconsistent view of the
  1106. resources owned by the AM. These messages are advisory, and the AM may
  1107. elect to ignore them.
  1108. <p>
  1109. The message is a snapshot of the resources the RM wants back from the AM.
  1110. While demand persists, the RM will repeat its request; applications should
  1111. not interpret each message as a request for <em>additional</em>
  1112. resources on top of previous messages. Resources requested consistently
  1113. over some duration may be forcibly killed by the RM.
  1114. @return A specification of the resources to reclaim from this AM.]]>
  1115. </doc>
  1116. </method>
  1117. <method name="getNMTokens" return="java.util.List"
  1118. abstract="true" native="false" synchronized="false"
  1119. static="false" final="false" visibility="public"
  1120. deprecated="not deprecated">
  1121. <doc>
  1122. <![CDATA[Get the list of NMTokens required for communicating with NM. New NMTokens
  1123. issued only if
  1124. <p>
  1125. 1) AM is receiving first container on underlying NodeManager.<br>
  1126. OR<br>
  1127. 2) NMToken master key rolled over in ResourceManager and AM is getting new
  1128. container on the same underlying NodeManager.
  1129. <p>
  1130. AM will receive one NMToken per NM irrespective of the number of containers
  1131. issued on same NM. AM is expected to store these tokens until issued a
  1132. new token for the same NM.]]>
  1133. </doc>
  1134. </method>
  1135. <method name="getIncreasedContainers" return="java.util.List"
  1136. abstract="true" native="false" synchronized="false"
  1137. static="false" final="false" visibility="public"
  1138. deprecated="not deprecated">
  1139. <doc>
  1140. <![CDATA[Get the list of newly increased containers by <code>ResourceManager</code>]]>
  1141. </doc>
  1142. </method>
  1143. <method name="getDecreasedContainers" return="java.util.List"
  1144. abstract="true" native="false" synchronized="false"
  1145. static="false" final="false" visibility="public"
  1146. deprecated="not deprecated">
  1147. <doc>
  1148. <![CDATA[Get the list of newly decreased containers by <code>NodeManager</code>]]>
  1149. </doc>
  1150. </method>
  1151. <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
  1152. abstract="true" native="false" synchronized="false"
  1153. static="false" final="false" visibility="public"
  1154. deprecated="not deprecated">
  1155. <doc>
  1156. <![CDATA[The AMRMToken that belong to this attempt
  1157. @return The AMRMToken that belong to this attempt]]>
  1158. </doc>
  1159. </method>
  1160. <doc>
  1161. <![CDATA[The response sent by the <code>ResourceManager</code> the
  1162. <code>ApplicationMaster</code> during resource negotiation.
  1163. <p>
  1164. The response, includes:
  1165. <ul>
  1166. <li>Response ID to track duplicate responses.</li>
  1167. <li>
  1168. An AMCommand sent by ResourceManager to let the
  1169. {@code ApplicationMaster} take some actions (resync, shutdown etc.).
  1170. </li>
  1171. <li>A list of newly allocated {@link Container}.</li>
  1172. <li>A list of completed {@link Container}s' statuses.</li>
  1173. <li>
  1174. The available headroom for resources in the cluster for the
  1175. application.
  1176. </li>
  1177. <li>A list of nodes whose status has been updated.</li>
  1178. <li>The number of available nodes in a cluster.</li>
  1179. <li>A description of resources requested back by the cluster</li>
  1180. <li>AMRMToken, if AMRMToken has been rolled over</li>
  1181. </ul>
  1182. @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
  1183. </doc>
  1184. </class>
  1185. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
  1186. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
  1187. <class name="ApplicationsRequestScope" extends="java.lang.Enum"
  1188. abstract="false"
  1189. static="false" final="true" visibility="public"
  1190. deprecated="not deprecated">
  1191. <method name="values" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope[]"
  1192. abstract="false" native="false" synchronized="false"
  1193. static="true" final="false" visibility="public"
  1194. deprecated="not deprecated">
  1195. </method>
  1196. <method name="valueOf" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"
  1197. abstract="false" native="false" synchronized="false"
  1198. static="true" final="false" visibility="public"
  1199. deprecated="not deprecated">
  1200. <param name="name" type="java.lang.String"/>
  1201. </method>
  1202. <doc>
  1203. <![CDATA[Enumeration that controls the scope of applications fetched]]>
  1204. </doc>
  1205. </class>
  1206. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
  1207. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
  1208. <class name="FinishApplicationMasterRequest" extends="java.lang.Object"
  1209. abstract="true"
  1210. static="false" final="false" visibility="public"
  1211. deprecated="not deprecated">
  1212. <constructor name="FinishApplicationMasterRequest"
  1213. static="false" final="false" visibility="public"
  1214. deprecated="not deprecated">
  1215. </constructor>
  1216. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"
  1217. abstract="false" native="false" synchronized="false"
  1218. static="true" final="false" visibility="public"
  1219. deprecated="not deprecated">
  1220. <param name="finalAppStatus" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
  1221. <param name="diagnostics" type="java.lang.String"/>
  1222. <param name="url" type="java.lang.String"/>
  1223. </method>
  1224. <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  1225. abstract="true" native="false" synchronized="false"
  1226. static="false" final="false" visibility="public"
  1227. deprecated="not deprecated">
  1228. <doc>
  1229. <![CDATA[Get <em>final state</em> of the <code>ApplicationMaster</code>.
  1230. @return <em>final state</em> of the <code>ApplicationMaster</code>]]>
  1231. </doc>
  1232. </method>
  1233. <method name="setFinalApplicationStatus"
  1234. abstract="true" native="false" synchronized="false"
  1235. static="false" final="false" visibility="public"
  1236. deprecated="not deprecated">
  1237. <param name="finalState" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
  1238. <doc>
  1239. <![CDATA[Set the <em>final state</em> of the <code>ApplicationMaster</code>
  1240. @param finalState <em>final state</em> of the <code>ApplicationMaster</code>]]>
  1241. </doc>
  1242. </method>
  1243. <method name="getDiagnostics" return="java.lang.String"
  1244. abstract="true" native="false" synchronized="false"
  1245. static="false" final="false" visibility="public"
  1246. deprecated="not deprecated">
  1247. <doc>
  1248. <![CDATA[Get <em>diagnostic information</em> on application failure.
  1249. @return <em>diagnostic information</em> on application failure]]>
  1250. </doc>
  1251. </method>
  1252. <method name="setDiagnostics"
  1253. abstract="true" native="false" synchronized="false"
  1254. static="false" final="false" visibility="public"
  1255. deprecated="not deprecated">
  1256. <param name="diagnostics" type="java.lang.String"/>
  1257. <doc>
  1258. <![CDATA[Set <em>diagnostic information</em> on application failure.
  1259. @param diagnostics <em>diagnostic information</em> on application failure]]>
  1260. </doc>
  1261. </method>
  1262. <method name="getTrackingUrl" return="java.lang.String"
  1263. abstract="true" native="false" synchronized="false"
  1264. static="false" final="false" visibility="public"
  1265. deprecated="not deprecated">
  1266. <doc>
  1267. <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
  1268. This url if contains scheme then that will be used by resource manager
  1269. web application proxy otherwise it will default to http.
  1270. @return <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  1271. </doc>
  1272. </method>
  1273. <method name="setTrackingUrl"
  1274. abstract="true" native="false" synchronized="false"
  1275. static="false" final="false" visibility="public"
  1276. deprecated="not deprecated">
  1277. <param name="url" type="java.lang.String"/>
  1278. <doc>
  1279. <![CDATA[Set the <em>final tracking URL</em>for the <code>ApplicationMaster</code>.
  1280. This is the web-URL to which ResourceManager or web-application proxy will
  1281. redirect client/users once the application is finished and the
  1282. <code>ApplicationMaster</code> is gone.
  1283. <p>
  1284. If the passed url has a scheme then that will be used by the
  1285. ResourceManager and web-application proxy, otherwise the scheme will
  1286. default to http.
  1287. </p>
  1288. <p>
  1289. Empty, null, "N/A" strings are all valid besides a real URL. In case an url
  1290. isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
  1291. <p>
  1292. @param url
  1293. <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  1294. </doc>
  1295. </method>
  1296. <doc>
  1297. <![CDATA[The finalization request sent by the {@code ApplicationMaster} to
  1298. inform the {@code ResourceManager} about its completion.
  1299. <p>
  1300. The final request includes details such:
  1301. <ul>
  1302. <li>Final state of the {@code ApplicationMaster}</li>
  1303. <li>
  1304. Diagnostic information in case of failure of the
  1305. {@code ApplicationMaster}
  1306. </li>
  1307. <li>Tracking URL</li>
  1308. </ul>
  1309. @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
  1310. </doc>
  1311. </class>
  1312. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
  1313. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
  1314. <class name="FinishApplicationMasterResponse" extends="java.lang.Object"
  1315. abstract="true"
  1316. static="false" final="false" visibility="public"
  1317. deprecated="not deprecated">
  1318. <constructor name="FinishApplicationMasterResponse"
  1319. static="false" final="false" visibility="public"
  1320. deprecated="not deprecated">
  1321. </constructor>
  1322. <method name="getIsUnregistered" return="boolean"
  1323. abstract="true" native="false" synchronized="false"
  1324. static="false" final="false" visibility="public"
  1325. deprecated="not deprecated">
  1326. <doc>
  1327. <![CDATA[Get the flag which indicates that the application has successfully
  1328. unregistered with the RM and the application can safely stop.]]>
  1329. </doc>
  1330. </method>
  1331. <doc>
  1332. <![CDATA[The response sent by the <code>ResourceManager</code> to a
  1333. <code>ApplicationMaster</code> on it's completion.
  1334. <p>
  1335. The response, includes:
  1336. <ul>
  1337. <li>A flag which indicates that the application has successfully unregistered
  1338. with the RM and the application can safely stop.</li>
  1339. </ul>
  1340. <p>
  1341. Note: The flag indicates whether the application has successfully
  1342. unregistered and is safe to stop. The application may stop after the flag is
  1343. true. If the application stops before the flag is true then the RM may retry
  1344. the application.
  1345. @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
  1346. </doc>
  1347. </class>
  1348. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
  1349. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
  1350. <class name="GetApplicationAttemptReportRequest" extends="java.lang.Object"
  1351. abstract="true"
  1352. static="false" final="false" visibility="public"
  1353. deprecated="not deprecated">
  1354. <constructor name="GetApplicationAttemptReportRequest"
  1355. static="false" final="false" visibility="public"
  1356. deprecated="not deprecated">
  1357. </constructor>
  1358. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"
  1359. abstract="false" native="false" synchronized="false"
  1360. static="true" final="false" visibility="public"
  1361. deprecated="not deprecated">
  1362. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1363. </method>
  1364. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  1365. abstract="true" native="false" synchronized="false"
  1366. static="false" final="false" visibility="public"
  1367. deprecated="not deprecated">
  1368. <doc>
  1369. <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
  1370. @return <code>ApplicationAttemptId</code> of an application attempt]]>
  1371. </doc>
  1372. </method>
  1373. <method name="setApplicationAttemptId"
  1374. abstract="true" native="false" synchronized="false"
  1375. static="false" final="false" visibility="public"
  1376. deprecated="not deprecated">
  1377. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1378. <doc>
  1379. <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
  1380. @param applicationAttemptId
  1381. <code>ApplicationAttemptId</code> of an application attempt]]>
  1382. </doc>
  1383. </method>
  1384. <doc>
  1385. <![CDATA[<p>
  1386. The request sent by a client to the <code>ResourceManager</code> to get an
  1387. {@link ApplicationAttemptReport} for an application attempt.
  1388. </p>
  1389. <p>
  1390. The request should include the {@link ApplicationAttemptId} of the
  1391. application attempt.
  1392. </p>
  1393. @see ApplicationAttemptReport
  1394. @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
  1395. </doc>
  1396. </class>
  1397. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
  1398. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
  1399. <class name="GetApplicationAttemptReportResponse" extends="java.lang.Object"
  1400. abstract="true"
  1401. static="false" final="false" visibility="public"
  1402. deprecated="not deprecated">
  1403. <constructor name="GetApplicationAttemptReportResponse"
  1404. static="false" final="false" visibility="public"
  1405. deprecated="not deprecated">
  1406. </constructor>
  1407. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
  1408. abstract="false" native="false" synchronized="false"
  1409. static="true" final="false" visibility="public"
  1410. deprecated="not deprecated">
  1411. <param name="ApplicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
  1412. </method>
  1413. <method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
  1414. abstract="true" native="false" synchronized="false"
  1415. static="false" final="false" visibility="public"
  1416. deprecated="not deprecated">
  1417. <doc>
  1418. <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
  1419. @return <code>ApplicationAttemptReport</code> for the application attempt]]>
  1420. </doc>
  1421. </method>
  1422. <method name="setApplicationAttemptReport"
  1423. abstract="true" native="false" synchronized="false"
  1424. static="false" final="false" visibility="public"
  1425. deprecated="not deprecated">
  1426. <param name="applicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
  1427. <doc>
  1428. <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
  1429. @param applicationAttemptReport
  1430. <code>ApplicationAttemptReport</code> for the application attempt]]>
  1431. </doc>
  1432. </method>
  1433. <doc>
  1434. <![CDATA[<p>
  1435. The response sent by the <code>ResourceManager</code> to a client requesting
  1436. an application attempt report.
  1437. </p>
  1438. <p>
  1439. The response includes an {@link ApplicationAttemptReport} which has the
  1440. details about the particular application attempt
  1441. </p>
  1442. @see ApplicationAttemptReport
  1443. @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
  1444. </doc>
  1445. </class>
  1446. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
  1447. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
  1448. <class name="GetApplicationAttemptsRequest" extends="java.lang.Object"
  1449. abstract="true"
  1450. static="false" final="false" visibility="public"
  1451. deprecated="not deprecated">
  1452. <constructor name="GetApplicationAttemptsRequest"
  1453. static="false" final="false" visibility="public"
  1454. deprecated="not deprecated">
  1455. </constructor>
  1456. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"
  1457. abstract="false" native="false" synchronized="false"
  1458. static="true" final="false" visibility="public"
  1459. deprecated="not deprecated">
  1460. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1461. </method>
  1462. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  1463. abstract="true" native="false" synchronized="false"
  1464. static="false" final="false" visibility="public"
  1465. deprecated="not deprecated">
  1466. <doc>
  1467. <![CDATA[Get the <code>ApplicationId</code> of an application
  1468. @return <code>ApplicationId</code> of an application]]>
  1469. </doc>
  1470. </method>
  1471. <method name="setApplicationId"
  1472. abstract="true" native="false" synchronized="false"
  1473. static="false" final="false" visibility="public"
  1474. deprecated="not deprecated">
  1475. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1476. <doc>
  1477. <![CDATA[Set the <code>ApplicationId</code> of an application
  1478. @param applicationId
  1479. <code>ApplicationId</code> of an application]]>
  1480. </doc>
  1481. </method>
  1482. <doc>
  1483. <![CDATA[<p>
  1484. The request from clients to get a list of application attempt reports of an
  1485. application from the <code>ResourceManager</code>.
  1486. </p>
  1487. @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
  1488. </doc>
  1489. </class>
  1490. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
  1491. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
  1492. <class name="GetApplicationAttemptsResponse" extends="java.lang.Object"
  1493. abstract="true"
  1494. static="false" final="false" visibility="public"
  1495. deprecated="not deprecated">
  1496. <constructor name="GetApplicationAttemptsResponse"
  1497. static="false" final="false" visibility="public"
  1498. deprecated="not deprecated">
  1499. </constructor>
  1500. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
  1501. abstract="false" native="false" synchronized="false"
  1502. static="true" final="false" visibility="public"
  1503. deprecated="not deprecated">
  1504. <param name="applicationAttempts" type="java.util.List"/>
  1505. </method>
  1506. <method name="getApplicationAttemptList" return="java.util.List"
  1507. abstract="true" native="false" synchronized="false"
  1508. static="false" final="false" visibility="public"
  1509. deprecated="not deprecated">
  1510. <doc>
  1511. <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
  1512. @return a list of <code>ApplicationReport</code> of an application]]>
  1513. </doc>
  1514. </method>
  1515. <method name="setApplicationAttemptList"
  1516. abstract="true" native="false" synchronized="false"
  1517. static="false" final="false" visibility="public"
  1518. deprecated="not deprecated">
  1519. <param name="applicationAttempts" type="java.util.List"/>
  1520. <doc>
  1521. <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
  1522. @param applicationAttempts
  1523. a list of <code>ApplicationReport</code> of an application]]>
  1524. </doc>
  1525. </method>
  1526. <doc>
  1527. <![CDATA[<p>
  1528. The response sent by the <code>ResourceManager</code> to a client requesting
  1529. a list of {@link ApplicationAttemptReport} for application attempts.
  1530. </p>
  1531. <p>
  1532. The <code>ApplicationAttemptReport</code> for each application includes the
  1533. details of an application attempt.
  1534. </p>
  1535. @see ApplicationAttemptReport
  1536. @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
  1537. </doc>
  1538. </class>
  1539. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
  1540. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
  1541. <class name="GetApplicationReportRequest" extends="java.lang.Object"
  1542. abstract="true"
  1543. static="false" final="false" visibility="public"
  1544. deprecated="not deprecated">
  1545. <constructor name="GetApplicationReportRequest"
  1546. static="false" final="false" visibility="public"
  1547. deprecated="not deprecated">
  1548. </constructor>
  1549. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"
  1550. abstract="false" native="false" synchronized="false"
  1551. static="true" final="false" visibility="public"
  1552. deprecated="not deprecated">
  1553. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1554. </method>
  1555. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  1556. abstract="true" native="false" synchronized="false"
  1557. static="false" final="false" visibility="public"
  1558. deprecated="not deprecated">
  1559. <doc>
  1560. <![CDATA[Get the <code>ApplicationId</code> of the application.
  1561. @return <code>ApplicationId</code> of the application]]>
  1562. </doc>
  1563. </method>
  1564. <method name="setApplicationId"
  1565. abstract="true" native="false" synchronized="false"
  1566. static="false" final="false" visibility="public"
  1567. deprecated="not deprecated">
  1568. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1569. <doc>
  1570. <![CDATA[Set the <code>ApplicationId</code> of the application
  1571. @param applicationId <code>ApplicationId</code> of the application]]>
  1572. </doc>
  1573. </method>
  1574. <doc>
  1575. <![CDATA[<p>The request sent by a client to the <code>ResourceManager</code> to
  1576. get an {@link ApplicationReport} for an application.</p>
  1577. <p>The request should include the {@link ApplicationId} of the
  1578. application.</p>
  1579. @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)
  1580. @see ApplicationReport]]>
  1581. </doc>
  1582. </class>
  1583. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
  1584. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
  1585. <class name="GetApplicationReportResponse" extends="java.lang.Object"
  1586. abstract="true"
  1587. static="false" final="false" visibility="public"
  1588. deprecated="not deprecated">
  1589. <constructor name="GetApplicationReportResponse"
  1590. static="false" final="false" visibility="public"
  1591. deprecated="not deprecated">
  1592. </constructor>
  1593. <method name="getApplicationReport" return="org.apache.hadoop.yarn.api.records.ApplicationReport"
  1594. abstract="true" native="false" synchronized="false"
  1595. static="false" final="false" visibility="public"
  1596. deprecated="not deprecated">
  1597. <doc>
  1598. <![CDATA[Get the <code>ApplicationReport</code> for the application.
  1599. @return <code>ApplicationReport</code> for the application]]>
  1600. </doc>
  1601. </method>
  1602. <doc>
  1603. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  1604. requesting an application report.</p>
  1605. <p>The response includes an {@link ApplicationReport} which has details such
  1606. as user, queue, name, host on which the <code>ApplicationMaster</code> is
  1607. running, RPC port, tracking URL, diagnostics, start time etc.</p>
  1608. @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)]]>
  1609. </doc>
  1610. </class>
  1611. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
  1612. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
  1613. <class name="GetApplicationsRequest" extends="java.lang.Object"
  1614. abstract="true"
  1615. static="false" final="false" visibility="public"
  1616. deprecated="not deprecated">
  1617. <constructor name="GetApplicationsRequest"
  1618. static="false" final="false" visibility="public"
  1619. deprecated="not deprecated">
  1620. </constructor>
  1621. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  1622. abstract="false" native="false" synchronized="false"
  1623. static="true" final="false" visibility="public"
  1624. deprecated="not deprecated">
  1625. </method>
  1626. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  1627. abstract="false" native="false" synchronized="false"
  1628. static="true" final="false" visibility="public"
  1629. deprecated="not deprecated">
  1630. <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
  1631. <param name="users" type="java.util.Set"/>
  1632. <param name="queues" type="java.util.Set"/>
  1633. <param name="applicationTypes" type="java.util.Set"/>
  1634. <param name="applicationTags" type="java.util.Set"/>
  1635. <param name="applicationStates" type="java.util.EnumSet"/>
  1636. <param name="startRange" type="org.apache.commons.lang.math.LongRange"/>
  1637. <param name="finishRange" type="org.apache.commons.lang.math.LongRange"/>
  1638. <param name="limit" type="java.lang.Long"/>
  1639. <doc>
  1640. <![CDATA[<p>
  1641. The request from clients to get a report of Applications matching the
  1642. giving application types in the cluster from the
  1643. <code>ResourceManager</code>.
  1644. </p>
  1645. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  1646. <p>Setting any of the parameters to null, would just disable that
  1647. filter</p>
  1648. @param scope {@link ApplicationsRequestScope} to filter by
  1649. @param users list of users to filter by
  1650. @param queues list of scheduler queues to filter by
  1651. @param applicationTypes types of applications
  1652. @param applicationTags application tags to filter by
  1653. @param applicationStates application states to filter by
  1654. @param startRange range of application start times to filter by
  1655. @param finishRange range of application finish times to filter by
  1656. @param limit number of applications to limit to
  1657. @return {@link GetApplicationsRequest} to be used with
  1658. {@link ApplicationClientProtocol#getApplications(GetApplicationsRequest)}]]>
  1659. </doc>
  1660. </method>
  1661. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  1662. abstract="false" native="false" synchronized="false"
  1663. static="true" final="false" visibility="public"
  1664. deprecated="not deprecated">
  1665. <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
  1666. <doc>
  1667. <![CDATA[<p>
  1668. The request from clients to get a report of Applications matching the
  1669. giving application types in the cluster from the
  1670. <code>ResourceManager</code>.
  1671. </p>
  1672. @param scope {@link ApplicationsRequestScope} to filter by
  1673. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  1674. </doc>
  1675. </method>
  1676. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  1677. abstract="false" native="false" synchronized="false"
  1678. static="true" final="false" visibility="public"
  1679. deprecated="not deprecated">
  1680. <param name="applicationTypes" type="java.util.Set"/>
  1681. <doc>
  1682. <![CDATA[<p>
  1683. The request from clients to get a report of Applications matching the
  1684. giving application types in the cluster from the
  1685. <code>ResourceManager</code>.
  1686. </p>
  1687. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  1688. </doc>
  1689. </method>
  1690. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  1691. abstract="false" native="false" synchronized="false"
  1692. static="true" final="false" visibility="public"
  1693. deprecated="not deprecated">
  1694. <param name="applicationStates" type="java.util.EnumSet"/>
  1695. <doc>
  1696. <![CDATA[<p>
  1697. The request from clients to get a report of Applications matching the
  1698. giving application states in the cluster from the
  1699. <code>ResourceManager</code>.
  1700. </p>
  1701. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  1702. </doc>
  1703. </method>
  1704. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  1705. abstract="false" native="false" synchronized="false"
  1706. static="true" final="false" visibility="public"
  1707. deprecated="not deprecated">
  1708. <param name="applicationTypes" type="java.util.Set"/>
  1709. <param name="applicationStates" type="java.util.EnumSet"/>
  1710. <doc>
  1711. <![CDATA[<p>
  1712. The request from clients to get a report of Applications matching the
  1713. giving and application types and application types in the cluster from the
  1714. <code>ResourceManager</code>.
  1715. </p>
  1716. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  1717. </doc>
  1718. </method>
  1719. <method name="getApplicationTypes" return="java.util.Set"
  1720. abstract="true" native="false" synchronized="false"
  1721. static="false" final="false" visibility="public"
  1722. deprecated="not deprecated">
  1723. <doc>
  1724. <![CDATA[Get the application types to filter applications on
  1725. @return Set of Application Types to filter on]]>
  1726. </doc>
  1727. </method>
  1728. <method name="getApplicationStates" return="java.util.EnumSet"
  1729. abstract="true" native="false" synchronized="false"
  1730. static="false" final="false" visibility="public"
  1731. deprecated="not deprecated">
  1732. <doc>
  1733. <![CDATA[Get the application states to filter applications on
  1734. @return Set of Application states to filter on]]>
  1735. </doc>
  1736. </method>
  1737. <doc>
  1738. <![CDATA[<p>The request from clients to get a report of Applications
  1739. in the cluster from the <code>ResourceManager</code>.</p>
  1740. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  1741. </doc>
  1742. </class>
  1743. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
  1744. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
  1745. <class name="GetApplicationsResponse" extends="java.lang.Object"
  1746. abstract="true"
  1747. static="false" final="false" visibility="public"
  1748. deprecated="not deprecated">
  1749. <constructor name="GetApplicationsResponse"
  1750. static="false" final="false" visibility="public"
  1751. deprecated="not deprecated">
  1752. </constructor>
  1753. <method name="getApplicationList" return="java.util.List"
  1754. abstract="true" native="false" synchronized="false"
  1755. static="false" final="false" visibility="public"
  1756. deprecated="not deprecated">
  1757. <doc>
  1758. <![CDATA[Get <code>ApplicationReport</code> for applications.
  1759. @return <code>ApplicationReport</code> for applications]]>
  1760. </doc>
  1761. </method>
  1762. <doc>
  1763. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  1764. requesting an {@link ApplicationReport} for applications.</p>
  1765. <p>The <code>ApplicationReport</code> for each application includes details
  1766. such as user, queue, name, host on which the <code>ApplicationMaster</code>
  1767. is running, RPC port, tracking URL, diagnostics, start time etc.</p>
  1768. @see ApplicationReport
  1769. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  1770. </doc>
  1771. </class>
  1772. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
  1773. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
  1774. <class name="GetClusterMetricsRequest" extends="java.lang.Object"
  1775. abstract="true"
  1776. static="false" final="false" visibility="public"
  1777. deprecated="not deprecated">
  1778. <constructor name="GetClusterMetricsRequest"
  1779. static="false" final="false" visibility="public"
  1780. deprecated="not deprecated">
  1781. </constructor>
  1782. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"
  1783. abstract="false" native="false" synchronized="false"
  1784. static="true" final="false" visibility="public"
  1785. deprecated="not deprecated">
  1786. </method>
  1787. <doc>
  1788. <![CDATA[<p>The request sent by clients to get cluster metrics from the
  1789. <code>ResourceManager</code>.</p>
  1790. <p>Currently, this is empty.</p>
  1791. @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
  1792. </doc>
  1793. </class>
  1794. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
  1795. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
  1796. <class name="GetClusterMetricsResponse" extends="java.lang.Object"
  1797. abstract="true"
  1798. static="false" final="false" visibility="public"
  1799. deprecated="not deprecated">
  1800. <constructor name="GetClusterMetricsResponse"
  1801. static="false" final="false" visibility="public"
  1802. deprecated="not deprecated">
  1803. </constructor>
  1804. <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.records.YarnClusterMetrics"
  1805. abstract="true" native="false" synchronized="false"
  1806. static="false" final="false" visibility="public"
  1807. deprecated="not deprecated">
  1808. <doc>
  1809. <![CDATA[Get the <code>YarnClusterMetrics</code> for the cluster.
  1810. @return <code>YarnClusterMetrics</code> for the cluster]]>
  1811. </doc>
  1812. </method>
  1813. <doc>
  1814. <![CDATA[The response sent by the <code>ResourceManager</code> to a client
  1815. requesting cluster metrics.
  1816. @see YarnClusterMetrics
  1817. @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
  1818. </doc>
  1819. </class>
  1820. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
  1821. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
  1822. <class name="GetClusterNodeLabelsRequest" extends="java.lang.Object"
  1823. abstract="true"
  1824. static="false" final="false" visibility="public"
  1825. deprecated="not deprecated">
  1826. <constructor name="GetClusterNodeLabelsRequest"
  1827. static="false" final="false" visibility="public"
  1828. deprecated="not deprecated">
  1829. </constructor>
  1830. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"
  1831. abstract="false" native="false" synchronized="false"
  1832. static="true" final="false" visibility="public"
  1833. deprecated="not deprecated">
  1834. </method>
  1835. </class>
  1836. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
  1837. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
  1838. <class name="GetClusterNodeLabelsResponse" extends="java.lang.Object"
  1839. abstract="true"
  1840. static="false" final="false" visibility="public"
  1841. deprecated="not deprecated">
  1842. <constructor name="GetClusterNodeLabelsResponse"
  1843. static="false" final="false" visibility="public"
  1844. deprecated="not deprecated">
  1845. </constructor>
  1846. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  1847. abstract="false" native="false" synchronized="false"
  1848. static="true" final="false" visibility="public"
  1849. deprecated="not deprecated">
  1850. <param name="labels" type="java.util.Set"/>
  1851. </method>
  1852. <method name="setNodeLabels"
  1853. abstract="true" native="false" synchronized="false"
  1854. static="false" final="false" visibility="public"
  1855. deprecated="not deprecated">
  1856. <param name="labels" type="java.util.Set"/>
  1857. </method>
  1858. <method name="getNodeLabels" return="java.util.Set"
  1859. abstract="true" native="false" synchronized="false"
  1860. static="false" final="false" visibility="public"
  1861. deprecated="not deprecated">
  1862. </method>
  1863. </class>
  1864. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
  1865. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
  1866. <class name="GetClusterNodesRequest" extends="java.lang.Object"
  1867. abstract="true"
  1868. static="false" final="false" visibility="public"
  1869. deprecated="not deprecated">
  1870. <constructor name="GetClusterNodesRequest"
  1871. static="false" final="false" visibility="public"
  1872. deprecated="not deprecated">
  1873. </constructor>
  1874. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
  1875. abstract="false" native="false" synchronized="false"
  1876. static="true" final="false" visibility="public"
  1877. deprecated="not deprecated">
  1878. <param name="states" type="java.util.EnumSet"/>
  1879. </method>
  1880. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
  1881. abstract="false" native="false" synchronized="false"
  1882. static="true" final="false" visibility="public"
  1883. deprecated="not deprecated">
  1884. </method>
  1885. <method name="getNodeStates" return="java.util.EnumSet"
  1886. abstract="true" native="false" synchronized="false"
  1887. static="false" final="false" visibility="public"
  1888. deprecated="not deprecated">
  1889. <doc>
  1890. <![CDATA[The state to filter the cluster nodes with.]]>
  1891. </doc>
  1892. </method>
  1893. <method name="setNodeStates"
  1894. abstract="true" native="false" synchronized="false"
  1895. static="false" final="false" visibility="public"
  1896. deprecated="not deprecated">
  1897. <param name="states" type="java.util.EnumSet"/>
  1898. <doc>
  1899. <![CDATA[The state to filter the cluster nodes with.]]>
  1900. </doc>
  1901. </method>
  1902. <doc>
  1903. <![CDATA[<p>The request from clients to get a report of all nodes
  1904. in the cluster from the <code>ResourceManager</code>.</p>
  1905. The request will ask for all nodes in the given {@link NodeState}s.
  1906. @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
  1907. </doc>
  1908. </class>
  1909. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
  1910. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
  1911. <class name="GetClusterNodesResponse" extends="java.lang.Object"
  1912. abstract="true"
  1913. static="false" final="false" visibility="public"
  1914. deprecated="not deprecated">
  1915. <constructor name="GetClusterNodesResponse"
  1916. static="false" final="false" visibility="public"
  1917. deprecated="not deprecated">
  1918. </constructor>
  1919. <method name="getNodeReports" return="java.util.List"
  1920. abstract="true" native="false" synchronized="false"
  1921. static="false" final="false" visibility="public"
  1922. deprecated="not deprecated">
  1923. <doc>
  1924. <![CDATA[Get <code>NodeReport</code> for all nodes in the cluster.
  1925. @return <code>NodeReport</code> for all nodes in the cluster]]>
  1926. </doc>
  1927. </method>
  1928. <doc>
  1929. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  1930. requesting a {@link NodeReport} for all nodes.</p>
  1931. <p>The <code>NodeReport</code> contains per-node information such as
  1932. available resources, number of containers, tracking url, rack name, health
  1933. status etc.
  1934. @see NodeReport
  1935. @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
  1936. </doc>
  1937. </class>
  1938. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
  1939. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
  1940. <class name="GetContainerReportRequest" extends="java.lang.Object"
  1941. abstract="true"
  1942. static="false" final="false" visibility="public"
  1943. deprecated="not deprecated">
  1944. <constructor name="GetContainerReportRequest"
  1945. static="false" final="false" visibility="public"
  1946. deprecated="not deprecated">
  1947. </constructor>
  1948. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"
  1949. abstract="false" native="false" synchronized="false"
  1950. static="true" final="false" visibility="public"
  1951. deprecated="not deprecated">
  1952. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  1953. </method>
  1954. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  1955. abstract="true" native="false" synchronized="false"
  1956. static="false" final="false" visibility="public"
  1957. deprecated="not deprecated">
  1958. <doc>
  1959. <![CDATA[Get the <code>ContainerId</code> of the Container.
  1960. @return <code>ContainerId</code> of the Container]]>
  1961. </doc>
  1962. </method>
  1963. <method name="setContainerId"
  1964. abstract="true" native="false" synchronized="false"
  1965. static="false" final="false" visibility="public"
  1966. deprecated="not deprecated">
  1967. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  1968. <doc>
  1969. <![CDATA[Set the <code>ContainerId</code> of the container
  1970. @param containerId
  1971. <code>ContainerId</code> of the container]]>
  1972. </doc>
  1973. </method>
  1974. <doc>
  1975. <![CDATA[<p>
  1976. The request sent by a client to the <code>ResourceManager</code> to get an
  1977. {@link ContainerReport} for a container.
  1978. </p>]]>
  1979. </doc>
  1980. </class>
  1981. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
  1982. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
  1983. <class name="GetContainerReportResponse" extends="java.lang.Object"
  1984. abstract="true"
  1985. static="false" final="false" visibility="public"
  1986. deprecated="not deprecated">
  1987. <constructor name="GetContainerReportResponse"
  1988. static="false" final="false" visibility="public"
  1989. deprecated="not deprecated">
  1990. </constructor>
  1991. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
  1992. abstract="false" native="false" synchronized="false"
  1993. static="true" final="false" visibility="public"
  1994. deprecated="not deprecated">
  1995. <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
  1996. </method>
  1997. <method name="getContainerReport" return="org.apache.hadoop.yarn.api.records.ContainerReport"
  1998. abstract="true" native="false" synchronized="false"
  1999. static="false" final="false" visibility="public"
  2000. deprecated="not deprecated">
  2001. <doc>
  2002. <![CDATA[Get the <code>ContainerReport</code> for the container.
  2003. @return <code>ContainerReport</code> for the container]]>
  2004. </doc>
  2005. </method>
  2006. <method name="setContainerReport"
  2007. abstract="true" native="false" synchronized="false"
  2008. static="false" final="false" visibility="public"
  2009. deprecated="not deprecated">
  2010. <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
  2011. </method>
  2012. <doc>
  2013. <![CDATA[<p>
  2014. The response sent by the <code>ResourceManager</code> to a client requesting
  2015. a container report.
  2016. </p>
  2017. <p>
  2018. The response includes a {@link ContainerReport} which has details of a
  2019. container.
  2020. </p>]]>
  2021. </doc>
  2022. </class>
  2023. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
  2024. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
  2025. <class name="GetContainersRequest" extends="java.lang.Object"
  2026. abstract="true"
  2027. static="false" final="false" visibility="public"
  2028. deprecated="not deprecated">
  2029. <constructor name="GetContainersRequest"
  2030. static="false" final="false" visibility="public"
  2031. deprecated="not deprecated">
  2032. </constructor>
  2033. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"
  2034. abstract="false" native="false" synchronized="false"
  2035. static="true" final="false" visibility="public"
  2036. deprecated="not deprecated">
  2037. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2038. </method>
  2039. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2040. abstract="true" native="false" synchronized="false"
  2041. static="false" final="false" visibility="public"
  2042. deprecated="not deprecated">
  2043. <doc>
  2044. <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
  2045. @return <code>ApplicationAttemptId</code> of an application attempt]]>
  2046. </doc>
  2047. </method>
  2048. <method name="setApplicationAttemptId"
  2049. abstract="true" native="false" synchronized="false"
  2050. static="false" final="false" visibility="public"
  2051. deprecated="not deprecated">
  2052. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2053. <doc>
  2054. <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
  2055. @param applicationAttemptId
  2056. <code>ApplicationAttemptId</code> of an application attempt]]>
  2057. </doc>
  2058. </method>
  2059. <doc>
  2060. <![CDATA[<p>
  2061. The request from clients to get a list of container reports, which belong to
  2062. an application attempt from the <code>ResourceManager</code>.
  2063. </p>
  2064. @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
  2065. </doc>
  2066. </class>
  2067. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
  2068. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
  2069. <class name="GetContainersResponse" extends="java.lang.Object"
  2070. abstract="true"
  2071. static="false" final="false" visibility="public"
  2072. deprecated="not deprecated">
  2073. <constructor name="GetContainersResponse"
  2074. static="false" final="false" visibility="public"
  2075. deprecated="not deprecated">
  2076. </constructor>
  2077. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
  2078. abstract="false" native="false" synchronized="false"
  2079. static="true" final="false" visibility="public"
  2080. deprecated="not deprecated">
  2081. <param name="containers" type="java.util.List"/>
  2082. </method>
  2083. <method name="getContainerList" return="java.util.List"
  2084. abstract="true" native="false" synchronized="false"
  2085. static="false" final="false" visibility="public"
  2086. deprecated="not deprecated">
  2087. <doc>
  2088. <![CDATA[Get a list of <code>ContainerReport</code> for all the containers of an
  2089. application attempt.
  2090. @return a list of <code>ContainerReport</code> for all the containers of an
  2091. application attempt]]>
  2092. </doc>
  2093. </method>
  2094. <method name="setContainerList"
  2095. abstract="true" native="false" synchronized="false"
  2096. static="false" final="false" visibility="public"
  2097. deprecated="not deprecated">
  2098. <param name="containers" type="java.util.List"/>
  2099. <doc>
  2100. <![CDATA[Set a list of <code>ContainerReport</code> for all the containers of an
  2101. application attempt.
  2102. @param containers
  2103. a list of <code>ContainerReport</code> for all the containers of
  2104. an application attempt]]>
  2105. </doc>
  2106. </method>
  2107. <doc>
  2108. <![CDATA[<p>
  2109. The response sent by the <code>ResourceManager</code> to a client requesting
  2110. a list of {@link ContainerReport} for containers.
  2111. </p>
  2112. <p>
  2113. The <code>ContainerReport</code> for each container includes the container
  2114. details.
  2115. </p>
  2116. @see ContainerReport
  2117. @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
  2118. </doc>
  2119. </class>
  2120. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
  2121. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
  2122. <class name="GetContainerStatusesRequest" extends="java.lang.Object"
  2123. abstract="true"
  2124. static="false" final="false" visibility="public"
  2125. deprecated="not deprecated">
  2126. <constructor name="GetContainerStatusesRequest"
  2127. static="false" final="false" visibility="public"
  2128. deprecated="not deprecated">
  2129. </constructor>
  2130. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"
  2131. abstract="false" native="false" synchronized="false"
  2132. static="true" final="false" visibility="public"
  2133. deprecated="not deprecated">
  2134. <param name="containerIds" type="java.util.List"/>
  2135. </method>
  2136. <method name="getContainerIds" return="java.util.List"
  2137. abstract="true" native="false" synchronized="false"
  2138. static="false" final="false" visibility="public"
  2139. deprecated="not deprecated">
  2140. <doc>
  2141. <![CDATA[Get the list of <code>ContainerId</code>s of containers for which to obtain
  2142. the <code>ContainerStatus</code>.
  2143. @return the list of <code>ContainerId</code>s of containers for which to
  2144. obtain the <code>ContainerStatus</code>.]]>
  2145. </doc>
  2146. </method>
  2147. <method name="setContainerIds"
  2148. abstract="true" native="false" synchronized="false"
  2149. static="false" final="false" visibility="public"
  2150. deprecated="not deprecated">
  2151. <param name="containerIds" type="java.util.List"/>
  2152. <doc>
  2153. <![CDATA[Set a list of <code>ContainerId</code>s of containers for which to obtain
  2154. the <code>ContainerStatus</code>
  2155. @param containerIds
  2156. a list of <code>ContainerId</code>s of containers for which to
  2157. obtain the <code>ContainerStatus</code>]]>
  2158. </doc>
  2159. </method>
  2160. <doc>
  2161. <![CDATA[The request sent by the <code>ApplicationMaster</code> to the
  2162. <code>NodeManager</code> to get {@link ContainerStatus} of requested
  2163. containers.
  2164. @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
  2165. </doc>
  2166. </class>
  2167. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
  2168. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
  2169. <class name="GetContainerStatusesResponse" extends="java.lang.Object"
  2170. abstract="true"
  2171. static="false" final="false" visibility="public"
  2172. deprecated="not deprecated">
  2173. <constructor name="GetContainerStatusesResponse"
  2174. static="false" final="false" visibility="public"
  2175. deprecated="not deprecated">
  2176. </constructor>
  2177. <method name="getContainerStatuses" return="java.util.List"
  2178. abstract="true" native="false" synchronized="false"
  2179. static="false" final="false" visibility="public"
  2180. deprecated="not deprecated">
  2181. <doc>
  2182. <![CDATA[Get the <code>ContainerStatus</code>es of the requested containers.
  2183. @return <code>ContainerStatus</code>es of the requested containers.]]>
  2184. </doc>
  2185. </method>
  2186. <method name="getFailedRequests" return="java.util.Map"
  2187. abstract="true" native="false" synchronized="false"
  2188. static="false" final="false" visibility="public"
  2189. deprecated="not deprecated">
  2190. <doc>
  2191. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  2192. from per container for failed requests]]>
  2193. </doc>
  2194. </method>
  2195. <doc>
  2196. <![CDATA[The response sent by the <code>NodeManager</code> to the
  2197. <code>ApplicationMaster</code> when asked to obtain the
  2198. <code>ContainerStatus</code> of requested containers.
  2199. @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
  2200. </doc>
  2201. </class>
  2202. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
  2203. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
  2204. <class name="GetDelegationTokenRequest" extends="java.lang.Object"
  2205. abstract="true"
  2206. static="false" final="false" visibility="public"
  2207. deprecated="not deprecated">
  2208. <constructor name="GetDelegationTokenRequest"
  2209. static="false" final="false" visibility="public"
  2210. deprecated="not deprecated">
  2211. </constructor>
  2212. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"
  2213. abstract="false" native="false" synchronized="false"
  2214. static="true" final="false" visibility="public"
  2215. deprecated="not deprecated">
  2216. <param name="renewer" type="java.lang.String"/>
  2217. </method>
  2218. <method name="getRenewer" return="java.lang.String"
  2219. abstract="true" native="false" synchronized="false"
  2220. static="false" final="false" visibility="public"
  2221. deprecated="not deprecated">
  2222. </method>
  2223. <method name="setRenewer"
  2224. abstract="true" native="false" synchronized="false"
  2225. static="false" final="false" visibility="public"
  2226. deprecated="not deprecated">
  2227. <param name="renewer" type="java.lang.String"/>
  2228. </method>
  2229. <doc>
  2230. <![CDATA[The request issued by the client to get a delegation token from
  2231. the {@code ResourceManager}.
  2232. for more information.]]>
  2233. </doc>
  2234. </class>
  2235. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
  2236. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
  2237. <class name="GetDelegationTokenResponse" extends="java.lang.Object"
  2238. abstract="true"
  2239. static="false" final="false" visibility="public"
  2240. deprecated="not deprecated">
  2241. <constructor name="GetDelegationTokenResponse"
  2242. static="false" final="false" visibility="public"
  2243. deprecated="not deprecated">
  2244. </constructor>
  2245. <method name="getRMDelegationToken" return="org.apache.hadoop.yarn.api.records.Token"
  2246. abstract="true" native="false" synchronized="false"
  2247. static="false" final="false" visibility="public"
  2248. deprecated="not deprecated">
  2249. <doc>
  2250. <![CDATA[The Delegation tokens have a identifier which maps to
  2251. {@link AbstractDelegationTokenIdentifier}.]]>
  2252. </doc>
  2253. </method>
  2254. <doc>
  2255. <![CDATA[Response to a {@link GetDelegationTokenRequest} request
  2256. from the client. The response contains the token that
  2257. can be used by the containers to talk to ClientRMService.]]>
  2258. </doc>
  2259. </class>
  2260. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
  2261. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
  2262. <class name="GetNewApplicationRequest" extends="java.lang.Object"
  2263. abstract="true"
  2264. static="false" final="false" visibility="public"
  2265. deprecated="not deprecated">
  2266. <constructor name="GetNewApplicationRequest"
  2267. static="false" final="false" visibility="public"
  2268. deprecated="not deprecated">
  2269. </constructor>
  2270. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"
  2271. abstract="false" native="false" synchronized="false"
  2272. static="true" final="false" visibility="public"
  2273. deprecated="not deprecated">
  2274. </method>
  2275. <doc>
  2276. <![CDATA[<p>The request sent by clients to get a new {@link ApplicationId} for
  2277. submitting an application.</p>
  2278. <p>Currently, this is empty.</p>
  2279. @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
  2280. </doc>
  2281. </class>
  2282. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
  2283. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
  2284. <class name="GetNewApplicationResponse" extends="java.lang.Object"
  2285. abstract="true"
  2286. static="false" final="false" visibility="public"
  2287. deprecated="not deprecated">
  2288. <constructor name="GetNewApplicationResponse"
  2289. static="false" final="false" visibility="public"
  2290. deprecated="not deprecated">
  2291. </constructor>
  2292. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2293. abstract="true" native="false" synchronized="false"
  2294. static="false" final="false" visibility="public"
  2295. deprecated="not deprecated">
  2296. <doc>
  2297. <![CDATA[Get the <em>new</em> <code>ApplicationId</code> allocated by the
  2298. <code>ResourceManager</code>.
  2299. @return <em>new</em> <code>ApplicationId</code> allocated by the
  2300. <code>ResourceManager</code>]]>
  2301. </doc>
  2302. </method>
  2303. <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  2304. abstract="true" native="false" synchronized="false"
  2305. static="false" final="false" visibility="public"
  2306. deprecated="not deprecated">
  2307. <doc>
  2308. <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
  2309. <code>ResourceManager</code> in the cluster.
  2310. @return maximum capability of allocated resources in the cluster]]>
  2311. </doc>
  2312. </method>
  2313. <doc>
  2314. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client for
  2315. a request to get a new {@link ApplicationId} for submitting applications.</p>
  2316. <p>Clients can submit an application with the returned
  2317. {@link ApplicationId}.</p>
  2318. @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
  2319. </doc>
  2320. </class>
  2321. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
  2322. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
  2323. <class name="GetQueueInfoRequest" extends="java.lang.Object"
  2324. abstract="true"
  2325. static="false" final="false" visibility="public"
  2326. deprecated="not deprecated">
  2327. <constructor name="GetQueueInfoRequest"
  2328. static="false" final="false" visibility="public"
  2329. deprecated="not deprecated">
  2330. </constructor>
  2331. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"
  2332. abstract="false" native="false" synchronized="false"
  2333. static="true" final="false" visibility="public"
  2334. deprecated="not deprecated">
  2335. <param name="queueName" type="java.lang.String"/>
  2336. <param name="includeApplications" type="boolean"/>
  2337. <param name="includeChildQueues" type="boolean"/>
  2338. <param name="recursive" type="boolean"/>
  2339. </method>
  2340. <method name="getQueueName" return="java.lang.String"
  2341. abstract="true" native="false" synchronized="false"
  2342. static="false" final="false" visibility="public"
  2343. deprecated="not deprecated">
  2344. <doc>
  2345. <![CDATA[Get the <em>queue name</em> for which to get queue information.
  2346. @return <em>queue name</em> for which to get queue information]]>
  2347. </doc>
  2348. </method>
  2349. <method name="setQueueName"
  2350. abstract="true" native="false" synchronized="false"
  2351. static="false" final="false" visibility="public"
  2352. deprecated="not deprecated">
  2353. <param name="queueName" type="java.lang.String"/>
  2354. <doc>
  2355. <![CDATA[Set the <em>queue name</em> for which to get queue information
  2356. @param queueName <em>queue name</em> for which to get queue information]]>
  2357. </doc>
  2358. </method>
  2359. <method name="getIncludeApplications" return="boolean"
  2360. abstract="true" native="false" synchronized="false"
  2361. static="false" final="false" visibility="public"
  2362. deprecated="not deprecated">
  2363. <doc>
  2364. <![CDATA[Is information about <em>active applications</em> required?
  2365. @return <code>true</code> if applications' information is to be included,
  2366. else <code>false</code>]]>
  2367. </doc>
  2368. </method>
  2369. <method name="setIncludeApplications"
  2370. abstract="true" native="false" synchronized="false"
  2371. static="false" final="false" visibility="public"
  2372. deprecated="not deprecated">
  2373. <param name="includeApplications" type="boolean"/>
  2374. <doc>
  2375. <![CDATA[Should we get fetch information about <em>active applications</em>?
  2376. @param includeApplications fetch information about <em>active
  2377. applications</em>?]]>
  2378. </doc>
  2379. </method>
  2380. <method name="getIncludeChildQueues" return="boolean"
  2381. abstract="true" native="false" synchronized="false"
  2382. static="false" final="false" visibility="public"
  2383. deprecated="not deprecated">
  2384. <doc>
  2385. <![CDATA[Is information about <em>child queues</em> required?
  2386. @return <code>true</code> if information about child queues is required,
  2387. else <code>false</code>]]>
  2388. </doc>
  2389. </method>
  2390. <method name="setIncludeChildQueues"
  2391. abstract="true" native="false" synchronized="false"
  2392. static="false" final="false" visibility="public"
  2393. deprecated="not deprecated">
  2394. <param name="includeChildQueues" type="boolean"/>
  2395. <doc>
  2396. <![CDATA[Should we fetch information about <em>child queues</em>?
  2397. @param includeChildQueues fetch information about <em>child queues</em>?]]>
  2398. </doc>
  2399. </method>
  2400. <method name="getRecursive" return="boolean"
  2401. abstract="true" native="false" synchronized="false"
  2402. static="false" final="false" visibility="public"
  2403. deprecated="not deprecated">
  2404. <doc>
  2405. <![CDATA[Is information on the entire <em>child queue hierarchy</em> required?
  2406. @return <code>true</code> if information about entire hierarchy is
  2407. required, <code>false</code> otherwise]]>
  2408. </doc>
  2409. </method>
  2410. <method name="setRecursive"
  2411. abstract="true" native="false" synchronized="false"
  2412. static="false" final="false" visibility="public"
  2413. deprecated="not deprecated">
  2414. <param name="recursive" type="boolean"/>
  2415. <doc>
  2416. <![CDATA[Should we fetch information on the entire <em>child queue hierarchy</em>?
  2417. @param recursive fetch information on the entire <em>child queue
  2418. hierarchy</em>?]]>
  2419. </doc>
  2420. </method>
  2421. <doc>
  2422. <![CDATA[<p>The request sent by clients to get <em>queue information</em>
  2423. from the <code>ResourceManager</code>.</p>
  2424. @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
  2425. </doc>
  2426. </class>
  2427. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
  2428. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
  2429. <class name="GetQueueInfoResponse" extends="java.lang.Object"
  2430. abstract="true"
  2431. static="false" final="false" visibility="public"
  2432. deprecated="not deprecated">
  2433. <constructor name="GetQueueInfoResponse"
  2434. static="false" final="false" visibility="public"
  2435. deprecated="not deprecated">
  2436. </constructor>
  2437. <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.records.QueueInfo"
  2438. abstract="true" native="false" synchronized="false"
  2439. static="false" final="false" visibility="public"
  2440. deprecated="not deprecated">
  2441. <doc>
  2442. <![CDATA[Get the <code>QueueInfo</code> for the specified queue.
  2443. @return <code>QueueInfo</code> for the specified queue]]>
  2444. </doc>
  2445. </method>
  2446. <doc>
  2447. <![CDATA[The response sent by the {@code ResourceManager} to a client
  2448. requesting information about queues in the system.
  2449. <p>
  2450. The response includes a {@link QueueInfo} which has details such as
  2451. queue name, used/total capacities, running applications, child queues etc.
  2452. @see QueueInfo
  2453. @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
  2454. </doc>
  2455. </class>
  2456. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
  2457. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
  2458. <class name="GetQueueUserAclsInfoRequest" extends="java.lang.Object"
  2459. abstract="true"
  2460. static="false" final="false" visibility="public"
  2461. deprecated="not deprecated">
  2462. <constructor name="GetQueueUserAclsInfoRequest"
  2463. static="false" final="false" visibility="public"
  2464. deprecated="not deprecated">
  2465. </constructor>
  2466. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"
  2467. abstract="false" native="false" synchronized="false"
  2468. static="true" final="false" visibility="public"
  2469. deprecated="not deprecated">
  2470. </method>
  2471. <doc>
  2472. <![CDATA[<p>The request sent by clients to the <code>ResourceManager</code> to
  2473. get queue acls for the <em>current user</em>.</p>
  2474. <p>Currently, this is empty.</p>
  2475. @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  2476. </doc>
  2477. </class>
  2478. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
  2479. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
  2480. <class name="GetQueueUserAclsInfoResponse" extends="java.lang.Object"
  2481. abstract="true"
  2482. static="false" final="false" visibility="public"
  2483. deprecated="not deprecated">
  2484. <constructor name="GetQueueUserAclsInfoResponse"
  2485. static="false" final="false" visibility="public"
  2486. deprecated="not deprecated">
  2487. </constructor>
  2488. <method name="getUserAclsInfoList" return="java.util.List"
  2489. abstract="true" native="false" synchronized="false"
  2490. static="false" final="false" visibility="public"
  2491. deprecated="not deprecated">
  2492. <doc>
  2493. <![CDATA[Get the <code>QueueUserACLInfo</code> per queue for the user.
  2494. @return <code>QueueUserACLInfo</code> per queue for the user]]>
  2495. </doc>
  2496. </method>
  2497. <doc>
  2498. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to clients
  2499. seeking queue acls for the user.</p>
  2500. <p>The response contains a list of {@link QueueUserACLInfo} which
  2501. provides information about {@link QueueACL} per queue.</p>
  2502. @see QueueACL
  2503. @see QueueUserACLInfo
  2504. @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  2505. </doc>
  2506. </class>
  2507. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
  2508. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
  2509. <class name="KillApplicationRequest" extends="java.lang.Object"
  2510. abstract="true"
  2511. static="false" final="false" visibility="public"
  2512. deprecated="not deprecated">
  2513. <constructor name="KillApplicationRequest"
  2514. static="false" final="false" visibility="public"
  2515. deprecated="not deprecated">
  2516. </constructor>
  2517. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"
  2518. abstract="false" native="false" synchronized="false"
  2519. static="true" final="false" visibility="public"
  2520. deprecated="not deprecated">
  2521. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2522. </method>
  2523. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2524. abstract="true" native="false" synchronized="false"
  2525. static="false" final="false" visibility="public"
  2526. deprecated="not deprecated">
  2527. <doc>
  2528. <![CDATA[Get the <code>ApplicationId</code> of the application to be aborted.
  2529. @return <code>ApplicationId</code> of the application to be aborted]]>
  2530. </doc>
  2531. </method>
  2532. <method name="setApplicationId"
  2533. abstract="true" native="false" synchronized="false"
  2534. static="false" final="false" visibility="public"
  2535. deprecated="not deprecated">
  2536. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2537. </method>
  2538. <doc>
  2539. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  2540. to abort a submitted application.</p>
  2541. <p>The request includes the {@link ApplicationId} of the application to be
  2542. aborted.</p>
  2543. @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
  2544. </doc>
  2545. </class>
  2546. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
  2547. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
  2548. <class name="KillApplicationResponse" extends="java.lang.Object"
  2549. abstract="true"
  2550. static="false" final="false" visibility="public"
  2551. deprecated="not deprecated">
  2552. <constructor name="KillApplicationResponse"
  2553. static="false" final="false" visibility="public"
  2554. deprecated="not deprecated">
  2555. </constructor>
  2556. <method name="getIsKillCompleted" return="boolean"
  2557. abstract="true" native="false" synchronized="false"
  2558. static="false" final="false" visibility="public"
  2559. deprecated="not deprecated">
  2560. <doc>
  2561. <![CDATA[Get the flag which indicates that the process of killing application is completed or not.]]>
  2562. </doc>
  2563. </method>
  2564. <doc>
  2565. <![CDATA[The response sent by the <code>ResourceManager</code> to the client aborting
  2566. a submitted application.
  2567. <p>
  2568. The response, includes:
  2569. <ul>
  2570. <li>
  2571. A flag which indicates that the process of killing the application is
  2572. completed or not.
  2573. </li>
  2574. </ul>
  2575. Note: user is recommended to wait until this flag becomes true, otherwise if
  2576. the <code>ResourceManager</code> crashes before the process of killing the
  2577. application is completed, the <code>ResourceManager</code> may retry this
  2578. application on recovery.
  2579. @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
  2580. </doc>
  2581. </class>
  2582. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
  2583. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
  2584. <class name="MoveApplicationAcrossQueuesRequest" extends="java.lang.Object"
  2585. abstract="true"
  2586. static="false" final="false" visibility="public"
  2587. deprecated="not deprecated">
  2588. <constructor name="MoveApplicationAcrossQueuesRequest"
  2589. static="false" final="false" visibility="public"
  2590. deprecated="not deprecated">
  2591. </constructor>
  2592. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"
  2593. abstract="false" native="false" synchronized="false"
  2594. static="true" final="false" visibility="public"
  2595. deprecated="not deprecated">
  2596. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2597. <param name="queue" type="java.lang.String"/>
  2598. </method>
  2599. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2600. abstract="true" native="false" synchronized="false"
  2601. static="false" final="false" visibility="public"
  2602. deprecated="not deprecated">
  2603. <doc>
  2604. <![CDATA[Get the <code>ApplicationId</code> of the application to be moved.
  2605. @return <code>ApplicationId</code> of the application to be moved]]>
  2606. </doc>
  2607. </method>
  2608. <method name="setApplicationId"
  2609. abstract="true" native="false" synchronized="false"
  2610. static="false" final="false" visibility="public"
  2611. deprecated="not deprecated">
  2612. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2613. <doc>
  2614. <![CDATA[Set the <code>ApplicationId</code> of the application to be moved.
  2615. @param appId <code>ApplicationId</code> of the application to be moved]]>
  2616. </doc>
  2617. </method>
  2618. <method name="getTargetQueue" return="java.lang.String"
  2619. abstract="true" native="false" synchronized="false"
  2620. static="false" final="false" visibility="public"
  2621. deprecated="not deprecated">
  2622. <doc>
  2623. <![CDATA[Get the queue to place the application in.
  2624. @return the name of the queue to place the application in]]>
  2625. </doc>
  2626. </method>
  2627. <method name="setTargetQueue"
  2628. abstract="true" native="false" synchronized="false"
  2629. static="false" final="false" visibility="public"
  2630. deprecated="not deprecated">
  2631. <param name="queue" type="java.lang.String"/>
  2632. <doc>
  2633. <![CDATA[Get the queue to place the application in.
  2634. @param queue the name of the queue to place the application in]]>
  2635. </doc>
  2636. </method>
  2637. <doc>
  2638. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  2639. to move a submitted application to a different queue.</p>
  2640. <p>The request includes the {@link ApplicationId} of the application to be
  2641. moved and the queue to place it in.</p>
  2642. @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
  2643. </doc>
  2644. </class>
  2645. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
  2646. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
  2647. <class name="MoveApplicationAcrossQueuesResponse" extends="java.lang.Object"
  2648. abstract="false"
  2649. static="false" final="false" visibility="public"
  2650. deprecated="not deprecated">
  2651. <constructor name="MoveApplicationAcrossQueuesResponse"
  2652. static="false" final="false" visibility="public"
  2653. deprecated="not deprecated">
  2654. </constructor>
  2655. <doc>
  2656. <![CDATA[<p>
  2657. The response sent by the <code>ResourceManager</code> to the client moving
  2658. a submitted application to a different queue.
  2659. </p>
  2660. <p>
  2661. A response without exception means that the move has completed successfully.
  2662. </p>
  2663. @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
  2664. </doc>
  2665. </class>
  2666. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
  2667. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
  2668. <class name="RegisterApplicationMasterRequest" extends="java.lang.Object"
  2669. abstract="true"
  2670. static="false" final="false" visibility="public"
  2671. deprecated="not deprecated">
  2672. <constructor name="RegisterApplicationMasterRequest"
  2673. static="false" final="false" visibility="public"
  2674. deprecated="not deprecated">
  2675. </constructor>
  2676. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"
  2677. abstract="false" native="false" synchronized="false"
  2678. static="true" final="false" visibility="public"
  2679. deprecated="not deprecated">
  2680. <param name="host" type="java.lang.String"/>
  2681. <param name="port" type="int"/>
  2682. <param name="trackingUrl" type="java.lang.String"/>
  2683. <doc>
  2684. <![CDATA[Create a new instance of <code>RegisterApplicationMasterRequest</code>.
  2685. If <em>port, trackingUrl</em> is not used, use the following default value:
  2686. <ul>
  2687. <li>port: -1</li>
  2688. <li>trackingUrl: null</li>
  2689. </ul>
  2690. The port is allowed to be any integer larger than or equal to -1.
  2691. @return the new instance of <code>RegisterApplicationMasterRequest</code>]]>
  2692. </doc>
  2693. </method>
  2694. <method name="getHost" return="java.lang.String"
  2695. abstract="true" native="false" synchronized="false"
  2696. static="false" final="false" visibility="public"
  2697. deprecated="not deprecated">
  2698. <doc>
  2699. <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code> is
  2700. running.
  2701. @return <em>host</em> on which the <code>ApplicationMaster</code> is running]]>
  2702. </doc>
  2703. </method>
  2704. <method name="setHost"
  2705. abstract="true" native="false" synchronized="false"
  2706. static="false" final="false" visibility="public"
  2707. deprecated="not deprecated">
  2708. <param name="host" type="java.lang.String"/>
  2709. <doc>
  2710. <![CDATA[Set the <em>host</em> on which the <code>ApplicationMaster</code> is
  2711. running.
  2712. @param host <em>host</em> on which the <code>ApplicationMaster</code>
  2713. is running]]>
  2714. </doc>
  2715. </method>
  2716. <method name="getRpcPort" return="int"
  2717. abstract="true" native="false" synchronized="false"
  2718. static="false" final="false" visibility="public"
  2719. deprecated="not deprecated">
  2720. <doc>
  2721. <![CDATA[Get the <em>RPC port</em> on which the {@code ApplicationMaster} is
  2722. responding.
  2723. @return the <em>RPC port</em> on which the {@code ApplicationMaster}
  2724. is responding]]>
  2725. </doc>
  2726. </method>
  2727. <method name="setRpcPort"
  2728. abstract="true" native="false" synchronized="false"
  2729. static="false" final="false" visibility="public"
  2730. deprecated="not deprecated">
  2731. <param name="port" type="int"/>
  2732. <doc>
  2733. <![CDATA[Set the <em>RPC port</em> on which the {@code ApplicationMaster} is
  2734. responding.
  2735. @param port <em>RPC port</em> on which the {@code ApplicationMaster}
  2736. is responding]]>
  2737. </doc>
  2738. </method>
  2739. <method name="getTrackingUrl" return="java.lang.String"
  2740. abstract="true" native="false" synchronized="false"
  2741. static="false" final="false" visibility="public"
  2742. deprecated="not deprecated">
  2743. <doc>
  2744. <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
  2745. This url if contains scheme then that will be used by resource manager
  2746. web application proxy otherwise it will default to http.
  2747. @return <em>tracking URL</em> for the <code>ApplicationMaster</code>]]>
  2748. </doc>
  2749. </method>
  2750. <method name="setTrackingUrl"
  2751. abstract="true" native="false" synchronized="false"
  2752. static="false" final="false" visibility="public"
  2753. deprecated="not deprecated">
  2754. <param name="trackingUrl" type="java.lang.String"/>
  2755. <doc>
  2756. <![CDATA[Set the <em>tracking URL</em>for the <code>ApplicationMaster</code> while
  2757. it is running. This is the web-URL to which ResourceManager or
  2758. web-application proxy will redirect client/users while the application and
  2759. the <code>ApplicationMaster</code> are still running.
  2760. <p>
  2761. If the passed url has a scheme then that will be used by the
  2762. ResourceManager and web-application proxy, otherwise the scheme will
  2763. default to http.
  2764. </p>
  2765. <p>
  2766. Empty, null, "N/A" strings are all valid besides a real URL. In case an url
  2767. isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
  2768. <p>
  2769. @param trackingUrl
  2770. <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  2771. </doc>
  2772. </method>
  2773. <doc>
  2774. <![CDATA[The request sent by the {@code ApplicationMaster} to {@code ResourceManager}
  2775. on registration.
  2776. <p>
  2777. The registration includes details such as:
  2778. <ul>
  2779. <li>Hostname on which the AM is running.</li>
  2780. <li>RPC Port</li>
  2781. <li>Tracking URL</li>
  2782. </ul>
  2783. @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
  2784. </doc>
  2785. </class>
  2786. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
  2787. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
  2788. <class name="RegisterApplicationMasterResponse" extends="java.lang.Object"
  2789. abstract="true"
  2790. static="false" final="false" visibility="public"
  2791. deprecated="not deprecated">
  2792. <constructor name="RegisterApplicationMasterResponse"
  2793. static="false" final="false" visibility="public"
  2794. deprecated="not deprecated">
  2795. </constructor>
  2796. <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  2797. abstract="true" native="false" synchronized="false"
  2798. static="false" final="false" visibility="public"
  2799. deprecated="not deprecated">
  2800. <doc>
  2801. <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
  2802. <code>ResourceManager</code> in the cluster.
  2803. @return maximum capability of allocated resources in the cluster]]>
  2804. </doc>
  2805. </method>
  2806. <method name="getApplicationACLs" return="java.util.Map"
  2807. abstract="true" native="false" synchronized="false"
  2808. static="false" final="false" visibility="public"
  2809. deprecated="not deprecated">
  2810. <doc>
  2811. <![CDATA[Get the <code>ApplicationACL</code>s for the application.
  2812. @return all the <code>ApplicationACL</code>s]]>
  2813. </doc>
  2814. </method>
  2815. <method name="getClientToAMTokenMasterKey" return="java.nio.ByteBuffer"
  2816. abstract="true" native="false" synchronized="false"
  2817. static="false" final="false" visibility="public"
  2818. deprecated="not deprecated">
  2819. <doc>
  2820. <![CDATA[<p>Get ClientToAMToken master key.</p>
  2821. <p>The ClientToAMToken master key is sent to <code>ApplicationMaster</code>
  2822. by <code>ResourceManager</code> via {@link RegisterApplicationMasterResponse}
  2823. , used to verify corresponding ClientToAMToken.</p>]]>
  2824. </doc>
  2825. </method>
  2826. <method name="setClientToAMTokenMasterKey"
  2827. abstract="true" native="false" synchronized="false"
  2828. static="false" final="false" visibility="public"
  2829. deprecated="not deprecated">
  2830. <param name="key" type="java.nio.ByteBuffer"/>
  2831. <doc>
  2832. <![CDATA[Set ClientToAMToken master key.]]>
  2833. </doc>
  2834. </method>
  2835. <method name="getQueue" return="java.lang.String"
  2836. abstract="true" native="false" synchronized="false"
  2837. static="false" final="false" visibility="public"
  2838. deprecated="not deprecated">
  2839. <doc>
  2840. <![CDATA[<p>Get the queue that the application was placed in.<p>]]>
  2841. </doc>
  2842. </method>
  2843. <method name="setQueue"
  2844. abstract="true" native="false" synchronized="false"
  2845. static="false" final="false" visibility="public"
  2846. deprecated="not deprecated">
  2847. <param name="queue" type="java.lang.String"/>
  2848. <doc>
  2849. <![CDATA[<p>Set the queue that the application was placed in.<p>]]>
  2850. </doc>
  2851. </method>
  2852. <method name="getContainersFromPreviousAttempts" return="java.util.List"
  2853. abstract="true" native="false" synchronized="false"
  2854. static="false" final="false" visibility="public"
  2855. deprecated="not deprecated">
  2856. <doc>
  2857. <![CDATA[<p>
  2858. Get the list of running containers as viewed by
  2859. <code>ResourceManager</code> from previous application attempts.
  2860. </p>
  2861. @return the list of running containers as viewed by
  2862. <code>ResourceManager</code> from previous application attempts
  2863. @see RegisterApplicationMasterResponse#getNMTokensFromPreviousAttempts()]]>
  2864. </doc>
  2865. </method>
  2866. <method name="getNMTokensFromPreviousAttempts" return="java.util.List"
  2867. abstract="true" native="false" synchronized="false"
  2868. static="false" final="false" visibility="public"
  2869. deprecated="not deprecated">
  2870. <doc>
  2871. <![CDATA[Get the list of NMTokens for communicating with the NMs where the
  2872. containers of previous application attempts are running.
  2873. @return the list of NMTokens for communicating with the NMs where the
  2874. containers of previous application attempts are running.
  2875. @see RegisterApplicationMasterResponse#getContainersFromPreviousAttempts()]]>
  2876. </doc>
  2877. </method>
  2878. <method name="getSchedulerResourceTypes" return="java.util.EnumSet"
  2879. abstract="true" native="false" synchronized="false"
  2880. static="false" final="false" visibility="public"
  2881. deprecated="not deprecated">
  2882. <doc>
  2883. <![CDATA[Get a set of the resource types considered by the scheduler.
  2884. @return a Map of RM settings]]>
  2885. </doc>
  2886. </method>
  2887. <doc>
  2888. <![CDATA[The response sent by the {@code ResourceManager} to a new
  2889. {@code ApplicationMaster} on registration.
  2890. <p>
  2891. The response contains critical details such as:
  2892. <ul>
  2893. <li>Maximum capability for allocated resources in the cluster.</li>
  2894. <li>{@code ApplicationACL}s for the application.</li>
  2895. <li>ClientToAMToken master key.</li>
  2896. </ul>
  2897. @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
  2898. </doc>
  2899. </class>
  2900. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
  2901. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
  2902. <class name="ReleaseSharedCacheResourceRequest" extends="java.lang.Object"
  2903. abstract="true"
  2904. static="false" final="false" visibility="public"
  2905. deprecated="not deprecated">
  2906. <constructor name="ReleaseSharedCacheResourceRequest"
  2907. static="false" final="false" visibility="public"
  2908. deprecated="not deprecated">
  2909. </constructor>
  2910. <method name="getAppId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2911. abstract="true" native="false" synchronized="false"
  2912. static="false" final="false" visibility="public"
  2913. deprecated="not deprecated">
  2914. <doc>
  2915. <![CDATA[Get the <code>ApplicationId</code> of the resource to be released.
  2916. @return <code>ApplicationId</code>]]>
  2917. </doc>
  2918. </method>
  2919. <method name="setAppId"
  2920. abstract="true" native="false" synchronized="false"
  2921. static="false" final="false" visibility="public"
  2922. deprecated="not deprecated">
  2923. <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2924. <doc>
  2925. <![CDATA[Set the <code>ApplicationId</code> of the resource to be released.
  2926. @param id <code>ApplicationId</code>]]>
  2927. </doc>
  2928. </method>
  2929. <method name="getResourceKey" return="java.lang.String"
  2930. abstract="true" native="false" synchronized="false"
  2931. static="false" final="false" visibility="public"
  2932. deprecated="not deprecated">
  2933. <doc>
  2934. <![CDATA[Get the <code>key</code> of the resource to be released.
  2935. @return <code>key</code>]]>
  2936. </doc>
  2937. </method>
  2938. <method name="setResourceKey"
  2939. abstract="true" native="false" synchronized="false"
  2940. static="false" final="false" visibility="public"
  2941. deprecated="not deprecated">
  2942. <param name="key" type="java.lang.String"/>
  2943. <doc>
  2944. <![CDATA[Set the <code>key</code> of the resource to be released.
  2945. @param key unique identifier for the resource]]>
  2946. </doc>
  2947. </method>
  2948. <doc>
  2949. <![CDATA[<p>The request from clients to release a resource in the shared cache.</p>]]>
  2950. </doc>
  2951. </class>
  2952. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
  2953. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
  2954. <class name="ReleaseSharedCacheResourceResponse" extends="java.lang.Object"
  2955. abstract="true"
  2956. static="false" final="false" visibility="public"
  2957. deprecated="not deprecated">
  2958. <constructor name="ReleaseSharedCacheResourceResponse"
  2959. static="false" final="false" visibility="public"
  2960. deprecated="not deprecated">
  2961. </constructor>
  2962. <doc>
  2963. <![CDATA[<p>
  2964. The response to clients from the <code>SharedCacheManager</code> when
  2965. releasing a resource in the shared cache.
  2966. </p>
  2967. <p>
  2968. Currently, this is empty.
  2969. </p>]]>
  2970. </doc>
  2971. </class>
  2972. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
  2973. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
  2974. <class name="ReservationDeleteRequest" extends="java.lang.Object"
  2975. abstract="true"
  2976. static="false" final="false" visibility="public"
  2977. deprecated="not deprecated">
  2978. <constructor name="ReservationDeleteRequest"
  2979. static="false" final="false" visibility="public"
  2980. deprecated="not deprecated">
  2981. </constructor>
  2982. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"
  2983. abstract="false" native="false" synchronized="false"
  2984. static="true" final="false" visibility="public"
  2985. deprecated="not deprecated">
  2986. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  2987. </method>
  2988. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  2989. abstract="true" native="false" synchronized="false"
  2990. static="false" final="false" visibility="public"
  2991. deprecated="not deprecated">
  2992. <doc>
  2993. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  2994. allocation in the scheduler (between start and end time of this
  2995. reservation)
  2996. @return the {@link ReservationId} representing the unique id of the
  2997. corresponding reserved resource allocation in the scheduler]]>
  2998. </doc>
  2999. </method>
  3000. <method name="setReservationId"
  3001. abstract="true" native="false" synchronized="false"
  3002. static="false" final="false" visibility="public"
  3003. deprecated="not deprecated">
  3004. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3005. <doc>
  3006. <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
  3007. allocation in the scheduler (between start and end time of this
  3008. reservation)
  3009. @param reservationId the {@link ReservationId} representing the the unique
  3010. id of the corresponding reserved resource allocation in the
  3011. scheduler]]>
  3012. </doc>
  3013. </method>
  3014. <doc>
  3015. <![CDATA[{@link ReservationDeleteRequest} captures the set of requirements the user
  3016. has to delete an existing reservation.
  3017. @see ReservationDefinition]]>
  3018. </doc>
  3019. </class>
  3020. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
  3021. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
  3022. <class name="ReservationDeleteResponse" extends="java.lang.Object"
  3023. abstract="true"
  3024. static="false" final="false" visibility="public"
  3025. deprecated="not deprecated">
  3026. <constructor name="ReservationDeleteResponse"
  3027. static="false" final="false" visibility="public"
  3028. deprecated="not deprecated">
  3029. </constructor>
  3030. <doc>
  3031. <![CDATA[{@link ReservationDeleteResponse} contains the answer of the admission
  3032. control system in the {@code ResourceManager} to a reservation delete
  3033. operation. Currently response is empty if the operation was successful, if
  3034. not an exception reporting reason for a failure.
  3035. @see ReservationDefinition]]>
  3036. </doc>
  3037. </class>
  3038. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
  3039. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
  3040. <class name="ReservationSubmissionRequest" extends="java.lang.Object"
  3041. abstract="true"
  3042. static="false" final="false" visibility="public"
  3043. deprecated="not deprecated">
  3044. <constructor name="ReservationSubmissionRequest"
  3045. static="false" final="false" visibility="public"
  3046. deprecated="not deprecated">
  3047. </constructor>
  3048. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"
  3049. abstract="false" native="false" synchronized="false"
  3050. static="true" final="false" visibility="public"
  3051. deprecated="not deprecated">
  3052. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3053. <param name="queueName" type="java.lang.String"/>
  3054. </method>
  3055. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  3056. abstract="true" native="false" synchronized="false"
  3057. static="false" final="false" visibility="public"
  3058. deprecated="not deprecated">
  3059. <doc>
  3060. <![CDATA[Get the {@link ReservationDefinition} representing the user constraints for
  3061. this reservation
  3062. @return the reservation definition representing user constraints]]>
  3063. </doc>
  3064. </method>
  3065. <method name="setReservationDefinition"
  3066. abstract="true" native="false" synchronized="false"
  3067. static="false" final="false" visibility="public"
  3068. deprecated="not deprecated">
  3069. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3070. <doc>
  3071. <![CDATA[Set the {@link ReservationDefinition} representing the user constraints for
  3072. this reservation
  3073. @param reservationDefinition the reservation request representing the
  3074. reservation]]>
  3075. </doc>
  3076. </method>
  3077. <method name="getQueue" return="java.lang.String"
  3078. abstract="true" native="false" synchronized="false"
  3079. static="false" final="false" visibility="public"
  3080. deprecated="not deprecated">
  3081. <doc>
  3082. <![CDATA[Get the name of the {@code Plan} that corresponds to the name of the
  3083. {@link QueueInfo} in the scheduler to which the reservation will be
  3084. submitted to.
  3085. @return the name of the {@code Plan} that corresponds to the name of the
  3086. {@link QueueInfo} in the scheduler to which the reservation will be
  3087. submitted to]]>
  3088. </doc>
  3089. </method>
  3090. <method name="setQueue"
  3091. abstract="true" native="false" synchronized="false"
  3092. static="false" final="false" visibility="public"
  3093. deprecated="not deprecated">
  3094. <param name="queueName" type="java.lang.String"/>
  3095. <doc>
  3096. <![CDATA[Set the name of the {@code Plan} that corresponds to the name of the
  3097. {@link QueueInfo} in the scheduler to which the reservation will be
  3098. submitted to
  3099. @param queueName the name of the parent {@code Plan} that corresponds to
  3100. the name of the {@link QueueInfo} in the scheduler to which the
  3101. reservation will be submitted to]]>
  3102. </doc>
  3103. </method>
  3104. <doc>
  3105. <![CDATA[{@link ReservationSubmissionRequest} captures the set of requirements the
  3106. user has to create a reservation.
  3107. @see ReservationDefinition]]>
  3108. </doc>
  3109. </class>
  3110. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
  3111. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
  3112. <class name="ReservationSubmissionResponse" extends="java.lang.Object"
  3113. abstract="true"
  3114. static="false" final="false" visibility="public"
  3115. deprecated="not deprecated">
  3116. <constructor name="ReservationSubmissionResponse"
  3117. static="false" final="false" visibility="public"
  3118. deprecated="not deprecated">
  3119. </constructor>
  3120. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  3121. abstract="true" native="false" synchronized="false"
  3122. static="false" final="false" visibility="public"
  3123. deprecated="not deprecated">
  3124. <doc>
  3125. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  3126. allocation in the scheduler (between start and end time of this
  3127. reservation)
  3128. @return the {@link ReservationId} representing the unique id of the
  3129. corresponding reserved resource allocation in the scheduler]]>
  3130. </doc>
  3131. </method>
  3132. <doc>
  3133. <![CDATA[{@link ReservationSubmissionResponse} contains the answer of the admission
  3134. control system in the {@code ResourceManager} to a reservation create
  3135. operation. Response contains a {@link ReservationId} if the operation was
  3136. successful, if not an exception reporting reason for a failure.
  3137. @see ReservationDefinition]]>
  3138. </doc>
  3139. </class>
  3140. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
  3141. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
  3142. <class name="ReservationUpdateRequest" extends="java.lang.Object"
  3143. abstract="true"
  3144. static="false" final="false" visibility="public"
  3145. deprecated="not deprecated">
  3146. <constructor name="ReservationUpdateRequest"
  3147. static="false" final="false" visibility="public"
  3148. deprecated="not deprecated">
  3149. </constructor>
  3150. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"
  3151. abstract="false" native="false" synchronized="false"
  3152. static="true" final="false" visibility="public"
  3153. deprecated="not deprecated">
  3154. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3155. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3156. </method>
  3157. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  3158. abstract="true" native="false" synchronized="false"
  3159. static="false" final="false" visibility="public"
  3160. deprecated="not deprecated">
  3161. <doc>
  3162. <![CDATA[Get the {@link ReservationDefinition} representing the updated user
  3163. constraints for this reservation
  3164. @return the reservation definition representing user constraints]]>
  3165. </doc>
  3166. </method>
  3167. <method name="setReservationDefinition"
  3168. abstract="true" native="false" synchronized="false"
  3169. static="false" final="false" visibility="public"
  3170. deprecated="not deprecated">
  3171. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3172. <doc>
  3173. <![CDATA[Set the {@link ReservationDefinition} representing the updated user
  3174. constraints for this reservation
  3175. @param reservationDefinition the reservation request representing the
  3176. reservation]]>
  3177. </doc>
  3178. </method>
  3179. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  3180. abstract="true" native="false" synchronized="false"
  3181. static="false" final="false" visibility="public"
  3182. deprecated="not deprecated">
  3183. <doc>
  3184. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  3185. allocation in the scheduler (between start and end time of this
  3186. reservation)
  3187. @return the {@link ReservationId} representing the unique id of the
  3188. corresponding reserved resource allocation in the scheduler]]>
  3189. </doc>
  3190. </method>
  3191. <method name="setReservationId"
  3192. abstract="true" native="false" synchronized="false"
  3193. static="false" final="false" visibility="public"
  3194. deprecated="not deprecated">
  3195. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3196. <doc>
  3197. <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
  3198. allocation in the scheduler (between start and end time of this
  3199. reservation)
  3200. @param reservationId the {@link ReservationId} representing the the unique
  3201. id of the corresponding reserved resource allocation in the
  3202. scheduler]]>
  3203. </doc>
  3204. </method>
  3205. <doc>
  3206. <![CDATA[{@link ReservationUpdateRequest} captures the set of requirements the user
  3207. has to update an existing reservation.
  3208. @see ReservationDefinition]]>
  3209. </doc>
  3210. </class>
  3211. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
  3212. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
  3213. <class name="ReservationUpdateResponse" extends="java.lang.Object"
  3214. abstract="true"
  3215. static="false" final="false" visibility="public"
  3216. deprecated="not deprecated">
  3217. <constructor name="ReservationUpdateResponse"
  3218. static="false" final="false" visibility="public"
  3219. deprecated="not deprecated">
  3220. </constructor>
  3221. <doc>
  3222. <![CDATA[{@link ReservationUpdateResponse} contains the answer of the admission
  3223. control system in the {@code ResourceManager} to a reservation update
  3224. operation. Currently response is empty if the operation was successful, if
  3225. not an exception reporting reason for a failure.
  3226. @see ReservationDefinition]]>
  3227. </doc>
  3228. </class>
  3229. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
  3230. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
  3231. <class name="StartContainerRequest" extends="java.lang.Object"
  3232. abstract="true"
  3233. static="false" final="false" visibility="public"
  3234. deprecated="not deprecated">
  3235. <constructor name="StartContainerRequest"
  3236. static="false" final="false" visibility="public"
  3237. deprecated="not deprecated">
  3238. </constructor>
  3239. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest"
  3240. abstract="false" native="false" synchronized="false"
  3241. static="true" final="false" visibility="public"
  3242. deprecated="not deprecated">
  3243. <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  3244. <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
  3245. </method>
  3246. <method name="getContainerLaunchContext" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  3247. abstract="true" native="false" synchronized="false"
  3248. static="false" final="false" visibility="public"
  3249. deprecated="not deprecated">
  3250. <doc>
  3251. <![CDATA[Get the <code>ContainerLaunchContext</code> for the container to be started
  3252. by the <code>NodeManager</code>.
  3253. @return <code>ContainerLaunchContext</code> for the container to be started
  3254. by the <code>NodeManager</code>]]>
  3255. </doc>
  3256. </method>
  3257. <method name="setContainerLaunchContext"
  3258. abstract="true" native="false" synchronized="false"
  3259. static="false" final="false" visibility="public"
  3260. deprecated="not deprecated">
  3261. <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  3262. <doc>
  3263. <![CDATA[Set the <code>ContainerLaunchContext</code> for the container to be started
  3264. by the <code>NodeManager</code>
  3265. @param context <code>ContainerLaunchContext</code> for the container to be
  3266. started by the <code>NodeManager</code>]]>
  3267. </doc>
  3268. </method>
  3269. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  3270. abstract="true" native="false" synchronized="false"
  3271. static="false" final="false" visibility="public"
  3272. deprecated="not deprecated">
  3273. <doc>
  3274. <![CDATA[Get the container token to be used for authorization during starting
  3275. container.
  3276. <p>
  3277. Note: {@link NMToken} will be used for authenticating communication with
  3278. {@code NodeManager}.
  3279. @return the container token to be used for authorization during starting
  3280. container.
  3281. @see NMToken
  3282. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3283. </doc>
  3284. </method>
  3285. <method name="setContainerToken"
  3286. abstract="true" native="false" synchronized="false"
  3287. static="false" final="false" visibility="public"
  3288. deprecated="not deprecated">
  3289. <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
  3290. </method>
  3291. <doc>
  3292. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
  3293. <code>NodeManager</code> to <em>start</em> a container.</p>
  3294. <p>The <code>ApplicationMaster</code> has to provide details such as
  3295. allocated resource capability, security tokens (if enabled), command
  3296. to be executed to start the container, environment for the process,
  3297. necessary binaries/jar/shared-objects etc. via the
  3298. {@link ContainerLaunchContext}.</p>
  3299. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3300. </doc>
  3301. </class>
  3302. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
  3303. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
  3304. <class name="StartContainersRequest" extends="java.lang.Object"
  3305. abstract="true"
  3306. static="false" final="false" visibility="public"
  3307. deprecated="not deprecated">
  3308. <constructor name="StartContainersRequest"
  3309. static="false" final="false" visibility="public"
  3310. deprecated="not deprecated">
  3311. </constructor>
  3312. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"
  3313. abstract="false" native="false" synchronized="false"
  3314. static="true" final="false" visibility="public"
  3315. deprecated="not deprecated">
  3316. <param name="requests" type="java.util.List"/>
  3317. </method>
  3318. <method name="getStartContainerRequests" return="java.util.List"
  3319. abstract="true" native="false" synchronized="false"
  3320. static="false" final="false" visibility="public"
  3321. deprecated="not deprecated">
  3322. <doc>
  3323. <![CDATA[Get a list of {@link StartContainerRequest} to start containers.
  3324. @return a list of {@link StartContainerRequest} to start containers.]]>
  3325. </doc>
  3326. </method>
  3327. <method name="setStartContainerRequests"
  3328. abstract="true" native="false" synchronized="false"
  3329. static="false" final="false" visibility="public"
  3330. deprecated="not deprecated">
  3331. <param name="request" type="java.util.List"/>
  3332. <doc>
  3333. <![CDATA[Set a list of {@link StartContainerRequest} to start containers.
  3334. @param request a list of {@link StartContainerRequest} to start containers]]>
  3335. </doc>
  3336. </method>
  3337. <doc>
  3338. <![CDATA[<p>
  3339. The request which contains a list of {@link StartContainerRequest} sent by
  3340. the <code>ApplicationMaster</code> to the <code>NodeManager</code> to
  3341. <em>start</em> containers.
  3342. </p>
  3343. <p>
  3344. In each {@link StartContainerRequest}, the <code>ApplicationMaster</code> has
  3345. to provide details such as allocated resource capability, security tokens (if
  3346. enabled), command to be executed to start the container, environment for the
  3347. process, necessary binaries/jar/shared-objects etc. via the
  3348. {@link ContainerLaunchContext}.
  3349. </p>
  3350. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3351. </doc>
  3352. </class>
  3353. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
  3354. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
  3355. <class name="StartContainersResponse" extends="java.lang.Object"
  3356. abstract="true"
  3357. static="false" final="false" visibility="public"
  3358. deprecated="not deprecated">
  3359. <constructor name="StartContainersResponse"
  3360. static="false" final="false" visibility="public"
  3361. deprecated="not deprecated">
  3362. </constructor>
  3363. <method name="getSuccessfullyStartedContainers" return="java.util.List"
  3364. abstract="true" native="false" synchronized="false"
  3365. static="false" final="false" visibility="public"
  3366. deprecated="not deprecated">
  3367. <doc>
  3368. <![CDATA[Get the list of <code>ContainerId</code> s of the containers that are
  3369. started successfully.
  3370. @return the list of <code>ContainerId</code> s of the containers that are
  3371. started successfully.
  3372. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3373. </doc>
  3374. </method>
  3375. <method name="getFailedRequests" return="java.util.Map"
  3376. abstract="true" native="false" synchronized="false"
  3377. static="false" final="false" visibility="public"
  3378. deprecated="not deprecated">
  3379. <doc>
  3380. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  3381. from per container for failed requests]]>
  3382. </doc>
  3383. </method>
  3384. <method name="getAllServicesMetaData" return="java.util.Map"
  3385. abstract="true" native="false" synchronized="false"
  3386. static="false" final="false" visibility="public"
  3387. deprecated="not deprecated">
  3388. <doc>
  3389. <![CDATA[<p>
  3390. Get the meta-data from all auxiliary services running on the
  3391. <code>NodeManager</code>.
  3392. </p>
  3393. <p>
  3394. The meta-data is returned as a Map between the auxiliary service names and
  3395. their corresponding per service meta-data as an opaque blob
  3396. <code>ByteBuffer</code>
  3397. </p>
  3398. <p>
  3399. To be able to interpret the per-service meta-data, you should consult the
  3400. documentation for the Auxiliary-service configured on the NodeManager
  3401. </p>
  3402. @return a Map between the names of auxiliary services and their
  3403. corresponding meta-data]]>
  3404. </doc>
  3405. </method>
  3406. <doc>
  3407. <![CDATA[<p>
  3408. The response sent by the <code>NodeManager</code> to the
  3409. <code>ApplicationMaster</code> when asked to <em>start</em> an allocated
  3410. container.
  3411. </p>
  3412. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3413. </doc>
  3414. </class>
  3415. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
  3416. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
  3417. <class name="StopContainersRequest" extends="java.lang.Object"
  3418. abstract="true"
  3419. static="false" final="false" visibility="public"
  3420. deprecated="not deprecated">
  3421. <constructor name="StopContainersRequest"
  3422. static="false" final="false" visibility="public"
  3423. deprecated="not deprecated">
  3424. </constructor>
  3425. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"
  3426. abstract="false" native="false" synchronized="false"
  3427. static="true" final="false" visibility="public"
  3428. deprecated="not deprecated">
  3429. <param name="containerIds" type="java.util.List"/>
  3430. </method>
  3431. <method name="getContainerIds" return="java.util.List"
  3432. abstract="true" native="false" synchronized="false"
  3433. static="false" final="false" visibility="public"
  3434. deprecated="not deprecated">
  3435. <doc>
  3436. <![CDATA[Get the <code>ContainerId</code>s of the containers to be stopped.
  3437. @return <code>ContainerId</code>s of containers to be stopped]]>
  3438. </doc>
  3439. </method>
  3440. <method name="setContainerIds"
  3441. abstract="true" native="false" synchronized="false"
  3442. static="false" final="false" visibility="public"
  3443. deprecated="not deprecated">
  3444. <param name="containerIds" type="java.util.List"/>
  3445. <doc>
  3446. <![CDATA[Set the <code>ContainerId</code>s of the containers to be stopped.
  3447. @param containerIds <code>ContainerId</code>s of the containers to be stopped]]>
  3448. </doc>
  3449. </method>
  3450. <doc>
  3451. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
  3452. <code>NodeManager</code> to <em>stop</em> containers.</p>
  3453. @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
  3454. </doc>
  3455. </class>
  3456. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
  3457. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
  3458. <class name="StopContainersResponse" extends="java.lang.Object"
  3459. abstract="true"
  3460. static="false" final="false" visibility="public"
  3461. deprecated="not deprecated">
  3462. <constructor name="StopContainersResponse"
  3463. static="false" final="false" visibility="public"
  3464. deprecated="not deprecated">
  3465. </constructor>
  3466. <method name="getSuccessfullyStoppedContainers" return="java.util.List"
  3467. abstract="true" native="false" synchronized="false"
  3468. static="false" final="false" visibility="public"
  3469. deprecated="not deprecated">
  3470. <doc>
  3471. <![CDATA[Get the list of containerIds of successfully stopped containers.
  3472. @return the list of containerIds of successfully stopped containers.]]>
  3473. </doc>
  3474. </method>
  3475. <method name="getFailedRequests" return="java.util.Map"
  3476. abstract="true" native="false" synchronized="false"
  3477. static="false" final="false" visibility="public"
  3478. deprecated="not deprecated">
  3479. <doc>
  3480. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  3481. from per container for failed requests]]>
  3482. </doc>
  3483. </method>
  3484. <doc>
  3485. <![CDATA[<p>
  3486. The response sent by the <code>NodeManager</code> to the
  3487. <code>ApplicationMaster</code> when asked to <em>stop</em> allocated
  3488. containers.
  3489. </p>
  3490. @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
  3491. </doc>
  3492. </class>
  3493. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
  3494. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
  3495. <class name="SubmitApplicationRequest" extends="java.lang.Object"
  3496. abstract="true"
  3497. static="false" final="false" visibility="public"
  3498. deprecated="not deprecated">
  3499. <constructor name="SubmitApplicationRequest"
  3500. static="false" final="false" visibility="public"
  3501. deprecated="not deprecated">
  3502. </constructor>
  3503. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"
  3504. abstract="false" native="false" synchronized="false"
  3505. static="true" final="false" visibility="public"
  3506. deprecated="not deprecated">
  3507. <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
  3508. </method>
  3509. <method name="getApplicationSubmissionContext" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  3510. abstract="true" native="false" synchronized="false"
  3511. static="false" final="false" visibility="public"
  3512. deprecated="not deprecated">
  3513. <doc>
  3514. <![CDATA[Get the <code>ApplicationSubmissionContext</code> for the application.
  3515. @return <code>ApplicationSubmissionContext</code> for the application]]>
  3516. </doc>
  3517. </method>
  3518. <method name="setApplicationSubmissionContext"
  3519. abstract="true" native="false" synchronized="false"
  3520. static="false" final="false" visibility="public"
  3521. deprecated="not deprecated">
  3522. <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
  3523. <doc>
  3524. <![CDATA[Set the <code>ApplicationSubmissionContext</code> for the application.
  3525. @param context <code>ApplicationSubmissionContext</code> for the
  3526. application]]>
  3527. </doc>
  3528. </method>
  3529. <doc>
  3530. <![CDATA[<p>The request sent by a client to <em>submit an application</em> to the
  3531. <code>ResourceManager</code>.</p>
  3532. <p>The request, via {@link ApplicationSubmissionContext}, contains
  3533. details such as queue, {@link Resource} required to run the
  3534. <code>ApplicationMaster</code>, the equivalent of
  3535. {@link ContainerLaunchContext} for launching the
  3536. <code>ApplicationMaster</code> etc.
  3537. @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
  3538. </doc>
  3539. </class>
  3540. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
  3541. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
  3542. <class name="SubmitApplicationResponse" extends="java.lang.Object"
  3543. abstract="true"
  3544. static="false" final="false" visibility="public"
  3545. deprecated="not deprecated">
  3546. <constructor name="SubmitApplicationResponse"
  3547. static="false" final="false" visibility="public"
  3548. deprecated="not deprecated">
  3549. </constructor>
  3550. <doc>
  3551. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client on
  3552. application submission.</p>
  3553. <p>Currently, this is empty.</p>
  3554. @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
  3555. </doc>
  3556. </class>
  3557. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
  3558. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
  3559. <class name="UseSharedCacheResourceRequest" extends="java.lang.Object"
  3560. abstract="true"
  3561. static="false" final="false" visibility="public"
  3562. deprecated="not deprecated">
  3563. <constructor name="UseSharedCacheResourceRequest"
  3564. static="false" final="false" visibility="public"
  3565. deprecated="not deprecated">
  3566. </constructor>
  3567. <method name="getAppId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3568. abstract="true" native="false" synchronized="false"
  3569. static="false" final="false" visibility="public"
  3570. deprecated="not deprecated">
  3571. <doc>
  3572. <![CDATA[Get the <code>ApplicationId</code> of the resource to be used.
  3573. @return <code>ApplicationId</code>]]>
  3574. </doc>
  3575. </method>
  3576. <method name="setAppId"
  3577. abstract="true" native="false" synchronized="false"
  3578. static="false" final="false" visibility="public"
  3579. deprecated="not deprecated">
  3580. <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3581. <doc>
  3582. <![CDATA[Set the <code>ApplicationId</code> of the resource to be used.
  3583. @param id <code>ApplicationId</code>]]>
  3584. </doc>
  3585. </method>
  3586. <method name="getResourceKey" return="java.lang.String"
  3587. abstract="true" native="false" synchronized="false"
  3588. static="false" final="false" visibility="public"
  3589. deprecated="not deprecated">
  3590. <doc>
  3591. <![CDATA[Get the <code>key</code> of the resource to be used.
  3592. @return <code>key</code>]]>
  3593. </doc>
  3594. </method>
  3595. <method name="setResourceKey"
  3596. abstract="true" native="false" synchronized="false"
  3597. static="false" final="false" visibility="public"
  3598. deprecated="not deprecated">
  3599. <param name="key" type="java.lang.String"/>
  3600. <doc>
  3601. <![CDATA[Set the <code>key</code> of the resource to be used.
  3602. @param key unique identifier for the resource]]>
  3603. </doc>
  3604. </method>
  3605. <doc>
  3606. <![CDATA[<p>
  3607. The request from clients to the <code>SharedCacheManager</code> that claims a
  3608. resource in the shared cache.
  3609. </p>]]>
  3610. </doc>
  3611. </class>
  3612. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
  3613. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
  3614. <class name="UseSharedCacheResourceResponse" extends="java.lang.Object"
  3615. abstract="true"
  3616. static="false" final="false" visibility="public"
  3617. deprecated="not deprecated">
  3618. <constructor name="UseSharedCacheResourceResponse"
  3619. static="false" final="false" visibility="public"
  3620. deprecated="not deprecated">
  3621. </constructor>
  3622. <method name="getPath" return="java.lang.String"
  3623. abstract="true" native="false" synchronized="false"
  3624. static="false" final="false" visibility="public"
  3625. deprecated="not deprecated">
  3626. <doc>
  3627. <![CDATA[Get the <code>Path</code> corresponding to the requested resource in the
  3628. shared cache.
  3629. @return String A <code>Path</code> if the resource exists in the shared
  3630. cache, <code>null</code> otherwise]]>
  3631. </doc>
  3632. </method>
  3633. <method name="setPath"
  3634. abstract="true" native="false" synchronized="false"
  3635. static="false" final="false" visibility="public"
  3636. deprecated="not deprecated">
  3637. <param name="p" type="java.lang.String"/>
  3638. <doc>
  3639. <![CDATA[Set the <code>Path</code> corresponding to a resource in the shared cache.
  3640. @param p A <code>Path</code> corresponding to a resource in the shared
  3641. cache]]>
  3642. </doc>
  3643. </method>
  3644. <doc>
  3645. <![CDATA[<p>
  3646. The response from the SharedCacheManager to the client that indicates whether
  3647. a requested resource exists in the cache.
  3648. </p>]]>
  3649. </doc>
  3650. </class>
  3651. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
  3652. </package>
  3653. <package name="org.apache.hadoop.yarn.api.records">
  3654. <!-- start class org.apache.hadoop.yarn.api.records.AMCommand -->
  3655. <class name="AMCommand" extends="java.lang.Enum"
  3656. abstract="false"
  3657. static="false" final="true" visibility="public"
  3658. deprecated="not deprecated">
  3659. <method name="values" return="org.apache.hadoop.yarn.api.records.AMCommand[]"
  3660. abstract="false" native="false" synchronized="false"
  3661. static="true" final="false" visibility="public"
  3662. deprecated="not deprecated">
  3663. </method>
  3664. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.AMCommand"
  3665. abstract="false" native="false" synchronized="false"
  3666. static="true" final="false" visibility="public"
  3667. deprecated="not deprecated">
  3668. <param name="name" type="java.lang.String"/>
  3669. </method>
  3670. <doc>
  3671. <![CDATA[Command sent by the Resource Manager to the Application Master in the
  3672. AllocateResponse
  3673. @see AllocateResponse]]>
  3674. </doc>
  3675. </class>
  3676. <!-- end class org.apache.hadoop.yarn.api.records.AMCommand -->
  3677. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
  3678. <class name="ApplicationAccessType" extends="java.lang.Enum"
  3679. abstract="false"
  3680. static="false" final="true" visibility="public"
  3681. deprecated="not deprecated">
  3682. <method name="values" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType[]"
  3683. abstract="false" native="false" synchronized="false"
  3684. static="true" final="false" visibility="public"
  3685. deprecated="not deprecated">
  3686. </method>
  3687. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType"
  3688. abstract="false" native="false" synchronized="false"
  3689. static="true" final="false" visibility="public"
  3690. deprecated="not deprecated">
  3691. <param name="name" type="java.lang.String"/>
  3692. </method>
  3693. <doc>
  3694. <![CDATA[Application access types.]]>
  3695. </doc>
  3696. </class>
  3697. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
  3698. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
  3699. <class name="ApplicationAttemptId" extends="java.lang.Object"
  3700. abstract="true"
  3701. static="false" final="false" visibility="public"
  3702. deprecated="not deprecated">
  3703. <implements name="java.lang.Comparable"/>
  3704. <constructor name="ApplicationAttemptId"
  3705. static="false" final="false" visibility="public"
  3706. deprecated="not deprecated">
  3707. </constructor>
  3708. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3709. abstract="true" native="false" synchronized="false"
  3710. static="false" final="false" visibility="public"
  3711. deprecated="not deprecated">
  3712. <doc>
  3713. <![CDATA[Get the <code>ApplicationId</code> of the <code>ApplicationAttempId</code>.
  3714. @return <code>ApplicationId</code> of the <code>ApplicationAttempId</code>]]>
  3715. </doc>
  3716. </method>
  3717. <method name="getAttemptId" return="int"
  3718. abstract="true" native="false" synchronized="false"
  3719. static="false" final="false" visibility="public"
  3720. deprecated="not deprecated">
  3721. <doc>
  3722. <![CDATA[Get the <code>attempt id</code> of the <code>Application</code>.
  3723. @return <code>attempt id</code> of the <code>Application</code>]]>
  3724. </doc>
  3725. </method>
  3726. <method name="hashCode" return="int"
  3727. abstract="false" native="false" synchronized="false"
  3728. static="false" final="false" visibility="public"
  3729. deprecated="not deprecated">
  3730. </method>
  3731. <method name="equals" return="boolean"
  3732. abstract="false" native="false" synchronized="false"
  3733. static="false" final="false" visibility="public"
  3734. deprecated="not deprecated">
  3735. <param name="obj" type="java.lang.Object"/>
  3736. </method>
  3737. <method name="compareTo" return="int"
  3738. abstract="false" native="false" synchronized="false"
  3739. static="false" final="false" visibility="public"
  3740. deprecated="not deprecated">
  3741. <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  3742. </method>
  3743. <method name="toString" return="java.lang.String"
  3744. abstract="false" native="false" synchronized="false"
  3745. static="false" final="false" visibility="public"
  3746. deprecated="not deprecated">
  3747. </method>
  3748. <method name="build"
  3749. abstract="true" native="false" synchronized="false"
  3750. static="false" final="false" visibility="protected"
  3751. deprecated="not deprecated">
  3752. </method>
  3753. <field name="appAttemptIdStrPrefix" type="java.lang.String"
  3754. transient="false" volatile="false"
  3755. static="true" final="true" visibility="public"
  3756. deprecated="not deprecated">
  3757. </field>
  3758. <doc>
  3759. <![CDATA[<p><code>ApplicationAttemptId</code> denotes the particular <em>attempt</em>
  3760. of an <code>ApplicationMaster</code> for a given {@link ApplicationId}.</p>
  3761. <p>Multiple attempts might be needed to run an application to completion due
  3762. to temporal failures of the <code>ApplicationMaster</code> such as hardware
  3763. failures, connectivity issues etc. on the node on which it was scheduled.</p>]]>
  3764. </doc>
  3765. </class>
  3766. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
  3767. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
  3768. <class name="ApplicationAttemptReport" extends="java.lang.Object"
  3769. abstract="true"
  3770. static="false" final="false" visibility="public"
  3771. deprecated="not deprecated">
  3772. <constructor name="ApplicationAttemptReport"
  3773. static="false" final="false" visibility="public"
  3774. deprecated="not deprecated">
  3775. </constructor>
  3776. <method name="getYarnApplicationAttemptState" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
  3777. abstract="true" native="false" synchronized="false"
  3778. static="false" final="false" visibility="public"
  3779. deprecated="not deprecated">
  3780. <doc>
  3781. <![CDATA[Get the <em>YarnApplicationAttemptState</em> of the application attempt.
  3782. @return <em>YarnApplicationAttemptState</em> of the application attempt]]>
  3783. </doc>
  3784. </method>
  3785. <method name="getRpcPort" return="int"
  3786. abstract="true" native="false" synchronized="false"
  3787. static="false" final="false" visibility="public"
  3788. deprecated="not deprecated">
  3789. <doc>
  3790. <![CDATA[Get the <em>RPC port</em> of this attempt <code>ApplicationMaster</code>.
  3791. @return <em>RPC port</em> of this attempt <code>ApplicationMaster</code>]]>
  3792. </doc>
  3793. </method>
  3794. <method name="getHost" return="java.lang.String"
  3795. abstract="true" native="false" synchronized="false"
  3796. static="false" final="false" visibility="public"
  3797. deprecated="not deprecated">
  3798. <doc>
  3799. <![CDATA[Get the <em>host</em> on which this attempt of
  3800. <code>ApplicationMaster</code> is running.
  3801. @return <em>host</em> on which this attempt of
  3802. <code>ApplicationMaster</code> is running]]>
  3803. </doc>
  3804. </method>
  3805. <method name="getDiagnostics" return="java.lang.String"
  3806. abstract="true" native="false" synchronized="false"
  3807. static="false" final="false" visibility="public"
  3808. deprecated="not deprecated">
  3809. <doc>
  3810. <![CDATA[Get the <em>diagnositic information</em> of the application attempt in case
  3811. of errors.
  3812. @return <em>diagnositic information</em> of the application attempt in case
  3813. of errors]]>
  3814. </doc>
  3815. </method>
  3816. <method name="getTrackingUrl" return="java.lang.String"
  3817. abstract="true" native="false" synchronized="false"
  3818. static="false" final="false" visibility="public"
  3819. deprecated="not deprecated">
  3820. <doc>
  3821. <![CDATA[Get the <em>tracking url</em> for the application attempt.
  3822. @return <em>tracking url</em> for the application attempt]]>
  3823. </doc>
  3824. </method>
  3825. <method name="getOriginalTrackingUrl" return="java.lang.String"
  3826. abstract="true" native="false" synchronized="false"
  3827. static="false" final="false" visibility="public"
  3828. deprecated="not deprecated">
  3829. <doc>
  3830. <![CDATA[Get the <em>original tracking url</em> for the application attempt.
  3831. @return <em>original tracking url</em> for the application attempt]]>
  3832. </doc>
  3833. </method>
  3834. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  3835. abstract="true" native="false" synchronized="false"
  3836. static="false" final="false" visibility="public"
  3837. deprecated="not deprecated">
  3838. <doc>
  3839. <![CDATA[Get the <code>ApplicationAttemptId</code> of this attempt of the
  3840. application
  3841. @return <code>ApplicationAttemptId</code> of the attempt]]>
  3842. </doc>
  3843. </method>
  3844. <method name="getAMContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  3845. abstract="true" native="false" synchronized="false"
  3846. static="false" final="false" visibility="public"
  3847. deprecated="not deprecated">
  3848. <doc>
  3849. <![CDATA[Get the <code>ContainerId</code> of AMContainer for this attempt
  3850. @return <code>ContainerId</code> of the attempt]]>
  3851. </doc>
  3852. </method>
  3853. <doc>
  3854. <![CDATA[{@code ApplicationAttemptReport} is a report of an application attempt.
  3855. <p>
  3856. It includes details such as:
  3857. <ul>
  3858. <li>{@link ApplicationAttemptId} of the application.</li>
  3859. <li>Host on which the <code>ApplicationMaster</code> of this attempt is
  3860. running.</li>
  3861. <li>RPC port of the <code>ApplicationMaster</code> of this attempt.</li>
  3862. <li>Tracking URL.</li>
  3863. <li>Diagnostic information in case of errors.</li>
  3864. <li>{@link YarnApplicationAttemptState} of the application attempt.</li>
  3865. <li>{@link ContainerId} of the master Container.</li>
  3866. </ul>]]>
  3867. </doc>
  3868. </class>
  3869. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
  3870. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationId -->
  3871. <class name="ApplicationId" extends="java.lang.Object"
  3872. abstract="true"
  3873. static="false" final="false" visibility="public"
  3874. deprecated="not deprecated">
  3875. <implements name="java.lang.Comparable"/>
  3876. <constructor name="ApplicationId"
  3877. static="false" final="false" visibility="public"
  3878. deprecated="not deprecated">
  3879. </constructor>
  3880. <method name="getId" return="int"
  3881. abstract="true" native="false" synchronized="false"
  3882. static="false" final="false" visibility="public"
  3883. deprecated="not deprecated">
  3884. <doc>
  3885. <![CDATA[Get the short integer identifier of the <code>ApplicationId</code>
  3886. which is unique for all applications started by a particular instance
  3887. of the <code>ResourceManager</code>.
  3888. @return short integer identifier of the <code>ApplicationId</code>]]>
  3889. </doc>
  3890. </method>
  3891. <method name="getClusterTimestamp" return="long"
  3892. abstract="true" native="false" synchronized="false"
  3893. static="false" final="false" visibility="public"
  3894. deprecated="not deprecated">
  3895. <doc>
  3896. <![CDATA[Get the <em>start time</em> of the <code>ResourceManager</code> which is
  3897. used to generate globally unique <code>ApplicationId</code>.
  3898. @return <em>start time</em> of the <code>ResourceManager</code>]]>
  3899. </doc>
  3900. </method>
  3901. <method name="build"
  3902. abstract="true" native="false" synchronized="false"
  3903. static="false" final="false" visibility="protected"
  3904. deprecated="not deprecated">
  3905. </method>
  3906. <method name="compareTo" return="int"
  3907. abstract="false" native="false" synchronized="false"
  3908. static="false" final="false" visibility="public"
  3909. deprecated="not deprecated">
  3910. <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3911. </method>
  3912. <method name="toString" return="java.lang.String"
  3913. abstract="false" native="false" synchronized="false"
  3914. static="false" final="false" visibility="public"
  3915. deprecated="not deprecated">
  3916. </method>
  3917. <method name="hashCode" return="int"
  3918. abstract="false" native="false" synchronized="false"
  3919. static="false" final="false" visibility="public"
  3920. deprecated="not deprecated">
  3921. </method>
  3922. <method name="equals" return="boolean"
  3923. abstract="false" native="false" synchronized="false"
  3924. static="false" final="false" visibility="public"
  3925. deprecated="not deprecated">
  3926. <param name="obj" type="java.lang.Object"/>
  3927. </method>
  3928. <field name="appIdStrPrefix" type="java.lang.String"
  3929. transient="false" volatile="false"
  3930. static="true" final="true" visibility="public"
  3931. deprecated="not deprecated">
  3932. </field>
  3933. <doc>
  3934. <![CDATA[<p><code>ApplicationId</code> represents the <em>globally unique</em>
  3935. identifier for an application.</p>
  3936. <p>The globally unique nature of the identifier is achieved by using the
  3937. <em>cluster timestamp</em> i.e. start-time of the
  3938. <code>ResourceManager</code> along with a monotonically increasing counter
  3939. for the application.</p>]]>
  3940. </doc>
  3941. </class>
  3942. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationId -->
  3943. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationReport -->
  3944. <class name="ApplicationReport" extends="java.lang.Object"
  3945. abstract="true"
  3946. static="false" final="false" visibility="public"
  3947. deprecated="not deprecated">
  3948. <constructor name="ApplicationReport"
  3949. static="false" final="false" visibility="public"
  3950. deprecated="not deprecated">
  3951. </constructor>
  3952. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3953. abstract="true" native="false" synchronized="false"
  3954. static="false" final="false" visibility="public"
  3955. deprecated="not deprecated">
  3956. <doc>
  3957. <![CDATA[Get the <code>ApplicationId</code> of the application.
  3958. @return <code>ApplicationId</code> of the application]]>
  3959. </doc>
  3960. </method>
  3961. <method name="getCurrentApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  3962. abstract="true" native="false" synchronized="false"
  3963. static="false" final="false" visibility="public"
  3964. deprecated="not deprecated">
  3965. <doc>
  3966. <![CDATA[Get the <code>ApplicationAttemptId</code> of the current
  3967. attempt of the application
  3968. @return <code>ApplicationAttemptId</code> of the attempt]]>
  3969. </doc>
  3970. </method>
  3971. <method name="getUser" return="java.lang.String"
  3972. abstract="true" native="false" synchronized="false"
  3973. static="false" final="false" visibility="public"
  3974. deprecated="not deprecated">
  3975. <doc>
  3976. <![CDATA[Get the <em>user</em> who submitted the application.
  3977. @return <em>user</em> who submitted the application]]>
  3978. </doc>
  3979. </method>
  3980. <method name="getQueue" return="java.lang.String"
  3981. abstract="true" native="false" synchronized="false"
  3982. static="false" final="false" visibility="public"
  3983. deprecated="not deprecated">
  3984. <doc>
  3985. <![CDATA[Get the <em>queue</em> to which the application was submitted.
  3986. @return <em>queue</em> to which the application was submitted]]>
  3987. </doc>
  3988. </method>
  3989. <method name="getName" return="java.lang.String"
  3990. abstract="true" native="false" synchronized="false"
  3991. static="false" final="false" visibility="public"
  3992. deprecated="not deprecated">
  3993. <doc>
  3994. <![CDATA[Get the user-defined <em>name</em> of the application.
  3995. @return <em>name</em> of the application]]>
  3996. </doc>
  3997. </method>
  3998. <method name="getHost" return="java.lang.String"
  3999. abstract="true" native="false" synchronized="false"
  4000. static="false" final="false" visibility="public"
  4001. deprecated="not deprecated">
  4002. <doc>
  4003. <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code>
  4004. is running.
  4005. @return <em>host</em> on which the <code>ApplicationMaster</code>
  4006. is running]]>
  4007. </doc>
  4008. </method>
  4009. <method name="getRpcPort" return="int"
  4010. abstract="true" native="false" synchronized="false"
  4011. static="false" final="false" visibility="public"
  4012. deprecated="not deprecated">
  4013. <doc>
  4014. <![CDATA[Get the <em>RPC port</em> of the <code>ApplicationMaster</code>.
  4015. @return <em>RPC port</em> of the <code>ApplicationMaster</code>]]>
  4016. </doc>
  4017. </method>
  4018. <method name="getClientToAMToken" return="org.apache.hadoop.yarn.api.records.Token"
  4019. abstract="true" native="false" synchronized="false"
  4020. static="false" final="false" visibility="public"
  4021. deprecated="not deprecated">
  4022. <doc>
  4023. <![CDATA[Get the <em>client token</em> for communicating with the
  4024. <code>ApplicationMaster</code>.
  4025. <p>
  4026. <em>ClientToAMToken</em> is the security token used by the AMs to verify
  4027. authenticity of any <code>client</code>.
  4028. </p>
  4029. <p>
  4030. The <code>ResourceManager</code>, provides a secure token (via
  4031. {@link ApplicationReport#getClientToAMToken()}) which is verified by the
  4032. ApplicationMaster when the client directly talks to an AM.
  4033. </p>
  4034. @return <em>client token</em> for communicating with the
  4035. <code>ApplicationMaster</code>]]>
  4036. </doc>
  4037. </method>
  4038. <method name="getYarnApplicationState" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
  4039. abstract="true" native="false" synchronized="false"
  4040. static="false" final="false" visibility="public"
  4041. deprecated="not deprecated">
  4042. <doc>
  4043. <![CDATA[Get the <code>YarnApplicationState</code> of the application.
  4044. @return <code>YarnApplicationState</code> of the application]]>
  4045. </doc>
  4046. </method>
  4047. <method name="getDiagnostics" return="java.lang.String"
  4048. abstract="true" native="false" synchronized="false"
  4049. static="false" final="false" visibility="public"
  4050. deprecated="not deprecated">
  4051. <doc>
  4052. <![CDATA[Get the <em>diagnositic information</em> of the application in case of
  4053. errors.
  4054. @return <em>diagnositic information</em> of the application in case
  4055. of errors]]>
  4056. </doc>
  4057. </method>
  4058. <method name="getTrackingUrl" return="java.lang.String"
  4059. abstract="true" native="false" synchronized="false"
  4060. static="false" final="false" visibility="public"
  4061. deprecated="not deprecated">
  4062. <doc>
  4063. <![CDATA[Get the <em>tracking url</em> for the application.
  4064. @return <em>tracking url</em> for the application]]>
  4065. </doc>
  4066. </method>
  4067. <method name="getStartTime" return="long"
  4068. abstract="true" native="false" synchronized="false"
  4069. static="false" final="false" visibility="public"
  4070. deprecated="not deprecated">
  4071. <doc>
  4072. <![CDATA[Get the <em>start time</em> of the application.
  4073. @return <em>start time</em> of the application]]>
  4074. </doc>
  4075. </method>
  4076. <method name="getFinishTime" return="long"
  4077. abstract="true" native="false" synchronized="false"
  4078. static="false" final="false" visibility="public"
  4079. deprecated="not deprecated">
  4080. <doc>
  4081. <![CDATA[Get the <em>finish time</em> of the application.
  4082. @return <em>finish time</em> of the application]]>
  4083. </doc>
  4084. </method>
  4085. <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  4086. abstract="true" native="false" synchronized="false"
  4087. static="false" final="false" visibility="public"
  4088. deprecated="not deprecated">
  4089. <doc>
  4090. <![CDATA[Get the <em>final finish status</em> of the application.
  4091. @return <em>final finish status</em> of the application]]>
  4092. </doc>
  4093. </method>
  4094. <method name="getApplicationResourceUsageReport" return="org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport"
  4095. abstract="true" native="false" synchronized="false"
  4096. static="false" final="false" visibility="public"
  4097. deprecated="not deprecated">
  4098. <doc>
  4099. <![CDATA[Retrieve the structure containing the job resources for this application
  4100. @return the job resources structure for this application]]>
  4101. </doc>
  4102. </method>
  4103. <method name="getProgress" return="float"
  4104. abstract="true" native="false" synchronized="false"
  4105. static="false" final="false" visibility="public"
  4106. deprecated="not deprecated">
  4107. <doc>
  4108. <![CDATA[Get the application's progress ( range 0.0 to 1.0 )
  4109. @return application's progress]]>
  4110. </doc>
  4111. </method>
  4112. <method name="getApplicationType" return="java.lang.String"
  4113. abstract="true" native="false" synchronized="false"
  4114. static="false" final="false" visibility="public"
  4115. deprecated="not deprecated">
  4116. <doc>
  4117. <![CDATA[Get the application's Type
  4118. @return application's Type]]>
  4119. </doc>
  4120. </method>
  4121. <method name="getApplicationTags" return="java.util.Set"
  4122. abstract="true" native="false" synchronized="false"
  4123. static="false" final="false" visibility="public"
  4124. deprecated="not deprecated">
  4125. <doc>
  4126. <![CDATA[Get all tags corresponding to the application
  4127. @return Application's tags]]>
  4128. </doc>
  4129. </method>
  4130. <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
  4131. abstract="true" native="false" synchronized="false"
  4132. static="false" final="false" visibility="public"
  4133. deprecated="not deprecated">
  4134. <doc>
  4135. <![CDATA[Get the AMRM token of the application.
  4136. <p>
  4137. The AMRM token is required for AM to RM scheduling operations. For
  4138. managed Application Masters Yarn takes care of injecting it. For unmanaged
  4139. Applications Masters, the token must be obtained via this method and set
  4140. in the {@link org.apache.hadoop.security.UserGroupInformation} of the
  4141. current user.
  4142. <p>
  4143. The AMRM token will be returned only if all the following conditions are
  4144. met:
  4145. <ul>
  4146. <li>the requester is the owner of the ApplicationMaster</li>
  4147. <li>the application master is an unmanaged ApplicationMaster</li>
  4148. <li>the application master is in ACCEPTED state</li>
  4149. </ul>
  4150. Else this method returns NULL.
  4151. @return the AM to RM token if available.]]>
  4152. </doc>
  4153. </method>
  4154. <doc>
  4155. <![CDATA[{@code ApplicationReport} is a report of an application.
  4156. <p>
  4157. It includes details such as:
  4158. <ul>
  4159. <li>{@link ApplicationId} of the application.</li>
  4160. <li>Applications user.</li>
  4161. <li>Application queue.</li>
  4162. <li>Application name.</li>
  4163. <li>Host on which the <code>ApplicationMaster</code> is running.</li>
  4164. <li>RPC port of the <code>ApplicationMaster</code>.</li>
  4165. <li>Tracking URL.</li>
  4166. <li>{@link YarnApplicationState} of the application.</li>
  4167. <li>Diagnostic information in case of errors.</li>
  4168. <li>Start time of the application.</li>
  4169. <li>Client {@link Token} of the application (if security is enabled).</li>
  4170. </ul>
  4171. @see ApplicationClientProtocol#getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest)]]>
  4172. </doc>
  4173. </class>
  4174. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationReport -->
  4175. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
  4176. <class name="ApplicationResourceUsageReport" extends="java.lang.Object"
  4177. abstract="true"
  4178. static="false" final="false" visibility="public"
  4179. deprecated="not deprecated">
  4180. <constructor name="ApplicationResourceUsageReport"
  4181. static="false" final="false" visibility="public"
  4182. deprecated="not deprecated">
  4183. </constructor>
  4184. <method name="getNumUsedContainers" return="int"
  4185. abstract="true" native="false" synchronized="false"
  4186. static="false" final="false" visibility="public"
  4187. deprecated="not deprecated">
  4188. <doc>
  4189. <![CDATA[Get the number of used containers. -1 for invalid/inaccessible reports.
  4190. @return the number of used containers]]>
  4191. </doc>
  4192. </method>
  4193. <method name="getUsedResources" return="org.apache.hadoop.yarn.api.records.Resource"
  4194. abstract="true" native="false" synchronized="false"
  4195. static="false" final="false" visibility="public"
  4196. deprecated="not deprecated">
  4197. <doc>
  4198. <![CDATA[Get the used <code>Resource</code>. -1 for invalid/inaccessible reports.
  4199. @return the used <code>Resource</code>]]>
  4200. </doc>
  4201. </method>
  4202. <method name="getReservedResources" return="org.apache.hadoop.yarn.api.records.Resource"
  4203. abstract="true" native="false" synchronized="false"
  4204. static="false" final="false" visibility="public"
  4205. deprecated="not deprecated">
  4206. <doc>
  4207. <![CDATA[Get the reserved <code>Resource</code>. -1 for invalid/inaccessible reports.
  4208. @return the reserved <code>Resource</code>]]>
  4209. </doc>
  4210. </method>
  4211. <method name="getNeededResources" return="org.apache.hadoop.yarn.api.records.Resource"
  4212. abstract="true" native="false" synchronized="false"
  4213. static="false" final="false" visibility="public"
  4214. deprecated="not deprecated">
  4215. <doc>
  4216. <![CDATA[Get the needed <code>Resource</code>. -1 for invalid/inaccessible reports.
  4217. @return the needed <code>Resource</code>]]>
  4218. </doc>
  4219. </method>
  4220. <method name="getMemorySeconds" return="long"
  4221. abstract="true" native="false" synchronized="false"
  4222. static="false" final="false" visibility="public"
  4223. deprecated="not deprecated">
  4224. <doc>
  4225. <![CDATA[Get the aggregated amount of memory (in megabytes) the application has
  4226. allocated times the number of seconds the application has been running.
  4227. @return the aggregated amount of memory seconds]]>
  4228. </doc>
  4229. </method>
  4230. <method name="getVcoreSeconds" return="long"
  4231. abstract="true" native="false" synchronized="false"
  4232. static="false" final="false" visibility="public"
  4233. deprecated="not deprecated">
  4234. <doc>
  4235. <![CDATA[Get the aggregated number of vcores that the application has allocated
  4236. times the number of seconds the application has been running.
  4237. @return the aggregated number of vcore seconds]]>
  4238. </doc>
  4239. </method>
  4240. <doc>
  4241. <![CDATA[Contains various scheduling metrics to be reported by UI and CLI.]]>
  4242. </doc>
  4243. </class>
  4244. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
  4245. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
  4246. <class name="ApplicationSubmissionContext" extends="java.lang.Object"
  4247. abstract="true"
  4248. static="false" final="false" visibility="public"
  4249. deprecated="not deprecated">
  4250. <constructor name="ApplicationSubmissionContext"
  4251. static="false" final="false" visibility="public"
  4252. deprecated="not deprecated">
  4253. </constructor>
  4254. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4255. abstract="false" native="false" synchronized="false"
  4256. static="true" final="false" visibility="public"
  4257. deprecated="not deprecated">
  4258. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4259. <param name="applicationName" type="java.lang.String"/>
  4260. <param name="queue" type="java.lang.String"/>
  4261. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4262. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4263. <param name="isUnmanagedAM" type="boolean"/>
  4264. <param name="cancelTokensWhenComplete" type="boolean"/>
  4265. <param name="maxAppAttempts" type="int"/>
  4266. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4267. <param name="applicationType" type="java.lang.String"/>
  4268. <param name="keepContainers" type="boolean"/>
  4269. <param name="appLabelExpression" type="java.lang.String"/>
  4270. <param name="amContainerLabelExpression" type="java.lang.String"/>
  4271. </method>
  4272. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4273. abstract="false" native="false" synchronized="false"
  4274. static="true" final="false" visibility="public"
  4275. deprecated="not deprecated">
  4276. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4277. <param name="applicationName" type="java.lang.String"/>
  4278. <param name="queue" type="java.lang.String"/>
  4279. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4280. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4281. <param name="isUnmanagedAM" type="boolean"/>
  4282. <param name="cancelTokensWhenComplete" type="boolean"/>
  4283. <param name="maxAppAttempts" type="int"/>
  4284. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4285. <param name="applicationType" type="java.lang.String"/>
  4286. <param name="keepContainers" type="boolean"/>
  4287. </method>
  4288. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4289. abstract="false" native="false" synchronized="false"
  4290. static="true" final="false" visibility="public"
  4291. deprecated="not deprecated">
  4292. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4293. <param name="applicationName" type="java.lang.String"/>
  4294. <param name="queue" type="java.lang.String"/>
  4295. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4296. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4297. <param name="isUnmanagedAM" type="boolean"/>
  4298. <param name="cancelTokensWhenComplete" type="boolean"/>
  4299. <param name="maxAppAttempts" type="int"/>
  4300. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4301. <param name="applicationType" type="java.lang.String"/>
  4302. </method>
  4303. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4304. abstract="false" native="false" synchronized="false"
  4305. static="true" final="false" visibility="public"
  4306. deprecated="not deprecated">
  4307. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4308. <param name="applicationName" type="java.lang.String"/>
  4309. <param name="queue" type="java.lang.String"/>
  4310. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4311. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4312. <param name="isUnmanagedAM" type="boolean"/>
  4313. <param name="cancelTokensWhenComplete" type="boolean"/>
  4314. <param name="maxAppAttempts" type="int"/>
  4315. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4316. </method>
  4317. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4318. abstract="false" native="false" synchronized="false"
  4319. static="true" final="false" visibility="public"
  4320. deprecated="not deprecated">
  4321. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4322. <param name="applicationName" type="java.lang.String"/>
  4323. <param name="queue" type="java.lang.String"/>
  4324. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4325. <param name="isUnmanagedAM" type="boolean"/>
  4326. <param name="cancelTokensWhenComplete" type="boolean"/>
  4327. <param name="maxAppAttempts" type="int"/>
  4328. <param name="applicationType" type="java.lang.String"/>
  4329. <param name="keepContainers" type="boolean"/>
  4330. <param name="appLabelExpression" type="java.lang.String"/>
  4331. <param name="resourceRequest" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  4332. </method>
  4333. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4334. abstract="false" native="false" synchronized="false"
  4335. static="true" final="false" visibility="public"
  4336. deprecated="not deprecated">
  4337. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4338. <param name="applicationName" type="java.lang.String"/>
  4339. <param name="queue" type="java.lang.String"/>
  4340. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4341. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4342. <param name="isUnmanagedAM" type="boolean"/>
  4343. <param name="cancelTokensWhenComplete" type="boolean"/>
  4344. <param name="maxAppAttempts" type="int"/>
  4345. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4346. <param name="applicationType" type="java.lang.String"/>
  4347. <param name="keepContainers" type="boolean"/>
  4348. <param name="attemptFailuresValidityInterval" type="long"/>
  4349. </method>
  4350. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4351. abstract="false" native="false" synchronized="false"
  4352. static="true" final="false" visibility="public"
  4353. deprecated="not deprecated">
  4354. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4355. <param name="applicationName" type="java.lang.String"/>
  4356. <param name="queue" type="java.lang.String"/>
  4357. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4358. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4359. <param name="isUnmanagedAM" type="boolean"/>
  4360. <param name="cancelTokensWhenComplete" type="boolean"/>
  4361. <param name="maxAppAttempts" type="int"/>
  4362. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4363. <param name="applicationType" type="java.lang.String"/>
  4364. <param name="keepContainers" type="boolean"/>
  4365. <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
  4366. </method>
  4367. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4368. abstract="true" native="false" synchronized="false"
  4369. static="false" final="false" visibility="public"
  4370. deprecated="not deprecated">
  4371. <doc>
  4372. <![CDATA[Get the <code>ApplicationId</code> of the submitted application.
  4373. @return <code>ApplicationId</code> of the submitted application]]>
  4374. </doc>
  4375. </method>
  4376. <method name="setApplicationId"
  4377. abstract="true" native="false" synchronized="false"
  4378. static="false" final="false" visibility="public"
  4379. deprecated="not deprecated">
  4380. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4381. <doc>
  4382. <![CDATA[Set the <code>ApplicationId</code> of the submitted application.
  4383. @param applicationId <code>ApplicationId</code> of the submitted
  4384. application]]>
  4385. </doc>
  4386. </method>
  4387. <method name="getApplicationName" return="java.lang.String"
  4388. abstract="true" native="false" synchronized="false"
  4389. static="false" final="false" visibility="public"
  4390. deprecated="not deprecated">
  4391. <doc>
  4392. <![CDATA[Get the application <em>name</em>.
  4393. @return application name]]>
  4394. </doc>
  4395. </method>
  4396. <method name="setApplicationName"
  4397. abstract="true" native="false" synchronized="false"
  4398. static="false" final="false" visibility="public"
  4399. deprecated="not deprecated">
  4400. <param name="applicationName" type="java.lang.String"/>
  4401. <doc>
  4402. <![CDATA[Set the application <em>name</em>.
  4403. @param applicationName application name]]>
  4404. </doc>
  4405. </method>
  4406. <method name="getQueue" return="java.lang.String"
  4407. abstract="true" native="false" synchronized="false"
  4408. static="false" final="false" visibility="public"
  4409. deprecated="not deprecated">
  4410. <doc>
  4411. <![CDATA[Get the <em>queue</em> to which the application is being submitted.
  4412. @return <em>queue</em> to which the application is being submitted]]>
  4413. </doc>
  4414. </method>
  4415. <method name="setQueue"
  4416. abstract="true" native="false" synchronized="false"
  4417. static="false" final="false" visibility="public"
  4418. deprecated="not deprecated">
  4419. <param name="queue" type="java.lang.String"/>
  4420. <doc>
  4421. <![CDATA[Set the <em>queue</em> to which the application is being submitted
  4422. @param queue <em>queue</em> to which the application is being submitted]]>
  4423. </doc>
  4424. </method>
  4425. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  4426. abstract="true" native="false" synchronized="false"
  4427. static="false" final="false" visibility="public"
  4428. deprecated="not deprecated">
  4429. <doc>
  4430. <![CDATA[Get the <code>Priority</code> of the application.
  4431. @return <code>Priority</code> of the application]]>
  4432. </doc>
  4433. </method>
  4434. <method name="getAMContainerSpec" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  4435. abstract="true" native="false" synchronized="false"
  4436. static="false" final="false" visibility="public"
  4437. deprecated="not deprecated">
  4438. <doc>
  4439. <![CDATA[Get the <code>ContainerLaunchContext</code> to describe the
  4440. <code>Container</code> with which the <code>ApplicationMaster</code> is
  4441. launched.
  4442. @return <code>ContainerLaunchContext</code> for the
  4443. <code>ApplicationMaster</code> container]]>
  4444. </doc>
  4445. </method>
  4446. <method name="setAMContainerSpec"
  4447. abstract="true" native="false" synchronized="false"
  4448. static="false" final="false" visibility="public"
  4449. deprecated="not deprecated">
  4450. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4451. <doc>
  4452. <![CDATA[Set the <code>ContainerLaunchContext</code> to describe the
  4453. <code>Container</code> with which the <code>ApplicationMaster</code> is
  4454. launched.
  4455. @param amContainer <code>ContainerLaunchContext</code> for the
  4456. <code>ApplicationMaster</code> container]]>
  4457. </doc>
  4458. </method>
  4459. <method name="getUnmanagedAM" return="boolean"
  4460. abstract="true" native="false" synchronized="false"
  4461. static="false" final="false" visibility="public"
  4462. deprecated="not deprecated">
  4463. <doc>
  4464. <![CDATA[Get if the RM should manage the execution of the AM.
  4465. If true, then the RM
  4466. will not allocate a container for the AM and start it. It will expect the
  4467. AM to be launched and connect to the RM within the AM liveliness period and
  4468. fail the app otherwise. The client should launch the AM only after the RM
  4469. has ACCEPTED the application and changed the <code>YarnApplicationState</code>.
  4470. Such apps will not be retried by the RM on app attempt failure.
  4471. The default value is false.
  4472. @return true if the AM is not managed by the RM]]>
  4473. </doc>
  4474. </method>
  4475. <method name="setUnmanagedAM"
  4476. abstract="true" native="false" synchronized="false"
  4477. static="false" final="false" visibility="public"
  4478. deprecated="not deprecated">
  4479. <param name="value" type="boolean"/>
  4480. <doc>
  4481. <![CDATA[@param value true if RM should not manage the AM]]>
  4482. </doc>
  4483. </method>
  4484. <method name="getMaxAppAttempts" return="int"
  4485. abstract="true" native="false" synchronized="false"
  4486. static="false" final="false" visibility="public"
  4487. deprecated="not deprecated">
  4488. <doc>
  4489. <![CDATA[@return the number of max attempts of the application to be submitted]]>
  4490. </doc>
  4491. </method>
  4492. <method name="setMaxAppAttempts"
  4493. abstract="true" native="false" synchronized="false"
  4494. static="false" final="false" visibility="public"
  4495. deprecated="not deprecated">
  4496. <param name="maxAppAttempts" type="int"/>
  4497. <doc>
  4498. <![CDATA[Set the number of max attempts of the application to be submitted. WARNING:
  4499. it should be no larger than the global number of max attempts in the Yarn
  4500. configuration.
  4501. @param maxAppAttempts the number of max attempts of the application
  4502. to be submitted.]]>
  4503. </doc>
  4504. </method>
  4505. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  4506. abstract="true" native="false" synchronized="false"
  4507. static="false" final="false" visibility="public"
  4508. deprecated="not deprecated">
  4509. <doc>
  4510. <![CDATA[Get the resource required by the <code>ApplicationMaster</code> for this
  4511. application. Please note this will be DEPRECATED, use <em>getResource</em>
  4512. in <em>getAMContainerResourceRequest</em> instead.
  4513. @return the resource required by the <code>ApplicationMaster</code> for
  4514. this application.]]>
  4515. </doc>
  4516. </method>
  4517. <method name="setResource"
  4518. abstract="true" native="false" synchronized="false"
  4519. static="false" final="false" visibility="public"
  4520. deprecated="not deprecated">
  4521. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4522. <doc>
  4523. <![CDATA[Set the resource required by the <code>ApplicationMaster</code> for this
  4524. application.
  4525. @param resource the resource required by the <code>ApplicationMaster</code>
  4526. for this application.]]>
  4527. </doc>
  4528. </method>
  4529. <method name="getApplicationType" return="java.lang.String"
  4530. abstract="true" native="false" synchronized="false"
  4531. static="false" final="false" visibility="public"
  4532. deprecated="not deprecated">
  4533. <doc>
  4534. <![CDATA[Get the application type
  4535. @return the application type]]>
  4536. </doc>
  4537. </method>
  4538. <method name="setApplicationType"
  4539. abstract="true" native="false" synchronized="false"
  4540. static="false" final="false" visibility="public"
  4541. deprecated="not deprecated">
  4542. <param name="applicationType" type="java.lang.String"/>
  4543. <doc>
  4544. <![CDATA[Set the application type
  4545. @param applicationType the application type]]>
  4546. </doc>
  4547. </method>
  4548. <method name="getKeepContainersAcrossApplicationAttempts" return="boolean"
  4549. abstract="true" native="false" synchronized="false"
  4550. static="false" final="false" visibility="public"
  4551. deprecated="not deprecated">
  4552. <doc>
  4553. <![CDATA[Get the flag which indicates whether to keep containers across application
  4554. attempts or not.
  4555. @return the flag which indicates whether to keep containers across
  4556. application attempts or not.]]>
  4557. </doc>
  4558. </method>
  4559. <method name="setKeepContainersAcrossApplicationAttempts"
  4560. abstract="true" native="false" synchronized="false"
  4561. static="false" final="false" visibility="public"
  4562. deprecated="not deprecated">
  4563. <param name="keepContainers" type="boolean"/>
  4564. <doc>
  4565. <![CDATA[Set the flag which indicates whether to keep containers across application
  4566. attempts.
  4567. <p>
  4568. If the flag is true, running containers will not be killed when application
  4569. attempt fails and these containers will be retrieved by the new application
  4570. attempt on registration via
  4571. {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}.
  4572. </p>
  4573. @param keepContainers
  4574. the flag which indicates whether to keep containers across
  4575. application attempts.]]>
  4576. </doc>
  4577. </method>
  4578. <method name="getApplicationTags" return="java.util.Set"
  4579. abstract="true" native="false" synchronized="false"
  4580. static="false" final="false" visibility="public"
  4581. deprecated="not deprecated">
  4582. <doc>
  4583. <![CDATA[Get tags for the application
  4584. @return the application tags]]>
  4585. </doc>
  4586. </method>
  4587. <method name="setApplicationTags"
  4588. abstract="true" native="false" synchronized="false"
  4589. static="false" final="false" visibility="public"
  4590. deprecated="not deprecated">
  4591. <param name="tags" type="java.util.Set"/>
  4592. <doc>
  4593. <![CDATA[Set tags for the application. A maximum of
  4594. {@link YarnConfiguration#APPLICATION_MAX_TAGS} are allowed
  4595. per application. Each tag can be at most
  4596. {@link YarnConfiguration#APPLICATION_MAX_TAG_LENGTH}
  4597. characters, and can contain only ASCII characters.
  4598. @param tags tags to set]]>
  4599. </doc>
  4600. </method>
  4601. <method name="getNodeLabelExpression" return="java.lang.String"
  4602. abstract="true" native="false" synchronized="false"
  4603. static="false" final="false" visibility="public"
  4604. deprecated="not deprecated">
  4605. <doc>
  4606. <![CDATA[Get node-label-expression for this app. If this is set, all containers of
  4607. this application without setting node-label-expression in ResurceRequest
  4608. will get allocated resources on only those nodes that satisfy this
  4609. node-label-expression.
  4610. If different node-label-expression of this app and ResourceRequest are set
  4611. at the same time, the one set in ResourceRequest will be used when
  4612. allocating container
  4613. @return node-label-expression for this app]]>
  4614. </doc>
  4615. </method>
  4616. <method name="setNodeLabelExpression"
  4617. abstract="true" native="false" synchronized="false"
  4618. static="false" final="false" visibility="public"
  4619. deprecated="not deprecated">
  4620. <param name="nodeLabelExpression" type="java.lang.String"/>
  4621. <doc>
  4622. <![CDATA[Set node-label-expression for this app
  4623. @param nodeLabelExpression node-label-expression of this app]]>
  4624. </doc>
  4625. </method>
  4626. <method name="getAMContainerResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  4627. abstract="true" native="false" synchronized="false"
  4628. static="false" final="false" visibility="public"
  4629. deprecated="not deprecated">
  4630. <doc>
  4631. <![CDATA[Get ResourceRequest of AM container, if this is not null, scheduler will
  4632. use this to acquire resource for AM container.
  4633. If this is null, scheduler will assemble a ResourceRequest by using
  4634. <em>getResource</em> and <em>getPriority</em> of
  4635. <em>ApplicationSubmissionContext</em>.
  4636. Number of containers and Priority will be ignore.
  4637. @return ResourceRequest of AM container]]>
  4638. </doc>
  4639. </method>
  4640. <method name="setAMContainerResourceRequest"
  4641. abstract="true" native="false" synchronized="false"
  4642. static="false" final="false" visibility="public"
  4643. deprecated="not deprecated">
  4644. <param name="request" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  4645. <doc>
  4646. <![CDATA[Set ResourceRequest of AM container
  4647. @param request of AM container]]>
  4648. </doc>
  4649. </method>
  4650. <method name="getAttemptFailuresValidityInterval" return="long"
  4651. abstract="true" native="false" synchronized="false"
  4652. static="false" final="false" visibility="public"
  4653. deprecated="not deprecated">
  4654. <doc>
  4655. <![CDATA[Get the attemptFailuresValidityInterval in milliseconds for the application
  4656. @return the attemptFailuresValidityInterval]]>
  4657. </doc>
  4658. </method>
  4659. <method name="setAttemptFailuresValidityInterval"
  4660. abstract="true" native="false" synchronized="false"
  4661. static="false" final="false" visibility="public"
  4662. deprecated="not deprecated">
  4663. <param name="attemptFailuresValidityInterval" type="long"/>
  4664. <doc>
  4665. <![CDATA[Set the attemptFailuresValidityInterval in milliseconds for the application
  4666. @param attemptFailuresValidityInterval]]>
  4667. </doc>
  4668. </method>
  4669. <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  4670. abstract="true" native="false" synchronized="false"
  4671. static="false" final="false" visibility="public"
  4672. deprecated="not deprecated">
  4673. <doc>
  4674. <![CDATA[Get <code>LogAggregationContext</code> of the application
  4675. @return <code>LogAggregationContext</code> of the application]]>
  4676. </doc>
  4677. </method>
  4678. <method name="setLogAggregationContext"
  4679. abstract="true" native="false" synchronized="false"
  4680. static="false" final="false" visibility="public"
  4681. deprecated="not deprecated">
  4682. <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
  4683. <doc>
  4684. <![CDATA[Set <code>LogAggregationContext</code> for the application
  4685. @param logAggregationContext
  4686. for the application]]>
  4687. </doc>
  4688. </method>
  4689. <method name="getReservationID" return="org.apache.hadoop.yarn.api.records.ReservationId"
  4690. abstract="true" native="false" synchronized="false"
  4691. static="false" final="false" visibility="public"
  4692. deprecated="not deprecated">
  4693. <doc>
  4694. <![CDATA[Get the reservation id, that corresponds to a valid resource allocation in
  4695. the scheduler (between start and end time of the corresponding reservation)
  4696. @return the reservation id representing the unique id of the corresponding
  4697. reserved resource allocation in the scheduler]]>
  4698. </doc>
  4699. </method>
  4700. <method name="setReservationID"
  4701. abstract="true" native="false" synchronized="false"
  4702. static="false" final="false" visibility="public"
  4703. deprecated="not deprecated">
  4704. <param name="reservationID" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  4705. <doc>
  4706. <![CDATA[Set the reservation id, that correspond to a valid resource allocation in
  4707. the scheduler (between start and end time of the corresponding reservation)
  4708. @param reservationID representing the unique id of the
  4709. corresponding reserved resource allocation in the scheduler]]>
  4710. </doc>
  4711. </method>
  4712. <doc>
  4713. <![CDATA[{@code ApplicationSubmissionContext} represents all of the
  4714. information needed by the {@code ResourceManager} to launch
  4715. the {@code ApplicationMaster} for an application.
  4716. <p>
  4717. It includes details such as:
  4718. <ul>
  4719. <li>{@link ApplicationId} of the application.</li>
  4720. <li>Application user.</li>
  4721. <li>Application name.</li>
  4722. <li>{@link Priority} of the application.</li>
  4723. <li>
  4724. {@link ContainerLaunchContext} of the container in which the
  4725. <code>ApplicationMaster</code> is executed.
  4726. </li>
  4727. <li>
  4728. maxAppAttempts. The maximum number of application attempts.
  4729. It should be no larger than the global number of max attempts in the
  4730. Yarn configuration.
  4731. </li>
  4732. <li>
  4733. attemptFailuresValidityInterval. The default value is -1.
  4734. when attemptFailuresValidityInterval in milliseconds is set to
  4735. {@literal >} 0, the failure number will no take failures which happen
  4736. out of the validityInterval into failure count. If failure count
  4737. reaches to maxAppAttempts, the application will be failed.
  4738. </li>
  4739. <li>Optional, application-specific {@link LogAggregationContext}</li>
  4740. </ul>
  4741. @see ContainerLaunchContext
  4742. @see ApplicationClientProtocol#submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest)]]>
  4743. </doc>
  4744. </class>
  4745. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
  4746. <!-- start class org.apache.hadoop.yarn.api.records.Container -->
  4747. <class name="Container" extends="java.lang.Object"
  4748. abstract="true"
  4749. static="false" final="false" visibility="public"
  4750. deprecated="not deprecated">
  4751. <implements name="java.lang.Comparable"/>
  4752. <constructor name="Container"
  4753. static="false" final="false" visibility="public"
  4754. deprecated="not deprecated">
  4755. </constructor>
  4756. <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  4757. abstract="true" native="false" synchronized="false"
  4758. static="false" final="false" visibility="public"
  4759. deprecated="not deprecated">
  4760. <doc>
  4761. <![CDATA[Get the globally unique identifier for the container.
  4762. @return globally unique identifier for the container]]>
  4763. </doc>
  4764. </method>
  4765. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  4766. abstract="true" native="false" synchronized="false"
  4767. static="false" final="false" visibility="public"
  4768. deprecated="not deprecated">
  4769. <doc>
  4770. <![CDATA[Get the identifier of the node on which the container is allocated.
  4771. @return identifier of the node on which the container is allocated]]>
  4772. </doc>
  4773. </method>
  4774. <method name="getNodeHttpAddress" return="java.lang.String"
  4775. abstract="true" native="false" synchronized="false"
  4776. static="false" final="false" visibility="public"
  4777. deprecated="not deprecated">
  4778. <doc>
  4779. <![CDATA[Get the http uri of the node on which the container is allocated.
  4780. @return http uri of the node on which the container is allocated]]>
  4781. </doc>
  4782. </method>
  4783. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  4784. abstract="true" native="false" synchronized="false"
  4785. static="false" final="false" visibility="public"
  4786. deprecated="not deprecated">
  4787. <doc>
  4788. <![CDATA[Get the <code>Resource</code> allocated to the container.
  4789. @return <code>Resource</code> allocated to the container]]>
  4790. </doc>
  4791. </method>
  4792. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  4793. abstract="true" native="false" synchronized="false"
  4794. static="false" final="false" visibility="public"
  4795. deprecated="not deprecated">
  4796. <doc>
  4797. <![CDATA[Get the <code>Priority</code> at which the <code>Container</code> was
  4798. allocated.
  4799. @return <code>Priority</code> at which the <code>Container</code> was
  4800. allocated]]>
  4801. </doc>
  4802. </method>
  4803. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  4804. abstract="true" native="false" synchronized="false"
  4805. static="false" final="false" visibility="public"
  4806. deprecated="not deprecated">
  4807. <doc>
  4808. <![CDATA[Get the <code>ContainerToken</code> for the container.
  4809. <p><code>ContainerToken</code> is the security token used by the framework
  4810. to verify authenticity of any <code>Container</code>.</p>
  4811. <p>The <code>ResourceManager</code>, on container allocation provides a
  4812. secure token which is verified by the <code>NodeManager</code> on
  4813. container launch.</p>
  4814. <p>Applications do not need to care about <code>ContainerToken</code>, they
  4815. are transparently handled by the framework - the allocated
  4816. <code>Container</code> includes the <code>ContainerToken</code>.</p>
  4817. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
  4818. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
  4819. @return <code>ContainerToken</code> for the container]]>
  4820. </doc>
  4821. </method>
  4822. <doc>
  4823. <![CDATA[{@code Container} represents an allocated resource in the cluster.
  4824. <p>
  4825. The {@code ResourceManager} is the sole authority to allocate any
  4826. {@code Container} to applications. The allocated {@code Container}
  4827. is always on a single node and has a unique {@link ContainerId}. It has
  4828. a specific amount of {@link Resource} allocated.
  4829. <p>
  4830. It includes details such as:
  4831. <ul>
  4832. <li>{@link ContainerId} for the container, which is globally unique.</li>
  4833. <li>
  4834. {@link NodeId} of the node on which it is allocated.
  4835. </li>
  4836. <li>HTTP uri of the node.</li>
  4837. <li>{@link Resource} allocated to the container.</li>
  4838. <li>{@link Priority} at which the container was allocated.</li>
  4839. <li>
  4840. Container {@link Token} of the container, used to securely verify
  4841. authenticity of the allocation.
  4842. </li>
  4843. </ul>
  4844. Typically, an {@code ApplicationMaster} receives the {@code Container}
  4845. from the {@code ResourceManager} during resource-negotiation and then
  4846. talks to the {@code NodeManager} to start/stop containers.
  4847. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
  4848. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
  4849. @see ContainerManagementProtocol#stopContainers(org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest)]]>
  4850. </doc>
  4851. </class>
  4852. <!-- end class org.apache.hadoop.yarn.api.records.Container -->
  4853. <!-- start class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
  4854. <class name="ContainerExitStatus" extends="java.lang.Object"
  4855. abstract="false"
  4856. static="false" final="false" visibility="public"
  4857. deprecated="not deprecated">
  4858. <constructor name="ContainerExitStatus"
  4859. static="false" final="false" visibility="public"
  4860. deprecated="not deprecated">
  4861. </constructor>
  4862. <field name="SUCCESS" type="int"
  4863. transient="false" volatile="false"
  4864. static="true" final="true" visibility="public"
  4865. deprecated="not deprecated">
  4866. </field>
  4867. <field name="INVALID" type="int"
  4868. transient="false" volatile="false"
  4869. static="true" final="true" visibility="public"
  4870. deprecated="not deprecated">
  4871. </field>
  4872. <field name="ABORTED" type="int"
  4873. transient="false" volatile="false"
  4874. static="true" final="true" visibility="public"
  4875. deprecated="not deprecated">
  4876. <doc>
  4877. <![CDATA[Containers killed by the framework, either due to being released by
  4878. the application or being 'lost' due to node failures etc.]]>
  4879. </doc>
  4880. </field>
  4881. <field name="DISKS_FAILED" type="int"
  4882. transient="false" volatile="false"
  4883. static="true" final="true" visibility="public"
  4884. deprecated="not deprecated">
  4885. <doc>
  4886. <![CDATA[When threshold number of the nodemanager-local-directories or
  4887. threshold number of the nodemanager-log-directories become bad.]]>
  4888. </doc>
  4889. </field>
  4890. <field name="PREEMPTED" type="int"
  4891. transient="false" volatile="false"
  4892. static="true" final="true" visibility="public"
  4893. deprecated="not deprecated">
  4894. <doc>
  4895. <![CDATA[Containers preempted by the framework.]]>
  4896. </doc>
  4897. </field>
  4898. <field name="KILLED_EXCEEDED_VMEM" type="int"
  4899. transient="false" volatile="false"
  4900. static="true" final="true" visibility="public"
  4901. deprecated="not deprecated">
  4902. <doc>
  4903. <![CDATA[Container terminated because of exceeding allocated virtual memory.]]>
  4904. </doc>
  4905. </field>
  4906. <field name="KILLED_EXCEEDED_PMEM" type="int"
  4907. transient="false" volatile="false"
  4908. static="true" final="true" visibility="public"
  4909. deprecated="not deprecated">
  4910. <doc>
  4911. <![CDATA[Container terminated because of exceeding allocated physical memory.]]>
  4912. </doc>
  4913. </field>
  4914. <field name="KILLED_BY_APPMASTER" type="int"
  4915. transient="false" volatile="false"
  4916. static="true" final="true" visibility="public"
  4917. deprecated="not deprecated">
  4918. <doc>
  4919. <![CDATA[Container was terminated by stop request by the app master.]]>
  4920. </doc>
  4921. </field>
  4922. <field name="KILLED_BY_RESOURCEMANAGER" type="int"
  4923. transient="false" volatile="false"
  4924. static="true" final="true" visibility="public"
  4925. deprecated="not deprecated">
  4926. <doc>
  4927. <![CDATA[Container was terminated by the resource manager.]]>
  4928. </doc>
  4929. </field>
  4930. <field name="KILLED_AFTER_APP_COMPLETION" type="int"
  4931. transient="false" volatile="false"
  4932. static="true" final="true" visibility="public"
  4933. deprecated="not deprecated">
  4934. <doc>
  4935. <![CDATA[Container was terminated after the application finished.]]>
  4936. </doc>
  4937. </field>
  4938. <doc>
  4939. <![CDATA[Container exit statuses indicating special exit circumstances.]]>
  4940. </doc>
  4941. </class>
  4942. <!-- end class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
  4943. <!-- start class org.apache.hadoop.yarn.api.records.ContainerId -->
  4944. <class name="ContainerId" extends="java.lang.Object"
  4945. abstract="true"
  4946. static="false" final="false" visibility="public"
  4947. deprecated="not deprecated">
  4948. <implements name="java.lang.Comparable"/>
  4949. <constructor name="ContainerId"
  4950. static="false" final="false" visibility="public"
  4951. deprecated="not deprecated">
  4952. </constructor>
  4953. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  4954. abstract="true" native="false" synchronized="false"
  4955. static="false" final="false" visibility="public"
  4956. deprecated="not deprecated">
  4957. <doc>
  4958. <![CDATA[Get the <code>ApplicationAttemptId</code> of the application to which the
  4959. <code>Container</code> was assigned.
  4960. <p>
  4961. Note: If containers are kept alive across application attempts via
  4962. {@link ApplicationSubmissionContext#setKeepContainersAcrossApplicationAttempts(boolean)}
  4963. the <code>ContainerId</code> does not necessarily contain the current
  4964. running application attempt's <code>ApplicationAttemptId</code> This
  4965. container can be allocated by previously exited application attempt and
  4966. managed by the current running attempt thus have the previous application
  4967. attempt's <code>ApplicationAttemptId</code>.
  4968. </p>
  4969. @return <code>ApplicationAttemptId</code> of the application to which the
  4970. <code>Container</code> was assigned]]>
  4971. </doc>
  4972. </method>
  4973. <method name="getId" return="int"
  4974. abstract="true" native="false" synchronized="false"
  4975. static="false" final="false" visibility="public"
  4976. deprecated="not deprecated">
  4977. <doc>
  4978. <![CDATA[Get the lower 32 bits of identifier of the <code>ContainerId</code>,
  4979. which doesn't include epoch. Note that this method will be marked as
  4980. deprecated, so please use <code>getContainerId</code> instead.
  4981. @return lower 32 bits of identifier of the <code>ContainerId</code>]]>
  4982. </doc>
  4983. </method>
  4984. <method name="getContainerId" return="long"
  4985. abstract="true" native="false" synchronized="false"
  4986. static="false" final="false" visibility="public"
  4987. deprecated="not deprecated">
  4988. <doc>
  4989. <![CDATA[Get the identifier of the <code>ContainerId</code>. Upper 24 bits are
  4990. reserved as epoch of cluster, and lower 40 bits are reserved as
  4991. sequential number of containers.
  4992. @return identifier of the <code>ContainerId</code>]]>
  4993. </doc>
  4994. </method>
  4995. <method name="hashCode" return="int"
  4996. abstract="false" native="false" synchronized="false"
  4997. static="false" final="false" visibility="public"
  4998. deprecated="not deprecated">
  4999. </method>
  5000. <method name="equals" return="boolean"
  5001. abstract="false" native="false" synchronized="false"
  5002. static="false" final="false" visibility="public"
  5003. deprecated="not deprecated">
  5004. <param name="obj" type="java.lang.Object"/>
  5005. </method>
  5006. <method name="compareTo" return="int"
  5007. abstract="false" native="false" synchronized="false"
  5008. static="false" final="false" visibility="public"
  5009. deprecated="not deprecated">
  5010. <param name="other" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5011. </method>
  5012. <method name="toString" return="java.lang.String"
  5013. abstract="false" native="false" synchronized="false"
  5014. static="false" final="false" visibility="public"
  5015. deprecated="not deprecated">
  5016. <doc>
  5017. <![CDATA[@return A string representation of containerId. The format is
  5018. container_e*epoch*_*clusterTimestamp*_*appId*_*attemptId*_*containerId*
  5019. when epoch is larger than 0
  5020. (e.g. container_e17_1410901177871_0001_01_000005).
  5021. *epoch* is increased when RM restarts or fails over.
  5022. When epoch is 0, epoch is omitted
  5023. (e.g. container_1410901177871_0001_01_000005).]]>
  5024. </doc>
  5025. </method>
  5026. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5027. abstract="false" native="false" synchronized="false"
  5028. static="true" final="false" visibility="public"
  5029. deprecated="not deprecated">
  5030. <param name="containerIdStr" type="java.lang.String"/>
  5031. </method>
  5032. <method name="build"
  5033. abstract="true" native="false" synchronized="false"
  5034. static="false" final="false" visibility="protected"
  5035. deprecated="not deprecated">
  5036. </method>
  5037. <field name="CONTAINER_ID_BITMASK" type="long"
  5038. transient="false" volatile="false"
  5039. static="true" final="true" visibility="public"
  5040. deprecated="not deprecated">
  5041. </field>
  5042. <doc>
  5043. <![CDATA[<p><code>ContainerId</code> represents a globally unique identifier
  5044. for a {@link Container} in the cluster.</p>]]>
  5045. </doc>
  5046. </class>
  5047. <!-- end class org.apache.hadoop.yarn.api.records.ContainerId -->
  5048. <!-- start class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
  5049. <class name="ContainerLaunchContext" extends="java.lang.Object"
  5050. abstract="true"
  5051. static="false" final="false" visibility="public"
  5052. deprecated="not deprecated">
  5053. <constructor name="ContainerLaunchContext"
  5054. static="false" final="false" visibility="public"
  5055. deprecated="not deprecated">
  5056. </constructor>
  5057. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  5058. abstract="false" native="false" synchronized="false"
  5059. static="true" final="false" visibility="public"
  5060. deprecated="not deprecated">
  5061. <param name="localResources" type="java.util.Map"/>
  5062. <param name="environment" type="java.util.Map"/>
  5063. <param name="commands" type="java.util.List"/>
  5064. <param name="serviceData" type="java.util.Map"/>
  5065. <param name="tokens" type="java.nio.ByteBuffer"/>
  5066. <param name="acls" type="java.util.Map"/>
  5067. </method>
  5068. <method name="getTokens" return="java.nio.ByteBuffer"
  5069. abstract="true" native="false" synchronized="false"
  5070. static="false" final="false" visibility="public"
  5071. deprecated="not deprecated">
  5072. <doc>
  5073. <![CDATA[Get all the tokens needed by this container. It may include file-system
  5074. tokens, ApplicationMaster related tokens if this container is an
  5075. ApplicationMaster or framework level tokens needed by this container to
  5076. communicate to various services in a secure manner.
  5077. @return tokens needed by this container.]]>
  5078. </doc>
  5079. </method>
  5080. <method name="setTokens"
  5081. abstract="true" native="false" synchronized="false"
  5082. static="false" final="false" visibility="public"
  5083. deprecated="not deprecated">
  5084. <param name="tokens" type="java.nio.ByteBuffer"/>
  5085. <doc>
  5086. <![CDATA[Set security tokens needed by this container.
  5087. @param tokens security tokens]]>
  5088. </doc>
  5089. </method>
  5090. <method name="getLocalResources" return="java.util.Map"
  5091. abstract="true" native="false" synchronized="false"
  5092. static="false" final="false" visibility="public"
  5093. deprecated="not deprecated">
  5094. <doc>
  5095. <![CDATA[Get <code>LocalResource</code> required by the container.
  5096. @return all <code>LocalResource</code> required by the container]]>
  5097. </doc>
  5098. </method>
  5099. <method name="setLocalResources"
  5100. abstract="true" native="false" synchronized="false"
  5101. static="false" final="false" visibility="public"
  5102. deprecated="not deprecated">
  5103. <param name="localResources" type="java.util.Map"/>
  5104. <doc>
  5105. <![CDATA[Set <code>LocalResource</code> required by the container. All pre-existing
  5106. Map entries are cleared before adding the new Map
  5107. @param localResources <code>LocalResource</code> required by the container]]>
  5108. </doc>
  5109. </method>
  5110. <method name="getServiceData" return="java.util.Map"
  5111. abstract="true" native="false" synchronized="false"
  5112. static="false" final="false" visibility="public"
  5113. deprecated="not deprecated">
  5114. <doc>
  5115. <![CDATA[<p>
  5116. Get application-specific binary <em>service data</em>. This is a map keyed
  5117. by the name of each {@link AuxiliaryService} that is configured on a
  5118. NodeManager and value correspond to the application specific data targeted
  5119. for the keyed {@link AuxiliaryService}.
  5120. </p>
  5121. <p>
  5122. This will be used to initialize this application on the specific
  5123. {@link AuxiliaryService} running on the NodeManager by calling
  5124. {@link AuxiliaryService#initializeApplication(ApplicationInitializationContext)}
  5125. </p>
  5126. @return application-specific binary <em>service data</em>]]>
  5127. </doc>
  5128. </method>
  5129. <method name="setServiceData"
  5130. abstract="true" native="false" synchronized="false"
  5131. static="false" final="false" visibility="public"
  5132. deprecated="not deprecated">
  5133. <param name="serviceData" type="java.util.Map"/>
  5134. <doc>
  5135. <![CDATA[<p>
  5136. Set application-specific binary <em>service data</em>. This is a map keyed
  5137. by the name of each {@link AuxiliaryService} that is configured on a
  5138. NodeManager and value correspond to the application specific data targeted
  5139. for the keyed {@link AuxiliaryService}. All pre-existing Map entries are
  5140. preserved.
  5141. </p>
  5142. @param serviceData
  5143. application-specific binary <em>service data</em>]]>
  5144. </doc>
  5145. </method>
  5146. <method name="getEnvironment" return="java.util.Map"
  5147. abstract="true" native="false" synchronized="false"
  5148. static="false" final="false" visibility="public"
  5149. deprecated="not deprecated">
  5150. <doc>
  5151. <![CDATA[Get <em>environment variables</em> for the container.
  5152. @return <em>environment variables</em> for the container]]>
  5153. </doc>
  5154. </method>
  5155. <method name="setEnvironment"
  5156. abstract="true" native="false" synchronized="false"
  5157. static="false" final="false" visibility="public"
  5158. deprecated="not deprecated">
  5159. <param name="environment" type="java.util.Map"/>
  5160. <doc>
  5161. <![CDATA[Add <em>environment variables</em> for the container. All pre-existing Map
  5162. entries are cleared before adding the new Map
  5163. @param environment <em>environment variables</em> for the container]]>
  5164. </doc>
  5165. </method>
  5166. <method name="getCommands" return="java.util.List"
  5167. abstract="true" native="false" synchronized="false"
  5168. static="false" final="false" visibility="public"
  5169. deprecated="not deprecated">
  5170. <doc>
  5171. <![CDATA[Get the list of <em>commands</em> for launching the container.
  5172. @return the list of <em>commands</em> for launching the container]]>
  5173. </doc>
  5174. </method>
  5175. <method name="setCommands"
  5176. abstract="true" native="false" synchronized="false"
  5177. static="false" final="false" visibility="public"
  5178. deprecated="not deprecated">
  5179. <param name="commands" type="java.util.List"/>
  5180. <doc>
  5181. <![CDATA[Add the list of <em>commands</em> for launching the container. All
  5182. pre-existing List entries are cleared before adding the new List
  5183. @param commands the list of <em>commands</em> for launching the container]]>
  5184. </doc>
  5185. </method>
  5186. <method name="getApplicationACLs" return="java.util.Map"
  5187. abstract="true" native="false" synchronized="false"
  5188. static="false" final="false" visibility="public"
  5189. deprecated="not deprecated">
  5190. <doc>
  5191. <![CDATA[Get the <code>ApplicationACL</code>s for the application.
  5192. @return all the <code>ApplicationACL</code>s]]>
  5193. </doc>
  5194. </method>
  5195. <method name="setApplicationACLs"
  5196. abstract="true" native="false" synchronized="false"
  5197. static="false" final="false" visibility="public"
  5198. deprecated="not deprecated">
  5199. <param name="acls" type="java.util.Map"/>
  5200. <doc>
  5201. <![CDATA[Set the <code>ApplicationACL</code>s for the application. All pre-existing
  5202. Map entries are cleared before adding the new Map
  5203. @param acls <code>ApplicationACL</code>s for the application]]>
  5204. </doc>
  5205. </method>
  5206. <doc>
  5207. <![CDATA[{@code ContainerLaunchContext} represents all of the information
  5208. needed by the {@code NodeManager} to launch a container.
  5209. <p>
  5210. It includes details such as:
  5211. <ul>
  5212. <li>{@link ContainerId} of the container.</li>
  5213. <li>{@link Resource} allocated to the container.</li>
  5214. <li>User to whom the container is allocated.</li>
  5215. <li>Security tokens (if security is enabled).</li>
  5216. <li>
  5217. {@link LocalResource} necessary for running the container such
  5218. as binaries, jar, shared-objects, side-files etc.
  5219. </li>
  5220. <li>Optional, application-specific binary service data.</li>
  5221. <li>Environment variables for the launched process.</li>
  5222. <li>Command to launch the container.</li>
  5223. </ul>
  5224. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  5225. </doc>
  5226. </class>
  5227. <!-- end class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
  5228. <!-- start class org.apache.hadoop.yarn.api.records.ContainerReport -->
  5229. <class name="ContainerReport" extends="java.lang.Object"
  5230. abstract="true"
  5231. static="false" final="false" visibility="public"
  5232. deprecated="not deprecated">
  5233. <constructor name="ContainerReport"
  5234. static="false" final="false" visibility="public"
  5235. deprecated="not deprecated">
  5236. </constructor>
  5237. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5238. abstract="true" native="false" synchronized="false"
  5239. static="false" final="false" visibility="public"
  5240. deprecated="not deprecated">
  5241. <doc>
  5242. <![CDATA[Get the <code>ContainerId</code> of the container.
  5243. @return <code>ContainerId</code> of the container.]]>
  5244. </doc>
  5245. </method>
  5246. <method name="setContainerId"
  5247. abstract="true" native="false" synchronized="false"
  5248. static="false" final="false" visibility="public"
  5249. deprecated="not deprecated">
  5250. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5251. </method>
  5252. <method name="getAllocatedResource" return="org.apache.hadoop.yarn.api.records.Resource"
  5253. abstract="true" native="false" synchronized="false"
  5254. static="false" final="false" visibility="public"
  5255. deprecated="not deprecated">
  5256. <doc>
  5257. <![CDATA[Get the allocated <code>Resource</code> of the container.
  5258. @return allocated <code>Resource</code> of the container.]]>
  5259. </doc>
  5260. </method>
  5261. <method name="setAllocatedResource"
  5262. abstract="true" native="false" synchronized="false"
  5263. static="false" final="false" visibility="public"
  5264. deprecated="not deprecated">
  5265. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5266. </method>
  5267. <method name="getAssignedNode" return="org.apache.hadoop.yarn.api.records.NodeId"
  5268. abstract="true" native="false" synchronized="false"
  5269. static="false" final="false" visibility="public"
  5270. deprecated="not deprecated">
  5271. <doc>
  5272. <![CDATA[Get the allocated <code>NodeId</code> where container is running.
  5273. @return allocated <code>NodeId</code> where container is running.]]>
  5274. </doc>
  5275. </method>
  5276. <method name="setAssignedNode"
  5277. abstract="true" native="false" synchronized="false"
  5278. static="false" final="false" visibility="public"
  5279. deprecated="not deprecated">
  5280. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  5281. </method>
  5282. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  5283. abstract="true" native="false" synchronized="false"
  5284. static="false" final="false" visibility="public"
  5285. deprecated="not deprecated">
  5286. <doc>
  5287. <![CDATA[Get the allocated <code>Priority</code> of the container.
  5288. @return allocated <code>Priority</code> of the container.]]>
  5289. </doc>
  5290. </method>
  5291. <method name="setPriority"
  5292. abstract="true" native="false" synchronized="false"
  5293. static="false" final="false" visibility="public"
  5294. deprecated="not deprecated">
  5295. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5296. </method>
  5297. <method name="getCreationTime" return="long"
  5298. abstract="true" native="false" synchronized="false"
  5299. static="false" final="false" visibility="public"
  5300. deprecated="not deprecated">
  5301. <doc>
  5302. <![CDATA[Get the creation time of the container.
  5303. @return creation time of the container]]>
  5304. </doc>
  5305. </method>
  5306. <method name="setCreationTime"
  5307. abstract="true" native="false" synchronized="false"
  5308. static="false" final="false" visibility="public"
  5309. deprecated="not deprecated">
  5310. <param name="creationTime" type="long"/>
  5311. </method>
  5312. <method name="getFinishTime" return="long"
  5313. abstract="true" native="false" synchronized="false"
  5314. static="false" final="false" visibility="public"
  5315. deprecated="not deprecated">
  5316. <doc>
  5317. <![CDATA[Get the Finish time of the container.
  5318. @return Finish time of the container]]>
  5319. </doc>
  5320. </method>
  5321. <method name="setFinishTime"
  5322. abstract="true" native="false" synchronized="false"
  5323. static="false" final="false" visibility="public"
  5324. deprecated="not deprecated">
  5325. <param name="finishTime" type="long"/>
  5326. </method>
  5327. <method name="getDiagnosticsInfo" return="java.lang.String"
  5328. abstract="true" native="false" synchronized="false"
  5329. static="false" final="false" visibility="public"
  5330. deprecated="not deprecated">
  5331. <doc>
  5332. <![CDATA[Get the DiagnosticsInfo of the container.
  5333. @return DiagnosticsInfo of the container]]>
  5334. </doc>
  5335. </method>
  5336. <method name="setDiagnosticsInfo"
  5337. abstract="true" native="false" synchronized="false"
  5338. static="false" final="false" visibility="public"
  5339. deprecated="not deprecated">
  5340. <param name="diagnosticsInfo" type="java.lang.String"/>
  5341. </method>
  5342. <method name="getLogUrl" return="java.lang.String"
  5343. abstract="true" native="false" synchronized="false"
  5344. static="false" final="false" visibility="public"
  5345. deprecated="not deprecated">
  5346. <doc>
  5347. <![CDATA[Get the LogURL of the container.
  5348. @return LogURL of the container]]>
  5349. </doc>
  5350. </method>
  5351. <method name="setLogUrl"
  5352. abstract="true" native="false" synchronized="false"
  5353. static="false" final="false" visibility="public"
  5354. deprecated="not deprecated">
  5355. <param name="logUrl" type="java.lang.String"/>
  5356. </method>
  5357. <method name="getContainerState" return="org.apache.hadoop.yarn.api.records.ContainerState"
  5358. abstract="true" native="false" synchronized="false"
  5359. static="false" final="false" visibility="public"
  5360. deprecated="not deprecated">
  5361. <doc>
  5362. <![CDATA[Get the final <code>ContainerState</code> of the container.
  5363. @return final <code>ContainerState</code> of the container.]]>
  5364. </doc>
  5365. </method>
  5366. <method name="setContainerState"
  5367. abstract="true" native="false" synchronized="false"
  5368. static="false" final="false" visibility="public"
  5369. deprecated="not deprecated">
  5370. <param name="containerState" type="org.apache.hadoop.yarn.api.records.ContainerState"/>
  5371. </method>
  5372. <method name="getContainerExitStatus" return="int"
  5373. abstract="true" native="false" synchronized="false"
  5374. static="false" final="false" visibility="public"
  5375. deprecated="not deprecated">
  5376. <doc>
  5377. <![CDATA[Get the final <code>exit status</code> of the container.
  5378. @return final <code>exit status</code> of the container.]]>
  5379. </doc>
  5380. </method>
  5381. <method name="setContainerExitStatus"
  5382. abstract="true" native="false" synchronized="false"
  5383. static="false" final="false" visibility="public"
  5384. deprecated="not deprecated">
  5385. <param name="containerExitStatus" type="int"/>
  5386. </method>
  5387. <method name="getNodeHttpAddress" return="java.lang.String"
  5388. abstract="true" native="false" synchronized="false"
  5389. static="false" final="false" visibility="public"
  5390. deprecated="not deprecated">
  5391. <doc>
  5392. <![CDATA[Get the Node Http address of the container
  5393. @return the node http address of the container]]>
  5394. </doc>
  5395. </method>
  5396. <doc>
  5397. <![CDATA[{@code ContainerReport} is a report of an container.
  5398. <p>
  5399. It includes details such as:
  5400. <ul>
  5401. <li>{@link ContainerId} of the container.</li>
  5402. <li>Allocated Resources to the container.</li>
  5403. <li>Assigned Node id.</li>
  5404. <li>Assigned Priority.</li>
  5405. <li>Creation Time.</li>
  5406. <li>Finish Time.</li>
  5407. <li>Container Exit Status.</li>
  5408. <li>{@link ContainerState} of the container.</li>
  5409. <li>Diagnostic information in case of errors.</li>
  5410. <li>Log URL.</li>
  5411. <li>nodeHttpAddress</li>
  5412. </ul>]]>
  5413. </doc>
  5414. </class>
  5415. <!-- end class org.apache.hadoop.yarn.api.records.ContainerReport -->
  5416. <!-- start class org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest -->
  5417. <class name="ContainerResourceIncreaseRequest" extends="java.lang.Object"
  5418. abstract="true"
  5419. static="false" final="false" visibility="public"
  5420. deprecated="not deprecated">
  5421. <constructor name="ContainerResourceIncreaseRequest"
  5422. static="false" final="false" visibility="public"
  5423. deprecated="not deprecated">
  5424. </constructor>
  5425. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest"
  5426. abstract="false" native="false" synchronized="false"
  5427. static="true" final="false" visibility="public"
  5428. deprecated="not deprecated">
  5429. <param name="existingContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5430. <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5431. </method>
  5432. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5433. abstract="true" native="false" synchronized="false"
  5434. static="false" final="false" visibility="public"
  5435. deprecated="not deprecated">
  5436. </method>
  5437. <method name="setContainerId"
  5438. abstract="true" native="false" synchronized="false"
  5439. static="false" final="false" visibility="public"
  5440. deprecated="not deprecated">
  5441. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5442. </method>
  5443. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  5444. abstract="true" native="false" synchronized="false"
  5445. static="false" final="false" visibility="public"
  5446. deprecated="not deprecated">
  5447. </method>
  5448. <method name="setCapability"
  5449. abstract="true" native="false" synchronized="false"
  5450. static="false" final="false" visibility="public"
  5451. deprecated="not deprecated">
  5452. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5453. </method>
  5454. <method name="hashCode" return="int"
  5455. abstract="false" native="false" synchronized="false"
  5456. static="false" final="false" visibility="public"
  5457. deprecated="not deprecated">
  5458. </method>
  5459. <method name="equals" return="boolean"
  5460. abstract="false" native="false" synchronized="false"
  5461. static="false" final="false" visibility="public"
  5462. deprecated="not deprecated">
  5463. <param name="other" type="java.lang.Object"/>
  5464. </method>
  5465. <doc>
  5466. <![CDATA[Used by Application Master, send a container resource increase request to
  5467. Resource Manager]]>
  5468. </doc>
  5469. </class>
  5470. <!-- end class org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest -->
  5471. <!-- start class org.apache.hadoop.yarn.api.records.ContainerState -->
  5472. <class name="ContainerState" extends="java.lang.Enum"
  5473. abstract="false"
  5474. static="false" final="true" visibility="public"
  5475. deprecated="not deprecated">
  5476. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerState[]"
  5477. abstract="false" native="false" synchronized="false"
  5478. static="true" final="false" visibility="public"
  5479. deprecated="not deprecated">
  5480. </method>
  5481. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerState"
  5482. abstract="false" native="false" synchronized="false"
  5483. static="true" final="false" visibility="public"
  5484. deprecated="not deprecated">
  5485. <param name="name" type="java.lang.String"/>
  5486. </method>
  5487. <doc>
  5488. <![CDATA[<p>State of a <code>Container</code>.</p>]]>
  5489. </doc>
  5490. </class>
  5491. <!-- end class org.apache.hadoop.yarn.api.records.ContainerState -->
  5492. <!-- start class org.apache.hadoop.yarn.api.records.ContainerStatus -->
  5493. <class name="ContainerStatus" extends="java.lang.Object"
  5494. abstract="true"
  5495. static="false" final="false" visibility="public"
  5496. deprecated="not deprecated">
  5497. <constructor name="ContainerStatus"
  5498. static="false" final="false" visibility="public"
  5499. deprecated="not deprecated">
  5500. </constructor>
  5501. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5502. abstract="true" native="false" synchronized="false"
  5503. static="false" final="false" visibility="public"
  5504. deprecated="not deprecated">
  5505. <doc>
  5506. <![CDATA[Get the <code>ContainerId</code> of the container.
  5507. @return <code>ContainerId</code> of the container]]>
  5508. </doc>
  5509. </method>
  5510. <method name="getState" return="org.apache.hadoop.yarn.api.records.ContainerState"
  5511. abstract="true" native="false" synchronized="false"
  5512. static="false" final="false" visibility="public"
  5513. deprecated="not deprecated">
  5514. <doc>
  5515. <![CDATA[Get the <code>ContainerState</code> of the container.
  5516. @return <code>ContainerState</code> of the container]]>
  5517. </doc>
  5518. </method>
  5519. <method name="getExitStatus" return="int"
  5520. abstract="true" native="false" synchronized="false"
  5521. static="false" final="false" visibility="public"
  5522. deprecated="not deprecated">
  5523. <doc>
  5524. <![CDATA[<p>Get the <em>exit status</em> for the container.</p>
  5525. <p>Note: This is valid only for completed containers i.e. containers
  5526. with state {@link ContainerState#COMPLETE}.
  5527. Otherwise, it returns an ContainerExitStatus.INVALID.
  5528. </p>
  5529. <p>Containers killed by the framework, either due to being released by
  5530. the application or being 'lost' due to node failures etc. have a special
  5531. exit code of ContainerExitStatus.ABORTED.</p>
  5532. <p>When threshold number of the nodemanager-local-directories or
  5533. threshold number of the nodemanager-log-directories become bad, then
  5534. container is not launched and is exited with ContainersExitStatus.DISKS_FAILED.
  5535. </p>
  5536. @return <em>exit status</em> for the container]]>
  5537. </doc>
  5538. </method>
  5539. <method name="getDiagnostics" return="java.lang.String"
  5540. abstract="true" native="false" synchronized="false"
  5541. static="false" final="false" visibility="public"
  5542. deprecated="not deprecated">
  5543. <doc>
  5544. <![CDATA[Get <em>diagnostic messages</em> for failed containers.
  5545. @return <em>diagnostic messages</em> for failed containers]]>
  5546. </doc>
  5547. </method>
  5548. <doc>
  5549. <![CDATA[{@code ContainerStatus} represents the current status of a
  5550. {@code Container}.
  5551. <p>
  5552. It provides details such as:
  5553. <ul>
  5554. <li>{@code ContainerId} of the container.</li>
  5555. <li>{@code ContainerState} of the container.</li>
  5556. <li><em>Exit status</em> of a completed container.</li>
  5557. <li><em>Diagnostic</em> message for a failed container.</li>
  5558. </ul>]]>
  5559. </doc>
  5560. </class>
  5561. <!-- end class org.apache.hadoop.yarn.api.records.ContainerStatus -->
  5562. <!-- start class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
  5563. <class name="FinalApplicationStatus" extends="java.lang.Enum"
  5564. abstract="false"
  5565. static="false" final="true" visibility="public"
  5566. deprecated="not deprecated">
  5567. <method name="values" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus[]"
  5568. abstract="false" native="false" synchronized="false"
  5569. static="true" final="false" visibility="public"
  5570. deprecated="not deprecated">
  5571. </method>
  5572. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  5573. abstract="false" native="false" synchronized="false"
  5574. static="true" final="false" visibility="public"
  5575. deprecated="not deprecated">
  5576. <param name="name" type="java.lang.String"/>
  5577. </method>
  5578. <doc>
  5579. <![CDATA[Enumeration of various final states of an <code>Application</code>.]]>
  5580. </doc>
  5581. </class>
  5582. <!-- end class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
  5583. <!-- start class org.apache.hadoop.yarn.api.records.LocalResource -->
  5584. <class name="LocalResource" extends="java.lang.Object"
  5585. abstract="true"
  5586. static="false" final="false" visibility="public"
  5587. deprecated="not deprecated">
  5588. <constructor name="LocalResource"
  5589. static="false" final="false" visibility="public"
  5590. deprecated="not deprecated">
  5591. </constructor>
  5592. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  5593. abstract="false" native="false" synchronized="false"
  5594. static="true" final="false" visibility="public"
  5595. deprecated="not deprecated">
  5596. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  5597. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  5598. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  5599. <param name="size" type="long"/>
  5600. <param name="timestamp" type="long"/>
  5601. <param name="pattern" type="java.lang.String"/>
  5602. </method>
  5603. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  5604. abstract="false" native="false" synchronized="false"
  5605. static="true" final="false" visibility="public"
  5606. deprecated="not deprecated">
  5607. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  5608. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  5609. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  5610. <param name="size" type="long"/>
  5611. <param name="timestamp" type="long"/>
  5612. <param name="pattern" type="java.lang.String"/>
  5613. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  5614. </method>
  5615. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  5616. abstract="false" native="false" synchronized="false"
  5617. static="true" final="false" visibility="public"
  5618. deprecated="not deprecated">
  5619. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  5620. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  5621. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  5622. <param name="size" type="long"/>
  5623. <param name="timestamp" type="long"/>
  5624. </method>
  5625. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  5626. abstract="false" native="false" synchronized="false"
  5627. static="true" final="false" visibility="public"
  5628. deprecated="not deprecated">
  5629. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  5630. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  5631. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  5632. <param name="size" type="long"/>
  5633. <param name="timestamp" type="long"/>
  5634. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  5635. </method>
  5636. <method name="getResource" return="org.apache.hadoop.yarn.api.records.URL"
  5637. abstract="true" native="false" synchronized="false"
  5638. static="false" final="false" visibility="public"
  5639. deprecated="not deprecated">
  5640. <doc>
  5641. <![CDATA[Get the <em>location</em> of the resource to be localized.
  5642. @return <em>location</em> of the resource to be localized]]>
  5643. </doc>
  5644. </method>
  5645. <method name="setResource"
  5646. abstract="true" native="false" synchronized="false"
  5647. static="false" final="false" visibility="public"
  5648. deprecated="not deprecated">
  5649. <param name="resource" type="org.apache.hadoop.yarn.api.records.URL"/>
  5650. <doc>
  5651. <![CDATA[Set <em>location</em> of the resource to be localized.
  5652. @param resource <em>location</em> of the resource to be localized]]>
  5653. </doc>
  5654. </method>
  5655. <method name="getSize" return="long"
  5656. abstract="true" native="false" synchronized="false"
  5657. static="false" final="false" visibility="public"
  5658. deprecated="not deprecated">
  5659. <doc>
  5660. <![CDATA[Get the <em>size</em> of the resource to be localized.
  5661. @return <em>size</em> of the resource to be localized]]>
  5662. </doc>
  5663. </method>
  5664. <method name="setSize"
  5665. abstract="true" native="false" synchronized="false"
  5666. static="false" final="false" visibility="public"
  5667. deprecated="not deprecated">
  5668. <param name="size" type="long"/>
  5669. <doc>
  5670. <![CDATA[Set the <em>size</em> of the resource to be localized.
  5671. @param size <em>size</em> of the resource to be localized]]>
  5672. </doc>
  5673. </method>
  5674. <method name="getTimestamp" return="long"
  5675. abstract="true" native="false" synchronized="false"
  5676. static="false" final="false" visibility="public"
  5677. deprecated="not deprecated">
  5678. <doc>
  5679. <![CDATA[Get the original <em>timestamp</em> of the resource to be localized, used
  5680. for verification.
  5681. @return <em>timestamp</em> of the resource to be localized]]>
  5682. </doc>
  5683. </method>
  5684. <method name="setTimestamp"
  5685. abstract="true" native="false" synchronized="false"
  5686. static="false" final="false" visibility="public"
  5687. deprecated="not deprecated">
  5688. <param name="timestamp" type="long"/>
  5689. <doc>
  5690. <![CDATA[Set the <em>timestamp</em> of the resource to be localized, used
  5691. for verification.
  5692. @param timestamp <em>timestamp</em> of the resource to be localized]]>
  5693. </doc>
  5694. </method>
  5695. <method name="getType" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
  5696. abstract="true" native="false" synchronized="false"
  5697. static="false" final="false" visibility="public"
  5698. deprecated="not deprecated">
  5699. <doc>
  5700. <![CDATA[Get the <code>LocalResourceType</code> of the resource to be localized.
  5701. @return <code>LocalResourceType</code> of the resource to be localized]]>
  5702. </doc>
  5703. </method>
  5704. <method name="setType"
  5705. abstract="true" native="false" synchronized="false"
  5706. static="false" final="false" visibility="public"
  5707. deprecated="not deprecated">
  5708. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  5709. <doc>
  5710. <![CDATA[Set the <code>LocalResourceType</code> of the resource to be localized.
  5711. @param type <code>LocalResourceType</code> of the resource to be localized]]>
  5712. </doc>
  5713. </method>
  5714. <method name="getVisibility" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
  5715. abstract="true" native="false" synchronized="false"
  5716. static="false" final="false" visibility="public"
  5717. deprecated="not deprecated">
  5718. <doc>
  5719. <![CDATA[Get the <code>LocalResourceVisibility</code> of the resource to be
  5720. localized.
  5721. @return <code>LocalResourceVisibility</code> of the resource to be
  5722. localized]]>
  5723. </doc>
  5724. </method>
  5725. <method name="setVisibility"
  5726. abstract="true" native="false" synchronized="false"
  5727. static="false" final="false" visibility="public"
  5728. deprecated="not deprecated">
  5729. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  5730. <doc>
  5731. <![CDATA[Set the <code>LocalResourceVisibility</code> of the resource to be
  5732. localized.
  5733. @param visibility <code>LocalResourceVisibility</code> of the resource to be
  5734. localized]]>
  5735. </doc>
  5736. </method>
  5737. <method name="getPattern" return="java.lang.String"
  5738. abstract="true" native="false" synchronized="false"
  5739. static="false" final="false" visibility="public"
  5740. deprecated="not deprecated">
  5741. <doc>
  5742. <![CDATA[Get the <em>pattern</em> that should be used to extract entries from the
  5743. archive (only used when type is <code>PATTERN</code>).
  5744. @return <em>pattern</em> that should be used to extract entries from the
  5745. archive.]]>
  5746. </doc>
  5747. </method>
  5748. <method name="setPattern"
  5749. abstract="true" native="false" synchronized="false"
  5750. static="false" final="false" visibility="public"
  5751. deprecated="not deprecated">
  5752. <param name="pattern" type="java.lang.String"/>
  5753. <doc>
  5754. <![CDATA[Set the <em>pattern</em> that should be used to extract entries from the
  5755. archive (only used when type is <code>PATTERN</code>).
  5756. @param pattern <em>pattern</em> that should be used to extract entries
  5757. from the archive.]]>
  5758. </doc>
  5759. </method>
  5760. <method name="getShouldBeUploadedToSharedCache" return="boolean"
  5761. abstract="true" native="false" synchronized="false"
  5762. static="false" final="false" visibility="public"
  5763. deprecated="not deprecated">
  5764. <doc>
  5765. <![CDATA[NM uses it to decide whether if it is necessary to upload the resource to
  5766. the shared cache]]>
  5767. </doc>
  5768. </method>
  5769. <method name="setShouldBeUploadedToSharedCache"
  5770. abstract="true" native="false" synchronized="false"
  5771. static="false" final="false" visibility="public"
  5772. deprecated="not deprecated">
  5773. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  5774. <doc>
  5775. <![CDATA[Inform NM whether upload to SCM is needed.
  5776. @param shouldBeUploadedToSharedCache <em>shouldBeUploadedToSharedCache</em>
  5777. of this request]]>
  5778. </doc>
  5779. </method>
  5780. <doc>
  5781. <![CDATA[<p><code>LocalResource</code> represents a local resource required to
  5782. run a container.</p>
  5783. <p>The <code>NodeManager</code> is responsible for localizing the resource
  5784. prior to launching the container.</p>
  5785. <p>Applications can specify {@link LocalResourceType} and
  5786. {@link LocalResourceVisibility}.</p>
  5787. @see LocalResourceType
  5788. @see LocalResourceVisibility
  5789. @see ContainerLaunchContext
  5790. @see ApplicationSubmissionContext
  5791. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  5792. </doc>
  5793. </class>
  5794. <!-- end class org.apache.hadoop.yarn.api.records.LocalResource -->
  5795. <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceType -->
  5796. <class name="LocalResourceType" extends="java.lang.Enum"
  5797. abstract="false"
  5798. static="false" final="true" visibility="public"
  5799. deprecated="not deprecated">
  5800. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceType[]"
  5801. abstract="false" native="false" synchronized="false"
  5802. static="true" final="false" visibility="public"
  5803. deprecated="not deprecated">
  5804. </method>
  5805. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
  5806. abstract="false" native="false" synchronized="false"
  5807. static="true" final="false" visibility="public"
  5808. deprecated="not deprecated">
  5809. <param name="name" type="java.lang.String"/>
  5810. </method>
  5811. <doc>
  5812. <![CDATA[{@code LocalResourceType} specifies the <em>type</em>
  5813. of a resource localized by the {@code NodeManager}.
  5814. <p>
  5815. The <em>type</em> can be one of:
  5816. <ul>
  5817. <li>
  5818. {@link #FILE} - Regular file i.e. uninterpreted bytes.
  5819. </li>
  5820. <li>
  5821. {@link #ARCHIVE} - Archive, which is automatically unarchived by the
  5822. <code>NodeManager</code>.
  5823. </li>
  5824. <li>
  5825. {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}.
  5826. </li>
  5827. </ul>
  5828. @see LocalResource
  5829. @see ContainerLaunchContext
  5830. @see ApplicationSubmissionContext
  5831. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  5832. </doc>
  5833. </class>
  5834. <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceType -->
  5835. <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
  5836. <class name="LocalResourceVisibility" extends="java.lang.Enum"
  5837. abstract="false"
  5838. static="false" final="true" visibility="public"
  5839. deprecated="not deprecated">
  5840. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility[]"
  5841. abstract="false" native="false" synchronized="false"
  5842. static="true" final="false" visibility="public"
  5843. deprecated="not deprecated">
  5844. </method>
  5845. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
  5846. abstract="false" native="false" synchronized="false"
  5847. static="true" final="false" visibility="public"
  5848. deprecated="not deprecated">
  5849. <param name="name" type="java.lang.String"/>
  5850. </method>
  5851. <doc>
  5852. <![CDATA[{@code LocalResourceVisibility} specifies the <em>visibility</em>
  5853. of a resource localized by the {@code NodeManager}.
  5854. <p>
  5855. The <em>visibility</em> can be one of:
  5856. <ul>
  5857. <li>{@link #PUBLIC} - Shared by all users on the node.</li>
  5858. <li>
  5859. {@link #PRIVATE} - Shared among all applications of the
  5860. <em>same user</em> on the node.
  5861. </li>
  5862. <li>
  5863. {@link #APPLICATION} - Shared only among containers of the
  5864. <em>same application</em> on the node.
  5865. </li>
  5866. </ul>
  5867. @see LocalResource
  5868. @see ContainerLaunchContext
  5869. @see ApplicationSubmissionContext
  5870. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  5871. </doc>
  5872. </class>
  5873. <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
  5874. <!-- start class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
  5875. <class name="LogAggregationContext" extends="java.lang.Object"
  5876. abstract="true"
  5877. static="false" final="false" visibility="public"
  5878. deprecated="not deprecated">
  5879. <constructor name="LogAggregationContext"
  5880. static="false" final="false" visibility="public"
  5881. deprecated="not deprecated">
  5882. </constructor>
  5883. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  5884. abstract="false" native="false" synchronized="false"
  5885. static="true" final="false" visibility="public"
  5886. deprecated="not deprecated">
  5887. <param name="includePattern" type="java.lang.String"/>
  5888. <param name="excludePattern" type="java.lang.String"/>
  5889. </method>
  5890. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  5891. abstract="false" native="false" synchronized="false"
  5892. static="true" final="false" visibility="public"
  5893. deprecated="not deprecated">
  5894. <param name="includePattern" type="java.lang.String"/>
  5895. <param name="excludePattern" type="java.lang.String"/>
  5896. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  5897. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  5898. </method>
  5899. <method name="getIncludePattern" return="java.lang.String"
  5900. abstract="true" native="false" synchronized="false"
  5901. static="false" final="false" visibility="public"
  5902. deprecated="not deprecated">
  5903. <doc>
  5904. <![CDATA[Get include pattern. This includePattern only takes affect
  5905. on logs that exist at the time of application finish.
  5906. @return include pattern]]>
  5907. </doc>
  5908. </method>
  5909. <method name="setIncludePattern"
  5910. abstract="true" native="false" synchronized="false"
  5911. static="false" final="false" visibility="public"
  5912. deprecated="not deprecated">
  5913. <param name="includePattern" type="java.lang.String"/>
  5914. <doc>
  5915. <![CDATA[Set include pattern. This includePattern only takes affect
  5916. on logs that exist at the time of application finish.
  5917. @param includePattern]]>
  5918. </doc>
  5919. </method>
  5920. <method name="getExcludePattern" return="java.lang.String"
  5921. abstract="true" native="false" synchronized="false"
  5922. static="false" final="false" visibility="public"
  5923. deprecated="not deprecated">
  5924. <doc>
  5925. <![CDATA[Get exclude pattern. This excludePattern only takes affect
  5926. on logs that exist at the time of application finish.
  5927. @return exclude pattern]]>
  5928. </doc>
  5929. </method>
  5930. <method name="setExcludePattern"
  5931. abstract="true" native="false" synchronized="false"
  5932. static="false" final="false" visibility="public"
  5933. deprecated="not deprecated">
  5934. <param name="excludePattern" type="java.lang.String"/>
  5935. <doc>
  5936. <![CDATA[Set exclude pattern. This excludePattern only takes affect
  5937. on logs that exist at the time of application finish.
  5938. @param excludePattern]]>
  5939. </doc>
  5940. </method>
  5941. <method name="getRolledLogsIncludePattern" return="java.lang.String"
  5942. abstract="true" native="false" synchronized="false"
  5943. static="false" final="false" visibility="public"
  5944. deprecated="not deprecated">
  5945. <doc>
  5946. <![CDATA[Get include pattern in a rolling fashion.
  5947. @return include pattern]]>
  5948. </doc>
  5949. </method>
  5950. <method name="setRolledLogsIncludePattern"
  5951. abstract="true" native="false" synchronized="false"
  5952. static="false" final="false" visibility="public"
  5953. deprecated="not deprecated">
  5954. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  5955. <doc>
  5956. <![CDATA[Set include pattern in a rolling fashion.
  5957. @param rolledLogsIncludePattern]]>
  5958. </doc>
  5959. </method>
  5960. <method name="getRolledLogsExcludePattern" return="java.lang.String"
  5961. abstract="true" native="false" synchronized="false"
  5962. static="false" final="false" visibility="public"
  5963. deprecated="not deprecated">
  5964. <doc>
  5965. <![CDATA[Get exclude pattern for aggregation in a rolling fashion.
  5966. @return exclude pattern]]>
  5967. </doc>
  5968. </method>
  5969. <method name="setRolledLogsExcludePattern"
  5970. abstract="true" native="false" synchronized="false"
  5971. static="false" final="false" visibility="public"
  5972. deprecated="not deprecated">
  5973. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  5974. <doc>
  5975. <![CDATA[Set exclude pattern for in a rolling fashion.
  5976. @param rolledLogsExcludePattern]]>
  5977. </doc>
  5978. </method>
  5979. <doc>
  5980. <![CDATA[{@code LogAggregationContext} represents all of the
  5981. information needed by the {@code NodeManager} to handle
  5982. the logs for an application.
  5983. <p>
  5984. It includes details such as:
  5985. <ul>
  5986. <li>
  5987. includePattern. It uses Java Regex to filter the log files
  5988. which match the defined include pattern and those log files
  5989. will be uploaded when the application finishes.
  5990. </li>
  5991. <li>
  5992. excludePattern. It uses Java Regex to filter the log files
  5993. which match the defined exclude pattern and those log files
  5994. will not be uploaded when application finishes. If the log file
  5995. name matches both the include and the exclude pattern, this file
  5996. will be excluded eventually.
  5997. </li>
  5998. <li>
  5999. rolledLogsIncludePattern. It uses Java Regex to filter the log files
  6000. which match the defined include pattern and those log files
  6001. will be aggregated in a rolling fashion.
  6002. </li>
  6003. <li>
  6004. rolledLogsExcludePattern. It uses Java Regex to filter the log files
  6005. which match the defined exclude pattern and those log files
  6006. will not be aggregated in a rolling fashion. If the log file
  6007. name matches both the include and the exclude pattern, this file
  6008. will be excluded eventually.
  6009. </li>
  6010. </ul>
  6011. @see ApplicationSubmissionContext]]>
  6012. </doc>
  6013. </class>
  6014. <!-- end class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
  6015. <!-- start class org.apache.hadoop.yarn.api.records.NMToken -->
  6016. <class name="NMToken" extends="java.lang.Object"
  6017. abstract="true"
  6018. static="false" final="false" visibility="public"
  6019. deprecated="not deprecated">
  6020. <constructor name="NMToken"
  6021. static="false" final="false" visibility="public"
  6022. deprecated="not deprecated">
  6023. </constructor>
  6024. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  6025. abstract="true" native="false" synchronized="false"
  6026. static="false" final="false" visibility="public"
  6027. deprecated="not deprecated">
  6028. <doc>
  6029. <![CDATA[Get the {@link NodeId} of the <code>NodeManager</code> for which the NMToken
  6030. is used to authenticate.
  6031. @return the {@link NodeId} of the <code>NodeManager</code> for which the
  6032. NMToken is used to authenticate.]]>
  6033. </doc>
  6034. </method>
  6035. <method name="setNodeId"
  6036. abstract="true" native="false" synchronized="false"
  6037. static="false" final="false" visibility="public"
  6038. deprecated="not deprecated">
  6039. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  6040. </method>
  6041. <method name="getToken" return="org.apache.hadoop.yarn.api.records.Token"
  6042. abstract="true" native="false" synchronized="false"
  6043. static="false" final="false" visibility="public"
  6044. deprecated="not deprecated">
  6045. <doc>
  6046. <![CDATA[Get the {@link Token} used for authenticating with <code>NodeManager</code>
  6047. @return the {@link Token} used for authenticating with <code>NodeManager</code>]]>
  6048. </doc>
  6049. </method>
  6050. <method name="setToken"
  6051. abstract="true" native="false" synchronized="false"
  6052. static="false" final="false" visibility="public"
  6053. deprecated="not deprecated">
  6054. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  6055. </method>
  6056. <method name="hashCode" return="int"
  6057. abstract="false" native="false" synchronized="false"
  6058. static="false" final="false" visibility="public"
  6059. deprecated="not deprecated">
  6060. </method>
  6061. <method name="equals" return="boolean"
  6062. abstract="false" native="false" synchronized="false"
  6063. static="false" final="false" visibility="public"
  6064. deprecated="not deprecated">
  6065. <param name="obj" type="java.lang.Object"/>
  6066. </method>
  6067. <doc>
  6068. <![CDATA[<p>The NMToken is used for authenticating communication with
  6069. <code>NodeManager</code></p>
  6070. <p>It is issued by <code>ResourceMananger</code> when <code>ApplicationMaster</code>
  6071. negotiates resource with <code>ResourceManager</code> and
  6072. validated on <code>NodeManager</code> side.</p>
  6073. @see AllocateResponse#getNMTokens()]]>
  6074. </doc>
  6075. </class>
  6076. <!-- end class org.apache.hadoop.yarn.api.records.NMToken -->
  6077. <!-- start class org.apache.hadoop.yarn.api.records.NodeId -->
  6078. <class name="NodeId" extends="java.lang.Object"
  6079. abstract="true"
  6080. static="false" final="false" visibility="public"
  6081. deprecated="not deprecated">
  6082. <implements name="java.lang.Comparable"/>
  6083. <constructor name="NodeId"
  6084. static="false" final="false" visibility="public"
  6085. deprecated="not deprecated">
  6086. </constructor>
  6087. <method name="getHost" return="java.lang.String"
  6088. abstract="true" native="false" synchronized="false"
  6089. static="false" final="false" visibility="public"
  6090. deprecated="not deprecated">
  6091. <doc>
  6092. <![CDATA[Get the <em>hostname</em> of the node.
  6093. @return <em>hostname</em> of the node]]>
  6094. </doc>
  6095. </method>
  6096. <method name="getPort" return="int"
  6097. abstract="true" native="false" synchronized="false"
  6098. static="false" final="false" visibility="public"
  6099. deprecated="not deprecated">
  6100. <doc>
  6101. <![CDATA[Get the <em>port</em> for communicating with the node.
  6102. @return <em>port</em> for communicating with the node]]>
  6103. </doc>
  6104. </method>
  6105. <method name="toString" return="java.lang.String"
  6106. abstract="false" native="false" synchronized="false"
  6107. static="false" final="false" visibility="public"
  6108. deprecated="not deprecated">
  6109. </method>
  6110. <method name="hashCode" return="int"
  6111. abstract="false" native="false" synchronized="false"
  6112. static="false" final="false" visibility="public"
  6113. deprecated="not deprecated">
  6114. </method>
  6115. <method name="equals" return="boolean"
  6116. abstract="false" native="false" synchronized="false"
  6117. static="false" final="false" visibility="public"
  6118. deprecated="not deprecated">
  6119. <param name="obj" type="java.lang.Object"/>
  6120. </method>
  6121. <method name="compareTo" return="int"
  6122. abstract="false" native="false" synchronized="false"
  6123. static="false" final="false" visibility="public"
  6124. deprecated="not deprecated">
  6125. <param name="other" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  6126. </method>
  6127. <method name="build"
  6128. abstract="true" native="false" synchronized="false"
  6129. static="false" final="false" visibility="protected"
  6130. deprecated="not deprecated">
  6131. </method>
  6132. <doc>
  6133. <![CDATA[<p><code>NodeId</code> is the unique identifier for a node.</p>
  6134. <p>It includes the <em>hostname</em> and <em>port</em> to uniquely
  6135. identify the node. Thus, it is unique across restarts of any
  6136. <code>NodeManager</code>.</p>]]>
  6137. </doc>
  6138. </class>
  6139. <!-- end class org.apache.hadoop.yarn.api.records.NodeId -->
  6140. <!-- start class org.apache.hadoop.yarn.api.records.NodeReport -->
  6141. <class name="NodeReport" extends="java.lang.Object"
  6142. abstract="true"
  6143. static="false" final="false" visibility="public"
  6144. deprecated="not deprecated">
  6145. <constructor name="NodeReport"
  6146. static="false" final="false" visibility="public"
  6147. deprecated="not deprecated">
  6148. </constructor>
  6149. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  6150. abstract="true" native="false" synchronized="false"
  6151. static="false" final="false" visibility="public"
  6152. deprecated="not deprecated">
  6153. <doc>
  6154. <![CDATA[Get the <code>NodeId</code> of the node.
  6155. @return <code>NodeId</code> of the node]]>
  6156. </doc>
  6157. </method>
  6158. <method name="getNodeState" return="org.apache.hadoop.yarn.api.records.NodeState"
  6159. abstract="true" native="false" synchronized="false"
  6160. static="false" final="false" visibility="public"
  6161. deprecated="not deprecated">
  6162. <doc>
  6163. <![CDATA[Get the <code>NodeState</code> of the node.
  6164. @return <code>NodeState</code> of the node]]>
  6165. </doc>
  6166. </method>
  6167. <method name="getHttpAddress" return="java.lang.String"
  6168. abstract="true" native="false" synchronized="false"
  6169. static="false" final="false" visibility="public"
  6170. deprecated="not deprecated">
  6171. <doc>
  6172. <![CDATA[Get the <em>http address</em> of the node.
  6173. @return <em>http address</em> of the node]]>
  6174. </doc>
  6175. </method>
  6176. <method name="getRackName" return="java.lang.String"
  6177. abstract="true" native="false" synchronized="false"
  6178. static="false" final="false" visibility="public"
  6179. deprecated="not deprecated">
  6180. <doc>
  6181. <![CDATA[Get the <em>rack name</em> for the node.
  6182. @return <em>rack name</em> for the node]]>
  6183. </doc>
  6184. </method>
  6185. <method name="getUsed" return="org.apache.hadoop.yarn.api.records.Resource"
  6186. abstract="true" native="false" synchronized="false"
  6187. static="false" final="false" visibility="public"
  6188. deprecated="not deprecated">
  6189. <doc>
  6190. <![CDATA[Get <em>used</em> <code>Resource</code> on the node.
  6191. @return <em>used</em> <code>Resource</code> on the node]]>
  6192. </doc>
  6193. </method>
  6194. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  6195. abstract="true" native="false" synchronized="false"
  6196. static="false" final="false" visibility="public"
  6197. deprecated="not deprecated">
  6198. <doc>
  6199. <![CDATA[Get the <em>total</em> <code>Resource</code> on the node.
  6200. @return <em>total</em> <code>Resource</code> on the node]]>
  6201. </doc>
  6202. </method>
  6203. <method name="getHealthReport" return="java.lang.String"
  6204. abstract="true" native="false" synchronized="false"
  6205. static="false" final="false" visibility="public"
  6206. deprecated="not deprecated">
  6207. <doc>
  6208. <![CDATA[Get the <em>diagnostic health report</em> of the node.
  6209. @return <em>diagnostic health report</em> of the node]]>
  6210. </doc>
  6211. </method>
  6212. <method name="getLastHealthReportTime" return="long"
  6213. abstract="true" native="false" synchronized="false"
  6214. static="false" final="false" visibility="public"
  6215. deprecated="not deprecated">
  6216. <doc>
  6217. <![CDATA[Get the <em>last timestamp</em> at which the health report was received.
  6218. @return <em>last timestamp</em> at which the health report was received]]>
  6219. </doc>
  6220. </method>
  6221. <method name="getNodeLabels" return="java.util.Set"
  6222. abstract="true" native="false" synchronized="false"
  6223. static="false" final="false" visibility="public"
  6224. deprecated="not deprecated">
  6225. <doc>
  6226. <![CDATA[Get labels of this node
  6227. @return labels of this node]]>
  6228. </doc>
  6229. </method>
  6230. <doc>
  6231. <![CDATA[{@code NodeReport} is a summary of runtime information of a node
  6232. in the cluster.
  6233. <p>
  6234. It includes details such as:
  6235. <ul>
  6236. <li>{@link NodeId} of the node.</li>
  6237. <li>HTTP Tracking URL of the node.</li>
  6238. <li>Rack name for the node.</li>
  6239. <li>Used {@link Resource} on the node.</li>
  6240. <li>Total available {@link Resource} of the node.</li>
  6241. <li>Number of running containers on the node.</li>
  6242. </ul>
  6243. @see ApplicationClientProtocol#getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)]]>
  6244. </doc>
  6245. </class>
  6246. <!-- end class org.apache.hadoop.yarn.api.records.NodeReport -->
  6247. <!-- start class org.apache.hadoop.yarn.api.records.NodeState -->
  6248. <class name="NodeState" extends="java.lang.Enum"
  6249. abstract="false"
  6250. static="false" final="true" visibility="public"
  6251. deprecated="not deprecated">
  6252. <method name="values" return="org.apache.hadoop.yarn.api.records.NodeState[]"
  6253. abstract="false" native="false" synchronized="false"
  6254. static="true" final="false" visibility="public"
  6255. deprecated="not deprecated">
  6256. </method>
  6257. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.NodeState"
  6258. abstract="false" native="false" synchronized="false"
  6259. static="true" final="false" visibility="public"
  6260. deprecated="not deprecated">
  6261. <param name="name" type="java.lang.String"/>
  6262. </method>
  6263. <method name="isUnusable" return="boolean"
  6264. abstract="false" native="false" synchronized="false"
  6265. static="false" final="false" visibility="public"
  6266. deprecated="not deprecated">
  6267. </method>
  6268. <doc>
  6269. <![CDATA[<p>State of a <code>Node</code>.</p>]]>
  6270. </doc>
  6271. </class>
  6272. <!-- end class org.apache.hadoop.yarn.api.records.NodeState -->
  6273. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
  6274. <class name="PreemptionContainer" extends="java.lang.Object"
  6275. abstract="true"
  6276. static="false" final="false" visibility="public"
  6277. deprecated="not deprecated">
  6278. <constructor name="PreemptionContainer"
  6279. static="false" final="false" visibility="public"
  6280. deprecated="not deprecated">
  6281. </constructor>
  6282. <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  6283. abstract="true" native="false" synchronized="false"
  6284. static="false" final="false" visibility="public"
  6285. deprecated="not deprecated">
  6286. <doc>
  6287. <![CDATA[@return Container referenced by this handle.]]>
  6288. </doc>
  6289. </method>
  6290. <doc>
  6291. <![CDATA[Specific container requested back by the <code>ResourceManager</code>.
  6292. @see PreemptionContract
  6293. @see StrictPreemptionContract]]>
  6294. </doc>
  6295. </class>
  6296. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
  6297. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContract -->
  6298. <class name="PreemptionContract" extends="java.lang.Object"
  6299. abstract="true"
  6300. static="false" final="false" visibility="public"
  6301. deprecated="not deprecated">
  6302. <constructor name="PreemptionContract"
  6303. static="false" final="false" visibility="public"
  6304. deprecated="not deprecated">
  6305. </constructor>
  6306. <method name="getResourceRequest" return="java.util.List"
  6307. abstract="true" native="false" synchronized="false"
  6308. static="false" final="false" visibility="public"
  6309. deprecated="not deprecated">
  6310. <doc>
  6311. <![CDATA[If the AM releases resources matching these requests, then the {@link
  6312. PreemptionContainer}s enumerated in {@link #getContainers()} should not be
  6313. evicted from the cluster. Due to delays in propagating cluster state and
  6314. sending these messages, there are conditions where satisfied contracts may
  6315. not prevent the platform from killing containers.
  6316. @return List of {@link PreemptionResourceRequest} to update the
  6317. <code>ApplicationMaster</code> about resources requested back by the
  6318. <code>ResourceManager</code>.
  6319. @see AllocateRequest#setAskList(List)]]>
  6320. </doc>
  6321. </method>
  6322. <method name="getContainers" return="java.util.Set"
  6323. abstract="true" native="false" synchronized="false"
  6324. static="false" final="false" visibility="public"
  6325. deprecated="not deprecated">
  6326. <doc>
  6327. <![CDATA[Assign the set of {@link PreemptionContainer} specifying which containers
  6328. owned by the <code>ApplicationMaster</code> that may be reclaimed by the
  6329. <code>ResourceManager</code>. If the AM prefers a different set of
  6330. containers, then it may checkpoint or kill containers matching the
  6331. description in {@link #getResourceRequest}.
  6332. @return Set of containers at risk if the contract is not met.]]>
  6333. </doc>
  6334. </method>
  6335. <doc>
  6336. <![CDATA[Description of resources requested back by the <code>ResourceManager</code>.
  6337. The <code>ApplicationMaster</code> (AM) can satisfy this request according
  6338. to its own priorities to prevent containers from being forcibly killed by
  6339. the platform.
  6340. @see PreemptionMessage]]>
  6341. </doc>
  6342. </class>
  6343. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContract -->
  6344. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
  6345. <class name="PreemptionMessage" extends="java.lang.Object"
  6346. abstract="true"
  6347. static="false" final="false" visibility="public"
  6348. deprecated="not deprecated">
  6349. <constructor name="PreemptionMessage"
  6350. static="false" final="false" visibility="public"
  6351. deprecated="not deprecated">
  6352. </constructor>
  6353. <method name="getStrictContract" return="org.apache.hadoop.yarn.api.records.StrictPreemptionContract"
  6354. abstract="true" native="false" synchronized="false"
  6355. static="false" final="false" visibility="public"
  6356. deprecated="not deprecated">
  6357. <doc>
  6358. <![CDATA[@return Specific resources that may be killed by the
  6359. <code>ResourceManager</code>]]>
  6360. </doc>
  6361. </method>
  6362. <method name="getContract" return="org.apache.hadoop.yarn.api.records.PreemptionContract"
  6363. abstract="true" native="false" synchronized="false"
  6364. static="false" final="false" visibility="public"
  6365. deprecated="not deprecated">
  6366. <doc>
  6367. <![CDATA[@return Contract describing resources to return to the cluster.]]>
  6368. </doc>
  6369. </method>
  6370. <doc>
  6371. <![CDATA[A {@link PreemptionMessage} is part of the RM-AM protocol, and it is used by
  6372. the RM to specify resources that the RM wants to reclaim from this
  6373. {@code ApplicationMaster} (AM). The AM receives a {@link
  6374. StrictPreemptionContract} message encoding which containers the platform may
  6375. forcibly kill, granting it an opportunity to checkpoint state or adjust its
  6376. execution plan. The message may also include a {@link PreemptionContract}
  6377. granting the AM more latitude in selecting which resources to return to the
  6378. cluster.
  6379. <p>
  6380. The AM should decode both parts of the message. The {@link
  6381. StrictPreemptionContract} specifies particular allocations that the RM
  6382. requires back. The AM can checkpoint containers' state, adjust its execution
  6383. plan to move the computation, or take no action and hope that conditions that
  6384. caused the RM to ask for the container will change.
  6385. <p>
  6386. In contrast, the {@link PreemptionContract} also includes a description of
  6387. resources with a set of containers. If the AM releases containers matching
  6388. that profile, then the containers enumerated in {@link
  6389. PreemptionContract#getContainers()} may not be killed.
  6390. <p>
  6391. Each preemption message reflects the RM's current understanding of the
  6392. cluster state, so a request to return <em>N</em> containers may not
  6393. reflect containers the AM is releasing, recently exited containers the RM has
  6394. yet to learn about, or new containers allocated before the message was
  6395. generated. Conversely, an RM may request a different profile of containers in
  6396. subsequent requests.
  6397. <p>
  6398. The policy enforced by the RM is part of the scheduler. Generally, only
  6399. containers that have been requested consistently should be killed, but the
  6400. details are not specified.]]>
  6401. </doc>
  6402. </class>
  6403. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
  6404. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
  6405. <class name="PreemptionResourceRequest" extends="java.lang.Object"
  6406. abstract="true"
  6407. static="false" final="false" visibility="public"
  6408. deprecated="not deprecated">
  6409. <constructor name="PreemptionResourceRequest"
  6410. static="false" final="false" visibility="public"
  6411. deprecated="not deprecated">
  6412. </constructor>
  6413. <method name="getResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  6414. abstract="true" native="false" synchronized="false"
  6415. static="false" final="false" visibility="public"
  6416. deprecated="not deprecated">
  6417. <doc>
  6418. <![CDATA[@return Resource described in this request, to be matched against running
  6419. containers.]]>
  6420. </doc>
  6421. </method>
  6422. <doc>
  6423. <![CDATA[Description of resources requested back by the cluster.
  6424. @see PreemptionContract
  6425. @see AllocateRequest#setAskList(java.util.List)]]>
  6426. </doc>
  6427. </class>
  6428. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
  6429. <!-- start class org.apache.hadoop.yarn.api.records.Priority -->
  6430. <class name="Priority" extends="java.lang.Object"
  6431. abstract="true"
  6432. static="false" final="false" visibility="public"
  6433. deprecated="not deprecated">
  6434. <implements name="java.lang.Comparable"/>
  6435. <constructor name="Priority"
  6436. static="false" final="false" visibility="public"
  6437. deprecated="not deprecated">
  6438. </constructor>
  6439. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Priority"
  6440. abstract="false" native="false" synchronized="false"
  6441. static="true" final="false" visibility="public"
  6442. deprecated="not deprecated">
  6443. <param name="p" type="int"/>
  6444. </method>
  6445. <method name="getPriority" return="int"
  6446. abstract="true" native="false" synchronized="false"
  6447. static="false" final="false" visibility="public"
  6448. deprecated="not deprecated">
  6449. <doc>
  6450. <![CDATA[Get the assigned priority
  6451. @return the assigned priority]]>
  6452. </doc>
  6453. </method>
  6454. <method name="setPriority"
  6455. abstract="true" native="false" synchronized="false"
  6456. static="false" final="false" visibility="public"
  6457. deprecated="not deprecated">
  6458. <param name="priority" type="int"/>
  6459. <doc>
  6460. <![CDATA[Set the assigned priority
  6461. @param priority the assigned priority]]>
  6462. </doc>
  6463. </method>
  6464. <method name="hashCode" return="int"
  6465. abstract="false" native="false" synchronized="false"
  6466. static="false" final="false" visibility="public"
  6467. deprecated="not deprecated">
  6468. </method>
  6469. <method name="equals" return="boolean"
  6470. abstract="false" native="false" synchronized="false"
  6471. static="false" final="false" visibility="public"
  6472. deprecated="not deprecated">
  6473. <param name="obj" type="java.lang.Object"/>
  6474. </method>
  6475. <method name="compareTo" return="int"
  6476. abstract="false" native="false" synchronized="false"
  6477. static="false" final="false" visibility="public"
  6478. deprecated="not deprecated">
  6479. <param name="other" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6480. </method>
  6481. <method name="toString" return="java.lang.String"
  6482. abstract="false" native="false" synchronized="false"
  6483. static="false" final="false" visibility="public"
  6484. deprecated="not deprecated">
  6485. </method>
  6486. <field name="UNDEFINED" type="org.apache.hadoop.yarn.api.records.Priority"
  6487. transient="false" volatile="false"
  6488. static="true" final="true" visibility="public"
  6489. deprecated="not deprecated">
  6490. </field>
  6491. <doc>
  6492. <![CDATA[The priority assigned to a ResourceRequest or Application or Container
  6493. allocation]]>
  6494. </doc>
  6495. </class>
  6496. <!-- end class org.apache.hadoop.yarn.api.records.Priority -->
  6497. <!-- start class org.apache.hadoop.yarn.api.records.QueueACL -->
  6498. <class name="QueueACL" extends="java.lang.Enum"
  6499. abstract="false"
  6500. static="false" final="true" visibility="public"
  6501. deprecated="not deprecated">
  6502. <method name="values" return="org.apache.hadoop.yarn.api.records.QueueACL[]"
  6503. abstract="false" native="false" synchronized="false"
  6504. static="true" final="false" visibility="public"
  6505. deprecated="not deprecated">
  6506. </method>
  6507. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueACL"
  6508. abstract="false" native="false" synchronized="false"
  6509. static="true" final="false" visibility="public"
  6510. deprecated="not deprecated">
  6511. <param name="name" type="java.lang.String"/>
  6512. </method>
  6513. <doc>
  6514. <![CDATA[{@code QueueACL} enumerates the various ACLs for queues.
  6515. <p>
  6516. The ACL is one of:
  6517. <ul>
  6518. <li>
  6519. {@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the queue.
  6520. </li>
  6521. <li>{@link #ADMINISTER_QUEUE} - ACL to administer the queue.</li>
  6522. </ul>
  6523. @see QueueInfo
  6524. @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
  6525. </doc>
  6526. </class>
  6527. <!-- end class org.apache.hadoop.yarn.api.records.QueueACL -->
  6528. <!-- start class org.apache.hadoop.yarn.api.records.QueueInfo -->
  6529. <class name="QueueInfo" extends="java.lang.Object"
  6530. abstract="true"
  6531. static="false" final="false" visibility="public"
  6532. deprecated="not deprecated">
  6533. <constructor name="QueueInfo"
  6534. static="false" final="false" visibility="public"
  6535. deprecated="not deprecated">
  6536. </constructor>
  6537. <method name="getQueueName" return="java.lang.String"
  6538. abstract="true" native="false" synchronized="false"
  6539. static="false" final="false" visibility="public"
  6540. deprecated="not deprecated">
  6541. <doc>
  6542. <![CDATA[Get the <em>name</em> of the queue.
  6543. @return <em>name</em> of the queue]]>
  6544. </doc>
  6545. </method>
  6546. <method name="getCapacity" return="float"
  6547. abstract="true" native="false" synchronized="false"
  6548. static="false" final="false" visibility="public"
  6549. deprecated="not deprecated">
  6550. <doc>
  6551. <![CDATA[Get the <em>configured capacity</em> of the queue.
  6552. @return <em>configured capacity</em> of the queue]]>
  6553. </doc>
  6554. </method>
  6555. <method name="getMaximumCapacity" return="float"
  6556. abstract="true" native="false" synchronized="false"
  6557. static="false" final="false" visibility="public"
  6558. deprecated="not deprecated">
  6559. <doc>
  6560. <![CDATA[Get the <em>maximum capacity</em> of the queue.
  6561. @return <em>maximum capacity</em> of the queue]]>
  6562. </doc>
  6563. </method>
  6564. <method name="getCurrentCapacity" return="float"
  6565. abstract="true" native="false" synchronized="false"
  6566. static="false" final="false" visibility="public"
  6567. deprecated="not deprecated">
  6568. <doc>
  6569. <![CDATA[Get the <em>current capacity</em> of the queue.
  6570. @return <em>current capacity</em> of the queue]]>
  6571. </doc>
  6572. </method>
  6573. <method name="getChildQueues" return="java.util.List"
  6574. abstract="true" native="false" synchronized="false"
  6575. static="false" final="false" visibility="public"
  6576. deprecated="not deprecated">
  6577. <doc>
  6578. <![CDATA[Get the <em>child queues</em> of the queue.
  6579. @return <em>child queues</em> of the queue]]>
  6580. </doc>
  6581. </method>
  6582. <method name="getApplications" return="java.util.List"
  6583. abstract="true" native="false" synchronized="false"
  6584. static="false" final="false" visibility="public"
  6585. deprecated="not deprecated">
  6586. <doc>
  6587. <![CDATA[Get the <em>running applications</em> of the queue.
  6588. @return <em>running applications</em> of the queue]]>
  6589. </doc>
  6590. </method>
  6591. <method name="getQueueState" return="org.apache.hadoop.yarn.api.records.QueueState"
  6592. abstract="true" native="false" synchronized="false"
  6593. static="false" final="false" visibility="public"
  6594. deprecated="not deprecated">
  6595. <doc>
  6596. <![CDATA[Get the <code>QueueState</code> of the queue.
  6597. @return <code>QueueState</code> of the queue]]>
  6598. </doc>
  6599. </method>
  6600. <method name="getAccessibleNodeLabels" return="java.util.Set"
  6601. abstract="true" native="false" synchronized="false"
  6602. static="false" final="false" visibility="public"
  6603. deprecated="not deprecated">
  6604. <doc>
  6605. <![CDATA[Get the <code>accessible node labels</code> of the queue.
  6606. @return <code>accessible node labels</code> of the queue]]>
  6607. </doc>
  6608. </method>
  6609. <method name="getDefaultNodeLabelExpression" return="java.lang.String"
  6610. abstract="true" native="false" synchronized="false"
  6611. static="false" final="false" visibility="public"
  6612. deprecated="not deprecated">
  6613. <doc>
  6614. <![CDATA[Get the <code>default node label expression</code> of the queue, this takes
  6615. affect only when the <code>ApplicationSubmissionContext</code> and
  6616. <code>ResourceRequest</code> don't specify their
  6617. <code>NodeLabelExpression</code>.
  6618. @return <code>default node label expression</code> of the queue]]>
  6619. </doc>
  6620. </method>
  6621. <method name="setDefaultNodeLabelExpression"
  6622. abstract="true" native="false" synchronized="false"
  6623. static="false" final="false" visibility="public"
  6624. deprecated="not deprecated">
  6625. <param name="defaultLabelExpression" type="java.lang.String"/>
  6626. </method>
  6627. <doc>
  6628. <![CDATA[QueueInfo is a report of the runtime information of the queue.
  6629. <p>
  6630. It includes information such as:
  6631. <ul>
  6632. <li>Queue name.</li>
  6633. <li>Capacity of the queue.</li>
  6634. <li>Maximum capacity of the queue.</li>
  6635. <li>Current capacity of the queue.</li>
  6636. <li>Child queues.</li>
  6637. <li>Running applications.</li>
  6638. <li>{@link QueueState} of the queue.</li>
  6639. </ul>
  6640. @see QueueState
  6641. @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
  6642. </doc>
  6643. </class>
  6644. <!-- end class org.apache.hadoop.yarn.api.records.QueueInfo -->
  6645. <!-- start class org.apache.hadoop.yarn.api.records.QueueState -->
  6646. <class name="QueueState" extends="java.lang.Enum"
  6647. abstract="false"
  6648. static="false" final="true" visibility="public"
  6649. deprecated="not deprecated">
  6650. <method name="values" return="org.apache.hadoop.yarn.api.records.QueueState[]"
  6651. abstract="false" native="false" synchronized="false"
  6652. static="true" final="false" visibility="public"
  6653. deprecated="not deprecated">
  6654. </method>
  6655. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueState"
  6656. abstract="false" native="false" synchronized="false"
  6657. static="true" final="false" visibility="public"
  6658. deprecated="not deprecated">
  6659. <param name="name" type="java.lang.String"/>
  6660. </method>
  6661. <doc>
  6662. <![CDATA[State of a Queue.
  6663. <p>
  6664. A queue is in one of:
  6665. <ul>
  6666. <li>{@link #RUNNING} - normal state.</li>
  6667. <li>{@link #STOPPED} - not accepting new application submissions.</li>
  6668. </ul>
  6669. @see QueueInfo
  6670. @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
  6671. </doc>
  6672. </class>
  6673. <!-- end class org.apache.hadoop.yarn.api.records.QueueState -->
  6674. <!-- start class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
  6675. <class name="QueueUserACLInfo" extends="java.lang.Object"
  6676. abstract="true"
  6677. static="false" final="false" visibility="public"
  6678. deprecated="not deprecated">
  6679. <constructor name="QueueUserACLInfo"
  6680. static="false" final="false" visibility="public"
  6681. deprecated="not deprecated">
  6682. </constructor>
  6683. <method name="getQueueName" return="java.lang.String"
  6684. abstract="true" native="false" synchronized="false"
  6685. static="false" final="false" visibility="public"
  6686. deprecated="not deprecated">
  6687. <doc>
  6688. <![CDATA[Get the <em>queue name</em> of the queue.
  6689. @return <em>queue name</em> of the queue]]>
  6690. </doc>
  6691. </method>
  6692. <method name="getUserAcls" return="java.util.List"
  6693. abstract="true" native="false" synchronized="false"
  6694. static="false" final="false" visibility="public"
  6695. deprecated="not deprecated">
  6696. <doc>
  6697. <![CDATA[Get the list of <code>QueueACL</code> for the given user.
  6698. @return list of <code>QueueACL</code> for the given user]]>
  6699. </doc>
  6700. </method>
  6701. <doc>
  6702. <![CDATA[<p><code>QueueUserACLInfo</code> provides information {@link QueueACL} for
  6703. the given user.</p>
  6704. @see QueueACL
  6705. @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
  6706. </doc>
  6707. </class>
  6708. <!-- end class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
  6709. <!-- start class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
  6710. <class name="ReservationDefinition" extends="java.lang.Object"
  6711. abstract="true"
  6712. static="false" final="false" visibility="public"
  6713. deprecated="not deprecated">
  6714. <constructor name="ReservationDefinition"
  6715. static="false" final="false" visibility="public"
  6716. deprecated="not deprecated">
  6717. </constructor>
  6718. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  6719. abstract="false" native="false" synchronized="false"
  6720. static="true" final="false" visibility="public"
  6721. deprecated="not deprecated">
  6722. <param name="arrival" type="long"/>
  6723. <param name="deadline" type="long"/>
  6724. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  6725. <param name="name" type="java.lang.String"/>
  6726. </method>
  6727. <method name="getArrival" return="long"
  6728. abstract="true" native="false" synchronized="false"
  6729. static="false" final="false" visibility="public"
  6730. deprecated="not deprecated">
  6731. <doc>
  6732. <![CDATA[Get the arrival time or the earliest time from which the resource(s) can be
  6733. allocated. Time expressed as UTC.
  6734. @return the earliest valid time for this reservation]]>
  6735. </doc>
  6736. </method>
  6737. <method name="setArrival"
  6738. abstract="true" native="false" synchronized="false"
  6739. static="false" final="false" visibility="public"
  6740. deprecated="not deprecated">
  6741. <param name="earliestStartTime" type="long"/>
  6742. <doc>
  6743. <![CDATA[Set the arrival time or the earliest time from which the resource(s) can be
  6744. allocated. Time expressed as UTC.
  6745. @param earliestStartTime the earliest valid time for this reservation]]>
  6746. </doc>
  6747. </method>
  6748. <method name="getDeadline" return="long"
  6749. abstract="true" native="false" synchronized="false"
  6750. static="false" final="false" visibility="public"
  6751. deprecated="not deprecated">
  6752. <doc>
  6753. <![CDATA[Get the deadline or the latest time by when the resource(s) must be
  6754. allocated. Time expressed as UTC.
  6755. @return the deadline or the latest time by when the resource(s) must be
  6756. allocated]]>
  6757. </doc>
  6758. </method>
  6759. <method name="setDeadline"
  6760. abstract="true" native="false" synchronized="false"
  6761. static="false" final="false" visibility="public"
  6762. deprecated="not deprecated">
  6763. <param name="latestEndTime" type="long"/>
  6764. <doc>
  6765. <![CDATA[Set the deadline or the latest time by when the resource(s) must be
  6766. allocated. Time expressed as UTC.
  6767. @param latestEndTime the deadline or the latest time by when the
  6768. resource(s) should be allocated]]>
  6769. </doc>
  6770. </method>
  6771. <method name="getReservationRequests" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
  6772. abstract="true" native="false" synchronized="false"
  6773. static="false" final="false" visibility="public"
  6774. deprecated="not deprecated">
  6775. <doc>
  6776. <![CDATA[Get the list of {@link ReservationRequests} representing the resources
  6777. required by the application
  6778. @return the list of {@link ReservationRequests}]]>
  6779. </doc>
  6780. </method>
  6781. <method name="setReservationRequests"
  6782. abstract="true" native="false" synchronized="false"
  6783. static="false" final="false" visibility="public"
  6784. deprecated="not deprecated">
  6785. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  6786. <doc>
  6787. <![CDATA[Set the list of {@link ReservationRequests} representing the resources
  6788. required by the application
  6789. @param reservationRequests the list of {@link ReservationRequests}]]>
  6790. </doc>
  6791. </method>
  6792. <method name="getReservationName" return="java.lang.String"
  6793. abstract="true" native="false" synchronized="false"
  6794. static="false" final="false" visibility="public"
  6795. deprecated="not deprecated">
  6796. <doc>
  6797. <![CDATA[Get the name for this reservation. The name need-not be unique, and it is
  6798. just a mnemonic for the user (akin to job names). Accepted reservations are
  6799. uniquely identified by a system-generated ReservationId.
  6800. @return string representing the name of the corresponding reserved resource
  6801. allocation in the scheduler]]>
  6802. </doc>
  6803. </method>
  6804. <method name="setReservationName"
  6805. abstract="true" native="false" synchronized="false"
  6806. static="false" final="false" visibility="public"
  6807. deprecated="not deprecated">
  6808. <param name="name" type="java.lang.String"/>
  6809. <doc>
  6810. <![CDATA[Set the name for this reservation. The name need-not be unique, and it is
  6811. just a mnemonic for the user (akin to job names). Accepted reservations are
  6812. uniquely identified by a system-generated ReservationId.
  6813. @param name representing the name of the corresponding reserved resource
  6814. allocation in the scheduler]]>
  6815. </doc>
  6816. </method>
  6817. <doc>
  6818. <![CDATA[{@link ReservationDefinition} captures the set of resource and time
  6819. constraints the user cares about regarding a reservation.
  6820. @see ResourceRequest]]>
  6821. </doc>
  6822. </class>
  6823. <!-- end class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
  6824. <!-- start class org.apache.hadoop.yarn.api.records.ReservationId -->
  6825. <class name="ReservationId" extends="java.lang.Object"
  6826. abstract="true"
  6827. static="false" final="false" visibility="public"
  6828. deprecated="not deprecated">
  6829. <implements name="java.lang.Comparable"/>
  6830. <constructor name="ReservationId"
  6831. static="false" final="false" visibility="public"
  6832. deprecated="not deprecated">
  6833. </constructor>
  6834. <method name="getId" return="long"
  6835. abstract="true" native="false" synchronized="false"
  6836. static="false" final="false" visibility="public"
  6837. deprecated="not deprecated">
  6838. <doc>
  6839. <![CDATA[Get the long identifier of the {@link ReservationId} which is unique for
  6840. all Reservations started by a particular instance of the
  6841. {@code ResourceManager}.
  6842. @return long identifier of the {@link ReservationId}]]>
  6843. </doc>
  6844. </method>
  6845. <method name="getClusterTimestamp" return="long"
  6846. abstract="true" native="false" synchronized="false"
  6847. static="false" final="false" visibility="public"
  6848. deprecated="not deprecated">
  6849. <doc>
  6850. <![CDATA[Get the <em>start time</em> of the {@code ResourceManager} which is used to
  6851. generate globally unique {@link ReservationId}.
  6852. @return <em>start time</em> of the {@code ResourceManager}]]>
  6853. </doc>
  6854. </method>
  6855. <method name="build"
  6856. abstract="true" native="false" synchronized="false"
  6857. static="false" final="false" visibility="protected"
  6858. deprecated="not deprecated">
  6859. </method>
  6860. <method name="compareTo" return="int"
  6861. abstract="false" native="false" synchronized="false"
  6862. static="false" final="false" visibility="public"
  6863. deprecated="not deprecated">
  6864. <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  6865. </method>
  6866. <method name="toString" return="java.lang.String"
  6867. abstract="false" native="false" synchronized="false"
  6868. static="false" final="false" visibility="public"
  6869. deprecated="not deprecated">
  6870. </method>
  6871. <method name="parseReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  6872. abstract="false" native="false" synchronized="false"
  6873. static="true" final="false" visibility="public"
  6874. deprecated="not deprecated">
  6875. <param name="reservationId" type="java.lang.String"/>
  6876. <exception name="IOException" type="java.io.IOException"/>
  6877. <doc>
  6878. <![CDATA[Parse the string argument as a {@link ReservationId}
  6879. @param reservationId the string representation of the {@link ReservationId}
  6880. @return the {@link ReservationId} corresponding to the input string if
  6881. valid, null if input is null
  6882. @throws IOException if unable to parse the input string]]>
  6883. </doc>
  6884. </method>
  6885. <method name="hashCode" return="int"
  6886. abstract="false" native="false" synchronized="false"
  6887. static="false" final="false" visibility="public"
  6888. deprecated="not deprecated">
  6889. </method>
  6890. <method name="equals" return="boolean"
  6891. abstract="false" native="false" synchronized="false"
  6892. static="false" final="false" visibility="public"
  6893. deprecated="not deprecated">
  6894. <param name="obj" type="java.lang.Object"/>
  6895. </method>
  6896. <field name="reserveIdStrPrefix" type="java.lang.String"
  6897. transient="false" volatile="false"
  6898. static="true" final="true" visibility="public"
  6899. deprecated="not deprecated">
  6900. </field>
  6901. <field name="clusterTimestamp" type="long"
  6902. transient="false" volatile="false"
  6903. static="false" final="false" visibility="protected"
  6904. deprecated="not deprecated">
  6905. </field>
  6906. <field name="id" type="long"
  6907. transient="false" volatile="false"
  6908. static="false" final="false" visibility="protected"
  6909. deprecated="not deprecated">
  6910. </field>
  6911. <doc>
  6912. <![CDATA[<p>
  6913. {@link ReservationId} represents the <em>globally unique</em> identifier for
  6914. a reservation.
  6915. </p>
  6916. <p>
  6917. The globally unique nature of the identifier is achieved by using the
  6918. <em>cluster timestamp</em> i.e. start-time of the {@code ResourceManager}
  6919. along with a monotonically increasing counter for the reservation.
  6920. </p>]]>
  6921. </doc>
  6922. </class>
  6923. <!-- end class org.apache.hadoop.yarn.api.records.ReservationId -->
  6924. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest -->
  6925. <class name="ReservationRequest" extends="java.lang.Object"
  6926. abstract="true"
  6927. static="false" final="false" visibility="public"
  6928. deprecated="not deprecated">
  6929. <implements name="java.lang.Comparable"/>
  6930. <constructor name="ReservationRequest"
  6931. static="false" final="false" visibility="public"
  6932. deprecated="not deprecated">
  6933. </constructor>
  6934. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
  6935. abstract="false" native="false" synchronized="false"
  6936. static="true" final="false" visibility="public"
  6937. deprecated="not deprecated">
  6938. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6939. <param name="numContainers" type="int"/>
  6940. </method>
  6941. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
  6942. abstract="false" native="false" synchronized="false"
  6943. static="true" final="false" visibility="public"
  6944. deprecated="not deprecated">
  6945. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6946. <param name="numContainers" type="int"/>
  6947. <param name="concurrency" type="int"/>
  6948. <param name="duration" type="long"/>
  6949. </method>
  6950. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  6951. abstract="true" native="false" synchronized="false"
  6952. static="false" final="false" visibility="public"
  6953. deprecated="not deprecated">
  6954. <doc>
  6955. <![CDATA[Get the {@link Resource} capability of the request.
  6956. @return {@link Resource} capability of the request]]>
  6957. </doc>
  6958. </method>
  6959. <method name="setCapability"
  6960. abstract="true" native="false" synchronized="false"
  6961. static="false" final="false" visibility="public"
  6962. deprecated="not deprecated">
  6963. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6964. <doc>
  6965. <![CDATA[Set the {@link Resource} capability of the request
  6966. @param capability {@link Resource} capability of the request]]>
  6967. </doc>
  6968. </method>
  6969. <method name="getNumContainers" return="int"
  6970. abstract="true" native="false" synchronized="false"
  6971. static="false" final="false" visibility="public"
  6972. deprecated="not deprecated">
  6973. <doc>
  6974. <![CDATA[Get the number of containers required with the given specifications.
  6975. @return number of containers required with the given specifications]]>
  6976. </doc>
  6977. </method>
  6978. <method name="setNumContainers"
  6979. abstract="true" native="false" synchronized="false"
  6980. static="false" final="false" visibility="public"
  6981. deprecated="not deprecated">
  6982. <param name="numContainers" type="int"/>
  6983. <doc>
  6984. <![CDATA[Set the number of containers required with the given specifications
  6985. @param numContainers number of containers required with the given
  6986. specifications]]>
  6987. </doc>
  6988. </method>
  6989. <method name="getConcurrency" return="int"
  6990. abstract="true" native="false" synchronized="false"
  6991. static="false" final="false" visibility="public"
  6992. deprecated="not deprecated">
  6993. <doc>
  6994. <![CDATA[Get the number of containers that need to be scheduled concurrently. The
  6995. default value of 1 would fall back to the current non concurrency
  6996. constraints on the scheduling behavior.
  6997. @return the number of containers to be concurrently scheduled]]>
  6998. </doc>
  6999. </method>
  7000. <method name="setConcurrency"
  7001. abstract="true" native="false" synchronized="false"
  7002. static="false" final="false" visibility="public"
  7003. deprecated="not deprecated">
  7004. <param name="numContainers" type="int"/>
  7005. <doc>
  7006. <![CDATA[Set the number of containers that need to be scheduled concurrently. The
  7007. default value of 1 would fall back to the current non concurrency
  7008. constraints on the scheduling behavior.
  7009. @param numContainers the number of containers to be concurrently scheduled]]>
  7010. </doc>
  7011. </method>
  7012. <method name="getDuration" return="long"
  7013. abstract="true" native="false" synchronized="false"
  7014. static="false" final="false" visibility="public"
  7015. deprecated="not deprecated">
  7016. <doc>
  7017. <![CDATA[Get the duration in milliseconds for which the resource is required. A
  7018. default value of -1, indicates an unspecified lease duration, and fallback
  7019. to current behavior.
  7020. @return the duration in milliseconds for which the resource is required]]>
  7021. </doc>
  7022. </method>
  7023. <method name="setDuration"
  7024. abstract="true" native="false" synchronized="false"
  7025. static="false" final="false" visibility="public"
  7026. deprecated="not deprecated">
  7027. <param name="duration" type="long"/>
  7028. <doc>
  7029. <![CDATA[Set the duration in milliseconds for which the resource is required.
  7030. @param duration the duration in milliseconds for which the resource is
  7031. required]]>
  7032. </doc>
  7033. </method>
  7034. <method name="hashCode" return="int"
  7035. abstract="false" native="false" synchronized="false"
  7036. static="false" final="false" visibility="public"
  7037. deprecated="not deprecated">
  7038. </method>
  7039. <method name="equals" return="boolean"
  7040. abstract="false" native="false" synchronized="false"
  7041. static="false" final="false" visibility="public"
  7042. deprecated="not deprecated">
  7043. <param name="obj" type="java.lang.Object"/>
  7044. </method>
  7045. <method name="compareTo" return="int"
  7046. abstract="false" native="false" synchronized="false"
  7047. static="false" final="false" visibility="public"
  7048. deprecated="not deprecated">
  7049. <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  7050. </method>
  7051. <doc>
  7052. <![CDATA[{@link ReservationRequest} represents the request made by an application to
  7053. the {@code ResourceManager} to reserve {@link Resource}s.
  7054. <p>
  7055. It includes:
  7056. <ul>
  7057. <li>{@link Resource} required for each request.</li>
  7058. <li>
  7059. Number of containers, of above specifications, which are required by the
  7060. application.
  7061. </li>
  7062. <li>Concurrency that indicates the gang size of the request.</li>
  7063. </ul>]]>
  7064. </doc>
  7065. </class>
  7066. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest -->
  7067. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
  7068. <class name="ReservationRequest.ReservationRequestComparator" extends="java.lang.Object"
  7069. abstract="false"
  7070. static="true" final="false" visibility="public"
  7071. deprecated="not deprecated">
  7072. <implements name="java.util.Comparator"/>
  7073. <implements name="java.io.Serializable"/>
  7074. <constructor name="ReservationRequestComparator"
  7075. static="false" final="false" visibility="public"
  7076. deprecated="not deprecated">
  7077. </constructor>
  7078. <method name="compare" return="int"
  7079. abstract="false" native="false" synchronized="false"
  7080. static="false" final="false" visibility="public"
  7081. deprecated="not deprecated">
  7082. <param name="r1" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  7083. <param name="r2" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  7084. </method>
  7085. </class>
  7086. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
  7087. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
  7088. <class name="ReservationRequestInterpreter" extends="java.lang.Enum"
  7089. abstract="false"
  7090. static="false" final="true" visibility="public"
  7091. deprecated="not deprecated">
  7092. <method name="values" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter[]"
  7093. abstract="false" native="false" synchronized="false"
  7094. static="true" final="false" visibility="public"
  7095. deprecated="not deprecated">
  7096. </method>
  7097. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
  7098. abstract="false" native="false" synchronized="false"
  7099. static="true" final="false" visibility="public"
  7100. deprecated="not deprecated">
  7101. <param name="name" type="java.lang.String"/>
  7102. </method>
  7103. <doc>
  7104. <![CDATA[Enumeration of various types of dependencies among multiple
  7105. {@link ReservationRequests} within one {@link ReservationDefinition} (from
  7106. least constraining to most constraining).]]>
  7107. </doc>
  7108. </class>
  7109. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
  7110. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequests -->
  7111. <class name="ReservationRequests" extends="java.lang.Object"
  7112. abstract="true"
  7113. static="false" final="false" visibility="public"
  7114. deprecated="not deprecated">
  7115. <constructor name="ReservationRequests"
  7116. static="false" final="false" visibility="public"
  7117. deprecated="not deprecated">
  7118. </constructor>
  7119. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
  7120. abstract="false" native="false" synchronized="false"
  7121. static="true" final="false" visibility="public"
  7122. deprecated="not deprecated">
  7123. <param name="reservationResources" type="java.util.List"/>
  7124. <param name="type" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
  7125. </method>
  7126. <method name="getReservationResources" return="java.util.List"
  7127. abstract="true" native="false" synchronized="false"
  7128. static="false" final="false" visibility="public"
  7129. deprecated="not deprecated">
  7130. <doc>
  7131. <![CDATA[Get the list of {@link ReservationRequest} representing the resources
  7132. required by the application
  7133. @return the list of {@link ReservationRequest}]]>
  7134. </doc>
  7135. </method>
  7136. <method name="setReservationResources"
  7137. abstract="true" native="false" synchronized="false"
  7138. static="false" final="false" visibility="public"
  7139. deprecated="not deprecated">
  7140. <param name="reservationResources" type="java.util.List"/>
  7141. <doc>
  7142. <![CDATA[Set the list of {@link ReservationRequest} representing the resources
  7143. required by the application
  7144. @param reservationResources the list of {@link ReservationRequest}]]>
  7145. </doc>
  7146. </method>
  7147. <method name="getInterpreter" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
  7148. abstract="true" native="false" synchronized="false"
  7149. static="false" final="false" visibility="public"
  7150. deprecated="not deprecated">
  7151. <doc>
  7152. <![CDATA[Get the {@link ReservationRequestInterpreter}, representing how the list of
  7153. resources should be allocated, this captures temporal ordering and other
  7154. constraints.
  7155. @return the list of {@link ReservationRequestInterpreter}]]>
  7156. </doc>
  7157. </method>
  7158. <method name="setInterpreter"
  7159. abstract="true" native="false" synchronized="false"
  7160. static="false" final="false" visibility="public"
  7161. deprecated="not deprecated">
  7162. <param name="interpreter" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
  7163. <doc>
  7164. <![CDATA[Set the {@link ReservationRequestInterpreter}, representing how the list of
  7165. resources should be allocated, this captures temporal ordering and other
  7166. constraints.
  7167. @param interpreter the {@link ReservationRequestInterpreter} for this
  7168. reservation]]>
  7169. </doc>
  7170. </method>
  7171. <doc>
  7172. <![CDATA[{@link ReservationRequests} captures the set of resource and constraints the
  7173. user cares about regarding a reservation.
  7174. @see ReservationRequest]]>
  7175. </doc>
  7176. </class>
  7177. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequests -->
  7178. <!-- start class org.apache.hadoop.yarn.api.records.Resource -->
  7179. <class name="Resource" extends="java.lang.Object"
  7180. abstract="true"
  7181. static="false" final="false" visibility="public"
  7182. deprecated="not deprecated">
  7183. <implements name="java.lang.Comparable"/>
  7184. <constructor name="Resource"
  7185. static="false" final="false" visibility="public"
  7186. deprecated="not deprecated">
  7187. </constructor>
  7188. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
  7189. abstract="false" native="false" synchronized="false"
  7190. static="true" final="false" visibility="public"
  7191. deprecated="not deprecated">
  7192. <param name="memory" type="int"/>
  7193. <param name="vCores" type="int"/>
  7194. </method>
  7195. <method name="getMemory" return="int"
  7196. abstract="true" native="false" synchronized="false"
  7197. static="false" final="false" visibility="public"
  7198. deprecated="not deprecated">
  7199. <doc>
  7200. <![CDATA[Get <em>memory</em> of the resource.
  7201. @return <em>memory</em> of the resource]]>
  7202. </doc>
  7203. </method>
  7204. <method name="setMemory"
  7205. abstract="true" native="false" synchronized="false"
  7206. static="false" final="false" visibility="public"
  7207. deprecated="not deprecated">
  7208. <param name="memory" type="int"/>
  7209. <doc>
  7210. <![CDATA[Set <em>memory</em> of the resource.
  7211. @param memory <em>memory</em> of the resource]]>
  7212. </doc>
  7213. </method>
  7214. <method name="getVirtualCores" return="int"
  7215. abstract="true" native="false" synchronized="false"
  7216. static="false" final="false" visibility="public"
  7217. deprecated="not deprecated">
  7218. <doc>
  7219. <![CDATA[Get <em>number of virtual cpu cores</em> of the resource.
  7220. Virtual cores are a unit for expressing CPU parallelism. A node's capacity
  7221. should be configured with virtual cores equal to its number of physical cores.
  7222. A container should be requested with the number of cores it can saturate, i.e.
  7223. the average number of threads it expects to have runnable at a time.
  7224. @return <em>num of virtual cpu cores</em> of the resource]]>
  7225. </doc>
  7226. </method>
  7227. <method name="setVirtualCores"
  7228. abstract="true" native="false" synchronized="false"
  7229. static="false" final="false" visibility="public"
  7230. deprecated="not deprecated">
  7231. <param name="vCores" type="int"/>
  7232. <doc>
  7233. <![CDATA[Set <em>number of virtual cpu cores</em> of the resource.
  7234. Virtual cores are a unit for expressing CPU parallelism. A node's capacity
  7235. should be configured with virtual cores equal to its number of physical cores.
  7236. A container should be requested with the number of cores it can saturate, i.e.
  7237. the average number of threads it expects to have runnable at a time.
  7238. @param vCores <em>number of virtual cpu cores</em> of the resource]]>
  7239. </doc>
  7240. </method>
  7241. <method name="hashCode" return="int"
  7242. abstract="false" native="false" synchronized="false"
  7243. static="false" final="false" visibility="public"
  7244. deprecated="not deprecated">
  7245. </method>
  7246. <method name="equals" return="boolean"
  7247. abstract="false" native="false" synchronized="false"
  7248. static="false" final="false" visibility="public"
  7249. deprecated="not deprecated">
  7250. <param name="obj" type="java.lang.Object"/>
  7251. </method>
  7252. <method name="toString" return="java.lang.String"
  7253. abstract="false" native="false" synchronized="false"
  7254. static="false" final="false" visibility="public"
  7255. deprecated="not deprecated">
  7256. </method>
  7257. <doc>
  7258. <![CDATA[<p><code>Resource</code> models a set of computer resources in the
  7259. cluster.</p>
  7260. <p>Currently it models both <em>memory</em> and <em>CPU</em>.</p>
  7261. <p>The unit for memory is megabytes. CPU is modeled with virtual cores
  7262. (vcores), a unit for expressing parallelism. A node's capacity should
  7263. be configured with virtual cores equal to its number of physical cores. A
  7264. container should be requested with the number of cores it can saturate, i.e.
  7265. the average number of threads it expects to have runnable at a time.</p>
  7266. <p>Virtual cores take integer values and thus currently CPU-scheduling is
  7267. very coarse. A complementary axis for CPU requests that represents processing
  7268. power will likely be added in the future to enable finer-grained resource
  7269. configuration.</p>
  7270. <p>Typically, applications request <code>Resource</code> of suitable
  7271. capability to run their component tasks.</p>
  7272. @see ResourceRequest
  7273. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  7274. </doc>
  7275. </class>
  7276. <!-- end class org.apache.hadoop.yarn.api.records.Resource -->
  7277. <!-- start class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
  7278. <class name="ResourceBlacklistRequest" extends="java.lang.Object"
  7279. abstract="true"
  7280. static="false" final="false" visibility="public"
  7281. deprecated="not deprecated">
  7282. <constructor name="ResourceBlacklistRequest"
  7283. static="false" final="false" visibility="public"
  7284. deprecated="not deprecated">
  7285. </constructor>
  7286. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
  7287. abstract="false" native="false" synchronized="false"
  7288. static="true" final="false" visibility="public"
  7289. deprecated="not deprecated">
  7290. <param name="additions" type="java.util.List"/>
  7291. <param name="removals" type="java.util.List"/>
  7292. </method>
  7293. <method name="getBlacklistAdditions" return="java.util.List"
  7294. abstract="true" native="false" synchronized="false"
  7295. static="false" final="false" visibility="public"
  7296. deprecated="not deprecated">
  7297. <doc>
  7298. <![CDATA[Get the list of resource-names which should be added to the
  7299. application blacklist.
  7300. @return list of resource-names which should be added to the
  7301. application blacklist]]>
  7302. </doc>
  7303. </method>
  7304. <method name="setBlacklistAdditions"
  7305. abstract="true" native="false" synchronized="false"
  7306. static="false" final="false" visibility="public"
  7307. deprecated="not deprecated">
  7308. <param name="resourceNames" type="java.util.List"/>
  7309. <doc>
  7310. <![CDATA[Set list of resource-names which should be added to the application blacklist.
  7311. @param resourceNames list of resource-names which should be added to the
  7312. application blacklist]]>
  7313. </doc>
  7314. </method>
  7315. <method name="getBlacklistRemovals" return="java.util.List"
  7316. abstract="true" native="false" synchronized="false"
  7317. static="false" final="false" visibility="public"
  7318. deprecated="not deprecated">
  7319. <doc>
  7320. <![CDATA[Get the list of resource-names which should be removed from the
  7321. application blacklist.
  7322. @return list of resource-names which should be removed from the
  7323. application blacklist]]>
  7324. </doc>
  7325. </method>
  7326. <method name="setBlacklistRemovals"
  7327. abstract="true" native="false" synchronized="false"
  7328. static="false" final="false" visibility="public"
  7329. deprecated="not deprecated">
  7330. <param name="resourceNames" type="java.util.List"/>
  7331. <doc>
  7332. <![CDATA[Set list of resource-names which should be removed from the
  7333. application blacklist.
  7334. @param resourceNames list of resource-names which should be removed from the
  7335. application blacklist]]>
  7336. </doc>
  7337. </method>
  7338. <doc>
  7339. <![CDATA[{@link ResourceBlacklistRequest} encapsulates the list of resource-names
  7340. which should be added or removed from the <em>blacklist</em> of resources
  7341. for the application.
  7342. @see ResourceRequest
  7343. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  7344. </doc>
  7345. </class>
  7346. <!-- end class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
  7347. <!-- start class org.apache.hadoop.yarn.api.records.ResourceOption -->
  7348. <class name="ResourceOption" extends="java.lang.Object"
  7349. abstract="true"
  7350. static="false" final="false" visibility="public"
  7351. deprecated="not deprecated">
  7352. <constructor name="ResourceOption"
  7353. static="false" final="false" visibility="public"
  7354. deprecated="not deprecated">
  7355. </constructor>
  7356. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceOption"
  7357. abstract="false" native="false" synchronized="false"
  7358. static="true" final="false" visibility="public"
  7359. deprecated="not deprecated">
  7360. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7361. <param name="overCommitTimeout" type="int"/>
  7362. </method>
  7363. <method name="toString" return="java.lang.String"
  7364. abstract="false" native="false" synchronized="false"
  7365. static="false" final="false" visibility="public"
  7366. deprecated="not deprecated">
  7367. </method>
  7368. </class>
  7369. <!-- end class org.apache.hadoop.yarn.api.records.ResourceOption -->
  7370. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest -->
  7371. <class name="ResourceRequest" extends="java.lang.Object"
  7372. abstract="true"
  7373. static="false" final="false" visibility="public"
  7374. deprecated="not deprecated">
  7375. <implements name="java.lang.Comparable"/>
  7376. <constructor name="ResourceRequest"
  7377. static="false" final="false" visibility="public"
  7378. deprecated="not deprecated">
  7379. </constructor>
  7380. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  7381. abstract="false" native="false" synchronized="false"
  7382. static="true" final="false" visibility="public"
  7383. deprecated="not deprecated">
  7384. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  7385. <param name="hostName" type="java.lang.String"/>
  7386. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7387. <param name="numContainers" type="int"/>
  7388. </method>
  7389. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  7390. abstract="false" native="false" synchronized="false"
  7391. static="true" final="false" visibility="public"
  7392. deprecated="not deprecated">
  7393. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  7394. <param name="hostName" type="java.lang.String"/>
  7395. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7396. <param name="numContainers" type="int"/>
  7397. <param name="relaxLocality" type="boolean"/>
  7398. </method>
  7399. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  7400. abstract="false" native="false" synchronized="false"
  7401. static="true" final="false" visibility="public"
  7402. deprecated="not deprecated">
  7403. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  7404. <param name="hostName" type="java.lang.String"/>
  7405. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7406. <param name="numContainers" type="int"/>
  7407. <param name="relaxLocality" type="boolean"/>
  7408. <param name="labelExpression" type="java.lang.String"/>
  7409. </method>
  7410. <method name="isAnyLocation" return="boolean"
  7411. abstract="false" native="false" synchronized="false"
  7412. static="true" final="false" visibility="public"
  7413. deprecated="not deprecated">
  7414. <param name="hostName" type="java.lang.String"/>
  7415. <doc>
  7416. <![CDATA[Check whether the given <em>host/rack</em> string represents an arbitrary
  7417. host name.
  7418. @param hostName <em>host/rack</em> on which the allocation is desired
  7419. @return whether the given <em>host/rack</em> string represents an arbitrary
  7420. host name]]>
  7421. </doc>
  7422. </method>
  7423. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  7424. abstract="true" native="false" synchronized="false"
  7425. static="false" final="false" visibility="public"
  7426. deprecated="not deprecated">
  7427. <doc>
  7428. <![CDATA[Get the <code>Priority</code> of the request.
  7429. @return <code>Priority</code> of the request]]>
  7430. </doc>
  7431. </method>
  7432. <method name="setPriority"
  7433. abstract="true" native="false" synchronized="false"
  7434. static="false" final="false" visibility="public"
  7435. deprecated="not deprecated">
  7436. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  7437. <doc>
  7438. <![CDATA[Set the <code>Priority</code> of the request
  7439. @param priority <code>Priority</code> of the request]]>
  7440. </doc>
  7441. </method>
  7442. <method name="getResourceName" return="java.lang.String"
  7443. abstract="true" native="false" synchronized="false"
  7444. static="false" final="false" visibility="public"
  7445. deprecated="not deprecated">
  7446. <doc>
  7447. <![CDATA[Get the resource (e.g. <em>host/rack</em>) on which the allocation
  7448. is desired.
  7449. A special value of <em>*</em> signifies that <em>any</em> resource
  7450. (host/rack) is acceptable.
  7451. @return resource (e.g. <em>host/rack</em>) on which the allocation
  7452. is desired]]>
  7453. </doc>
  7454. </method>
  7455. <method name="setResourceName"
  7456. abstract="true" native="false" synchronized="false"
  7457. static="false" final="false" visibility="public"
  7458. deprecated="not deprecated">
  7459. <param name="resourceName" type="java.lang.String"/>
  7460. <doc>
  7461. <![CDATA[Set the resource name (e.g. <em>host/rack</em>) on which the allocation
  7462. is desired.
  7463. A special value of <em>*</em> signifies that <em>any</em> resource name
  7464. (e.g. host/rack) is acceptable.
  7465. @param resourceName (e.g. <em>host/rack</em>) on which the
  7466. allocation is desired]]>
  7467. </doc>
  7468. </method>
  7469. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  7470. abstract="true" native="false" synchronized="false"
  7471. static="false" final="false" visibility="public"
  7472. deprecated="not deprecated">
  7473. <doc>
  7474. <![CDATA[Get the <code>Resource</code> capability of the request.
  7475. @return <code>Resource</code> capability of the request]]>
  7476. </doc>
  7477. </method>
  7478. <method name="setCapability"
  7479. abstract="true" native="false" synchronized="false"
  7480. static="false" final="false" visibility="public"
  7481. deprecated="not deprecated">
  7482. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7483. <doc>
  7484. <![CDATA[Set the <code>Resource</code> capability of the request
  7485. @param capability <code>Resource</code> capability of the request]]>
  7486. </doc>
  7487. </method>
  7488. <method name="getNumContainers" return="int"
  7489. abstract="true" native="false" synchronized="false"
  7490. static="false" final="false" visibility="public"
  7491. deprecated="not deprecated">
  7492. <doc>
  7493. <![CDATA[Get the number of containers required with the given specifications.
  7494. @return number of containers required with the given specifications]]>
  7495. </doc>
  7496. </method>
  7497. <method name="setNumContainers"
  7498. abstract="true" native="false" synchronized="false"
  7499. static="false" final="false" visibility="public"
  7500. deprecated="not deprecated">
  7501. <param name="numContainers" type="int"/>
  7502. <doc>
  7503. <![CDATA[Set the number of containers required with the given specifications
  7504. @param numContainers number of containers required with the given
  7505. specifications]]>
  7506. </doc>
  7507. </method>
  7508. <method name="getRelaxLocality" return="boolean"
  7509. abstract="true" native="false" synchronized="false"
  7510. static="false" final="false" visibility="public"
  7511. deprecated="not deprecated">
  7512. <doc>
  7513. <![CDATA[Get whether locality relaxation is enabled with this
  7514. <code>ResourceRequest</code>. Defaults to true.
  7515. @return whether locality relaxation is enabled with this
  7516. <code>ResourceRequest</code>.]]>
  7517. </doc>
  7518. </method>
  7519. <method name="setRelaxLocality"
  7520. abstract="true" native="false" synchronized="false"
  7521. static="false" final="false" visibility="public"
  7522. deprecated="not deprecated">
  7523. <param name="relaxLocality" type="boolean"/>
  7524. <doc>
  7525. <![CDATA[<p>For a request at a network hierarchy level, set whether locality can be relaxed
  7526. to that level and beyond.<p>
  7527. <p>If the flag is off on a rack-level <code>ResourceRequest</code>,
  7528. containers at that request's priority will not be assigned to nodes on that
  7529. request's rack unless requests specifically for those nodes have also been
  7530. submitted.<p>
  7531. <p>If the flag is off on an {@link ResourceRequest#ANY}-level
  7532. <code>ResourceRequest</code>, containers at that request's priority will
  7533. only be assigned on racks for which specific requests have also been
  7534. submitted.<p>
  7535. <p>For example, to request a container strictly on a specific node, the
  7536. corresponding rack-level and any-level requests should have locality
  7537. relaxation set to false. Similarly, to request a container strictly on a
  7538. specific rack, the corresponding any-level request should have locality
  7539. relaxation set to false.<p>
  7540. @param relaxLocality whether locality relaxation is enabled with this
  7541. <code>ResourceRequest</code>.]]>
  7542. </doc>
  7543. </method>
  7544. <method name="getNodeLabelExpression" return="java.lang.String"
  7545. abstract="true" native="false" synchronized="false"
  7546. static="false" final="false" visibility="public"
  7547. deprecated="not deprecated">
  7548. <doc>
  7549. <![CDATA[Get node-label-expression for this Resource Request. If this is set, all
  7550. containers allocated to satisfy this resource-request will be only on those
  7551. nodes that satisfy this node-label-expression.
  7552. Please note that node label expression now can only take effect when the
  7553. resource request has resourceName = ANY
  7554. @return node-label-expression]]>
  7555. </doc>
  7556. </method>
  7557. <method name="setNodeLabelExpression"
  7558. abstract="true" native="false" synchronized="false"
  7559. static="false" final="false" visibility="public"
  7560. deprecated="not deprecated">
  7561. <param name="nodelabelExpression" type="java.lang.String"/>
  7562. <doc>
  7563. <![CDATA[Set node label expression of this resource request. Now only support
  7564. specifying a single node label. In the future we will support more complex
  7565. node label expression specification like {@code AND(&&), OR(||)}, etc.
  7566. Any please note that node label expression now can only take effect when
  7567. the resource request has resourceName = ANY
  7568. @param nodelabelExpression
  7569. node-label-expression of this ResourceRequest]]>
  7570. </doc>
  7571. </method>
  7572. <method name="hashCode" return="int"
  7573. abstract="false" native="false" synchronized="false"
  7574. static="false" final="false" visibility="public"
  7575. deprecated="not deprecated">
  7576. </method>
  7577. <method name="equals" return="boolean"
  7578. abstract="false" native="false" synchronized="false"
  7579. static="false" final="false" visibility="public"
  7580. deprecated="not deprecated">
  7581. <param name="obj" type="java.lang.Object"/>
  7582. </method>
  7583. <method name="compareTo" return="int"
  7584. abstract="false" native="false" synchronized="false"
  7585. static="false" final="false" visibility="public"
  7586. deprecated="not deprecated">
  7587. <param name="other" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  7588. </method>
  7589. <field name="ANY" type="java.lang.String"
  7590. transient="false" volatile="false"
  7591. static="true" final="true" visibility="public"
  7592. deprecated="not deprecated">
  7593. <doc>
  7594. <![CDATA[The constant string representing no locality.
  7595. It should be used by all references that want to pass an arbitrary host
  7596. name in.]]>
  7597. </doc>
  7598. </field>
  7599. <doc>
  7600. <![CDATA[{@code ResourceRequest} represents the request made
  7601. by an application to the {@code ResourceManager}
  7602. to obtain various {@code Container} allocations.
  7603. <p>
  7604. It includes:
  7605. <ul>
  7606. <li>{@link Priority} of the request.</li>
  7607. <li>
  7608. The <em>name</em> of the machine or rack on which the allocation is
  7609. desired. A special value of <em>*</em> signifies that
  7610. <em>any</em> host/rack is acceptable to the application.
  7611. </li>
  7612. <li>{@link Resource} required for each request.</li>
  7613. <li>
  7614. Number of containers, of above specifications, which are required
  7615. by the application.
  7616. </li>
  7617. <li>
  7618. A boolean <em>relaxLocality</em> flag, defaulting to {@code true},
  7619. which tells the {@code ResourceManager} if the application wants
  7620. locality to be loose (i.e. allows fall-through to rack or <em>any</em>)
  7621. or strict (i.e. specify hard constraint on resource allocation).
  7622. </li>
  7623. </ul>
  7624. @see Resource
  7625. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  7626. </doc>
  7627. </class>
  7628. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest -->
  7629. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
  7630. <class name="ResourceRequest.ResourceRequestComparator" extends="java.lang.Object"
  7631. abstract="false"
  7632. static="true" final="false" visibility="public"
  7633. deprecated="not deprecated">
  7634. <implements name="java.util.Comparator"/>
  7635. <implements name="java.io.Serializable"/>
  7636. <constructor name="ResourceRequestComparator"
  7637. static="false" final="false" visibility="public"
  7638. deprecated="not deprecated">
  7639. </constructor>
  7640. <method name="compare" return="int"
  7641. abstract="false" native="false" synchronized="false"
  7642. static="false" final="false" visibility="public"
  7643. deprecated="not deprecated">
  7644. <param name="r1" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  7645. <param name="r2" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  7646. </method>
  7647. </class>
  7648. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
  7649. <!-- start class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
  7650. <class name="StrictPreemptionContract" extends="java.lang.Object"
  7651. abstract="true"
  7652. static="false" final="false" visibility="public"
  7653. deprecated="not deprecated">
  7654. <constructor name="StrictPreemptionContract"
  7655. static="false" final="false" visibility="public"
  7656. deprecated="not deprecated">
  7657. </constructor>
  7658. <method name="getContainers" return="java.util.Set"
  7659. abstract="true" native="false" synchronized="false"
  7660. static="false" final="false" visibility="public"
  7661. deprecated="not deprecated">
  7662. <doc>
  7663. <![CDATA[Get the set of {@link PreemptionContainer} specifying containers owned by
  7664. the <code>ApplicationMaster</code> that may be reclaimed by the
  7665. <code>ResourceManager</code>.
  7666. @return the set of {@link ContainerId} to be preempted.]]>
  7667. </doc>
  7668. </method>
  7669. <doc>
  7670. <![CDATA[Enumeration of particular allocations to be reclaimed. The platform will
  7671. reclaim exactly these resources, so the <code>ApplicationMaster</code> (AM)
  7672. may attempt to checkpoint work or adjust its execution plan to accommodate
  7673. it. In contrast to {@link PreemptionContract}, the AM has no flexibility in
  7674. selecting which resources to return to the cluster.
  7675. @see PreemptionMessage]]>
  7676. </doc>
  7677. </class>
  7678. <!-- end class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
  7679. <!-- start class org.apache.hadoop.yarn.api.records.Token -->
  7680. <class name="Token" extends="java.lang.Object"
  7681. abstract="true"
  7682. static="false" final="false" visibility="public"
  7683. deprecated="not deprecated">
  7684. <constructor name="Token"
  7685. static="false" final="false" visibility="public"
  7686. deprecated="not deprecated">
  7687. </constructor>
  7688. <method name="getIdentifier" return="java.nio.ByteBuffer"
  7689. abstract="true" native="false" synchronized="false"
  7690. static="false" final="false" visibility="public"
  7691. deprecated="not deprecated">
  7692. <doc>
  7693. <![CDATA[Get the token identifier.
  7694. @return token identifier]]>
  7695. </doc>
  7696. </method>
  7697. <method name="getPassword" return="java.nio.ByteBuffer"
  7698. abstract="true" native="false" synchronized="false"
  7699. static="false" final="false" visibility="public"
  7700. deprecated="not deprecated">
  7701. <doc>
  7702. <![CDATA[Get the token password
  7703. @return token password]]>
  7704. </doc>
  7705. </method>
  7706. <method name="getKind" return="java.lang.String"
  7707. abstract="true" native="false" synchronized="false"
  7708. static="false" final="false" visibility="public"
  7709. deprecated="not deprecated">
  7710. <doc>
  7711. <![CDATA[Get the token kind.
  7712. @return token kind]]>
  7713. </doc>
  7714. </method>
  7715. <method name="getService" return="java.lang.String"
  7716. abstract="true" native="false" synchronized="false"
  7717. static="false" final="false" visibility="public"
  7718. deprecated="not deprecated">
  7719. <doc>
  7720. <![CDATA[Get the service to which the token is allocated.
  7721. @return service to which the token is allocated]]>
  7722. </doc>
  7723. </method>
  7724. <doc>
  7725. <![CDATA[<p><code>Token</code> is the security entity used by the framework
  7726. to verify authenticity of any resource.</p>]]>
  7727. </doc>
  7728. </class>
  7729. <!-- end class org.apache.hadoop.yarn.api.records.Token -->
  7730. <!-- start class org.apache.hadoop.yarn.api.records.URL -->
  7731. <class name="URL" extends="java.lang.Object"
  7732. abstract="true"
  7733. static="false" final="false" visibility="public"
  7734. deprecated="not deprecated">
  7735. <constructor name="URL"
  7736. static="false" final="false" visibility="public"
  7737. deprecated="not deprecated">
  7738. </constructor>
  7739. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.URL"
  7740. abstract="false" native="false" synchronized="false"
  7741. static="true" final="false" visibility="public"
  7742. deprecated="not deprecated">
  7743. <param name="scheme" type="java.lang.String"/>
  7744. <param name="host" type="java.lang.String"/>
  7745. <param name="port" type="int"/>
  7746. <param name="file" type="java.lang.String"/>
  7747. </method>
  7748. <method name="getScheme" return="java.lang.String"
  7749. abstract="true" native="false" synchronized="false"
  7750. static="false" final="false" visibility="public"
  7751. deprecated="not deprecated">
  7752. <doc>
  7753. <![CDATA[Get the scheme of the URL.
  7754. @return scheme of the URL]]>
  7755. </doc>
  7756. </method>
  7757. <method name="setScheme"
  7758. abstract="true" native="false" synchronized="false"
  7759. static="false" final="false" visibility="public"
  7760. deprecated="not deprecated">
  7761. <param name="scheme" type="java.lang.String"/>
  7762. <doc>
  7763. <![CDATA[Set the scheme of the URL
  7764. @param scheme scheme of the URL]]>
  7765. </doc>
  7766. </method>
  7767. <method name="getUserInfo" return="java.lang.String"
  7768. abstract="true" native="false" synchronized="false"
  7769. static="false" final="false" visibility="public"
  7770. deprecated="not deprecated">
  7771. <doc>
  7772. <![CDATA[Get the user info of the URL.
  7773. @return user info of the URL]]>
  7774. </doc>
  7775. </method>
  7776. <method name="setUserInfo"
  7777. abstract="true" native="false" synchronized="false"
  7778. static="false" final="false" visibility="public"
  7779. deprecated="not deprecated">
  7780. <param name="userInfo" type="java.lang.String"/>
  7781. <doc>
  7782. <![CDATA[Set the user info of the URL.
  7783. @param userInfo user info of the URL]]>
  7784. </doc>
  7785. </method>
  7786. <method name="getHost" return="java.lang.String"
  7787. abstract="true" native="false" synchronized="false"
  7788. static="false" final="false" visibility="public"
  7789. deprecated="not deprecated">
  7790. <doc>
  7791. <![CDATA[Get the host of the URL.
  7792. @return host of the URL]]>
  7793. </doc>
  7794. </method>
  7795. <method name="setHost"
  7796. abstract="true" native="false" synchronized="false"
  7797. static="false" final="false" visibility="public"
  7798. deprecated="not deprecated">
  7799. <param name="host" type="java.lang.String"/>
  7800. <doc>
  7801. <![CDATA[Set the host of the URL.
  7802. @param host host of the URL]]>
  7803. </doc>
  7804. </method>
  7805. <method name="getPort" return="int"
  7806. abstract="true" native="false" synchronized="false"
  7807. static="false" final="false" visibility="public"
  7808. deprecated="not deprecated">
  7809. <doc>
  7810. <![CDATA[Get the port of the URL.
  7811. @return port of the URL]]>
  7812. </doc>
  7813. </method>
  7814. <method name="setPort"
  7815. abstract="true" native="false" synchronized="false"
  7816. static="false" final="false" visibility="public"
  7817. deprecated="not deprecated">
  7818. <param name="port" type="int"/>
  7819. <doc>
  7820. <![CDATA[Set the port of the URL
  7821. @param port port of the URL]]>
  7822. </doc>
  7823. </method>
  7824. <method name="getFile" return="java.lang.String"
  7825. abstract="true" native="false" synchronized="false"
  7826. static="false" final="false" visibility="public"
  7827. deprecated="not deprecated">
  7828. <doc>
  7829. <![CDATA[Get the file of the URL.
  7830. @return file of the URL]]>
  7831. </doc>
  7832. </method>
  7833. <method name="setFile"
  7834. abstract="true" native="false" synchronized="false"
  7835. static="false" final="false" visibility="public"
  7836. deprecated="not deprecated">
  7837. <param name="file" type="java.lang.String"/>
  7838. <doc>
  7839. <![CDATA[Set the file of the URL.
  7840. @param file file of the URL]]>
  7841. </doc>
  7842. </method>
  7843. <doc>
  7844. <![CDATA[<p><code>URL</code> represents a serializable {@link java.net.URL}.</p>]]>
  7845. </doc>
  7846. </class>
  7847. <!-- end class org.apache.hadoop.yarn.api.records.URL -->
  7848. <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
  7849. <class name="YarnApplicationAttemptState" extends="java.lang.Enum"
  7850. abstract="false"
  7851. static="false" final="true" visibility="public"
  7852. deprecated="not deprecated">
  7853. <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState[]"
  7854. abstract="false" native="false" synchronized="false"
  7855. static="true" final="false" visibility="public"
  7856. deprecated="not deprecated">
  7857. </method>
  7858. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
  7859. abstract="false" native="false" synchronized="false"
  7860. static="true" final="false" visibility="public"
  7861. deprecated="not deprecated">
  7862. <param name="name" type="java.lang.String"/>
  7863. </method>
  7864. <doc>
  7865. <![CDATA[Enumeration of various states of a <code>RMAppAttempt</code>.]]>
  7866. </doc>
  7867. </class>
  7868. <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
  7869. <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
  7870. <class name="YarnApplicationState" extends="java.lang.Enum"
  7871. abstract="false"
  7872. static="false" final="true" visibility="public"
  7873. deprecated="not deprecated">
  7874. <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationState[]"
  7875. abstract="false" native="false" synchronized="false"
  7876. static="true" final="false" visibility="public"
  7877. deprecated="not deprecated">
  7878. </method>
  7879. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
  7880. abstract="false" native="false" synchronized="false"
  7881. static="true" final="false" visibility="public"
  7882. deprecated="not deprecated">
  7883. <param name="name" type="java.lang.String"/>
  7884. </method>
  7885. <doc>
  7886. <![CDATA[Enumeration of various states of an <code>ApplicationMaster</code>.]]>
  7887. </doc>
  7888. </class>
  7889. <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
  7890. <!-- start class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
  7891. <class name="YarnClusterMetrics" extends="java.lang.Object"
  7892. abstract="true"
  7893. static="false" final="false" visibility="public"
  7894. deprecated="not deprecated">
  7895. <constructor name="YarnClusterMetrics"
  7896. static="false" final="false" visibility="public"
  7897. deprecated="not deprecated">
  7898. </constructor>
  7899. <method name="getNumNodeManagers" return="int"
  7900. abstract="true" native="false" synchronized="false"
  7901. static="false" final="false" visibility="public"
  7902. deprecated="not deprecated">
  7903. <doc>
  7904. <![CDATA[Get the number of <code>NodeManager</code>s in the cluster.
  7905. @return number of <code>NodeManager</code>s in the cluster]]>
  7906. </doc>
  7907. </method>
  7908. <doc>
  7909. <![CDATA[<p><code>YarnClusterMetrics</code> represents cluster metrics.</p>
  7910. <p>Currently only number of <code>NodeManager</code>s is provided.</p>]]>
  7911. </doc>
  7912. </class>
  7913. <!-- end class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
  7914. </package>
  7915. <package name="org.apache.hadoop.yarn.api.records.timeline">
  7916. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
  7917. <class name="TimelineDelegationTokenResponse" extends="java.lang.Object"
  7918. abstract="false"
  7919. static="false" final="false" visibility="public"
  7920. deprecated="not deprecated">
  7921. <constructor name="TimelineDelegationTokenResponse"
  7922. static="false" final="false" visibility="public"
  7923. deprecated="not deprecated">
  7924. </constructor>
  7925. <method name="getType" return="java.lang.String"
  7926. abstract="false" native="false" synchronized="false"
  7927. static="false" final="false" visibility="public"
  7928. deprecated="not deprecated">
  7929. </method>
  7930. <method name="setType"
  7931. abstract="false" native="false" synchronized="false"
  7932. static="false" final="false" visibility="public"
  7933. deprecated="not deprecated">
  7934. <param name="type" type="java.lang.String"/>
  7935. </method>
  7936. <method name="getContent" return="java.lang.Object"
  7937. abstract="false" native="false" synchronized="false"
  7938. static="false" final="false" visibility="public"
  7939. deprecated="not deprecated">
  7940. </method>
  7941. <method name="setContent"
  7942. abstract="false" native="false" synchronized="false"
  7943. static="false" final="false" visibility="public"
  7944. deprecated="not deprecated">
  7945. <param name="content" type="java.lang.Object"/>
  7946. </method>
  7947. <doc>
  7948. <![CDATA[The response of delegation token related request]]>
  7949. </doc>
  7950. </class>
  7951. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
  7952. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
  7953. <class name="TimelineDomain" extends="java.lang.Object"
  7954. abstract="false"
  7955. static="false" final="false" visibility="public"
  7956. deprecated="not deprecated">
  7957. <constructor name="TimelineDomain"
  7958. static="false" final="false" visibility="public"
  7959. deprecated="not deprecated">
  7960. </constructor>
  7961. <method name="getId" return="java.lang.String"
  7962. abstract="false" native="false" synchronized="false"
  7963. static="false" final="false" visibility="public"
  7964. deprecated="not deprecated">
  7965. <doc>
  7966. <![CDATA[Get the domain ID
  7967. @return the domain ID]]>
  7968. </doc>
  7969. </method>
  7970. <method name="setId"
  7971. abstract="false" native="false" synchronized="false"
  7972. static="false" final="false" visibility="public"
  7973. deprecated="not deprecated">
  7974. <param name="id" type="java.lang.String"/>
  7975. <doc>
  7976. <![CDATA[Set the domain ID
  7977. @param id the domain ID]]>
  7978. </doc>
  7979. </method>
  7980. <method name="getDescription" return="java.lang.String"
  7981. abstract="false" native="false" synchronized="false"
  7982. static="false" final="false" visibility="public"
  7983. deprecated="not deprecated">
  7984. <doc>
  7985. <![CDATA[Get the domain description
  7986. @return the domain description]]>
  7987. </doc>
  7988. </method>
  7989. <method name="setDescription"
  7990. abstract="false" native="false" synchronized="false"
  7991. static="false" final="false" visibility="public"
  7992. deprecated="not deprecated">
  7993. <param name="description" type="java.lang.String"/>
  7994. <doc>
  7995. <![CDATA[Set the domain description
  7996. @param description the domain description]]>
  7997. </doc>
  7998. </method>
  7999. <method name="getOwner" return="java.lang.String"
  8000. abstract="false" native="false" synchronized="false"
  8001. static="false" final="false" visibility="public"
  8002. deprecated="not deprecated">
  8003. <doc>
  8004. <![CDATA[Get the domain owner
  8005. @return the domain owner]]>
  8006. </doc>
  8007. </method>
  8008. <method name="setOwner"
  8009. abstract="false" native="false" synchronized="false"
  8010. static="false" final="false" visibility="public"
  8011. deprecated="not deprecated">
  8012. <param name="owner" type="java.lang.String"/>
  8013. <doc>
  8014. <![CDATA[Set the domain owner. The user doesn't need to set it, which will
  8015. automatically set to the user who puts the domain.
  8016. @param owner the domain owner]]>
  8017. </doc>
  8018. </method>
  8019. <method name="getReaders" return="java.lang.String"
  8020. abstract="false" native="false" synchronized="false"
  8021. static="false" final="false" visibility="public"
  8022. deprecated="not deprecated">
  8023. <doc>
  8024. <![CDATA[Get the reader (and/or reader group) list string
  8025. @return the reader (and/or reader group) list string]]>
  8026. </doc>
  8027. </method>
  8028. <method name="setReaders"
  8029. abstract="false" native="false" synchronized="false"
  8030. static="false" final="false" visibility="public"
  8031. deprecated="not deprecated">
  8032. <param name="readers" type="java.lang.String"/>
  8033. <doc>
  8034. <![CDATA[Set the reader (and/or reader group) list string
  8035. @param readers the reader (and/or reader group) list string]]>
  8036. </doc>
  8037. </method>
  8038. <method name="getWriters" return="java.lang.String"
  8039. abstract="false" native="false" synchronized="false"
  8040. static="false" final="false" visibility="public"
  8041. deprecated="not deprecated">
  8042. <doc>
  8043. <![CDATA[Get the writer (and/or writer group) list string
  8044. @return the writer (and/or writer group) list string]]>
  8045. </doc>
  8046. </method>
  8047. <method name="setWriters"
  8048. abstract="false" native="false" synchronized="false"
  8049. static="false" final="false" visibility="public"
  8050. deprecated="not deprecated">
  8051. <param name="writers" type="java.lang.String"/>
  8052. <doc>
  8053. <![CDATA[Set the writer (and/or writer group) list string
  8054. @param writers the writer (and/or writer group) list string]]>
  8055. </doc>
  8056. </method>
  8057. <method name="getCreatedTime" return="java.lang.Long"
  8058. abstract="false" native="false" synchronized="false"
  8059. static="false" final="false" visibility="public"
  8060. deprecated="not deprecated">
  8061. <doc>
  8062. <![CDATA[Get the created time of the domain
  8063. @return the created time of the domain]]>
  8064. </doc>
  8065. </method>
  8066. <method name="setCreatedTime"
  8067. abstract="false" native="false" synchronized="false"
  8068. static="false" final="false" visibility="public"
  8069. deprecated="not deprecated">
  8070. <param name="createdTime" type="java.lang.Long"/>
  8071. <doc>
  8072. <![CDATA[Set the created time of the domain
  8073. @param createdTime the created time of the domain]]>
  8074. </doc>
  8075. </method>
  8076. <method name="getModifiedTime" return="java.lang.Long"
  8077. abstract="false" native="false" synchronized="false"
  8078. static="false" final="false" visibility="public"
  8079. deprecated="not deprecated">
  8080. <doc>
  8081. <![CDATA[Get the modified time of the domain
  8082. @return the modified time of the domain]]>
  8083. </doc>
  8084. </method>
  8085. <method name="setModifiedTime"
  8086. abstract="false" native="false" synchronized="false"
  8087. static="false" final="false" visibility="public"
  8088. deprecated="not deprecated">
  8089. <param name="modifiedTime" type="java.lang.Long"/>
  8090. <doc>
  8091. <![CDATA[Set the modified time of the domain
  8092. @param modifiedTime the modified time of the domain]]>
  8093. </doc>
  8094. </method>
  8095. <doc>
  8096. <![CDATA[<p>
  8097. This class contains the information about a timeline domain, which is used
  8098. to a user to host a number of timeline entities, isolating them from others'.
  8099. The user can also define the reader and writer users/groups for the the
  8100. domain, which is used to control the access to its entities.
  8101. </p>
  8102. <p>
  8103. The reader and writer users/groups pattern that the user can supply is the
  8104. same as what <code>AccessControlList</code> takes.
  8105. </p>]]>
  8106. </doc>
  8107. </class>
  8108. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
  8109. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
  8110. <class name="TimelineDomains" extends="java.lang.Object"
  8111. abstract="false"
  8112. static="false" final="false" visibility="public"
  8113. deprecated="not deprecated">
  8114. <constructor name="TimelineDomains"
  8115. static="false" final="false" visibility="public"
  8116. deprecated="not deprecated">
  8117. </constructor>
  8118. <method name="getDomains" return="java.util.List"
  8119. abstract="false" native="false" synchronized="false"
  8120. static="false" final="false" visibility="public"
  8121. deprecated="not deprecated">
  8122. <doc>
  8123. <![CDATA[Get a list of domains
  8124. @return a list of domains]]>
  8125. </doc>
  8126. </method>
  8127. <method name="addDomain"
  8128. abstract="false" native="false" synchronized="false"
  8129. static="false" final="false" visibility="public"
  8130. deprecated="not deprecated">
  8131. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  8132. <doc>
  8133. <![CDATA[Add a single domain into the existing domain list
  8134. @param domain
  8135. a single domain]]>
  8136. </doc>
  8137. </method>
  8138. <method name="addDomains"
  8139. abstract="false" native="false" synchronized="false"
  8140. static="false" final="false" visibility="public"
  8141. deprecated="not deprecated">
  8142. <param name="domains" type="java.util.List"/>
  8143. <doc>
  8144. <![CDATA[All a list of domains into the existing domain list
  8145. @param domains
  8146. a list of domains]]>
  8147. </doc>
  8148. </method>
  8149. <method name="setDomains"
  8150. abstract="false" native="false" synchronized="false"
  8151. static="false" final="false" visibility="public"
  8152. deprecated="not deprecated">
  8153. <param name="domains" type="java.util.List"/>
  8154. <doc>
  8155. <![CDATA[Set the domain list to the given list of domains
  8156. @param domains
  8157. a list of domains]]>
  8158. </doc>
  8159. </method>
  8160. <doc>
  8161. <![CDATA[The class that hosts a list of timeline domains.]]>
  8162. </doc>
  8163. </class>
  8164. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
  8165. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
  8166. <class name="TimelineEntities" extends="java.lang.Object"
  8167. abstract="false"
  8168. static="false" final="false" visibility="public"
  8169. deprecated="not deprecated">
  8170. <constructor name="TimelineEntities"
  8171. static="false" final="false" visibility="public"
  8172. deprecated="not deprecated">
  8173. </constructor>
  8174. <method name="getEntities" return="java.util.List"
  8175. abstract="false" native="false" synchronized="false"
  8176. static="false" final="false" visibility="public"
  8177. deprecated="not deprecated">
  8178. <doc>
  8179. <![CDATA[Get a list of entities
  8180. @return a list of entities]]>
  8181. </doc>
  8182. </method>
  8183. <method name="addEntity"
  8184. abstract="false" native="false" synchronized="false"
  8185. static="false" final="false" visibility="public"
  8186. deprecated="not deprecated">
  8187. <param name="entity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
  8188. <doc>
  8189. <![CDATA[Add a single entity into the existing entity list
  8190. @param entity
  8191. a single entity]]>
  8192. </doc>
  8193. </method>
  8194. <method name="addEntities"
  8195. abstract="false" native="false" synchronized="false"
  8196. static="false" final="false" visibility="public"
  8197. deprecated="not deprecated">
  8198. <param name="entities" type="java.util.List"/>
  8199. <doc>
  8200. <![CDATA[All a list of entities into the existing entity list
  8201. @param entities
  8202. a list of entities]]>
  8203. </doc>
  8204. </method>
  8205. <method name="setEntities"
  8206. abstract="false" native="false" synchronized="false"
  8207. static="false" final="false" visibility="public"
  8208. deprecated="not deprecated">
  8209. <param name="entities" type="java.util.List"/>
  8210. <doc>
  8211. <![CDATA[Set the entity list to the given list of entities
  8212. @param entities
  8213. a list of entities]]>
  8214. </doc>
  8215. </method>
  8216. <doc>
  8217. <![CDATA[The class that hosts a list of timeline entities.]]>
  8218. </doc>
  8219. </class>
  8220. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
  8221. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
  8222. <class name="TimelineEntity" extends="java.lang.Object"
  8223. abstract="false"
  8224. static="false" final="false" visibility="public"
  8225. deprecated="not deprecated">
  8226. <implements name="java.lang.Comparable"/>
  8227. <constructor name="TimelineEntity"
  8228. static="false" final="false" visibility="public"
  8229. deprecated="not deprecated">
  8230. </constructor>
  8231. <method name="getEntityType" return="java.lang.String"
  8232. abstract="false" native="false" synchronized="false"
  8233. static="false" final="false" visibility="public"
  8234. deprecated="not deprecated">
  8235. <doc>
  8236. <![CDATA[Get the entity type
  8237. @return the entity type]]>
  8238. </doc>
  8239. </method>
  8240. <method name="setEntityType"
  8241. abstract="false" native="false" synchronized="false"
  8242. static="false" final="false" visibility="public"
  8243. deprecated="not deprecated">
  8244. <param name="entityType" type="java.lang.String"/>
  8245. <doc>
  8246. <![CDATA[Set the entity type
  8247. @param entityType
  8248. the entity type]]>
  8249. </doc>
  8250. </method>
  8251. <method name="getEntityId" return="java.lang.String"
  8252. abstract="false" native="false" synchronized="false"
  8253. static="false" final="false" visibility="public"
  8254. deprecated="not deprecated">
  8255. <doc>
  8256. <![CDATA[Get the entity Id
  8257. @return the entity Id]]>
  8258. </doc>
  8259. </method>
  8260. <method name="setEntityId"
  8261. abstract="false" native="false" synchronized="false"
  8262. static="false" final="false" visibility="public"
  8263. deprecated="not deprecated">
  8264. <param name="entityId" type="java.lang.String"/>
  8265. <doc>
  8266. <![CDATA[Set the entity Id
  8267. @param entityId
  8268. the entity Id]]>
  8269. </doc>
  8270. </method>
  8271. <method name="getStartTime" return="java.lang.Long"
  8272. abstract="false" native="false" synchronized="false"
  8273. static="false" final="false" visibility="public"
  8274. deprecated="not deprecated">
  8275. <doc>
  8276. <![CDATA[Get the start time of the entity
  8277. @return the start time of the entity]]>
  8278. </doc>
  8279. </method>
  8280. <method name="setStartTime"
  8281. abstract="false" native="false" synchronized="false"
  8282. static="false" final="false" visibility="public"
  8283. deprecated="not deprecated">
  8284. <param name="startTime" type="java.lang.Long"/>
  8285. <doc>
  8286. <![CDATA[Set the start time of the entity
  8287. @param startTime
  8288. the start time of the entity]]>
  8289. </doc>
  8290. </method>
  8291. <method name="getEvents" return="java.util.List"
  8292. abstract="false" native="false" synchronized="false"
  8293. static="false" final="false" visibility="public"
  8294. deprecated="not deprecated">
  8295. <doc>
  8296. <![CDATA[Get a list of events related to the entity
  8297. @return a list of events related to the entity]]>
  8298. </doc>
  8299. </method>
  8300. <method name="addEvent"
  8301. abstract="false" native="false" synchronized="false"
  8302. static="false" final="false" visibility="public"
  8303. deprecated="not deprecated">
  8304. <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  8305. <doc>
  8306. <![CDATA[Add a single event related to the entity to the existing event list
  8307. @param event
  8308. a single event related to the entity]]>
  8309. </doc>
  8310. </method>
  8311. <method name="addEvents"
  8312. abstract="false" native="false" synchronized="false"
  8313. static="false" final="false" visibility="public"
  8314. deprecated="not deprecated">
  8315. <param name="events" type="java.util.List"/>
  8316. <doc>
  8317. <![CDATA[Add a list of events related to the entity to the existing event list
  8318. @param events
  8319. a list of events related to the entity]]>
  8320. </doc>
  8321. </method>
  8322. <method name="setEvents"
  8323. abstract="false" native="false" synchronized="false"
  8324. static="false" final="false" visibility="public"
  8325. deprecated="not deprecated">
  8326. <param name="events" type="java.util.List"/>
  8327. <doc>
  8328. <![CDATA[Set the event list to the given list of events related to the entity
  8329. @param events
  8330. events a list of events related to the entity]]>
  8331. </doc>
  8332. </method>
  8333. <method name="getRelatedEntities" return="java.util.Map"
  8334. abstract="false" native="false" synchronized="false"
  8335. static="false" final="false" visibility="public"
  8336. deprecated="not deprecated">
  8337. <doc>
  8338. <![CDATA[Get the related entities
  8339. @return the related entities]]>
  8340. </doc>
  8341. </method>
  8342. <method name="addRelatedEntity"
  8343. abstract="false" native="false" synchronized="false"
  8344. static="false" final="false" visibility="public"
  8345. deprecated="not deprecated">
  8346. <param name="entityType" type="java.lang.String"/>
  8347. <param name="entityId" type="java.lang.String"/>
  8348. <doc>
  8349. <![CDATA[Add an entity to the existing related entity map
  8350. @param entityType
  8351. the entity type
  8352. @param entityId
  8353. the entity Id]]>
  8354. </doc>
  8355. </method>
  8356. <method name="addRelatedEntities"
  8357. abstract="false" native="false" synchronized="false"
  8358. static="false" final="false" visibility="public"
  8359. deprecated="not deprecated">
  8360. <param name="relatedEntities" type="java.util.Map"/>
  8361. <doc>
  8362. <![CDATA[Add a map of related entities to the existing related entity map
  8363. @param relatedEntities
  8364. a map of related entities]]>
  8365. </doc>
  8366. </method>
  8367. <method name="setRelatedEntities"
  8368. abstract="false" native="false" synchronized="false"
  8369. static="false" final="false" visibility="public"
  8370. deprecated="not deprecated">
  8371. <param name="relatedEntities" type="java.util.Map"/>
  8372. <doc>
  8373. <![CDATA[Set the related entity map to the given map of related entities
  8374. @param relatedEntities
  8375. a map of related entities]]>
  8376. </doc>
  8377. </method>
  8378. <method name="getPrimaryFilters" return="java.util.Map"
  8379. abstract="false" native="false" synchronized="false"
  8380. static="false" final="false" visibility="public"
  8381. deprecated="not deprecated">
  8382. <doc>
  8383. <![CDATA[Get the primary filters
  8384. @return the primary filters]]>
  8385. </doc>
  8386. </method>
  8387. <method name="addPrimaryFilter"
  8388. abstract="false" native="false" synchronized="false"
  8389. static="false" final="false" visibility="public"
  8390. deprecated="not deprecated">
  8391. <param name="key" type="java.lang.String"/>
  8392. <param name="value" type="java.lang.Object"/>
  8393. <doc>
  8394. <![CDATA[Add a single piece of primary filter to the existing primary filter map
  8395. @param key
  8396. the primary filter key
  8397. @param value
  8398. the primary filter value]]>
  8399. </doc>
  8400. </method>
  8401. <method name="addPrimaryFilters"
  8402. abstract="false" native="false" synchronized="false"
  8403. static="false" final="false" visibility="public"
  8404. deprecated="not deprecated">
  8405. <param name="primaryFilters" type="java.util.Map"/>
  8406. <doc>
  8407. <![CDATA[Add a map of primary filters to the existing primary filter map
  8408. @param primaryFilters
  8409. a map of primary filters]]>
  8410. </doc>
  8411. </method>
  8412. <method name="setPrimaryFilters"
  8413. abstract="false" native="false" synchronized="false"
  8414. static="false" final="false" visibility="public"
  8415. deprecated="not deprecated">
  8416. <param name="primaryFilters" type="java.util.Map"/>
  8417. <doc>
  8418. <![CDATA[Set the primary filter map to the given map of primary filters
  8419. @param primaryFilters
  8420. a map of primary filters]]>
  8421. </doc>
  8422. </method>
  8423. <method name="getOtherInfo" return="java.util.Map"
  8424. abstract="false" native="false" synchronized="false"
  8425. static="false" final="false" visibility="public"
  8426. deprecated="not deprecated">
  8427. <doc>
  8428. <![CDATA[Get the other information of the entity
  8429. @return the other information of the entity]]>
  8430. </doc>
  8431. </method>
  8432. <method name="addOtherInfo"
  8433. abstract="false" native="false" synchronized="false"
  8434. static="false" final="false" visibility="public"
  8435. deprecated="not deprecated">
  8436. <param name="key" type="java.lang.String"/>
  8437. <param name="value" type="java.lang.Object"/>
  8438. <doc>
  8439. <![CDATA[Add one piece of other information of the entity to the existing other info
  8440. map
  8441. @param key
  8442. the other information key
  8443. @param value
  8444. the other information value]]>
  8445. </doc>
  8446. </method>
  8447. <method name="addOtherInfo"
  8448. abstract="false" native="false" synchronized="false"
  8449. static="false" final="false" visibility="public"
  8450. deprecated="not deprecated">
  8451. <param name="otherInfo" type="java.util.Map"/>
  8452. <doc>
  8453. <![CDATA[Add a map of other information of the entity to the existing other info map
  8454. @param otherInfo
  8455. a map of other information]]>
  8456. </doc>
  8457. </method>
  8458. <method name="setOtherInfo"
  8459. abstract="false" native="false" synchronized="false"
  8460. static="false" final="false" visibility="public"
  8461. deprecated="not deprecated">
  8462. <param name="otherInfo" type="java.util.Map"/>
  8463. <doc>
  8464. <![CDATA[Set the other info map to the given map of other information
  8465. @param otherInfo
  8466. a map of other information]]>
  8467. </doc>
  8468. </method>
  8469. <method name="getDomainId" return="java.lang.String"
  8470. abstract="false" native="false" synchronized="false"
  8471. static="false" final="false" visibility="public"
  8472. deprecated="not deprecated">
  8473. <doc>
  8474. <![CDATA[Get the ID of the domain that the entity is to be put
  8475. @return the domain ID]]>
  8476. </doc>
  8477. </method>
  8478. <method name="setDomainId"
  8479. abstract="false" native="false" synchronized="false"
  8480. static="false" final="false" visibility="public"
  8481. deprecated="not deprecated">
  8482. <param name="domainId" type="java.lang.String"/>
  8483. <doc>
  8484. <![CDATA[Set the ID of the domain that the entity is to be put
  8485. @param domainId
  8486. the name space ID]]>
  8487. </doc>
  8488. </method>
  8489. <method name="hashCode" return="int"
  8490. abstract="false" native="false" synchronized="false"
  8491. static="false" final="false" visibility="public"
  8492. deprecated="not deprecated">
  8493. </method>
  8494. <method name="equals" return="boolean"
  8495. abstract="false" native="false" synchronized="false"
  8496. static="false" final="false" visibility="public"
  8497. deprecated="not deprecated">
  8498. <param name="obj" type="java.lang.Object"/>
  8499. </method>
  8500. <method name="compareTo" return="int"
  8501. abstract="false" native="false" synchronized="false"
  8502. static="false" final="false" visibility="public"
  8503. deprecated="not deprecated">
  8504. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
  8505. </method>
  8506. <doc>
  8507. <![CDATA[<p>
  8508. The class that contains the the meta information of some conceptual entity
  8509. and its related events. The entity can be an application, an application
  8510. attempt, a container or whatever the user-defined object.
  8511. </p>
  8512. <p>
  8513. Primary filters will be used to index the entities in
  8514. <code>TimelineStore</code>, such that users should carefully choose the
  8515. information they want to store as the primary filters. The remaining can be
  8516. stored as other information.
  8517. </p>]]>
  8518. </doc>
  8519. </class>
  8520. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
  8521. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
  8522. <class name="TimelineEvent" extends="java.lang.Object"
  8523. abstract="false"
  8524. static="false" final="false" visibility="public"
  8525. deprecated="not deprecated">
  8526. <implements name="java.lang.Comparable"/>
  8527. <constructor name="TimelineEvent"
  8528. static="false" final="false" visibility="public"
  8529. deprecated="not deprecated">
  8530. </constructor>
  8531. <method name="getTimestamp" return="long"
  8532. abstract="false" native="false" synchronized="false"
  8533. static="false" final="false" visibility="public"
  8534. deprecated="not deprecated">
  8535. <doc>
  8536. <![CDATA[Get the timestamp of the event
  8537. @return the timestamp of the event]]>
  8538. </doc>
  8539. </method>
  8540. <method name="setTimestamp"
  8541. abstract="false" native="false" synchronized="false"
  8542. static="false" final="false" visibility="public"
  8543. deprecated="not deprecated">
  8544. <param name="timestamp" type="long"/>
  8545. <doc>
  8546. <![CDATA[Set the timestamp of the event
  8547. @param timestamp
  8548. the timestamp of the event]]>
  8549. </doc>
  8550. </method>
  8551. <method name="getEventType" return="java.lang.String"
  8552. abstract="false" native="false" synchronized="false"
  8553. static="false" final="false" visibility="public"
  8554. deprecated="not deprecated">
  8555. <doc>
  8556. <![CDATA[Get the event type
  8557. @return the event type]]>
  8558. </doc>
  8559. </method>
  8560. <method name="setEventType"
  8561. abstract="false" native="false" synchronized="false"
  8562. static="false" final="false" visibility="public"
  8563. deprecated="not deprecated">
  8564. <param name="eventType" type="java.lang.String"/>
  8565. <doc>
  8566. <![CDATA[Set the event type
  8567. @param eventType
  8568. the event type]]>
  8569. </doc>
  8570. </method>
  8571. <method name="getEventInfo" return="java.util.Map"
  8572. abstract="false" native="false" synchronized="false"
  8573. static="false" final="false" visibility="public"
  8574. deprecated="not deprecated">
  8575. <doc>
  8576. <![CDATA[Set the information of the event
  8577. @return the information of the event]]>
  8578. </doc>
  8579. </method>
  8580. <method name="addEventInfo"
  8581. abstract="false" native="false" synchronized="false"
  8582. static="false" final="false" visibility="public"
  8583. deprecated="not deprecated">
  8584. <param name="key" type="java.lang.String"/>
  8585. <param name="value" type="java.lang.Object"/>
  8586. <doc>
  8587. <![CDATA[Add one piece of the information of the event to the existing information
  8588. map
  8589. @param key
  8590. the information key
  8591. @param value
  8592. the information value]]>
  8593. </doc>
  8594. </method>
  8595. <method name="addEventInfo"
  8596. abstract="false" native="false" synchronized="false"
  8597. static="false" final="false" visibility="public"
  8598. deprecated="not deprecated">
  8599. <param name="eventInfo" type="java.util.Map"/>
  8600. <doc>
  8601. <![CDATA[Add a map of the information of the event to the existing information map
  8602. @param eventInfo
  8603. a map of of the information of the event]]>
  8604. </doc>
  8605. </method>
  8606. <method name="setEventInfo"
  8607. abstract="false" native="false" synchronized="false"
  8608. static="false" final="false" visibility="public"
  8609. deprecated="not deprecated">
  8610. <param name="eventInfo" type="java.util.Map"/>
  8611. <doc>
  8612. <![CDATA[Set the information map to the given map of the information of the event
  8613. @param eventInfo
  8614. a map of of the information of the event]]>
  8615. </doc>
  8616. </method>
  8617. <method name="compareTo" return="int"
  8618. abstract="false" native="false" synchronized="false"
  8619. static="false" final="false" visibility="public"
  8620. deprecated="not deprecated">
  8621. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  8622. </method>
  8623. <method name="equals" return="boolean"
  8624. abstract="false" native="false" synchronized="false"
  8625. static="false" final="false" visibility="public"
  8626. deprecated="not deprecated">
  8627. <param name="o" type="java.lang.Object"/>
  8628. </method>
  8629. <method name="hashCode" return="int"
  8630. abstract="false" native="false" synchronized="false"
  8631. static="false" final="false" visibility="public"
  8632. deprecated="not deprecated">
  8633. </method>
  8634. <doc>
  8635. <![CDATA[The class that contains the information of an event that is related to some
  8636. conceptual entity of an application. Users are free to define what the event
  8637. means, such as starting an application, getting allocated a container and
  8638. etc.]]>
  8639. </doc>
  8640. </class>
  8641. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
  8642. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
  8643. <class name="TimelineEvents" extends="java.lang.Object"
  8644. abstract="false"
  8645. static="false" final="false" visibility="public"
  8646. deprecated="not deprecated">
  8647. <constructor name="TimelineEvents"
  8648. static="false" final="false" visibility="public"
  8649. deprecated="not deprecated">
  8650. </constructor>
  8651. <method name="getAllEvents" return="java.util.List"
  8652. abstract="false" native="false" synchronized="false"
  8653. static="false" final="false" visibility="public"
  8654. deprecated="not deprecated">
  8655. <doc>
  8656. <![CDATA[Get a list of {@link EventsOfOneEntity} instances
  8657. @return a list of {@link EventsOfOneEntity} instances]]>
  8658. </doc>
  8659. </method>
  8660. <method name="addEvent"
  8661. abstract="false" native="false" synchronized="false"
  8662. static="false" final="false" visibility="public"
  8663. deprecated="not deprecated">
  8664. <param name="eventsOfOneEntity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity"/>
  8665. <doc>
  8666. <![CDATA[Add a single {@link EventsOfOneEntity} instance into the existing list
  8667. @param eventsOfOneEntity
  8668. a single {@link EventsOfOneEntity} instance]]>
  8669. </doc>
  8670. </method>
  8671. <method name="addEvents"
  8672. abstract="false" native="false" synchronized="false"
  8673. static="false" final="false" visibility="public"
  8674. deprecated="not deprecated">
  8675. <param name="allEvents" type="java.util.List"/>
  8676. <doc>
  8677. <![CDATA[Add a list of {@link EventsOfOneEntity} instances into the existing list
  8678. @param allEvents
  8679. a list of {@link EventsOfOneEntity} instances]]>
  8680. </doc>
  8681. </method>
  8682. <method name="setEvents"
  8683. abstract="false" native="false" synchronized="false"
  8684. static="false" final="false" visibility="public"
  8685. deprecated="not deprecated">
  8686. <param name="allEvents" type="java.util.List"/>
  8687. <doc>
  8688. <![CDATA[Set the list to the given list of {@link EventsOfOneEntity} instances
  8689. @param allEvents
  8690. a list of {@link EventsOfOneEntity} instances]]>
  8691. </doc>
  8692. </method>
  8693. <doc>
  8694. <![CDATA[The class that hosts a list of events, which are categorized according to
  8695. their related entities.]]>
  8696. </doc>
  8697. </class>
  8698. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
  8699. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
  8700. <class name="TimelineEvents.EventsOfOneEntity" extends="java.lang.Object"
  8701. abstract="false"
  8702. static="true" final="false" visibility="public"
  8703. deprecated="not deprecated">
  8704. <constructor name="EventsOfOneEntity"
  8705. static="false" final="false" visibility="public"
  8706. deprecated="not deprecated">
  8707. </constructor>
  8708. <method name="getEntityId" return="java.lang.String"
  8709. abstract="false" native="false" synchronized="false"
  8710. static="false" final="false" visibility="public"
  8711. deprecated="not deprecated">
  8712. <doc>
  8713. <![CDATA[Get the entity Id
  8714. @return the entity Id]]>
  8715. </doc>
  8716. </method>
  8717. <method name="setEntityId"
  8718. abstract="false" native="false" synchronized="false"
  8719. static="false" final="false" visibility="public"
  8720. deprecated="not deprecated">
  8721. <param name="entityId" type="java.lang.String"/>
  8722. <doc>
  8723. <![CDATA[Set the entity Id
  8724. @param entityId
  8725. the entity Id]]>
  8726. </doc>
  8727. </method>
  8728. <method name="getEntityType" return="java.lang.String"
  8729. abstract="false" native="false" synchronized="false"
  8730. static="false" final="false" visibility="public"
  8731. deprecated="not deprecated">
  8732. <doc>
  8733. <![CDATA[Get the entity type
  8734. @return the entity type]]>
  8735. </doc>
  8736. </method>
  8737. <method name="setEntityType"
  8738. abstract="false" native="false" synchronized="false"
  8739. static="false" final="false" visibility="public"
  8740. deprecated="not deprecated">
  8741. <param name="entityType" type="java.lang.String"/>
  8742. <doc>
  8743. <![CDATA[Set the entity type
  8744. @param entityType
  8745. the entity type]]>
  8746. </doc>
  8747. </method>
  8748. <method name="getEvents" return="java.util.List"
  8749. abstract="false" native="false" synchronized="false"
  8750. static="false" final="false" visibility="public"
  8751. deprecated="not deprecated">
  8752. <doc>
  8753. <![CDATA[Get a list of events
  8754. @return a list of events]]>
  8755. </doc>
  8756. </method>
  8757. <method name="addEvent"
  8758. abstract="false" native="false" synchronized="false"
  8759. static="false" final="false" visibility="public"
  8760. deprecated="not deprecated">
  8761. <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  8762. <doc>
  8763. <![CDATA[Add a single event to the existing event list
  8764. @param event
  8765. a single event]]>
  8766. </doc>
  8767. </method>
  8768. <method name="addEvents"
  8769. abstract="false" native="false" synchronized="false"
  8770. static="false" final="false" visibility="public"
  8771. deprecated="not deprecated">
  8772. <param name="events" type="java.util.List"/>
  8773. <doc>
  8774. <![CDATA[Add a list of event to the existing event list
  8775. @param events
  8776. a list of events]]>
  8777. </doc>
  8778. </method>
  8779. <method name="setEvents"
  8780. abstract="false" native="false" synchronized="false"
  8781. static="false" final="false" visibility="public"
  8782. deprecated="not deprecated">
  8783. <param name="events" type="java.util.List"/>
  8784. <doc>
  8785. <![CDATA[Set the event list to the given list of events
  8786. @param events
  8787. a list of events]]>
  8788. </doc>
  8789. </method>
  8790. <doc>
  8791. <![CDATA[The class that hosts a list of events that are only related to one entity.]]>
  8792. </doc>
  8793. </class>
  8794. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
  8795. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
  8796. <class name="TimelinePutResponse" extends="java.lang.Object"
  8797. abstract="false"
  8798. static="false" final="false" visibility="public"
  8799. deprecated="not deprecated">
  8800. <constructor name="TimelinePutResponse"
  8801. static="false" final="false" visibility="public"
  8802. deprecated="not deprecated">
  8803. </constructor>
  8804. <method name="getErrors" return="java.util.List"
  8805. abstract="false" native="false" synchronized="false"
  8806. static="false" final="false" visibility="public"
  8807. deprecated="not deprecated">
  8808. <doc>
  8809. <![CDATA[Get a list of {@link TimelinePutError} instances
  8810. @return a list of {@link TimelinePutError} instances]]>
  8811. </doc>
  8812. </method>
  8813. <method name="addError"
  8814. abstract="false" native="false" synchronized="false"
  8815. static="false" final="false" visibility="public"
  8816. deprecated="not deprecated">
  8817. <param name="error" type="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError"/>
  8818. <doc>
  8819. <![CDATA[Add a single {@link TimelinePutError} instance into the existing list
  8820. @param error
  8821. a single {@link TimelinePutError} instance]]>
  8822. </doc>
  8823. </method>
  8824. <method name="addErrors"
  8825. abstract="false" native="false" synchronized="false"
  8826. static="false" final="false" visibility="public"
  8827. deprecated="not deprecated">
  8828. <param name="errors" type="java.util.List"/>
  8829. <doc>
  8830. <![CDATA[Add a list of {@link TimelinePutError} instances into the existing list
  8831. @param errors
  8832. a list of {@link TimelinePutError} instances]]>
  8833. </doc>
  8834. </method>
  8835. <method name="setErrors"
  8836. abstract="false" native="false" synchronized="false"
  8837. static="false" final="false" visibility="public"
  8838. deprecated="not deprecated">
  8839. <param name="errors" type="java.util.List"/>
  8840. <doc>
  8841. <![CDATA[Set the list to the given list of {@link TimelinePutError} instances
  8842. @param errors
  8843. a list of {@link TimelinePutError} instances]]>
  8844. </doc>
  8845. </method>
  8846. <doc>
  8847. <![CDATA[A class that holds a list of put errors. This is the response returned when a
  8848. list of {@link TimelineEntity} objects is added to the timeline. If there are errors
  8849. in storing individual entity objects, they will be indicated in the list of
  8850. errors.]]>
  8851. </doc>
  8852. </class>
  8853. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
  8854. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
  8855. <class name="TimelinePutResponse.TimelinePutError" extends="java.lang.Object"
  8856. abstract="false"
  8857. static="true" final="false" visibility="public"
  8858. deprecated="not deprecated">
  8859. <constructor name="TimelinePutError"
  8860. static="false" final="false" visibility="public"
  8861. deprecated="not deprecated">
  8862. </constructor>
  8863. <method name="getEntityId" return="java.lang.String"
  8864. abstract="false" native="false" synchronized="false"
  8865. static="false" final="false" visibility="public"
  8866. deprecated="not deprecated">
  8867. <doc>
  8868. <![CDATA[Get the entity Id
  8869. @return the entity Id]]>
  8870. </doc>
  8871. </method>
  8872. <method name="setEntityId"
  8873. abstract="false" native="false" synchronized="false"
  8874. static="false" final="false" visibility="public"
  8875. deprecated="not deprecated">
  8876. <param name="entityId" type="java.lang.String"/>
  8877. <doc>
  8878. <![CDATA[Set the entity Id
  8879. @param entityId
  8880. the entity Id]]>
  8881. </doc>
  8882. </method>
  8883. <method name="getEntityType" return="java.lang.String"
  8884. abstract="false" native="false" synchronized="false"
  8885. static="false" final="false" visibility="public"
  8886. deprecated="not deprecated">
  8887. <doc>
  8888. <![CDATA[Get the entity type
  8889. @return the entity type]]>
  8890. </doc>
  8891. </method>
  8892. <method name="setEntityType"
  8893. abstract="false" native="false" synchronized="false"
  8894. static="false" final="false" visibility="public"
  8895. deprecated="not deprecated">
  8896. <param name="entityType" type="java.lang.String"/>
  8897. <doc>
  8898. <![CDATA[Set the entity type
  8899. @param entityType
  8900. the entity type]]>
  8901. </doc>
  8902. </method>
  8903. <method name="getErrorCode" return="int"
  8904. abstract="false" native="false" synchronized="false"
  8905. static="false" final="false" visibility="public"
  8906. deprecated="not deprecated">
  8907. <doc>
  8908. <![CDATA[Get the error code
  8909. @return an error code]]>
  8910. </doc>
  8911. </method>
  8912. <method name="setErrorCode"
  8913. abstract="false" native="false" synchronized="false"
  8914. static="false" final="false" visibility="public"
  8915. deprecated="not deprecated">
  8916. <param name="errorCode" type="int"/>
  8917. <doc>
  8918. <![CDATA[Set the error code to the given error code
  8919. @param errorCode
  8920. an error code]]>
  8921. </doc>
  8922. </method>
  8923. <field name="NO_START_TIME" type="int"
  8924. transient="false" volatile="false"
  8925. static="true" final="true" visibility="public"
  8926. deprecated="not deprecated">
  8927. <doc>
  8928. <![CDATA[Error code returned when no start time can be found when putting an
  8929. entity. This occurs when the entity does not already exist in the store
  8930. and it is put with no start time or events specified.]]>
  8931. </doc>
  8932. </field>
  8933. <field name="IO_EXCEPTION" type="int"
  8934. transient="false" volatile="false"
  8935. static="true" final="true" visibility="public"
  8936. deprecated="not deprecated">
  8937. <doc>
  8938. <![CDATA[Error code returned if an IOException is encountered when putting an
  8939. entity.]]>
  8940. </doc>
  8941. </field>
  8942. <field name="SYSTEM_FILTER_CONFLICT" type="int"
  8943. transient="false" volatile="false"
  8944. static="true" final="true" visibility="public"
  8945. deprecated="not deprecated">
  8946. <doc>
  8947. <![CDATA[Error code returned if the user specifies the timeline system reserved
  8948. filter key]]>
  8949. </doc>
  8950. </field>
  8951. <field name="ACCESS_DENIED" type="int"
  8952. transient="false" volatile="false"
  8953. static="true" final="true" visibility="public"
  8954. deprecated="not deprecated">
  8955. <doc>
  8956. <![CDATA[Error code returned if the user is denied to access the timeline data]]>
  8957. </doc>
  8958. </field>
  8959. <field name="NO_DOMAIN" type="int"
  8960. transient="false" volatile="false"
  8961. static="true" final="true" visibility="public"
  8962. deprecated="not deprecated">
  8963. <doc>
  8964. <![CDATA[Error code returned if the entity doesn't have an valid domain ID]]>
  8965. </doc>
  8966. </field>
  8967. <field name="FORBIDDEN_RELATION" type="int"
  8968. transient="false" volatile="false"
  8969. static="true" final="true" visibility="public"
  8970. deprecated="not deprecated">
  8971. <doc>
  8972. <![CDATA[Error code returned if the user is denied to relate the entity to another
  8973. one in different domain]]>
  8974. </doc>
  8975. </field>
  8976. <doc>
  8977. <![CDATA[A class that holds the error code for one entity.]]>
  8978. </doc>
  8979. </class>
  8980. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
  8981. </package>
  8982. <package name="org.apache.hadoop.yarn.conf">
  8983. <!-- start class org.apache.hadoop.yarn.conf.YarnConfiguration -->
  8984. <class name="YarnConfiguration" extends="org.apache.hadoop.conf.Configuration"
  8985. abstract="false"
  8986. static="false" final="false" visibility="public"
  8987. deprecated="not deprecated">
  8988. <constructor name="YarnConfiguration"
  8989. static="false" final="false" visibility="public"
  8990. deprecated="not deprecated">
  8991. </constructor>
  8992. <constructor name="YarnConfiguration" type="org.apache.hadoop.conf.Configuration"
  8993. static="false" final="false" visibility="public"
  8994. deprecated="not deprecated">
  8995. </constructor>
  8996. <method name="getSocketAddr" return="java.net.InetSocketAddress"
  8997. abstract="false" native="false" synchronized="false"
  8998. static="false" final="false" visibility="public"
  8999. deprecated="not deprecated">
  9000. <param name="name" type="java.lang.String"/>
  9001. <param name="defaultAddress" type="java.lang.String"/>
  9002. <param name="defaultPort" type="int"/>
  9003. <doc>
  9004. <![CDATA[Get the socket address for <code>name</code> property as a
  9005. <code>InetSocketAddress</code>. On an HA cluster,
  9006. this fetches the address corresponding to the RM identified by
  9007. {@link #RM_HA_ID}.
  9008. @param name property name.
  9009. @param defaultAddress the default value
  9010. @param defaultPort the default port
  9011. @return InetSocketAddress]]>
  9012. </doc>
  9013. </method>
  9014. <method name="updateConnectAddr" return="java.net.InetSocketAddress"
  9015. abstract="false" native="false" synchronized="false"
  9016. static="false" final="false" visibility="public"
  9017. deprecated="not deprecated">
  9018. <param name="name" type="java.lang.String"/>
  9019. <param name="addr" type="java.net.InetSocketAddress"/>
  9020. </method>
  9021. <method name="useHttps" return="boolean"
  9022. abstract="false" native="false" synchronized="false"
  9023. static="true" final="false" visibility="public"
  9024. deprecated="not deprecated">
  9025. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  9026. </method>
  9027. <method name="shouldRMFailFast" return="boolean"
  9028. abstract="false" native="false" synchronized="false"
  9029. static="true" final="false" visibility="public"
  9030. deprecated="not deprecated">
  9031. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  9032. </method>
  9033. <field name="CS_CONFIGURATION_FILE" type="java.lang.String"
  9034. transient="false" volatile="false"
  9035. static="true" final="true" visibility="public"
  9036. deprecated="not deprecated">
  9037. </field>
  9038. <field name="HADOOP_POLICY_CONFIGURATION_FILE" type="java.lang.String"
  9039. transient="false" volatile="false"
  9040. static="true" final="true" visibility="public"
  9041. deprecated="not deprecated">
  9042. </field>
  9043. <field name="YARN_SITE_CONFIGURATION_FILE" type="java.lang.String"
  9044. transient="false" volatile="false"
  9045. static="true" final="true" visibility="public"
  9046. deprecated="not deprecated">
  9047. </field>
  9048. <field name="CORE_SITE_CONFIGURATION_FILE" type="java.lang.String"
  9049. transient="false" volatile="false"
  9050. static="true" final="true" visibility="public"
  9051. deprecated="not deprecated">
  9052. </field>
  9053. <field name="RM_CONFIGURATION_FILES" type="java.util.List"
  9054. transient="false" volatile="false"
  9055. static="true" final="true" visibility="public"
  9056. deprecated="not deprecated">
  9057. </field>
  9058. <field name="APPLICATION_MAX_TAGS" type="int"
  9059. transient="false" volatile="false"
  9060. static="true" final="true" visibility="public"
  9061. deprecated="not deprecated">
  9062. </field>
  9063. <field name="APPLICATION_MAX_TAG_LENGTH" type="int"
  9064. transient="false" volatile="false"
  9065. static="true" final="true" visibility="public"
  9066. deprecated="not deprecated">
  9067. </field>
  9068. <field name="YARN_PREFIX" type="java.lang.String"
  9069. transient="false" volatile="false"
  9070. static="true" final="true" visibility="public"
  9071. deprecated="not deprecated">
  9072. </field>
  9073. <field name="DEBUG_NM_DELETE_DELAY_SEC" type="java.lang.String"
  9074. transient="false" volatile="false"
  9075. static="true" final="true" visibility="public"
  9076. deprecated="not deprecated">
  9077. <doc>
  9078. <![CDATA[Delay before deleting resource to ease debugging of NM issues]]>
  9079. </doc>
  9080. </field>
  9081. <field name="IPC_PREFIX" type="java.lang.String"
  9082. transient="false" volatile="false"
  9083. static="true" final="true" visibility="public"
  9084. deprecated="not deprecated">
  9085. </field>
  9086. <field name="IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
  9087. transient="false" volatile="false"
  9088. static="true" final="true" visibility="public"
  9089. deprecated="not deprecated">
  9090. <doc>
  9091. <![CDATA[Factory to create client IPC classes.]]>
  9092. </doc>
  9093. </field>
  9094. <field name="DEFAULT_IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
  9095. transient="false" volatile="false"
  9096. static="true" final="true" visibility="public"
  9097. deprecated="not deprecated">
  9098. </field>
  9099. <field name="IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
  9100. transient="false" volatile="false"
  9101. static="true" final="true" visibility="public"
  9102. deprecated="not deprecated">
  9103. <doc>
  9104. <![CDATA[Factory to create server IPC classes.]]>
  9105. </doc>
  9106. </field>
  9107. <field name="DEFAULT_IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
  9108. transient="false" volatile="false"
  9109. static="true" final="true" visibility="public"
  9110. deprecated="not deprecated">
  9111. </field>
  9112. <field name="IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
  9113. transient="false" volatile="false"
  9114. static="true" final="true" visibility="public"
  9115. deprecated="not deprecated">
  9116. <doc>
  9117. <![CDATA[Factory to create serializeable records.]]>
  9118. </doc>
  9119. </field>
  9120. <field name="DEFAULT_IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
  9121. transient="false" volatile="false"
  9122. static="true" final="true" visibility="public"
  9123. deprecated="not deprecated">
  9124. </field>
  9125. <field name="IPC_RPC_IMPL" type="java.lang.String"
  9126. transient="false" volatile="false"
  9127. static="true" final="true" visibility="public"
  9128. deprecated="not deprecated">
  9129. <doc>
  9130. <![CDATA[RPC class implementation]]>
  9131. </doc>
  9132. </field>
  9133. <field name="DEFAULT_IPC_RPC_IMPL" type="java.lang.String"
  9134. transient="false" volatile="false"
  9135. static="true" final="true" visibility="public"
  9136. deprecated="not deprecated">
  9137. </field>
  9138. <field name="RM_PREFIX" type="java.lang.String"
  9139. transient="false" volatile="false"
  9140. static="true" final="true" visibility="public"
  9141. deprecated="not deprecated">
  9142. </field>
  9143. <field name="RM_CLUSTER_ID" type="java.lang.String"
  9144. transient="false" volatile="false"
  9145. static="true" final="true" visibility="public"
  9146. deprecated="not deprecated">
  9147. </field>
  9148. <field name="RM_HOSTNAME" type="java.lang.String"
  9149. transient="false" volatile="false"
  9150. static="true" final="true" visibility="public"
  9151. deprecated="not deprecated">
  9152. </field>
  9153. <field name="RM_ADDRESS" type="java.lang.String"
  9154. transient="false" volatile="false"
  9155. static="true" final="true" visibility="public"
  9156. deprecated="not deprecated">
  9157. <doc>
  9158. <![CDATA[The address of the applications manager interface in the RM.]]>
  9159. </doc>
  9160. </field>
  9161. <field name="DEFAULT_RM_PORT" type="int"
  9162. transient="false" volatile="false"
  9163. static="true" final="true" visibility="public"
  9164. deprecated="not deprecated">
  9165. </field>
  9166. <field name="DEFAULT_RM_ADDRESS" type="java.lang.String"
  9167. transient="false" volatile="false"
  9168. static="true" final="true" visibility="public"
  9169. deprecated="not deprecated">
  9170. </field>
  9171. <field name="RM_BIND_HOST" type="java.lang.String"
  9172. transient="false" volatile="false"
  9173. static="true" final="true" visibility="public"
  9174. deprecated="not deprecated">
  9175. <doc>
  9176. <![CDATA[The actual bind address for the RM.]]>
  9177. </doc>
  9178. </field>
  9179. <field name="RM_CLIENT_THREAD_COUNT" type="java.lang.String"
  9180. transient="false" volatile="false"
  9181. static="true" final="true" visibility="public"
  9182. deprecated="not deprecated">
  9183. <doc>
  9184. <![CDATA[The number of threads used to handle applications manager requests.]]>
  9185. </doc>
  9186. </field>
  9187. <field name="DEFAULT_RM_CLIENT_THREAD_COUNT" type="int"
  9188. transient="false" volatile="false"
  9189. static="true" final="true" visibility="public"
  9190. deprecated="not deprecated">
  9191. </field>
  9192. <field name="RM_AMLAUNCHER_THREAD_COUNT" type="java.lang.String"
  9193. transient="false" volatile="false"
  9194. static="true" final="true" visibility="public"
  9195. deprecated="not deprecated">
  9196. <doc>
  9197. <![CDATA[Number of threads used to launch/cleanup AM.]]>
  9198. </doc>
  9199. </field>
  9200. <field name="DEFAULT_RM_AMLAUNCHER_THREAD_COUNT" type="int"
  9201. transient="false" volatile="false"
  9202. static="true" final="true" visibility="public"
  9203. deprecated="not deprecated">
  9204. </field>
  9205. <field name="RM_NODEMANAGER_CONNECT_RETIRES" type="java.lang.String"
  9206. transient="false" volatile="false"
  9207. static="true" final="true" visibility="public"
  9208. deprecated="not deprecated">
  9209. <doc>
  9210. <![CDATA[Retry times to connect with NM.]]>
  9211. </doc>
  9212. </field>
  9213. <field name="DEFAULT_RM_NODEMANAGER_CONNECT_RETIRES" type="int"
  9214. transient="false" volatile="false"
  9215. static="true" final="true" visibility="public"
  9216. deprecated="not deprecated">
  9217. </field>
  9218. <field name="RM_PRINCIPAL" type="java.lang.String"
  9219. transient="false" volatile="false"
  9220. static="true" final="true" visibility="public"
  9221. deprecated="not deprecated">
  9222. <doc>
  9223. <![CDATA[The Kerberos principal for the resource manager.]]>
  9224. </doc>
  9225. </field>
  9226. <field name="RM_SCHEDULER_ADDRESS" type="java.lang.String"
  9227. transient="false" volatile="false"
  9228. static="true" final="true" visibility="public"
  9229. deprecated="not deprecated">
  9230. <doc>
  9231. <![CDATA[The address of the scheduler interface.]]>
  9232. </doc>
  9233. </field>
  9234. <field name="DEFAULT_RM_SCHEDULER_PORT" type="int"
  9235. transient="false" volatile="false"
  9236. static="true" final="true" visibility="public"
  9237. deprecated="not deprecated">
  9238. </field>
  9239. <field name="DEFAULT_RM_SCHEDULER_ADDRESS" type="java.lang.String"
  9240. transient="false" volatile="false"
  9241. static="true" final="true" visibility="public"
  9242. deprecated="not deprecated">
  9243. </field>
  9244. <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="java.lang.String"
  9245. transient="false" volatile="false"
  9246. static="true" final="true" visibility="public"
  9247. deprecated="not deprecated">
  9248. <doc>
  9249. <![CDATA[Miniumum request grant-able by the RM scheduler.]]>
  9250. </doc>
  9251. </field>
  9252. <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="int"
  9253. transient="false" volatile="false"
  9254. static="true" final="true" visibility="public"
  9255. deprecated="not deprecated">
  9256. </field>
  9257. <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="java.lang.String"
  9258. transient="false" volatile="false"
  9259. static="true" final="true" visibility="public"
  9260. deprecated="not deprecated">
  9261. </field>
  9262. <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="int"
  9263. transient="false" volatile="false"
  9264. static="true" final="true" visibility="public"
  9265. deprecated="not deprecated">
  9266. </field>
  9267. <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="java.lang.String"
  9268. transient="false" volatile="false"
  9269. static="true" final="true" visibility="public"
  9270. deprecated="not deprecated">
  9271. <doc>
  9272. <![CDATA[Maximum request grant-able by the RM scheduler.]]>
  9273. </doc>
  9274. </field>
  9275. <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="int"
  9276. transient="false" volatile="false"
  9277. static="true" final="true" visibility="public"
  9278. deprecated="not deprecated">
  9279. </field>
  9280. <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="java.lang.String"
  9281. transient="false" volatile="false"
  9282. static="true" final="true" visibility="public"
  9283. deprecated="not deprecated">
  9284. </field>
  9285. <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="int"
  9286. transient="false" volatile="false"
  9287. static="true" final="true" visibility="public"
  9288. deprecated="not deprecated">
  9289. </field>
  9290. <field name="RM_SCHEDULER_CLIENT_THREAD_COUNT" type="java.lang.String"
  9291. transient="false" volatile="false"
  9292. static="true" final="true" visibility="public"
  9293. deprecated="not deprecated">
  9294. <doc>
  9295. <![CDATA[Number of threads to handle scheduler interface.]]>
  9296. </doc>
  9297. </field>
  9298. <field name="DEFAULT_RM_SCHEDULER_CLIENT_THREAD_COUNT" type="int"
  9299. transient="false" volatile="false"
  9300. static="true" final="true" visibility="public"
  9301. deprecated="not deprecated">
  9302. </field>
  9303. <field name="RM_SCHEDULER_INCLUDE_PORT_IN_NODE_NAME" type="java.lang.String"
  9304. transient="false" volatile="false"
  9305. static="true" final="true" visibility="public"
  9306. deprecated="not deprecated">
  9307. <doc>
  9308. <![CDATA[If the port should be included or not in the node name. The node name
  9309. is used by the scheduler for resource requests allocation location
  9310. matching. Typically this is just the hostname, using the port is needed
  9311. when using minicluster and specific NM are required.]]>
  9312. </doc>
  9313. </field>
  9314. <field name="DEFAULT_RM_SCHEDULER_USE_PORT_FOR_NODE_NAME" type="boolean"
  9315. transient="false" volatile="false"
  9316. static="true" final="true" visibility="public"
  9317. deprecated="not deprecated">
  9318. </field>
  9319. <field name="RM_WEBAPP_UI_ACTIONS_ENABLED" type="java.lang.String"
  9320. transient="false" volatile="false"
  9321. static="true" final="true" visibility="public"
  9322. deprecated="not deprecated">
  9323. <doc>
  9324. <![CDATA[Enable Resource Manager webapp ui actions]]>
  9325. </doc>
  9326. </field>
  9327. <field name="DEFAULT_RM_WEBAPP_UI_ACTIONS_ENABLED" type="boolean"
  9328. transient="false" volatile="false"
  9329. static="true" final="true" visibility="public"
  9330. deprecated="not deprecated">
  9331. </field>
  9332. <field name="RM_RESERVATION_SYSTEM_ENABLE" type="java.lang.String"
  9333. transient="false" volatile="false"
  9334. static="true" final="true" visibility="public"
  9335. deprecated="not deprecated">
  9336. <doc>
  9337. <![CDATA[Whether the RM should enable Reservation System]]>
  9338. </doc>
  9339. </field>
  9340. <field name="DEFAULT_RM_RESERVATION_SYSTEM_ENABLE" type="boolean"
  9341. transient="false" volatile="false"
  9342. static="true" final="true" visibility="public"
  9343. deprecated="not deprecated">
  9344. </field>
  9345. <field name="RM_RESERVATION_SYSTEM_CLASS" type="java.lang.String"
  9346. transient="false" volatile="false"
  9347. static="true" final="true" visibility="public"
  9348. deprecated="not deprecated">
  9349. <doc>
  9350. <![CDATA[The class to use as the Reservation System.]]>
  9351. </doc>
  9352. </field>
  9353. <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER" type="java.lang.String"
  9354. transient="false" volatile="false"
  9355. static="true" final="true" visibility="public"
  9356. deprecated="not deprecated">
  9357. <doc>
  9358. <![CDATA[The PlanFollower for the Reservation System.]]>
  9359. </doc>
  9360. </field>
  9361. <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="java.lang.String"
  9362. transient="false" volatile="false"
  9363. static="true" final="true" visibility="public"
  9364. deprecated="not deprecated">
  9365. <doc>
  9366. <![CDATA[The step size of the Reservation System.]]>
  9367. </doc>
  9368. </field>
  9369. <field name="DEFAULT_RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="long"
  9370. transient="false" volatile="false"
  9371. static="true" final="true" visibility="public"
  9372. deprecated="not deprecated">
  9373. </field>
  9374. <field name="RM_SCHEDULER_ENABLE_MONITORS" type="java.lang.String"
  9375. transient="false" volatile="false"
  9376. static="true" final="true" visibility="public"
  9377. deprecated="not deprecated">
  9378. <doc>
  9379. <![CDATA[Enable periodic monitor threads.
  9380. @see #RM_SCHEDULER_MONITOR_POLICIES]]>
  9381. </doc>
  9382. </field>
  9383. <field name="DEFAULT_RM_SCHEDULER_ENABLE_MONITORS" type="boolean"
  9384. transient="false" volatile="false"
  9385. static="true" final="true" visibility="public"
  9386. deprecated="not deprecated">
  9387. </field>
  9388. <field name="RM_SCHEDULER_MONITOR_POLICIES" type="java.lang.String"
  9389. transient="false" volatile="false"
  9390. static="true" final="true" visibility="public"
  9391. deprecated="not deprecated">
  9392. <doc>
  9393. <![CDATA[List of SchedulingEditPolicy classes affecting the scheduler.]]>
  9394. </doc>
  9395. </field>
  9396. <field name="RM_WEBAPP_ADDRESS" type="java.lang.String"
  9397. transient="false" volatile="false"
  9398. static="true" final="true" visibility="public"
  9399. deprecated="not deprecated">
  9400. <doc>
  9401. <![CDATA[The address of the RM web application.]]>
  9402. </doc>
  9403. </field>
  9404. <field name="DEFAULT_RM_WEBAPP_PORT" type="int"
  9405. transient="false" volatile="false"
  9406. static="true" final="true" visibility="public"
  9407. deprecated="not deprecated">
  9408. </field>
  9409. <field name="DEFAULT_RM_WEBAPP_ADDRESS" type="java.lang.String"
  9410. transient="false" volatile="false"
  9411. static="true" final="true" visibility="public"
  9412. deprecated="not deprecated">
  9413. </field>
  9414. <field name="RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  9415. transient="false" volatile="false"
  9416. static="true" final="true" visibility="public"
  9417. deprecated="not deprecated">
  9418. <doc>
  9419. <![CDATA[The https address of the RM web application.]]>
  9420. </doc>
  9421. </field>
  9422. <field name="YARN_SSL_CLIENT_HTTPS_NEED_AUTH_DEFAULT" type="boolean"
  9423. transient="false" volatile="false"
  9424. static="true" final="true" visibility="public"
  9425. deprecated="not deprecated">
  9426. </field>
  9427. <field name="YARN_SSL_SERVER_RESOURCE_DEFAULT" type="java.lang.String"
  9428. transient="false" volatile="false"
  9429. static="true" final="true" visibility="public"
  9430. deprecated="not deprecated">
  9431. </field>
  9432. <field name="DEFAULT_RM_WEBAPP_HTTPS_PORT" type="int"
  9433. transient="false" volatile="false"
  9434. static="true" final="true" visibility="public"
  9435. deprecated="not deprecated">
  9436. </field>
  9437. <field name="DEFAULT_RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  9438. transient="false" volatile="false"
  9439. static="true" final="true" visibility="public"
  9440. deprecated="not deprecated">
  9441. </field>
  9442. <field name="RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
  9443. transient="false" volatile="false"
  9444. static="true" final="true" visibility="public"
  9445. deprecated="not deprecated">
  9446. </field>
  9447. <field name="DEFAULT_RM_RESOURCE_TRACKER_PORT" type="int"
  9448. transient="false" volatile="false"
  9449. static="true" final="true" visibility="public"
  9450. deprecated="not deprecated">
  9451. </field>
  9452. <field name="DEFAULT_RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
  9453. transient="false" volatile="false"
  9454. static="true" final="true" visibility="public"
  9455. deprecated="not deprecated">
  9456. </field>
  9457. <field name="RM_AM_EXPIRY_INTERVAL_MS" type="java.lang.String"
  9458. transient="false" volatile="false"
  9459. static="true" final="true" visibility="public"
  9460. deprecated="not deprecated">
  9461. <doc>
  9462. <![CDATA[The expiry interval for application master reporting.]]>
  9463. </doc>
  9464. </field>
  9465. <field name="DEFAULT_RM_AM_EXPIRY_INTERVAL_MS" type="int"
  9466. transient="false" volatile="false"
  9467. static="true" final="true" visibility="public"
  9468. deprecated="not deprecated">
  9469. </field>
  9470. <field name="RM_NM_EXPIRY_INTERVAL_MS" type="java.lang.String"
  9471. transient="false" volatile="false"
  9472. static="true" final="true" visibility="public"
  9473. deprecated="not deprecated">
  9474. <doc>
  9475. <![CDATA[How long to wait until a node manager is considered dead.]]>
  9476. </doc>
  9477. </field>
  9478. <field name="DEFAULT_RM_NM_EXPIRY_INTERVAL_MS" type="int"
  9479. transient="false" volatile="false"
  9480. static="true" final="true" visibility="public"
  9481. deprecated="not deprecated">
  9482. </field>
  9483. <field name="YARN_ACL_ENABLE" type="java.lang.String"
  9484. transient="false" volatile="false"
  9485. static="true" final="true" visibility="public"
  9486. deprecated="not deprecated">
  9487. <doc>
  9488. <![CDATA[Are acls enabled.]]>
  9489. </doc>
  9490. </field>
  9491. <field name="DEFAULT_YARN_ACL_ENABLE" type="boolean"
  9492. transient="false" volatile="false"
  9493. static="true" final="true" visibility="public"
  9494. deprecated="not deprecated">
  9495. </field>
  9496. <field name="YARN_ADMIN_ACL" type="java.lang.String"
  9497. transient="false" volatile="false"
  9498. static="true" final="true" visibility="public"
  9499. deprecated="not deprecated">
  9500. <doc>
  9501. <![CDATA[ACL of who can be admin of YARN cluster.]]>
  9502. </doc>
  9503. </field>
  9504. <field name="DEFAULT_YARN_ADMIN_ACL" type="java.lang.String"
  9505. transient="false" volatile="false"
  9506. static="true" final="true" visibility="public"
  9507. deprecated="not deprecated">
  9508. </field>
  9509. <field name="DEFAULT_YARN_APP_ACL" type="java.lang.String"
  9510. transient="false" volatile="false"
  9511. static="true" final="true" visibility="public"
  9512. deprecated="not deprecated">
  9513. <doc>
  9514. <![CDATA[ACL used in case none is found. Allows nothing.]]>
  9515. </doc>
  9516. </field>
  9517. <field name="YARN_INTERMEDIATE_DATA_ENCRYPTION" type="java.lang.String"
  9518. transient="false" volatile="false"
  9519. static="true" final="true" visibility="public"
  9520. deprecated="not deprecated">
  9521. <doc>
  9522. <![CDATA[Enable/disable intermediate-data encryption at YARN level. For now, this
  9523. only is used by the FileSystemRMStateStore to setup right file-system
  9524. security attributes.]]>
  9525. </doc>
  9526. </field>
  9527. <field name="DEFAULT_YARN_INTERMEDIATE_DATA_ENCRYPTION" type="java.lang.Boolean"
  9528. transient="false" volatile="false"
  9529. static="true" final="true" visibility="public"
  9530. deprecated="not deprecated">
  9531. </field>
  9532. <field name="RM_ADMIN_ADDRESS" type="java.lang.String"
  9533. transient="false" volatile="false"
  9534. static="true" final="true" visibility="public"
  9535. deprecated="not deprecated">
  9536. <doc>
  9537. <![CDATA[The address of the RM admin interface.]]>
  9538. </doc>
  9539. </field>
  9540. <field name="DEFAULT_RM_ADMIN_PORT" type="int"
  9541. transient="false" volatile="false"
  9542. static="true" final="true" visibility="public"
  9543. deprecated="not deprecated">
  9544. </field>
  9545. <field name="DEFAULT_RM_ADMIN_ADDRESS" type="java.lang.String"
  9546. transient="false" volatile="false"
  9547. static="true" final="true" visibility="public"
  9548. deprecated="not deprecated">
  9549. </field>
  9550. <field name="RM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
  9551. transient="false" volatile="false"
  9552. static="true" final="true" visibility="public"
  9553. deprecated="not deprecated">
  9554. <doc>
  9555. <![CDATA[Number of threads used to handle RM admin interface.]]>
  9556. </doc>
  9557. </field>
  9558. <field name="DEFAULT_RM_ADMIN_CLIENT_THREAD_COUNT" type="int"
  9559. transient="false" volatile="false"
  9560. static="true" final="true" visibility="public"
  9561. deprecated="not deprecated">
  9562. </field>
  9563. <field name="RM_AM_MAX_ATTEMPTS" type="java.lang.String"
  9564. transient="false" volatile="false"
  9565. static="true" final="true" visibility="public"
  9566. deprecated="not deprecated">
  9567. <doc>
  9568. <![CDATA[The maximum number of application attempts.
  9569. It's a global setting for all application masters.]]>
  9570. </doc>
  9571. </field>
  9572. <field name="DEFAULT_RM_AM_MAX_ATTEMPTS" type="int"
  9573. transient="false" volatile="false"
  9574. static="true" final="true" visibility="public"
  9575. deprecated="not deprecated">
  9576. </field>
  9577. <field name="RM_KEYTAB" type="java.lang.String"
  9578. transient="false" volatile="false"
  9579. static="true" final="true" visibility="public"
  9580. deprecated="not deprecated">
  9581. <doc>
  9582. <![CDATA[The keytab for the resource manager.]]>
  9583. </doc>
  9584. </field>
  9585. <field name="RM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
  9586. transient="false" volatile="false"
  9587. static="true" final="true" visibility="public"
  9588. deprecated="not deprecated">
  9589. <doc>
  9590. <![CDATA[The kerberos principal to be used for spnego filter for RM.]]>
  9591. </doc>
  9592. </field>
  9593. <field name="RM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
  9594. transient="false" volatile="false"
  9595. static="true" final="true" visibility="public"
  9596. deprecated="not deprecated">
  9597. <doc>
  9598. <![CDATA[The kerberos keytab to be used for spnego filter for RM.]]>
  9599. </doc>
  9600. </field>
  9601. <field name="RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="java.lang.String"
  9602. transient="false" volatile="false"
  9603. static="true" final="true" visibility="public"
  9604. deprecated="not deprecated">
  9605. <doc>
  9606. <![CDATA[Flag to enable override of the default kerberos authentication filter with
  9607. the RM authentication filter to allow authentication using delegation
  9608. tokens(fallback to kerberos if the tokens are missing). Only applicable
  9609. when the http authentication type is kerberos.]]>
  9610. </doc>
  9611. </field>
  9612. <field name="DEFAULT_RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="boolean"
  9613. transient="false" volatile="false"
  9614. static="true" final="true" visibility="public"
  9615. deprecated="not deprecated">
  9616. </field>
  9617. <field name="RM_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
  9618. transient="false" volatile="false"
  9619. static="true" final="true" visibility="public"
  9620. deprecated="not deprecated">
  9621. <doc>
  9622. <![CDATA[Enable cross origin (CORS) support.]]>
  9623. </doc>
  9624. </field>
  9625. <field name="DEFAULT_RM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
  9626. transient="false" volatile="false"
  9627. static="true" final="true" visibility="public"
  9628. deprecated="not deprecated">
  9629. </field>
  9630. <field name="RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="java.lang.String"
  9631. transient="false" volatile="false"
  9632. static="true" final="true" visibility="public"
  9633. deprecated="not deprecated">
  9634. <doc>
  9635. <![CDATA[How long to wait until a container is considered dead.]]>
  9636. </doc>
  9637. </field>
  9638. <field name="DEFAULT_RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="int"
  9639. transient="false" volatile="false"
  9640. static="true" final="true" visibility="public"
  9641. deprecated="not deprecated">
  9642. </field>
  9643. <field name="RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
  9644. transient="false" volatile="false"
  9645. static="true" final="true" visibility="public"
  9646. deprecated="not deprecated">
  9647. <doc>
  9648. <![CDATA[Path to file with nodes to include.]]>
  9649. </doc>
  9650. </field>
  9651. <field name="DEFAULT_RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
  9652. transient="false" volatile="false"
  9653. static="true" final="true" visibility="public"
  9654. deprecated="not deprecated">
  9655. </field>
  9656. <field name="RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
  9657. transient="false" volatile="false"
  9658. static="true" final="true" visibility="public"
  9659. deprecated="not deprecated">
  9660. <doc>
  9661. <![CDATA[Path to file with nodes to exclude.]]>
  9662. </doc>
  9663. </field>
  9664. <field name="DEFAULT_RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
  9665. transient="false" volatile="false"
  9666. static="true" final="true" visibility="public"
  9667. deprecated="not deprecated">
  9668. </field>
  9669. <field name="RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="java.lang.String"
  9670. transient="false" volatile="false"
  9671. static="true" final="true" visibility="public"
  9672. deprecated="not deprecated">
  9673. <doc>
  9674. <![CDATA[Number of threads to handle resource tracker calls.]]>
  9675. </doc>
  9676. </field>
  9677. <field name="DEFAULT_RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="int"
  9678. transient="false" volatile="false"
  9679. static="true" final="true" visibility="public"
  9680. deprecated="not deprecated">
  9681. </field>
  9682. <field name="RM_SCHEDULER" type="java.lang.String"
  9683. transient="false" volatile="false"
  9684. static="true" final="true" visibility="public"
  9685. deprecated="not deprecated">
  9686. <doc>
  9687. <![CDATA[The class to use as the resource scheduler.]]>
  9688. </doc>
  9689. </field>
  9690. <field name="DEFAULT_RM_SCHEDULER" type="java.lang.String"
  9691. transient="false" volatile="false"
  9692. static="true" final="true" visibility="public"
  9693. deprecated="not deprecated">
  9694. </field>
  9695. <field name="RM_NM_HEARTBEAT_INTERVAL_MS" type="java.lang.String"
  9696. transient="false" volatile="false"
  9697. static="true" final="true" visibility="public"
  9698. deprecated="not deprecated">
  9699. <doc>
  9700. <![CDATA[RM set next Heartbeat interval for NM]]>
  9701. </doc>
  9702. </field>
  9703. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MS" type="long"
  9704. transient="false" volatile="false"
  9705. static="true" final="true" visibility="public"
  9706. deprecated="not deprecated">
  9707. </field>
  9708. <field name="RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="java.lang.String"
  9709. transient="false" volatile="false"
  9710. static="true" final="true" visibility="public"
  9711. deprecated="not deprecated">
  9712. <doc>
  9713. <![CDATA[Number of worker threads that write the history data.]]>
  9714. </doc>
  9715. </field>
  9716. <field name="DEFAULT_RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="int"
  9717. transient="false" volatile="false"
  9718. static="true" final="true" visibility="public"
  9719. deprecated="not deprecated">
  9720. </field>
  9721. <field name="RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="java.lang.String"
  9722. transient="false" volatile="false"
  9723. static="true" final="true" visibility="public"
  9724. deprecated="not deprecated">
  9725. <doc>
  9726. <![CDATA[The setting that controls whether yarn system metrics is published on the
  9727. timeline server or not by RM.]]>
  9728. </doc>
  9729. </field>
  9730. <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="boolean"
  9731. transient="false" volatile="false"
  9732. static="true" final="true" visibility="public"
  9733. deprecated="not deprecated">
  9734. </field>
  9735. <field name="RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="java.lang.String"
  9736. transient="false" volatile="false"
  9737. static="true" final="true" visibility="public"
  9738. deprecated="not deprecated">
  9739. </field>
  9740. <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="int"
  9741. transient="false" volatile="false"
  9742. static="true" final="true" visibility="public"
  9743. deprecated="not deprecated">
  9744. </field>
  9745. <field name="RM_DELEGATION_KEY_UPDATE_INTERVAL_KEY" type="java.lang.String"
  9746. transient="false" volatile="false"
  9747. static="true" final="true" visibility="public"
  9748. deprecated="not deprecated">
  9749. </field>
  9750. <field name="RM_DELEGATION_KEY_UPDATE_INTERVAL_DEFAULT" type="long"
  9751. transient="false" volatile="false"
  9752. static="true" final="true" visibility="public"
  9753. deprecated="not deprecated">
  9754. </field>
  9755. <field name="RM_DELEGATION_TOKEN_RENEW_INTERVAL_KEY" type="java.lang.String"
  9756. transient="false" volatile="false"
  9757. static="true" final="true" visibility="public"
  9758. deprecated="not deprecated">
  9759. </field>
  9760. <field name="RM_DELEGATION_TOKEN_RENEW_INTERVAL_DEFAULT" type="long"
  9761. transient="false" volatile="false"
  9762. static="true" final="true" visibility="public"
  9763. deprecated="not deprecated">
  9764. </field>
  9765. <field name="RM_DELEGATION_TOKEN_MAX_LIFETIME_KEY" type="java.lang.String"
  9766. transient="false" volatile="false"
  9767. static="true" final="true" visibility="public"
  9768. deprecated="not deprecated">
  9769. </field>
  9770. <field name="RM_DELEGATION_TOKEN_MAX_LIFETIME_DEFAULT" type="long"
  9771. transient="false" volatile="false"
  9772. static="true" final="true" visibility="public"
  9773. deprecated="not deprecated">
  9774. </field>
  9775. <field name="RECOVERY_ENABLED" type="java.lang.String"
  9776. transient="false" volatile="false"
  9777. static="true" final="true" visibility="public"
  9778. deprecated="not deprecated">
  9779. </field>
  9780. <field name="DEFAULT_RM_RECOVERY_ENABLED" type="boolean"
  9781. transient="false" volatile="false"
  9782. static="true" final="true" visibility="public"
  9783. deprecated="not deprecated">
  9784. </field>
  9785. <field name="YARN_FAIL_FAST" type="java.lang.String"
  9786. transient="false" volatile="false"
  9787. static="true" final="true" visibility="public"
  9788. deprecated="not deprecated">
  9789. </field>
  9790. <field name="DEFAULT_YARN_FAIL_FAST" type="boolean"
  9791. transient="false" volatile="false"
  9792. static="true" final="true" visibility="public"
  9793. deprecated="not deprecated">
  9794. </field>
  9795. <field name="RM_FAIL_FAST" type="java.lang.String"
  9796. transient="false" volatile="false"
  9797. static="true" final="true" visibility="public"
  9798. deprecated="not deprecated">
  9799. </field>
  9800. <field name="RM_WORK_PRESERVING_RECOVERY_ENABLED" type="java.lang.String"
  9801. transient="false" volatile="false"
  9802. static="true" final="true" visibility="public"
  9803. deprecated="not deprecated">
  9804. </field>
  9805. <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_ENABLED" type="boolean"
  9806. transient="false" volatile="false"
  9807. static="true" final="true" visibility="public"
  9808. deprecated="not deprecated">
  9809. </field>
  9810. <field name="RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="java.lang.String"
  9811. transient="false" volatile="false"
  9812. static="true" final="true" visibility="public"
  9813. deprecated="not deprecated">
  9814. </field>
  9815. <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="long"
  9816. transient="false" volatile="false"
  9817. static="true" final="true" visibility="public"
  9818. deprecated="not deprecated">
  9819. </field>
  9820. <field name="RM_ZK_PREFIX" type="java.lang.String"
  9821. transient="false" volatile="false"
  9822. static="true" final="true" visibility="public"
  9823. deprecated="not deprecated">
  9824. <doc>
  9825. <![CDATA[Zookeeper interaction configs]]>
  9826. </doc>
  9827. </field>
  9828. <field name="RM_ZK_ADDRESS" type="java.lang.String"
  9829. transient="false" volatile="false"
  9830. static="true" final="true" visibility="public"
  9831. deprecated="not deprecated">
  9832. </field>
  9833. <field name="RM_ZK_NUM_RETRIES" type="java.lang.String"
  9834. transient="false" volatile="false"
  9835. static="true" final="true" visibility="public"
  9836. deprecated="not deprecated">
  9837. </field>
  9838. <field name="DEFAULT_ZK_RM_NUM_RETRIES" type="int"
  9839. transient="false" volatile="false"
  9840. static="true" final="true" visibility="public"
  9841. deprecated="not deprecated">
  9842. </field>
  9843. <field name="RM_ZK_RETRY_INTERVAL_MS" type="java.lang.String"
  9844. transient="false" volatile="false"
  9845. static="true" final="true" visibility="public"
  9846. deprecated="not deprecated">
  9847. </field>
  9848. <field name="DEFAULT_RM_ZK_RETRY_INTERVAL_MS" type="long"
  9849. transient="false" volatile="false"
  9850. static="true" final="true" visibility="public"
  9851. deprecated="not deprecated">
  9852. </field>
  9853. <field name="RM_ZK_TIMEOUT_MS" type="java.lang.String"
  9854. transient="false" volatile="false"
  9855. static="true" final="true" visibility="public"
  9856. deprecated="not deprecated">
  9857. </field>
  9858. <field name="DEFAULT_RM_ZK_TIMEOUT_MS" type="int"
  9859. transient="false" volatile="false"
  9860. static="true" final="true" visibility="public"
  9861. deprecated="not deprecated">
  9862. </field>
  9863. <field name="RM_ZK_ACL" type="java.lang.String"
  9864. transient="false" volatile="false"
  9865. static="true" final="true" visibility="public"
  9866. deprecated="not deprecated">
  9867. </field>
  9868. <field name="DEFAULT_RM_ZK_ACL" type="java.lang.String"
  9869. transient="false" volatile="false"
  9870. static="true" final="true" visibility="public"
  9871. deprecated="not deprecated">
  9872. </field>
  9873. <field name="RM_ZK_AUTH" type="java.lang.String"
  9874. transient="false" volatile="false"
  9875. static="true" final="true" visibility="public"
  9876. deprecated="not deprecated">
  9877. </field>
  9878. <field name="ZK_STATE_STORE_PREFIX" type="java.lang.String"
  9879. transient="false" volatile="false"
  9880. static="true" final="true" visibility="public"
  9881. deprecated="not deprecated">
  9882. </field>
  9883. <field name="ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
  9884. transient="false" volatile="false"
  9885. static="true" final="true" visibility="public"
  9886. deprecated="not deprecated">
  9887. <doc>
  9888. <![CDATA[Parent znode path under which ZKRMStateStore will create znodes]]>
  9889. </doc>
  9890. </field>
  9891. <field name="DEFAULT_ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
  9892. transient="false" volatile="false"
  9893. static="true" final="true" visibility="public"
  9894. deprecated="not deprecated">
  9895. </field>
  9896. <field name="ZK_RM_STATE_STORE_ROOT_NODE_ACL" type="java.lang.String"
  9897. transient="false" volatile="false"
  9898. static="true" final="true" visibility="public"
  9899. deprecated="not deprecated">
  9900. <doc>
  9901. <![CDATA[Root node ACLs for fencing]]>
  9902. </doc>
  9903. </field>
  9904. <field name="RM_HA_PREFIX" type="java.lang.String"
  9905. transient="false" volatile="false"
  9906. static="true" final="true" visibility="public"
  9907. deprecated="not deprecated">
  9908. <doc>
  9909. <![CDATA[HA related configs]]>
  9910. </doc>
  9911. </field>
  9912. <field name="RM_HA_ENABLED" type="java.lang.String"
  9913. transient="false" volatile="false"
  9914. static="true" final="true" visibility="public"
  9915. deprecated="not deprecated">
  9916. </field>
  9917. <field name="DEFAULT_RM_HA_ENABLED" type="boolean"
  9918. transient="false" volatile="false"
  9919. static="true" final="true" visibility="public"
  9920. deprecated="not deprecated">
  9921. </field>
  9922. <field name="RM_HA_IDS" type="java.lang.String"
  9923. transient="false" volatile="false"
  9924. static="true" final="true" visibility="public"
  9925. deprecated="not deprecated">
  9926. </field>
  9927. <field name="RM_HA_ID" type="java.lang.String"
  9928. transient="false" volatile="false"
  9929. static="true" final="true" visibility="public"
  9930. deprecated="not deprecated">
  9931. </field>
  9932. <field name="FS_BASED_RM_CONF_STORE" type="java.lang.String"
  9933. transient="false" volatile="false"
  9934. static="true" final="true" visibility="public"
  9935. deprecated="not deprecated">
  9936. <doc>
  9937. <![CDATA[Store the related configuration files in File System]]>
  9938. </doc>
  9939. </field>
  9940. <field name="DEFAULT_FS_BASED_RM_CONF_STORE" type="java.lang.String"
  9941. transient="false" volatile="false"
  9942. static="true" final="true" visibility="public"
  9943. deprecated="not deprecated">
  9944. </field>
  9945. <field name="RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
  9946. transient="false" volatile="false"
  9947. static="true" final="true" visibility="public"
  9948. deprecated="not deprecated">
  9949. </field>
  9950. <field name="DEFAULT_RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
  9951. transient="false" volatile="false"
  9952. static="true" final="true" visibility="public"
  9953. deprecated="not deprecated">
  9954. </field>
  9955. <field name="YARN_AUTHORIZATION_PROVIDER" type="java.lang.String"
  9956. transient="false" volatile="false"
  9957. static="true" final="true" visibility="public"
  9958. deprecated="not deprecated">
  9959. </field>
  9960. <field name="AUTO_FAILOVER_PREFIX" type="java.lang.String"
  9961. transient="false" volatile="false"
  9962. static="true" final="true" visibility="public"
  9963. deprecated="not deprecated">
  9964. </field>
  9965. <field name="AUTO_FAILOVER_ENABLED" type="java.lang.String"
  9966. transient="false" volatile="false"
  9967. static="true" final="true" visibility="public"
  9968. deprecated="not deprecated">
  9969. </field>
  9970. <field name="DEFAULT_AUTO_FAILOVER_ENABLED" type="boolean"
  9971. transient="false" volatile="false"
  9972. static="true" final="true" visibility="public"
  9973. deprecated="not deprecated">
  9974. </field>
  9975. <field name="AUTO_FAILOVER_EMBEDDED" type="java.lang.String"
  9976. transient="false" volatile="false"
  9977. static="true" final="true" visibility="public"
  9978. deprecated="not deprecated">
  9979. </field>
  9980. <field name="DEFAULT_AUTO_FAILOVER_EMBEDDED" type="boolean"
  9981. transient="false" volatile="false"
  9982. static="true" final="true" visibility="public"
  9983. deprecated="not deprecated">
  9984. </field>
  9985. <field name="AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
  9986. transient="false" volatile="false"
  9987. static="true" final="true" visibility="public"
  9988. deprecated="not deprecated">
  9989. </field>
  9990. <field name="DEFAULT_AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
  9991. transient="false" volatile="false"
  9992. static="true" final="true" visibility="public"
  9993. deprecated="not deprecated">
  9994. </field>
  9995. <field name="CLIENT_FAILOVER_PREFIX" type="java.lang.String"
  9996. transient="false" volatile="false"
  9997. static="true" final="true" visibility="public"
  9998. deprecated="not deprecated">
  9999. </field>
  10000. <field name="CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
  10001. transient="false" volatile="false"
  10002. static="true" final="true" visibility="public"
  10003. deprecated="not deprecated">
  10004. </field>
  10005. <field name="DEFAULT_CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
  10006. transient="false" volatile="false"
  10007. static="true" final="true" visibility="public"
  10008. deprecated="not deprecated">
  10009. </field>
  10010. <field name="CLIENT_FAILOVER_MAX_ATTEMPTS" type="java.lang.String"
  10011. transient="false" volatile="false"
  10012. static="true" final="true" visibility="public"
  10013. deprecated="not deprecated">
  10014. </field>
  10015. <field name="CLIENT_FAILOVER_SLEEPTIME_BASE_MS" type="java.lang.String"
  10016. transient="false" volatile="false"
  10017. static="true" final="true" visibility="public"
  10018. deprecated="not deprecated">
  10019. </field>
  10020. <field name="CLIENT_FAILOVER_SLEEPTIME_MAX_MS" type="java.lang.String"
  10021. transient="false" volatile="false"
  10022. static="true" final="true" visibility="public"
  10023. deprecated="not deprecated">
  10024. </field>
  10025. <field name="CLIENT_FAILOVER_RETRIES" type="java.lang.String"
  10026. transient="false" volatile="false"
  10027. static="true" final="true" visibility="public"
  10028. deprecated="not deprecated">
  10029. </field>
  10030. <field name="DEFAULT_CLIENT_FAILOVER_RETRIES" type="int"
  10031. transient="false" volatile="false"
  10032. static="true" final="true" visibility="public"
  10033. deprecated="not deprecated">
  10034. </field>
  10035. <field name="CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="java.lang.String"
  10036. transient="false" volatile="false"
  10037. static="true" final="true" visibility="public"
  10038. deprecated="not deprecated">
  10039. </field>
  10040. <field name="DEFAULT_CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="int"
  10041. transient="false" volatile="false"
  10042. static="true" final="true" visibility="public"
  10043. deprecated="not deprecated">
  10044. </field>
  10045. <field name="RM_STORE" type="java.lang.String"
  10046. transient="false" volatile="false"
  10047. static="true" final="true" visibility="public"
  10048. deprecated="not deprecated">
  10049. <doc>
  10050. <![CDATA[The class to use as the persistent store.]]>
  10051. </doc>
  10052. </field>
  10053. <field name="FS_RM_STATE_STORE_URI" type="java.lang.String"
  10054. transient="false" volatile="false"
  10055. static="true" final="true" visibility="public"
  10056. deprecated="not deprecated">
  10057. <doc>
  10058. <![CDATA[URI for FileSystemRMStateStore]]>
  10059. </doc>
  10060. </field>
  10061. <field name="FS_RM_STATE_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  10062. transient="false" volatile="false"
  10063. static="true" final="true" visibility="public"
  10064. deprecated="not deprecated">
  10065. </field>
  10066. <field name="DEFAULT_FS_RM_STATE_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  10067. transient="false" volatile="false"
  10068. static="true" final="true" visibility="public"
  10069. deprecated="not deprecated">
  10070. </field>
  10071. <field name="FS_RM_STATE_STORE_NUM_RETRIES" type="java.lang.String"
  10072. transient="false" volatile="false"
  10073. static="true" final="true" visibility="public"
  10074. deprecated="not deprecated">
  10075. </field>
  10076. <field name="DEFAULT_FS_RM_STATE_STORE_NUM_RETRIES" type="int"
  10077. transient="false" volatile="false"
  10078. static="true" final="true" visibility="public"
  10079. deprecated="not deprecated">
  10080. </field>
  10081. <field name="FS_RM_STATE_STORE_RETRY_INTERVAL_MS" type="java.lang.String"
  10082. transient="false" volatile="false"
  10083. static="true" final="true" visibility="public"
  10084. deprecated="not deprecated">
  10085. </field>
  10086. <field name="DEFAULT_FS_RM_STATE_STORE_RETRY_INTERVAL_MS" type="long"
  10087. transient="false" volatile="false"
  10088. static="true" final="true" visibility="public"
  10089. deprecated="not deprecated">
  10090. </field>
  10091. <field name="RM_LEVELDB_STORE_PATH" type="java.lang.String"
  10092. transient="false" volatile="false"
  10093. static="true" final="true" visibility="public"
  10094. deprecated="not deprecated">
  10095. </field>
  10096. <field name="RM_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
  10097. transient="false" volatile="false"
  10098. static="true" final="true" visibility="public"
  10099. deprecated="not deprecated">
  10100. <doc>
  10101. <![CDATA[The maximum number of completed applications RM keeps.]]>
  10102. </doc>
  10103. </field>
  10104. <field name="DEFAULT_RM_MAX_COMPLETED_APPLICATIONS" type="int"
  10105. transient="false" volatile="false"
  10106. static="true" final="true" visibility="public"
  10107. deprecated="not deprecated">
  10108. </field>
  10109. <field name="RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
  10110. transient="false" volatile="false"
  10111. static="true" final="true" visibility="public"
  10112. deprecated="not deprecated">
  10113. <doc>
  10114. <![CDATA[The maximum number of completed applications RM state store keeps, by
  10115. default equals to DEFAULT_RM_MAX_COMPLETED_APPLICATIONS]]>
  10116. </doc>
  10117. </field>
  10118. <field name="DEFAULT_RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="int"
  10119. transient="false" volatile="false"
  10120. static="true" final="true" visibility="public"
  10121. deprecated="not deprecated">
  10122. </field>
  10123. <field name="DEFAULT_APPLICATION_NAME" type="java.lang.String"
  10124. transient="false" volatile="false"
  10125. static="true" final="true" visibility="public"
  10126. deprecated="not deprecated">
  10127. <doc>
  10128. <![CDATA[Default application name]]>
  10129. </doc>
  10130. </field>
  10131. <field name="DEFAULT_APPLICATION_TYPE" type="java.lang.String"
  10132. transient="false" volatile="false"
  10133. static="true" final="true" visibility="public"
  10134. deprecated="not deprecated">
  10135. <doc>
  10136. <![CDATA[Default application type]]>
  10137. </doc>
  10138. </field>
  10139. <field name="APPLICATION_TYPE_LENGTH" type="int"
  10140. transient="false" volatile="false"
  10141. static="true" final="true" visibility="public"
  10142. deprecated="not deprecated">
  10143. <doc>
  10144. <![CDATA[Default application type length]]>
  10145. </doc>
  10146. </field>
  10147. <field name="DEFAULT_QUEUE_NAME" type="java.lang.String"
  10148. transient="false" volatile="false"
  10149. static="true" final="true" visibility="public"
  10150. deprecated="not deprecated">
  10151. <doc>
  10152. <![CDATA[Default queue name]]>
  10153. </doc>
  10154. </field>
  10155. <field name="RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
  10156. transient="false" volatile="false"
  10157. static="true" final="true" visibility="public"
  10158. deprecated="not deprecated">
  10159. <doc>
  10160. <![CDATA[Buckets (in minutes) for the number of apps running in each queue.]]>
  10161. </doc>
  10162. </field>
  10163. <field name="DEFAULT_RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
  10164. transient="false" volatile="false"
  10165. static="true" final="true" visibility="public"
  10166. deprecated="not deprecated">
  10167. <doc>
  10168. <![CDATA[Default sizes of the runtime metric buckets in minutes.]]>
  10169. </doc>
  10170. </field>
  10171. <field name="RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  10172. transient="false" volatile="false"
  10173. static="true" final="true" visibility="public"
  10174. deprecated="not deprecated">
  10175. </field>
  10176. <field name="DEFAULT_RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  10177. transient="false" volatile="false"
  10178. static="true" final="true" visibility="public"
  10179. deprecated="not deprecated">
  10180. </field>
  10181. <field name="RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  10182. transient="false" volatile="false"
  10183. static="true" final="true" visibility="public"
  10184. deprecated="not deprecated">
  10185. </field>
  10186. <field name="DEFAULT_RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  10187. transient="false" volatile="false"
  10188. static="true" final="true" visibility="public"
  10189. deprecated="not deprecated">
  10190. </field>
  10191. <field name="RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  10192. transient="false" volatile="false"
  10193. static="true" final="true" visibility="public"
  10194. deprecated="not deprecated">
  10195. </field>
  10196. <field name="DEFAULT_RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  10197. transient="false" volatile="false"
  10198. static="true" final="true" visibility="public"
  10199. deprecated="not deprecated">
  10200. </field>
  10201. <field name="RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  10202. transient="false" volatile="false"
  10203. static="true" final="true" visibility="public"
  10204. deprecated="not deprecated">
  10205. </field>
  10206. <field name="DEFAULT_RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  10207. transient="false" volatile="false"
  10208. static="true" final="true" visibility="public"
  10209. deprecated="not deprecated">
  10210. </field>
  10211. <field name="RM_PROXY_USER_PREFIX" type="java.lang.String"
  10212. transient="false" volatile="false"
  10213. static="true" final="true" visibility="public"
  10214. deprecated="not deprecated">
  10215. <doc>
  10216. <![CDATA[RM proxy users' prefix]]>
  10217. </doc>
  10218. </field>
  10219. <field name="NM_PREFIX" type="java.lang.String"
  10220. transient="false" volatile="false"
  10221. static="true" final="true" visibility="public"
  10222. deprecated="not deprecated">
  10223. <doc>
  10224. <![CDATA[Prefix for all node manager configs.]]>
  10225. </doc>
  10226. </field>
  10227. <field name="NM_ADMIN_USER_ENV" type="java.lang.String"
  10228. transient="false" volatile="false"
  10229. static="true" final="true" visibility="public"
  10230. deprecated="not deprecated">
  10231. <doc>
  10232. <![CDATA[Environment variables that will be sent to containers.]]>
  10233. </doc>
  10234. </field>
  10235. <field name="DEFAULT_NM_ADMIN_USER_ENV" type="java.lang.String"
  10236. transient="false" volatile="false"
  10237. static="true" final="true" visibility="public"
  10238. deprecated="not deprecated">
  10239. </field>
  10240. <field name="NM_ENV_WHITELIST" type="java.lang.String"
  10241. transient="false" volatile="false"
  10242. static="true" final="true" visibility="public"
  10243. deprecated="not deprecated">
  10244. <doc>
  10245. <![CDATA[Environment variables that containers may override rather than use NodeManager's default.]]>
  10246. </doc>
  10247. </field>
  10248. <field name="DEFAULT_NM_ENV_WHITELIST" type="java.lang.String"
  10249. transient="false" volatile="false"
  10250. static="true" final="true" visibility="public"
  10251. deprecated="not deprecated">
  10252. </field>
  10253. <field name="NM_ADDRESS" type="java.lang.String"
  10254. transient="false" volatile="false"
  10255. static="true" final="true" visibility="public"
  10256. deprecated="not deprecated">
  10257. <doc>
  10258. <![CDATA[address of node manager IPC.]]>
  10259. </doc>
  10260. </field>
  10261. <field name="DEFAULT_NM_PORT" type="int"
  10262. transient="false" volatile="false"
  10263. static="true" final="true" visibility="public"
  10264. deprecated="not deprecated">
  10265. </field>
  10266. <field name="DEFAULT_NM_ADDRESS" type="java.lang.String"
  10267. transient="false" volatile="false"
  10268. static="true" final="true" visibility="public"
  10269. deprecated="not deprecated">
  10270. </field>
  10271. <field name="NM_BIND_HOST" type="java.lang.String"
  10272. transient="false" volatile="false"
  10273. static="true" final="true" visibility="public"
  10274. deprecated="not deprecated">
  10275. <doc>
  10276. <![CDATA[The actual bind address or the NM.]]>
  10277. </doc>
  10278. </field>
  10279. <field name="NM_CONTAINER_EXECUTOR" type="java.lang.String"
  10280. transient="false" volatile="false"
  10281. static="true" final="true" visibility="public"
  10282. deprecated="not deprecated">
  10283. <doc>
  10284. <![CDATA[who will execute(launch) the containers.]]>
  10285. </doc>
  10286. </field>
  10287. <field name="NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="java.lang.String"
  10288. transient="false" volatile="false"
  10289. static="true" final="true" visibility="public"
  10290. deprecated="not deprecated">
  10291. <doc>
  10292. <![CDATA[Adjustment to make to the container os scheduling priority.
  10293. The valid values for this could vary depending on the platform.
  10294. On Linux, higher values mean run the containers at a less
  10295. favorable priority than the NM.
  10296. The value specified is an int.]]>
  10297. </doc>
  10298. </field>
  10299. <field name="DEFAULT_NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="int"
  10300. transient="false" volatile="false"
  10301. static="true" final="true" visibility="public"
  10302. deprecated="not deprecated">
  10303. </field>
  10304. <field name="NM_CONTAINER_MGR_THREAD_COUNT" type="java.lang.String"
  10305. transient="false" volatile="false"
  10306. static="true" final="true" visibility="public"
  10307. deprecated="not deprecated">
  10308. <doc>
  10309. <![CDATA[Number of threads container manager uses.]]>
  10310. </doc>
  10311. </field>
  10312. <field name="DEFAULT_NM_CONTAINER_MGR_THREAD_COUNT" type="int"
  10313. transient="false" volatile="false"
  10314. static="true" final="true" visibility="public"
  10315. deprecated="not deprecated">
  10316. </field>
  10317. <field name="NM_DELETE_THREAD_COUNT" type="java.lang.String"
  10318. transient="false" volatile="false"
  10319. static="true" final="true" visibility="public"
  10320. deprecated="not deprecated">
  10321. <doc>
  10322. <![CDATA[Number of threads used in cleanup.]]>
  10323. </doc>
  10324. </field>
  10325. <field name="DEFAULT_NM_DELETE_THREAD_COUNT" type="int"
  10326. transient="false" volatile="false"
  10327. static="true" final="true" visibility="public"
  10328. deprecated="not deprecated">
  10329. </field>
  10330. <field name="NM_KEYTAB" type="java.lang.String"
  10331. transient="false" volatile="false"
  10332. static="true" final="true" visibility="public"
  10333. deprecated="not deprecated">
  10334. <doc>
  10335. <![CDATA[Keytab for NM.]]>
  10336. </doc>
  10337. </field>
  10338. <field name="NM_LOCAL_DIRS" type="java.lang.String"
  10339. transient="false" volatile="false"
  10340. static="true" final="true" visibility="public"
  10341. deprecated="not deprecated">
  10342. <doc>
  10343. <![CDATA[List of directories to store localized files in.]]>
  10344. </doc>
  10345. </field>
  10346. <field name="DEFAULT_NM_LOCAL_DIRS" type="java.lang.String"
  10347. transient="false" volatile="false"
  10348. static="true" final="true" visibility="public"
  10349. deprecated="not deprecated">
  10350. </field>
  10351. <field name="NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="java.lang.String"
  10352. transient="false" volatile="false"
  10353. static="true" final="true" visibility="public"
  10354. deprecated="not deprecated">
  10355. <doc>
  10356. <![CDATA[Number of files in each localized directories
  10357. Avoid tuning this too low.]]>
  10358. </doc>
  10359. </field>
  10360. <field name="DEFAULT_NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="int"
  10361. transient="false" volatile="false"
  10362. static="true" final="true" visibility="public"
  10363. deprecated="not deprecated">
  10364. </field>
  10365. <field name="NM_LOCALIZER_ADDRESS" type="java.lang.String"
  10366. transient="false" volatile="false"
  10367. static="true" final="true" visibility="public"
  10368. deprecated="not deprecated">
  10369. <doc>
  10370. <![CDATA[Address where the localizer IPC is.]]>
  10371. </doc>
  10372. </field>
  10373. <field name="DEFAULT_NM_LOCALIZER_PORT" type="int"
  10374. transient="false" volatile="false"
  10375. static="true" final="true" visibility="public"
  10376. deprecated="not deprecated">
  10377. </field>
  10378. <field name="DEFAULT_NM_LOCALIZER_ADDRESS" type="java.lang.String"
  10379. transient="false" volatile="false"
  10380. static="true" final="true" visibility="public"
  10381. deprecated="not deprecated">
  10382. </field>
  10383. <field name="NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="java.lang.String"
  10384. transient="false" volatile="false"
  10385. static="true" final="true" visibility="public"
  10386. deprecated="not deprecated">
  10387. <doc>
  10388. <![CDATA[Interval in between cache cleanups.]]>
  10389. </doc>
  10390. </field>
  10391. <field name="DEFAULT_NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="long"
  10392. transient="false" volatile="false"
  10393. static="true" final="true" visibility="public"
  10394. deprecated="not deprecated">
  10395. </field>
  10396. <field name="NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="java.lang.String"
  10397. transient="false" volatile="false"
  10398. static="true" final="true" visibility="public"
  10399. deprecated="not deprecated">
  10400. <doc>
  10401. <![CDATA[Target size of localizer cache in MB, per nodemanager. It is a target
  10402. retention size that only includes resources with PUBLIC and PRIVATE
  10403. visibility and excludes resources with APPLICATION visibility]]>
  10404. </doc>
  10405. </field>
  10406. <field name="DEFAULT_NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="long"
  10407. transient="false" volatile="false"
  10408. static="true" final="true" visibility="public"
  10409. deprecated="not deprecated">
  10410. </field>
  10411. <field name="NM_LOCALIZER_CLIENT_THREAD_COUNT" type="java.lang.String"
  10412. transient="false" volatile="false"
  10413. static="true" final="true" visibility="public"
  10414. deprecated="not deprecated">
  10415. <doc>
  10416. <![CDATA[Number of threads to handle localization requests.]]>
  10417. </doc>
  10418. </field>
  10419. <field name="DEFAULT_NM_LOCALIZER_CLIENT_THREAD_COUNT" type="int"
  10420. transient="false" volatile="false"
  10421. static="true" final="true" visibility="public"
  10422. deprecated="not deprecated">
  10423. </field>
  10424. <field name="NM_LOCALIZER_FETCH_THREAD_COUNT" type="java.lang.String"
  10425. transient="false" volatile="false"
  10426. static="true" final="true" visibility="public"
  10427. deprecated="not deprecated">
  10428. <doc>
  10429. <![CDATA[Number of threads to use for localization fetching.]]>
  10430. </doc>
  10431. </field>
  10432. <field name="DEFAULT_NM_LOCALIZER_FETCH_THREAD_COUNT" type="int"
  10433. transient="false" volatile="false"
  10434. static="true" final="true" visibility="public"
  10435. deprecated="not deprecated">
  10436. </field>
  10437. <field name="NM_LOG_DIRS" type="java.lang.String"
  10438. transient="false" volatile="false"
  10439. static="true" final="true" visibility="public"
  10440. deprecated="not deprecated">
  10441. <doc>
  10442. <![CDATA[Where to store container logs.]]>
  10443. </doc>
  10444. </field>
  10445. <field name="DEFAULT_NM_LOG_DIRS" type="java.lang.String"
  10446. transient="false" volatile="false"
  10447. static="true" final="true" visibility="public"
  10448. deprecated="not deprecated">
  10449. </field>
  10450. <field name="NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  10451. transient="false" volatile="false"
  10452. static="true" final="true" visibility="public"
  10453. deprecated="not deprecated">
  10454. </field>
  10455. <field name="DEFAULT_NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  10456. transient="false" volatile="false"
  10457. static="true" final="true" visibility="public"
  10458. deprecated="not deprecated">
  10459. </field>
  10460. <field name="RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="java.lang.String"
  10461. transient="false" volatile="false"
  10462. static="true" final="true" visibility="public"
  10463. deprecated="not deprecated">
  10464. <doc>
  10465. <![CDATA[Interval at which the delayed token removal thread runs]]>
  10466. </doc>
  10467. </field>
  10468. <field name="DEFAULT_RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="long"
  10469. transient="false" volatile="false"
  10470. static="true" final="true" visibility="public"
  10471. deprecated="not deprecated">
  10472. </field>
  10473. <field name="RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="java.lang.String"
  10474. transient="false" volatile="false"
  10475. static="true" final="true" visibility="public"
  10476. deprecated="not deprecated">
  10477. <doc>
  10478. <![CDATA[Delegation Token renewer thread count]]>
  10479. </doc>
  10480. </field>
  10481. <field name="DEFAULT_RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="int"
  10482. transient="false" volatile="false"
  10483. static="true" final="true" visibility="public"
  10484. deprecated="not deprecated">
  10485. </field>
  10486. <field name="RM_PROXY_USER_PRIVILEGES_ENABLED" type="java.lang.String"
  10487. transient="false" volatile="false"
  10488. static="true" final="true" visibility="public"
  10489. deprecated="not deprecated">
  10490. </field>
  10491. <field name="DEFAULT_RM_PROXY_USER_PRIVILEGES_ENABLED" type="boolean"
  10492. transient="false" volatile="false"
  10493. static="true" final="false" visibility="public"
  10494. deprecated="not deprecated">
  10495. </field>
  10496. <field name="LOG_AGGREGATION_ENABLED" type="java.lang.String"
  10497. transient="false" volatile="false"
  10498. static="true" final="true" visibility="public"
  10499. deprecated="not deprecated">
  10500. <doc>
  10501. <![CDATA[Whether to enable log aggregation]]>
  10502. </doc>
  10503. </field>
  10504. <field name="DEFAULT_LOG_AGGREGATION_ENABLED" type="boolean"
  10505. transient="false" volatile="false"
  10506. static="true" final="true" visibility="public"
  10507. deprecated="not deprecated">
  10508. </field>
  10509. <field name="LOG_AGGREGATION_RETAIN_SECONDS" type="java.lang.String"
  10510. transient="false" volatile="false"
  10511. static="true" final="true" visibility="public"
  10512. deprecated="not deprecated">
  10513. <doc>
  10514. <![CDATA[How long to wait before deleting aggregated logs, -1 disables.
  10515. Be careful set this too small and you will spam the name node.]]>
  10516. </doc>
  10517. </field>
  10518. <field name="DEFAULT_LOG_AGGREGATION_RETAIN_SECONDS" type="long"
  10519. transient="false" volatile="false"
  10520. static="true" final="true" visibility="public"
  10521. deprecated="not deprecated">
  10522. </field>
  10523. <field name="LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="java.lang.String"
  10524. transient="false" volatile="false"
  10525. static="true" final="true" visibility="public"
  10526. deprecated="not deprecated">
  10527. <doc>
  10528. <![CDATA[How long to wait between aggregated log retention checks. If set to
  10529. a value {@literal <=} 0 then the value is computed as one-tenth of the
  10530. log retention setting. Be careful set this too small and you will spam
  10531. the name node.]]>
  10532. </doc>
  10533. </field>
  10534. <field name="DEFAULT_LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="long"
  10535. transient="false" volatile="false"
  10536. static="true" final="true" visibility="public"
  10537. deprecated="not deprecated">
  10538. </field>
  10539. <field name="NM_LOG_RETAIN_SECONDS" type="java.lang.String"
  10540. transient="false" volatile="false"
  10541. static="true" final="true" visibility="public"
  10542. deprecated="not deprecated">
  10543. <doc>
  10544. <![CDATA[Number of seconds to retain logs on the NodeManager. Only applicable if Log
  10545. aggregation is disabled]]>
  10546. </doc>
  10547. </field>
  10548. <field name="DEFAULT_NM_LOG_RETAIN_SECONDS" type="long"
  10549. transient="false" volatile="false"
  10550. static="true" final="true" visibility="public"
  10551. deprecated="not deprecated">
  10552. </field>
  10553. <field name="NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="java.lang.String"
  10554. transient="false" volatile="false"
  10555. static="true" final="true" visibility="public"
  10556. deprecated="not deprecated">
  10557. <doc>
  10558. <![CDATA[Define how often NMs wake up and upload log files]]>
  10559. </doc>
  10560. </field>
  10561. <field name="DEFAULT_NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="long"
  10562. transient="false" volatile="false"
  10563. static="true" final="true" visibility="public"
  10564. deprecated="not deprecated">
  10565. </field>
  10566. <field name="NM_LOG_DELETION_THREADS_COUNT" type="java.lang.String"
  10567. transient="false" volatile="false"
  10568. static="true" final="true" visibility="public"
  10569. deprecated="not deprecated">
  10570. <doc>
  10571. <![CDATA[Number of threads used in log cleanup. Only applicable if Log aggregation
  10572. is disabled]]>
  10573. </doc>
  10574. </field>
  10575. <field name="DEFAULT_NM_LOG_DELETE_THREAD_COUNT" type="int"
  10576. transient="false" volatile="false"
  10577. static="true" final="true" visibility="public"
  10578. deprecated="not deprecated">
  10579. </field>
  10580. <field name="NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
  10581. transient="false" volatile="false"
  10582. static="true" final="true" visibility="public"
  10583. deprecated="not deprecated">
  10584. <doc>
  10585. <![CDATA[Where to aggregate logs to.]]>
  10586. </doc>
  10587. </field>
  10588. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
  10589. transient="false" volatile="false"
  10590. static="true" final="true" visibility="public"
  10591. deprecated="not deprecated">
  10592. </field>
  10593. <field name="NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
  10594. transient="false" volatile="false"
  10595. static="true" final="true" visibility="public"
  10596. deprecated="not deprecated">
  10597. <doc>
  10598. <![CDATA[The remote log dir will be created at
  10599. NM_REMOTE_APP_LOG_DIR/${user}/NM_REMOTE_APP_LOG_DIR_SUFFIX/${appId}]]>
  10600. </doc>
  10601. </field>
  10602. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
  10603. transient="false" volatile="false"
  10604. static="true" final="true" visibility="public"
  10605. deprecated="not deprecated">
  10606. </field>
  10607. <field name="YARN_LOG_SERVER_URL" type="java.lang.String"
  10608. transient="false" volatile="false"
  10609. static="true" final="true" visibility="public"
  10610. deprecated="not deprecated">
  10611. </field>
  10612. <field name="YARN_TRACKING_URL_GENERATOR" type="java.lang.String"
  10613. transient="false" volatile="false"
  10614. static="true" final="true" visibility="public"
  10615. deprecated="not deprecated">
  10616. </field>
  10617. <field name="NM_PMEM_MB" type="java.lang.String"
  10618. transient="false" volatile="false"
  10619. static="true" final="true" visibility="public"
  10620. deprecated="not deprecated">
  10621. <doc>
  10622. <![CDATA[Amount of memory in GB that can be allocated for containers.]]>
  10623. </doc>
  10624. </field>
  10625. <field name="DEFAULT_NM_PMEM_MB" type="int"
  10626. transient="false" volatile="false"
  10627. static="true" final="true" visibility="public"
  10628. deprecated="not deprecated">
  10629. </field>
  10630. <field name="NM_PMEM_CHECK_ENABLED" type="java.lang.String"
  10631. transient="false" volatile="false"
  10632. static="true" final="true" visibility="public"
  10633. deprecated="not deprecated">
  10634. <doc>
  10635. <![CDATA[Specifies whether physical memory check is enabled.]]>
  10636. </doc>
  10637. </field>
  10638. <field name="DEFAULT_NM_PMEM_CHECK_ENABLED" type="boolean"
  10639. transient="false" volatile="false"
  10640. static="true" final="true" visibility="public"
  10641. deprecated="not deprecated">
  10642. </field>
  10643. <field name="NM_VMEM_CHECK_ENABLED" type="java.lang.String"
  10644. transient="false" volatile="false"
  10645. static="true" final="true" visibility="public"
  10646. deprecated="not deprecated">
  10647. <doc>
  10648. <![CDATA[Specifies whether physical memory check is enabled.]]>
  10649. </doc>
  10650. </field>
  10651. <field name="DEFAULT_NM_VMEM_CHECK_ENABLED" type="boolean"
  10652. transient="false" volatile="false"
  10653. static="true" final="true" visibility="public"
  10654. deprecated="not deprecated">
  10655. </field>
  10656. <field name="NM_VMEM_PMEM_RATIO" type="java.lang.String"
  10657. transient="false" volatile="false"
  10658. static="true" final="true" visibility="public"
  10659. deprecated="not deprecated">
  10660. <doc>
  10661. <![CDATA[Conversion ratio for physical memory to virtual memory.]]>
  10662. </doc>
  10663. </field>
  10664. <field name="DEFAULT_NM_VMEM_PMEM_RATIO" type="float"
  10665. transient="false" volatile="false"
  10666. static="true" final="true" visibility="public"
  10667. deprecated="not deprecated">
  10668. </field>
  10669. <field name="NM_VCORES" type="java.lang.String"
  10670. transient="false" volatile="false"
  10671. static="true" final="true" visibility="public"
  10672. deprecated="not deprecated">
  10673. <doc>
  10674. <![CDATA[Number of Virtual CPU Cores which can be allocated for containers.]]>
  10675. </doc>
  10676. </field>
  10677. <field name="DEFAULT_NM_VCORES" type="int"
  10678. transient="false" volatile="false"
  10679. static="true" final="true" visibility="public"
  10680. deprecated="not deprecated">
  10681. </field>
  10682. <field name="NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="java.lang.String"
  10683. transient="false" volatile="false"
  10684. static="true" final="true" visibility="public"
  10685. deprecated="not deprecated">
  10686. <doc>
  10687. <![CDATA[Percentage of overall CPU which can be allocated for containers.]]>
  10688. </doc>
  10689. </field>
  10690. <field name="DEFAULT_NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="int"
  10691. transient="false" volatile="false"
  10692. static="true" final="true" visibility="public"
  10693. deprecated="not deprecated">
  10694. </field>
  10695. <field name="NM_WEBAPP_ADDRESS" type="java.lang.String"
  10696. transient="false" volatile="false"
  10697. static="true" final="true" visibility="public"
  10698. deprecated="not deprecated">
  10699. <doc>
  10700. <![CDATA[NM Webapp address.]]>
  10701. </doc>
  10702. </field>
  10703. <field name="DEFAULT_NM_WEBAPP_PORT" type="int"
  10704. transient="false" volatile="false"
  10705. static="true" final="true" visibility="public"
  10706. deprecated="not deprecated">
  10707. </field>
  10708. <field name="DEFAULT_NM_WEBAPP_ADDRESS" type="java.lang.String"
  10709. transient="false" volatile="false"
  10710. static="true" final="true" visibility="public"
  10711. deprecated="not deprecated">
  10712. </field>
  10713. <field name="NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  10714. transient="false" volatile="false"
  10715. static="true" final="true" visibility="public"
  10716. deprecated="not deprecated">
  10717. <doc>
  10718. <![CDATA[NM Webapp https address.]]>
  10719. </doc>
  10720. </field>
  10721. <field name="DEFAULT_NM_WEBAPP_HTTPS_PORT" type="int"
  10722. transient="false" volatile="false"
  10723. static="true" final="true" visibility="public"
  10724. deprecated="not deprecated">
  10725. </field>
  10726. <field name="DEFAULT_NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  10727. transient="false" volatile="false"
  10728. static="true" final="true" visibility="public"
  10729. deprecated="not deprecated">
  10730. </field>
  10731. <field name="NM_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
  10732. transient="false" volatile="false"
  10733. static="true" final="true" visibility="public"
  10734. deprecated="not deprecated">
  10735. <doc>
  10736. <![CDATA[Enable/disable CORS filter.]]>
  10737. </doc>
  10738. </field>
  10739. <field name="DEFAULT_NM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
  10740. transient="false" volatile="false"
  10741. static="true" final="true" visibility="public"
  10742. deprecated="not deprecated">
  10743. </field>
  10744. <field name="NM_CONTAINER_MON_INTERVAL_MS" type="java.lang.String"
  10745. transient="false" volatile="false"
  10746. static="true" final="true" visibility="public"
  10747. deprecated="not deprecated">
  10748. <doc>
  10749. <![CDATA[How often to monitor containers.]]>
  10750. </doc>
  10751. </field>
  10752. <field name="DEFAULT_NM_CONTAINER_MON_INTERVAL_MS" type="int"
  10753. transient="false" volatile="false"
  10754. static="true" final="true" visibility="public"
  10755. deprecated="not deprecated">
  10756. </field>
  10757. <field name="NM_CONTAINER_MON_RESOURCE_CALCULATOR" type="java.lang.String"
  10758. transient="false" volatile="false"
  10759. static="true" final="true" visibility="public"
  10760. deprecated="not deprecated">
  10761. <doc>
  10762. <![CDATA[Class that calculates containers current resource utilization.]]>
  10763. </doc>
  10764. </field>
  10765. <field name="NM_CONTAINER_MON_PROCESS_TREE" type="java.lang.String"
  10766. transient="false" volatile="false"
  10767. static="true" final="true" visibility="public"
  10768. deprecated="not deprecated">
  10769. <doc>
  10770. <![CDATA[Class that calculates process tree resource utilization.]]>
  10771. </doc>
  10772. </field>
  10773. <field name="PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="java.lang.String"
  10774. transient="false" volatile="false"
  10775. static="true" final="true" visibility="public"
  10776. deprecated="not deprecated">
  10777. </field>
  10778. <field name="DEFAULT_PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="boolean"
  10779. transient="false" volatile="false"
  10780. static="true" final="true" visibility="public"
  10781. deprecated="not deprecated">
  10782. </field>
  10783. <field name="NM_CONTAINER_METRICS_ENABLE" type="java.lang.String"
  10784. transient="false" volatile="false"
  10785. static="true" final="true" visibility="public"
  10786. deprecated="not deprecated">
  10787. <doc>
  10788. <![CDATA[Enable/disable container metrics.]]>
  10789. </doc>
  10790. </field>
  10791. <field name="DEFAULT_NM_CONTAINER_METRICS_ENABLE" type="boolean"
  10792. transient="false" volatile="false"
  10793. static="true" final="true" visibility="public"
  10794. deprecated="not deprecated">
  10795. </field>
  10796. <field name="NM_CONTAINER_METRICS_PERIOD_MS" type="java.lang.String"
  10797. transient="false" volatile="false"
  10798. static="true" final="true" visibility="public"
  10799. deprecated="not deprecated">
  10800. <doc>
  10801. <![CDATA[Container metrics flush period. -1 for flush on completion.]]>
  10802. </doc>
  10803. </field>
  10804. <field name="DEFAULT_NM_CONTAINER_METRICS_PERIOD_MS" type="int"
  10805. transient="false" volatile="false"
  10806. static="true" final="true" visibility="public"
  10807. deprecated="not deprecated">
  10808. </field>
  10809. <field name="NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="java.lang.String"
  10810. transient="false" volatile="false"
  10811. static="true" final="true" visibility="public"
  10812. deprecated="not deprecated">
  10813. <doc>
  10814. <![CDATA[The delay time ms to unregister container metrics after completion.]]>
  10815. </doc>
  10816. </field>
  10817. <field name="DEFAULT_NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="int"
  10818. transient="false" volatile="false"
  10819. static="true" final="true" visibility="public"
  10820. deprecated="not deprecated">
  10821. </field>
  10822. <field name="NM_DISK_HEALTH_CHECK_ENABLE" type="java.lang.String"
  10823. transient="false" volatile="false"
  10824. static="true" final="true" visibility="public"
  10825. deprecated="not deprecated">
  10826. <doc>
  10827. <![CDATA[Enable/Disable disks' health checker. Default is true. An expert level
  10828. configuration property.]]>
  10829. </doc>
  10830. </field>
  10831. <field name="NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
  10832. transient="false" volatile="false"
  10833. static="true" final="true" visibility="public"
  10834. deprecated="not deprecated">
  10835. <doc>
  10836. <![CDATA[Frequency of running disks' health checker.]]>
  10837. </doc>
  10838. </field>
  10839. <field name="DEFAULT_NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="long"
  10840. transient="false" volatile="false"
  10841. static="true" final="true" visibility="public"
  10842. deprecated="not deprecated">
  10843. <doc>
  10844. <![CDATA[By default, disks' health is checked every 2 minutes.]]>
  10845. </doc>
  10846. </field>
  10847. <field name="NM_MIN_HEALTHY_DISKS_FRACTION" type="java.lang.String"
  10848. transient="false" volatile="false"
  10849. static="true" final="true" visibility="public"
  10850. deprecated="not deprecated">
  10851. <doc>
  10852. <![CDATA[The minimum fraction of number of disks to be healthy for the nodemanager
  10853. to launch new containers. This applies to nm-local-dirs and nm-log-dirs.]]>
  10854. </doc>
  10855. </field>
  10856. <field name="DEFAULT_NM_MIN_HEALTHY_DISKS_FRACTION" type="float"
  10857. transient="false" volatile="false"
  10858. static="true" final="true" visibility="public"
  10859. deprecated="not deprecated">
  10860. <doc>
  10861. <![CDATA[By default, at least 25% of disks are to be healthy to say that the node is
  10862. healthy in terms of disks.]]>
  10863. </doc>
  10864. </field>
  10865. <field name="NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="java.lang.String"
  10866. transient="false" volatile="false"
  10867. static="true" final="true" visibility="public"
  10868. deprecated="not deprecated">
  10869. <doc>
  10870. <![CDATA[The maximum percentage of disk space that can be used after which a disk is
  10871. marked as offline. Values can range from 0.0 to 100.0. If the value is
  10872. greater than or equal to 100, NM will check for full disk. This applies to
  10873. nm-local-dirs and nm-log-dirs.]]>
  10874. </doc>
  10875. </field>
  10876. <field name="DEFAULT_NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="float"
  10877. transient="false" volatile="false"
  10878. static="true" final="true" visibility="public"
  10879. deprecated="not deprecated">
  10880. <doc>
  10881. <![CDATA[By default, 90% of the disk can be used before it is marked as offline.]]>
  10882. </doc>
  10883. </field>
  10884. <field name="NM_MIN_PER_DISK_FREE_SPACE_MB" type="java.lang.String"
  10885. transient="false" volatile="false"
  10886. static="true" final="true" visibility="public"
  10887. deprecated="not deprecated">
  10888. <doc>
  10889. <![CDATA[The minimum space that must be available on a local dir for it to be used.
  10890. This applies to nm-local-dirs and nm-log-dirs.]]>
  10891. </doc>
  10892. </field>
  10893. <field name="DEFAULT_NM_MIN_PER_DISK_FREE_SPACE_MB" type="long"
  10894. transient="false" volatile="false"
  10895. static="true" final="true" visibility="public"
  10896. deprecated="not deprecated">
  10897. <doc>
  10898. <![CDATA[By default, all of the disk can be used before it is marked as offline.]]>
  10899. </doc>
  10900. </field>
  10901. <field name="NM_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
  10902. transient="false" volatile="false"
  10903. static="true" final="true" visibility="public"
  10904. deprecated="not deprecated">
  10905. <doc>
  10906. <![CDATA[Frequency of running node health script.]]>
  10907. </doc>
  10908. </field>
  10909. <field name="DEFAULT_NM_HEALTH_CHECK_INTERVAL_MS" type="long"
  10910. transient="false" volatile="false"
  10911. static="true" final="true" visibility="public"
  10912. deprecated="not deprecated">
  10913. </field>
  10914. <field name="NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="java.lang.String"
  10915. transient="false" volatile="false"
  10916. static="true" final="true" visibility="public"
  10917. deprecated="not deprecated">
  10918. <doc>
  10919. <![CDATA[Health check script time out period.]]>
  10920. </doc>
  10921. </field>
  10922. <field name="DEFAULT_NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="long"
  10923. transient="false" volatile="false"
  10924. static="true" final="true" visibility="public"
  10925. deprecated="not deprecated">
  10926. </field>
  10927. <field name="NM_HEALTH_CHECK_SCRIPT_PATH" type="java.lang.String"
  10928. transient="false" volatile="false"
  10929. static="true" final="true" visibility="public"
  10930. deprecated="not deprecated">
  10931. <doc>
  10932. <![CDATA[The health check script to run.]]>
  10933. </doc>
  10934. </field>
  10935. <field name="NM_HEALTH_CHECK_SCRIPT_OPTS" type="java.lang.String"
  10936. transient="false" volatile="false"
  10937. static="true" final="true" visibility="public"
  10938. deprecated="not deprecated">
  10939. <doc>
  10940. <![CDATA[The arguments to pass to the health check script.]]>
  10941. </doc>
  10942. </field>
  10943. <field name="NM_DOCKER_CONTAINER_EXECUTOR_IMAGE_NAME" type="java.lang.String"
  10944. transient="false" volatile="false"
  10945. static="true" final="true" visibility="public"
  10946. deprecated="not deprecated">
  10947. <doc>
  10948. <![CDATA[The Docker image name(For DockerContainerExecutor).]]>
  10949. </doc>
  10950. </field>
  10951. <field name="NM_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME" type="java.lang.String"
  10952. transient="false" volatile="false"
  10953. static="true" final="true" visibility="public"
  10954. deprecated="not deprecated">
  10955. <doc>
  10956. <![CDATA[The name of the docker executor (For DockerContainerExecutor).]]>
  10957. </doc>
  10958. </field>
  10959. <field name="NM_DEFAULT_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME" type="java.lang.String"
  10960. transient="false" volatile="false"
  10961. static="true" final="true" visibility="public"
  10962. deprecated="not deprecated">
  10963. <doc>
  10964. <![CDATA[The default docker executor (For DockerContainerExecutor).]]>
  10965. </doc>
  10966. </field>
  10967. <field name="NM_LINUX_CONTAINER_EXECUTOR_PATH" type="java.lang.String"
  10968. transient="false" volatile="false"
  10969. static="true" final="true" visibility="public"
  10970. deprecated="not deprecated">
  10971. <doc>
  10972. <![CDATA[The path to the Linux container executor.]]>
  10973. </doc>
  10974. </field>
  10975. <field name="NM_LINUX_CONTAINER_GROUP" type="java.lang.String"
  10976. transient="false" volatile="false"
  10977. static="true" final="true" visibility="public"
  10978. deprecated="not deprecated">
  10979. <doc>
  10980. <![CDATA[The UNIX group that the linux-container-executor should run as.
  10981. This is intended to be set as part of container-executor.cfg.]]>
  10982. </doc>
  10983. </field>
  10984. <field name="NM_NONSECURE_MODE_LIMIT_USERS" type="java.lang.String"
  10985. transient="false" volatile="false"
  10986. static="true" final="true" visibility="public"
  10987. deprecated="not deprecated">
  10988. <doc>
  10989. <![CDATA[If linux-container-executor should limit itself to one user
  10990. when running in non-secure mode.]]>
  10991. </doc>
  10992. </field>
  10993. <field name="DEFAULT_NM_NONSECURE_MODE_LIMIT_USERS" type="boolean"
  10994. transient="false" volatile="false"
  10995. static="true" final="true" visibility="public"
  10996. deprecated="not deprecated">
  10997. </field>
  10998. <field name="NM_NONSECURE_MODE_LOCAL_USER_KEY" type="java.lang.String"
  10999. transient="false" volatile="false"
  11000. static="true" final="true" visibility="public"
  11001. deprecated="not deprecated">
  11002. <doc>
  11003. <![CDATA[The UNIX user that containers will run as when Linux-container-executor
  11004. is used in nonsecure mode (a use case for this is using cgroups).]]>
  11005. </doc>
  11006. </field>
  11007. <field name="DEFAULT_NM_NONSECURE_MODE_LOCAL_USER" type="java.lang.String"
  11008. transient="false" volatile="false"
  11009. static="true" final="true" visibility="public"
  11010. deprecated="not deprecated">
  11011. </field>
  11012. <field name="NM_NONSECURE_MODE_USER_PATTERN_KEY" type="java.lang.String"
  11013. transient="false" volatile="false"
  11014. static="true" final="true" visibility="public"
  11015. deprecated="not deprecated">
  11016. <doc>
  11017. <![CDATA[The allowed pattern for UNIX user names enforced by
  11018. Linux-container-executor when used in nonsecure mode (use case for this
  11019. is using cgroups). The default value is taken from /usr/sbin/adduser]]>
  11020. </doc>
  11021. </field>
  11022. <field name="DEFAULT_NM_NONSECURE_MODE_USER_PATTERN" type="java.lang.String"
  11023. transient="false" volatile="false"
  11024. static="true" final="true" visibility="public"
  11025. deprecated="not deprecated">
  11026. </field>
  11027. <field name="NM_LINUX_CONTAINER_RESOURCES_HANDLER" type="java.lang.String"
  11028. transient="false" volatile="false"
  11029. static="true" final="true" visibility="public"
  11030. deprecated="not deprecated">
  11031. <doc>
  11032. <![CDATA[The type of resource enforcement to use with the
  11033. linux container executor.]]>
  11034. </doc>
  11035. </field>
  11036. <field name="NM_LINUX_CONTAINER_CGROUPS_HIERARCHY" type="java.lang.String"
  11037. transient="false" volatile="false"
  11038. static="true" final="true" visibility="public"
  11039. deprecated="not deprecated">
  11040. <doc>
  11041. <![CDATA[The path the linux container executor should use for cgroups]]>
  11042. </doc>
  11043. </field>
  11044. <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT" type="java.lang.String"
  11045. transient="false" volatile="false"
  11046. static="true" final="true" visibility="public"
  11047. deprecated="not deprecated">
  11048. <doc>
  11049. <![CDATA[Whether the linux container executor should mount cgroups if not found]]>
  11050. </doc>
  11051. </field>
  11052. <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT_PATH" type="java.lang.String"
  11053. transient="false" volatile="false"
  11054. static="true" final="true" visibility="public"
  11055. deprecated="not deprecated">
  11056. <doc>
  11057. <![CDATA[Where the linux container executor should mount cgroups if not found]]>
  11058. </doc>
  11059. </field>
  11060. <field name="NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="java.lang.String"
  11061. transient="false" volatile="false"
  11062. static="true" final="true" visibility="public"
  11063. deprecated="not deprecated">
  11064. <doc>
  11065. <![CDATA[Whether the apps should run in strict resource usage mode(not allowed to
  11066. use spare CPU)]]>
  11067. </doc>
  11068. </field>
  11069. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="boolean"
  11070. transient="false" volatile="false"
  11071. static="true" final="true" visibility="public"
  11072. deprecated="not deprecated">
  11073. </field>
  11074. <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="java.lang.String"
  11075. transient="false" volatile="false"
  11076. static="true" final="true" visibility="public"
  11077. deprecated="not deprecated">
  11078. <doc>
  11079. <![CDATA[Interval of time the linux container executor should try cleaning up
  11080. cgroups entry when cleaning up a container. This is required due to what
  11081. it seems a race condition because the SIGTERM/SIGKILL is asynch.]]>
  11082. </doc>
  11083. </field>
  11084. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="long"
  11085. transient="false" volatile="false"
  11086. static="true" final="true" visibility="public"
  11087. deprecated="not deprecated">
  11088. </field>
  11089. <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="java.lang.String"
  11090. transient="false" volatile="false"
  11091. static="true" final="true" visibility="public"
  11092. deprecated="not deprecated">
  11093. <doc>
  11094. <![CDATA[Delay between attempts to remove linux cgroup.]]>
  11095. </doc>
  11096. </field>
  11097. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="long"
  11098. transient="false" volatile="false"
  11099. static="true" final="true" visibility="public"
  11100. deprecated="not deprecated">
  11101. </field>
  11102. <field name="NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="java.lang.String"
  11103. transient="false" volatile="false"
  11104. static="true" final="true" visibility="public"
  11105. deprecated="not deprecated">
  11106. <doc>
  11107. <![CDATA[Indicates if memory and CPU limits will be set for the Windows Job
  11108. Object for the containers launched by the default container executor.]]>
  11109. </doc>
  11110. </field>
  11111. <field name="DEFAULT_NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="boolean"
  11112. transient="false" volatile="false"
  11113. static="true" final="true" visibility="public"
  11114. deprecated="not deprecated">
  11115. </field>
  11116. <field name="NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="java.lang.String"
  11117. transient="false" volatile="false"
  11118. static="true" final="true" visibility="public"
  11119. deprecated="not deprecated">
  11120. </field>
  11121. <field name="DEFAULT_NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="boolean"
  11122. transient="false" volatile="false"
  11123. static="true" final="true" visibility="public"
  11124. deprecated="not deprecated">
  11125. </field>
  11126. <field name="NM_WINDOWS_SECURE_CONTAINER_GROUP" type="java.lang.String"
  11127. transient="false" volatile="false"
  11128. static="true" final="true" visibility="public"
  11129. deprecated="not deprecated">
  11130. <doc>
  11131. <![CDATA[/* The Windows group that the windows-secure-container-executor should run as.]]>
  11132. </doc>
  11133. </field>
  11134. <field name="NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
  11135. transient="false" volatile="false"
  11136. static="true" final="true" visibility="public"
  11137. deprecated="not deprecated">
  11138. <doc>
  11139. <![CDATA[T-file compression types used to compress aggregated logs.]]>
  11140. </doc>
  11141. </field>
  11142. <field name="DEFAULT_NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
  11143. transient="false" volatile="false"
  11144. static="true" final="true" visibility="public"
  11145. deprecated="not deprecated">
  11146. </field>
  11147. <field name="NM_PRINCIPAL" type="java.lang.String"
  11148. transient="false" volatile="false"
  11149. static="true" final="true" visibility="public"
  11150. deprecated="not deprecated">
  11151. <doc>
  11152. <![CDATA[The kerberos principal for the node manager.]]>
  11153. </doc>
  11154. </field>
  11155. <field name="NM_AUX_SERVICES" type="java.lang.String"
  11156. transient="false" volatile="false"
  11157. static="true" final="true" visibility="public"
  11158. deprecated="not deprecated">
  11159. </field>
  11160. <field name="NM_AUX_SERVICE_FMT" type="java.lang.String"
  11161. transient="false" volatile="false"
  11162. static="true" final="true" visibility="public"
  11163. deprecated="not deprecated">
  11164. </field>
  11165. <field name="NM_USER_HOME_DIR" type="java.lang.String"
  11166. transient="false" volatile="false"
  11167. static="true" final="true" visibility="public"
  11168. deprecated="not deprecated">
  11169. </field>
  11170. <field name="NM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
  11171. transient="false" volatile="false"
  11172. static="true" final="true" visibility="public"
  11173. deprecated="not deprecated">
  11174. <doc>
  11175. <![CDATA[The kerberos principal to be used for spnego filter for NM.]]>
  11176. </doc>
  11177. </field>
  11178. <field name="NM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
  11179. transient="false" volatile="false"
  11180. static="true" final="true" visibility="public"
  11181. deprecated="not deprecated">
  11182. <doc>
  11183. <![CDATA[The kerberos keytab to be used for spnego filter for NM.]]>
  11184. </doc>
  11185. </field>
  11186. <field name="DEFAULT_NM_USER_HOME_DIR" type="java.lang.String"
  11187. transient="false" volatile="false"
  11188. static="true" final="true" visibility="public"
  11189. deprecated="not deprecated">
  11190. </field>
  11191. <field name="NM_RECOVERY_PREFIX" type="java.lang.String"
  11192. transient="false" volatile="false"
  11193. static="true" final="true" visibility="public"
  11194. deprecated="not deprecated">
  11195. </field>
  11196. <field name="NM_RECOVERY_ENABLED" type="java.lang.String"
  11197. transient="false" volatile="false"
  11198. static="true" final="true" visibility="public"
  11199. deprecated="not deprecated">
  11200. </field>
  11201. <field name="DEFAULT_NM_RECOVERY_ENABLED" type="boolean"
  11202. transient="false" volatile="false"
  11203. static="true" final="true" visibility="public"
  11204. deprecated="not deprecated">
  11205. </field>
  11206. <field name="NM_RECOVERY_DIR" type="java.lang.String"
  11207. transient="false" volatile="false"
  11208. static="true" final="true" visibility="public"
  11209. deprecated="not deprecated">
  11210. </field>
  11211. <field name="PROXY_PREFIX" type="java.lang.String"
  11212. transient="false" volatile="false"
  11213. static="true" final="true" visibility="public"
  11214. deprecated="not deprecated">
  11215. </field>
  11216. <field name="PROXY_PRINCIPAL" type="java.lang.String"
  11217. transient="false" volatile="false"
  11218. static="true" final="true" visibility="public"
  11219. deprecated="not deprecated">
  11220. <doc>
  11221. <![CDATA[The kerberos principal for the proxy.]]>
  11222. </doc>
  11223. </field>
  11224. <field name="PROXY_KEYTAB" type="java.lang.String"
  11225. transient="false" volatile="false"
  11226. static="true" final="true" visibility="public"
  11227. deprecated="not deprecated">
  11228. <doc>
  11229. <![CDATA[Keytab for Proxy.]]>
  11230. </doc>
  11231. </field>
  11232. <field name="PROXY_ADDRESS" type="java.lang.String"
  11233. transient="false" volatile="false"
  11234. static="true" final="true" visibility="public"
  11235. deprecated="not deprecated">
  11236. <doc>
  11237. <![CDATA[The address for the web proxy.]]>
  11238. </doc>
  11239. </field>
  11240. <field name="DEFAULT_PROXY_PORT" type="int"
  11241. transient="false" volatile="false"
  11242. static="true" final="true" visibility="public"
  11243. deprecated="not deprecated">
  11244. </field>
  11245. <field name="DEFAULT_PROXY_ADDRESS" type="java.lang.String"
  11246. transient="false" volatile="false"
  11247. static="true" final="true" visibility="public"
  11248. deprecated="not deprecated">
  11249. </field>
  11250. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCETRACKER_PROTOCOL" type="java.lang.String"
  11251. transient="false" volatile="false"
  11252. static="true" final="true" visibility="public"
  11253. deprecated="not deprecated">
  11254. <doc>
  11255. <![CDATA[YARN Service Level Authorization]]>
  11256. </doc>
  11257. </field>
  11258. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONCLIENT_PROTOCOL" type="java.lang.String"
  11259. transient="false" volatile="false"
  11260. static="true" final="true" visibility="public"
  11261. deprecated="not deprecated">
  11262. </field>
  11263. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCEMANAGER_ADMINISTRATION_PROTOCOL" type="java.lang.String"
  11264. transient="false" volatile="false"
  11265. static="true" final="true" visibility="public"
  11266. deprecated="not deprecated">
  11267. </field>
  11268. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONMASTER_PROTOCOL" type="java.lang.String"
  11269. transient="false" volatile="false"
  11270. static="true" final="true" visibility="public"
  11271. deprecated="not deprecated">
  11272. </field>
  11273. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_CONTAINER_MANAGEMENT_PROTOCOL" type="java.lang.String"
  11274. transient="false" volatile="false"
  11275. static="true" final="true" visibility="public"
  11276. deprecated="not deprecated">
  11277. </field>
  11278. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCE_LOCALIZER" type="java.lang.String"
  11279. transient="false" volatile="false"
  11280. static="true" final="true" visibility="public"
  11281. deprecated="not deprecated">
  11282. </field>
  11283. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONHISTORY_PROTOCOL" type="java.lang.String"
  11284. transient="false" volatile="false"
  11285. static="true" final="true" visibility="public"
  11286. deprecated="not deprecated">
  11287. </field>
  11288. <field name="NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="java.lang.String"
  11289. transient="false" volatile="false"
  11290. static="true" final="true" visibility="public"
  11291. deprecated="not deprecated">
  11292. <doc>
  11293. <![CDATA[No. of milliseconds to wait between sending a SIGTERM and SIGKILL
  11294. to a running container]]>
  11295. </doc>
  11296. </field>
  11297. <field name="DEFAULT_NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="long"
  11298. transient="false" volatile="false"
  11299. static="true" final="true" visibility="public"
  11300. deprecated="not deprecated">
  11301. </field>
  11302. <field name="NM_PROCESS_KILL_WAIT_MS" type="java.lang.String"
  11303. transient="false" volatile="false"
  11304. static="true" final="true" visibility="public"
  11305. deprecated="not deprecated">
  11306. <doc>
  11307. <![CDATA[Max time to wait for a process to come up when trying to cleanup
  11308. container resources]]>
  11309. </doc>
  11310. </field>
  11311. <field name="DEFAULT_NM_PROCESS_KILL_WAIT_MS" type="long"
  11312. transient="false" volatile="false"
  11313. static="true" final="true" visibility="public"
  11314. deprecated="not deprecated">
  11315. </field>
  11316. <field name="RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  11317. transient="false" volatile="false"
  11318. static="true" final="true" visibility="public"
  11319. deprecated="not deprecated">
  11320. <doc>
  11321. <![CDATA[Max time to wait to establish a connection to RM]]>
  11322. </doc>
  11323. </field>
  11324. <field name="DEFAULT_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="long"
  11325. transient="false" volatile="false"
  11326. static="true" final="true" visibility="public"
  11327. deprecated="not deprecated">
  11328. </field>
  11329. <field name="RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  11330. transient="false" volatile="false"
  11331. static="true" final="true" visibility="public"
  11332. deprecated="not deprecated">
  11333. <doc>
  11334. <![CDATA[Time interval between each attempt to connect to RM]]>
  11335. </doc>
  11336. </field>
  11337. <field name="DEFAULT_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="long"
  11338. transient="false" volatile="false"
  11339. static="true" final="true" visibility="public"
  11340. deprecated="not deprecated">
  11341. </field>
  11342. <field name="DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="java.lang.String"
  11343. transient="false" volatile="false"
  11344. static="true" final="true" visibility="public"
  11345. deprecated="not deprecated">
  11346. </field>
  11347. <field name="DEFAULT_DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="long"
  11348. transient="false" volatile="false"
  11349. static="true" final="true" visibility="public"
  11350. deprecated="not deprecated">
  11351. </field>
  11352. <field name="YARN_APPLICATION_CLASSPATH" type="java.lang.String"
  11353. transient="false" volatile="false"
  11354. static="true" final="true" visibility="public"
  11355. deprecated="not deprecated">
  11356. <doc>
  11357. <![CDATA[CLASSPATH for YARN applications. A comma-separated list of CLASSPATH
  11358. entries]]>
  11359. </doc>
  11360. </field>
  11361. <field name="DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH" type="java.lang.String[]"
  11362. transient="false" volatile="false"
  11363. static="true" final="true" visibility="public"
  11364. deprecated="not deprecated">
  11365. <doc>
  11366. <![CDATA[Default platform-agnostic CLASSPATH for YARN applications. A
  11367. comma-separated list of CLASSPATH entries. The parameter expansion marker
  11368. will be replaced with real parameter expansion marker ('%' for Windows and
  11369. '$' for Linux) by NodeManager on container launch. For example: {{VAR}}
  11370. will be replaced as $VAR on Linux, and %VAR% on Windows.]]>
  11371. </doc>
  11372. </field>
  11373. <field name="DEFAULT_YARN_APPLICATION_CLASSPATH" type="java.lang.String[]"
  11374. transient="false" volatile="false"
  11375. static="true" final="true" visibility="public"
  11376. deprecated="not deprecated">
  11377. <doc>
  11378. <![CDATA[<p>
  11379. Default platform-specific CLASSPATH for YARN applications. A
  11380. comma-separated list of CLASSPATH entries constructed based on the client
  11381. OS environment expansion syntax.
  11382. </p>
  11383. <p>
  11384. Note: Use {@link #DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH} for
  11385. cross-platform practice i.e. submit an application from a Windows client to
  11386. a Linux/Unix server or vice versa.
  11387. </p>]]>
  11388. </doc>
  11389. </field>
  11390. <field name="DEFAULT_CONTAINER_TEMP_DIR" type="java.lang.String"
  11391. transient="false" volatile="false"
  11392. static="true" final="true" visibility="public"
  11393. deprecated="not deprecated">
  11394. <doc>
  11395. <![CDATA[Container temp directory]]>
  11396. </doc>
  11397. </field>
  11398. <field name="IS_MINI_YARN_CLUSTER" type="java.lang.String"
  11399. transient="false" volatile="false"
  11400. static="true" final="true" visibility="public"
  11401. deprecated="not deprecated">
  11402. </field>
  11403. <field name="YARN_MC_PREFIX" type="java.lang.String"
  11404. transient="false" volatile="false"
  11405. static="true" final="true" visibility="public"
  11406. deprecated="not deprecated">
  11407. </field>
  11408. <field name="YARN_MINICLUSTER_FIXED_PORTS" type="java.lang.String"
  11409. transient="false" volatile="false"
  11410. static="true" final="true" visibility="public"
  11411. deprecated="not deprecated">
  11412. <doc>
  11413. <![CDATA[Whether to use fixed ports with the minicluster.]]>
  11414. </doc>
  11415. </field>
  11416. <field name="DEFAULT_YARN_MINICLUSTER_FIXED_PORTS" type="boolean"
  11417. transient="false" volatile="false"
  11418. static="true" final="true" visibility="public"
  11419. deprecated="not deprecated">
  11420. <doc>
  11421. <![CDATA[Default is false to be able to run tests concurrently without port
  11422. conflicts.]]>
  11423. </doc>
  11424. </field>
  11425. <field name="YARN_MINICLUSTER_USE_RPC" type="java.lang.String"
  11426. transient="false" volatile="false"
  11427. static="true" final="true" visibility="public"
  11428. deprecated="not deprecated">
  11429. <doc>
  11430. <![CDATA[Whether the NM should use RPC to connect to the RM. Default is false.
  11431. Can be set to true only when using fixed ports.]]>
  11432. </doc>
  11433. </field>
  11434. <field name="DEFAULT_YARN_MINICLUSTER_USE_RPC" type="boolean"
  11435. transient="false" volatile="false"
  11436. static="true" final="true" visibility="public"
  11437. deprecated="not deprecated">
  11438. </field>
  11439. <field name="YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="java.lang.String"
  11440. transient="false" volatile="false"
  11441. static="true" final="true" visibility="public"
  11442. deprecated="not deprecated">
  11443. <doc>
  11444. <![CDATA[Whether users are explicitly trying to control resource monitoring
  11445. configuration for the MiniYARNCluster. Disabled by default.]]>
  11446. </doc>
  11447. </field>
  11448. <field name="DEFAULT_YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="boolean"
  11449. transient="false" volatile="false"
  11450. static="true" final="true" visibility="public"
  11451. deprecated="not deprecated">
  11452. </field>
  11453. <field name="YARN_MINICLUSTER_NM_PMEM_MB" type="java.lang.String"
  11454. transient="false" volatile="false"
  11455. static="true" final="true" visibility="public"
  11456. deprecated="not deprecated">
  11457. <doc>
  11458. <![CDATA[Allow changing the memory for the NodeManager in the MiniYARNCluster]]>
  11459. </doc>
  11460. </field>
  11461. <field name="DEFAULT_YARN_MINICLUSTER_NM_PMEM_MB" type="int"
  11462. transient="false" volatile="false"
  11463. static="true" final="true" visibility="public"
  11464. deprecated="not deprecated">
  11465. </field>
  11466. <field name="YARN_APP_CONTAINER_LOG_DIR" type="java.lang.String"
  11467. transient="false" volatile="false"
  11468. static="true" final="true" visibility="public"
  11469. deprecated="not deprecated">
  11470. <doc>
  11471. <![CDATA[The log directory for the containers]]>
  11472. </doc>
  11473. </field>
  11474. <field name="YARN_APP_CONTAINER_LOG_SIZE" type="java.lang.String"
  11475. transient="false" volatile="false"
  11476. static="true" final="true" visibility="public"
  11477. deprecated="not deprecated">
  11478. </field>
  11479. <field name="YARN_APP_CONTAINER_LOG_BACKUPS" type="java.lang.String"
  11480. transient="false" volatile="false"
  11481. static="true" final="true" visibility="public"
  11482. deprecated="not deprecated">
  11483. </field>
  11484. <field name="TIMELINE_SERVICE_PREFIX" type="java.lang.String"
  11485. transient="false" volatile="false"
  11486. static="true" final="true" visibility="public"
  11487. deprecated="not deprecated">
  11488. </field>
  11489. <field name="TIMELINE_SERVICE_UI_NAMES" type="java.lang.String"
  11490. transient="false" volatile="false"
  11491. static="true" final="true" visibility="public"
  11492. deprecated="not deprecated">
  11493. <doc>
  11494. <![CDATA[Comma seperated list of names for UIs hosted in the timeline server
  11495. (For pluggable UIs).]]>
  11496. </doc>
  11497. </field>
  11498. <field name="TIMELINE_SERVICE_UI_WEB_PATH_PREFIX" type="java.lang.String"
  11499. transient="false" volatile="false"
  11500. static="true" final="true" visibility="public"
  11501. deprecated="not deprecated">
  11502. <doc>
  11503. <![CDATA[Relative web path that will serve up this UI (For pluggable UIs).]]>
  11504. </doc>
  11505. </field>
  11506. <field name="TIMELINE_SERVICE_UI_ON_DISK_PATH_PREFIX" type="java.lang.String"
  11507. transient="false" volatile="false"
  11508. static="true" final="true" visibility="public"
  11509. deprecated="not deprecated">
  11510. <doc>
  11511. <![CDATA[Path to war file or static content directory for this UI
  11512. (For pluggable UIs).]]>
  11513. </doc>
  11514. </field>
  11515. <field name="APPLICATION_HISTORY_PREFIX" type="java.lang.String"
  11516. transient="false" volatile="false"
  11517. static="true" final="true" visibility="public"
  11518. deprecated="not deprecated">
  11519. </field>
  11520. <field name="APPLICATION_HISTORY_ENABLED" type="java.lang.String"
  11521. transient="false" volatile="false"
  11522. static="true" final="true" visibility="public"
  11523. deprecated="not deprecated">
  11524. <doc>
  11525. <![CDATA[The setting that controls whether application history service is
  11526. enabled or not.]]>
  11527. </doc>
  11528. </field>
  11529. <field name="DEFAULT_APPLICATION_HISTORY_ENABLED" type="boolean"
  11530. transient="false" volatile="false"
  11531. static="true" final="true" visibility="public"
  11532. deprecated="not deprecated">
  11533. </field>
  11534. <field name="APPLICATION_HISTORY_STORE" type="java.lang.String"
  11535. transient="false" volatile="false"
  11536. static="true" final="true" visibility="public"
  11537. deprecated="not deprecated">
  11538. <doc>
  11539. <![CDATA[Application history store class]]>
  11540. </doc>
  11541. </field>
  11542. <field name="APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="java.lang.String"
  11543. transient="false" volatile="false"
  11544. static="true" final="true" visibility="public"
  11545. deprecated="not deprecated">
  11546. <doc>
  11547. <![CDATA[Save container meta-info in the application history store.]]>
  11548. </doc>
  11549. </field>
  11550. <field name="DEFAULT_APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="boolean"
  11551. transient="false" volatile="false"
  11552. static="true" final="true" visibility="public"
  11553. deprecated="not deprecated">
  11554. </field>
  11555. <field name="FS_APPLICATION_HISTORY_STORE_URI" type="java.lang.String"
  11556. transient="false" volatile="false"
  11557. static="true" final="true" visibility="public"
  11558. deprecated="not deprecated">
  11559. <doc>
  11560. <![CDATA[URI for FileSystemApplicationHistoryStore]]>
  11561. </doc>
  11562. </field>
  11563. <field name="FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
  11564. transient="false" volatile="false"
  11565. static="true" final="true" visibility="public"
  11566. deprecated="not deprecated">
  11567. <doc>
  11568. <![CDATA[T-file compression types used to compress history data.]]>
  11569. </doc>
  11570. </field>
  11571. <field name="DEFAULT_FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
  11572. transient="false" volatile="false"
  11573. static="true" final="true" visibility="public"
  11574. deprecated="not deprecated">
  11575. </field>
  11576. <field name="TIMELINE_SERVICE_ENABLED" type="java.lang.String"
  11577. transient="false" volatile="false"
  11578. static="true" final="true" visibility="public"
  11579. deprecated="not deprecated">
  11580. <doc>
  11581. <![CDATA[The setting that controls whether timeline service is enabled or not.]]>
  11582. </doc>
  11583. </field>
  11584. <field name="DEFAULT_TIMELINE_SERVICE_ENABLED" type="boolean"
  11585. transient="false" volatile="false"
  11586. static="true" final="true" visibility="public"
  11587. deprecated="not deprecated">
  11588. </field>
  11589. <field name="TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
  11590. transient="false" volatile="false"
  11591. static="true" final="true" visibility="public"
  11592. deprecated="not deprecated">
  11593. <doc>
  11594. <![CDATA[host:port address for timeline service RPC APIs.]]>
  11595. </doc>
  11596. </field>
  11597. <field name="DEFAULT_TIMELINE_SERVICE_PORT" type="int"
  11598. transient="false" volatile="false"
  11599. static="true" final="true" visibility="public"
  11600. deprecated="not deprecated">
  11601. </field>
  11602. <field name="DEFAULT_TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
  11603. transient="false" volatile="false"
  11604. static="true" final="true" visibility="public"
  11605. deprecated="not deprecated">
  11606. </field>
  11607. <field name="TIMELINE_SERVICE_BIND_HOST" type="java.lang.String"
  11608. transient="false" volatile="false"
  11609. static="true" final="true" visibility="public"
  11610. deprecated="not deprecated">
  11611. <doc>
  11612. <![CDATA[The listening endpoint for the timeline service application.]]>
  11613. </doc>
  11614. </field>
  11615. <field name="TIMELINE_SERVICE_HANDLER_THREAD_COUNT" type="java.lang.String"
  11616. transient="false" volatile="false"
  11617. static="true" final="true" visibility="public"
  11618. deprecated="not deprecated">
  11619. <doc>
  11620. <![CDATA[The number of threads to handle client RPC API requests.]]>
  11621. </doc>
  11622. </field>
  11623. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_THREAD_COUNT" type="int"
  11624. transient="false" volatile="false"
  11625. static="true" final="true" visibility="public"
  11626. deprecated="not deprecated">
  11627. </field>
  11628. <field name="TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
  11629. transient="false" volatile="false"
  11630. static="true" final="true" visibility="public"
  11631. deprecated="not deprecated">
  11632. <doc>
  11633. <![CDATA[The address of the timeline service web application.]]>
  11634. </doc>
  11635. </field>
  11636. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_PORT" type="int"
  11637. transient="false" volatile="false"
  11638. static="true" final="true" visibility="public"
  11639. deprecated="not deprecated">
  11640. </field>
  11641. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
  11642. transient="false" volatile="false"
  11643. static="true" final="true" visibility="public"
  11644. deprecated="not deprecated">
  11645. </field>
  11646. <field name="TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  11647. transient="false" volatile="false"
  11648. static="true" final="true" visibility="public"
  11649. deprecated="not deprecated">
  11650. <doc>
  11651. <![CDATA[The https address of the timeline service web application.]]>
  11652. </doc>
  11653. </field>
  11654. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_PORT" type="int"
  11655. transient="false" volatile="false"
  11656. static="true" final="true" visibility="public"
  11657. deprecated="not deprecated">
  11658. </field>
  11659. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  11660. transient="false" volatile="false"
  11661. static="true" final="true" visibility="public"
  11662. deprecated="not deprecated">
  11663. </field>
  11664. <field name="APPLICATION_HISTORY_MAX_APPS" type="java.lang.String"
  11665. transient="false" volatile="false"
  11666. static="true" final="true" visibility="public"
  11667. deprecated="not deprecated">
  11668. <doc>
  11669. <![CDATA[Defines the max number of applications could be fetched using
  11670. REST API or application history protocol and shown in timeline
  11671. server web ui.]]>
  11672. </doc>
  11673. </field>
  11674. <field name="DEFAULT_APPLICATION_HISTORY_MAX_APPS" type="long"
  11675. transient="false" volatile="false"
  11676. static="true" final="true" visibility="public"
  11677. deprecated="not deprecated">
  11678. </field>
  11679. <field name="TIMELINE_SERVICE_STORE" type="java.lang.String"
  11680. transient="false" volatile="false"
  11681. static="true" final="true" visibility="public"
  11682. deprecated="not deprecated">
  11683. <doc>
  11684. <![CDATA[Timeline service store class]]>
  11685. </doc>
  11686. </field>
  11687. <field name="TIMELINE_SERVICE_TTL_ENABLE" type="java.lang.String"
  11688. transient="false" volatile="false"
  11689. static="true" final="true" visibility="public"
  11690. deprecated="not deprecated">
  11691. <doc>
  11692. <![CDATA[Timeline service enable data age off]]>
  11693. </doc>
  11694. </field>
  11695. <field name="TIMELINE_SERVICE_TTL_MS" type="java.lang.String"
  11696. transient="false" volatile="false"
  11697. static="true" final="true" visibility="public"
  11698. deprecated="not deprecated">
  11699. <doc>
  11700. <![CDATA[Timeline service length of time to retain data]]>
  11701. </doc>
  11702. </field>
  11703. <field name="DEFAULT_TIMELINE_SERVICE_TTL_MS" type="long"
  11704. transient="false" volatile="false"
  11705. static="true" final="true" visibility="public"
  11706. deprecated="not deprecated">
  11707. </field>
  11708. <field name="TIMELINE_SERVICE_LEVELDB_PREFIX" type="java.lang.String"
  11709. transient="false" volatile="false"
  11710. static="true" final="true" visibility="public"
  11711. deprecated="not deprecated">
  11712. </field>
  11713. <field name="TIMELINE_SERVICE_LEVELDB_PATH" type="java.lang.String"
  11714. transient="false" volatile="false"
  11715. static="true" final="true" visibility="public"
  11716. deprecated="not deprecated">
  11717. <doc>
  11718. <![CDATA[Timeline service leveldb path]]>
  11719. </doc>
  11720. </field>
  11721. <field name="TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="java.lang.String"
  11722. transient="false" volatile="false"
  11723. static="true" final="true" visibility="public"
  11724. deprecated="not deprecated">
  11725. <doc>
  11726. <![CDATA[Timeline service leveldb read cache (uncompressed blocks)]]>
  11727. </doc>
  11728. </field>
  11729. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="long"
  11730. transient="false" volatile="false"
  11731. static="true" final="true" visibility="public"
  11732. deprecated="not deprecated">
  11733. </field>
  11734. <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="java.lang.String"
  11735. transient="false" volatile="false"
  11736. static="true" final="true" visibility="public"
  11737. deprecated="not deprecated">
  11738. <doc>
  11739. <![CDATA[Timeline service leveldb start time read cache (number of entities)]]>
  11740. </doc>
  11741. </field>
  11742. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="int"
  11743. transient="false" volatile="false"
  11744. static="true" final="true" visibility="public"
  11745. deprecated="not deprecated">
  11746. </field>
  11747. <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="java.lang.String"
  11748. transient="false" volatile="false"
  11749. static="true" final="true" visibility="public"
  11750. deprecated="not deprecated">
  11751. <doc>
  11752. <![CDATA[Timeline service leveldb start time write cache (number of entities)]]>
  11753. </doc>
  11754. </field>
  11755. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="int"
  11756. transient="false" volatile="false"
  11757. static="true" final="true" visibility="public"
  11758. deprecated="not deprecated">
  11759. </field>
  11760. <field name="TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="java.lang.String"
  11761. transient="false" volatile="false"
  11762. static="true" final="true" visibility="public"
  11763. deprecated="not deprecated">
  11764. <doc>
  11765. <![CDATA[Timeline service leveldb interval to wait between deletion rounds]]>
  11766. </doc>
  11767. </field>
  11768. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="long"
  11769. transient="false" volatile="false"
  11770. static="true" final="true" visibility="public"
  11771. deprecated="not deprecated">
  11772. </field>
  11773. <field name="TIMELINE_SERVICE_PRINCIPAL" type="java.lang.String"
  11774. transient="false" volatile="false"
  11775. static="true" final="true" visibility="public"
  11776. deprecated="not deprecated">
  11777. <doc>
  11778. <![CDATA[The Kerberos principal for the timeline server.]]>
  11779. </doc>
  11780. </field>
  11781. <field name="TIMELINE_SERVICE_KEYTAB" type="java.lang.String"
  11782. transient="false" volatile="false"
  11783. static="true" final="true" visibility="public"
  11784. deprecated="not deprecated">
  11785. <doc>
  11786. <![CDATA[The Kerberos keytab for the timeline server.]]>
  11787. </doc>
  11788. </field>
  11789. <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED" type="java.lang.String"
  11790. transient="false" volatile="false"
  11791. static="true" final="true" visibility="public"
  11792. deprecated="not deprecated">
  11793. <doc>
  11794. <![CDATA[Enables cross origin support for timeline server.]]>
  11795. </doc>
  11796. </field>
  11797. <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED_DEFAULT" type="boolean"
  11798. transient="false" volatile="false"
  11799. static="true" final="true" visibility="public"
  11800. deprecated="not deprecated">
  11801. <doc>
  11802. <![CDATA[Default value for cross origin support for timeline server.]]>
  11803. </doc>
  11804. </field>
  11805. <field name="TIMELINE_SERVICE_CLIENT_PREFIX" type="java.lang.String"
  11806. transient="false" volatile="false"
  11807. static="true" final="true" visibility="public"
  11808. deprecated="not deprecated">
  11809. <doc>
  11810. <![CDATA[Timeline client settings]]>
  11811. </doc>
  11812. </field>
  11813. <field name="TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="java.lang.String"
  11814. transient="false" volatile="false"
  11815. static="true" final="true" visibility="public"
  11816. deprecated="not deprecated">
  11817. <doc>
  11818. <![CDATA[Timeline client call, max retries (-1 means no limit)]]>
  11819. </doc>
  11820. </field>
  11821. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="int"
  11822. transient="false" volatile="false"
  11823. static="true" final="true" visibility="public"
  11824. deprecated="not deprecated">
  11825. </field>
  11826. <field name="TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="java.lang.String"
  11827. transient="false" volatile="false"
  11828. static="true" final="true" visibility="public"
  11829. deprecated="not deprecated">
  11830. <doc>
  11831. <![CDATA[Timeline client call, retry interval]]>
  11832. </doc>
  11833. </field>
  11834. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="long"
  11835. transient="false" volatile="false"
  11836. static="true" final="true" visibility="public"
  11837. deprecated="not deprecated">
  11838. </field>
  11839. <field name="TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="java.lang.String"
  11840. transient="false" volatile="false"
  11841. static="true" final="true" visibility="public"
  11842. deprecated="not deprecated">
  11843. <doc>
  11844. <![CDATA[Timeline client policy for whether connections are fatal]]>
  11845. </doc>
  11846. </field>
  11847. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="boolean"
  11848. transient="false" volatile="false"
  11849. static="true" final="true" visibility="public"
  11850. deprecated="not deprecated">
  11851. </field>
  11852. <field name="TIMELINE_SERVICE_RECOVERY_ENABLED" type="java.lang.String"
  11853. transient="false" volatile="false"
  11854. static="true" final="true" visibility="public"
  11855. deprecated="not deprecated">
  11856. <doc>
  11857. <![CDATA[Flag to enable recovery of timeline service]]>
  11858. </doc>
  11859. </field>
  11860. <field name="DEFAULT_TIMELINE_SERVICE_RECOVERY_ENABLED" type="boolean"
  11861. transient="false" volatile="false"
  11862. static="true" final="true" visibility="public"
  11863. deprecated="not deprecated">
  11864. </field>
  11865. <field name="TIMELINE_SERVICE_STATE_STORE_CLASS" type="java.lang.String"
  11866. transient="false" volatile="false"
  11867. static="true" final="true" visibility="public"
  11868. deprecated="not deprecated">
  11869. <doc>
  11870. <![CDATA[Timeline service state store class]]>
  11871. </doc>
  11872. </field>
  11873. <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PREFIX" type="java.lang.String"
  11874. transient="false" volatile="false"
  11875. static="true" final="true" visibility="public"
  11876. deprecated="not deprecated">
  11877. </field>
  11878. <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PATH" type="java.lang.String"
  11879. transient="false" volatile="false"
  11880. static="true" final="true" visibility="public"
  11881. deprecated="not deprecated">
  11882. <doc>
  11883. <![CDATA[Timeline service state store leveldb path]]>
  11884. </doc>
  11885. </field>
  11886. <field name="TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="java.lang.String"
  11887. transient="false" volatile="false"
  11888. static="true" final="true" visibility="public"
  11889. deprecated="not deprecated">
  11890. </field>
  11891. <field name="DEFAULT_TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="long"
  11892. transient="false" volatile="false"
  11893. static="true" final="true" visibility="public"
  11894. deprecated="not deprecated">
  11895. </field>
  11896. <field name="TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="java.lang.String"
  11897. transient="false" volatile="false"
  11898. static="true" final="true" visibility="public"
  11899. deprecated="not deprecated">
  11900. </field>
  11901. <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="long"
  11902. transient="false" volatile="false"
  11903. static="true" final="true" visibility="public"
  11904. deprecated="not deprecated">
  11905. </field>
  11906. <field name="TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="java.lang.String"
  11907. transient="false" volatile="false"
  11908. static="true" final="true" visibility="public"
  11909. deprecated="not deprecated">
  11910. </field>
  11911. <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="long"
  11912. transient="false" volatile="false"
  11913. static="true" final="true" visibility="public"
  11914. deprecated="not deprecated">
  11915. </field>
  11916. <field name="SHARED_CACHE_PREFIX" type="java.lang.String"
  11917. transient="false" volatile="false"
  11918. static="true" final="true" visibility="public"
  11919. deprecated="not deprecated">
  11920. </field>
  11921. <field name="SHARED_CACHE_ENABLED" type="java.lang.String"
  11922. transient="false" volatile="false"
  11923. static="true" final="true" visibility="public"
  11924. deprecated="not deprecated">
  11925. <doc>
  11926. <![CDATA[whether the shared cache is enabled/disabled]]>
  11927. </doc>
  11928. </field>
  11929. <field name="DEFAULT_SHARED_CACHE_ENABLED" type="boolean"
  11930. transient="false" volatile="false"
  11931. static="true" final="true" visibility="public"
  11932. deprecated="not deprecated">
  11933. </field>
  11934. <field name="SHARED_CACHE_ROOT" type="java.lang.String"
  11935. transient="false" volatile="false"
  11936. static="true" final="true" visibility="public"
  11937. deprecated="not deprecated">
  11938. <doc>
  11939. <![CDATA[The config key for the shared cache root directory.]]>
  11940. </doc>
  11941. </field>
  11942. <field name="DEFAULT_SHARED_CACHE_ROOT" type="java.lang.String"
  11943. transient="false" volatile="false"
  11944. static="true" final="true" visibility="public"
  11945. deprecated="not deprecated">
  11946. </field>
  11947. <field name="SHARED_CACHE_NESTED_LEVEL" type="java.lang.String"
  11948. transient="false" volatile="false"
  11949. static="true" final="true" visibility="public"
  11950. deprecated="not deprecated">
  11951. <doc>
  11952. <![CDATA[The config key for the level of nested directories before getting to the
  11953. checksum directory.]]>
  11954. </doc>
  11955. </field>
  11956. <field name="DEFAULT_SHARED_CACHE_NESTED_LEVEL" type="int"
  11957. transient="false" volatile="false"
  11958. static="true" final="true" visibility="public"
  11959. deprecated="not deprecated">
  11960. </field>
  11961. <field name="SCM_STORE_PREFIX" type="java.lang.String"
  11962. transient="false" volatile="false"
  11963. static="true" final="true" visibility="public"
  11964. deprecated="not deprecated">
  11965. </field>
  11966. <field name="SCM_STORE_CLASS" type="java.lang.String"
  11967. transient="false" volatile="false"
  11968. static="true" final="true" visibility="public"
  11969. deprecated="not deprecated">
  11970. </field>
  11971. <field name="DEFAULT_SCM_STORE_CLASS" type="java.lang.String"
  11972. transient="false" volatile="false"
  11973. static="true" final="true" visibility="public"
  11974. deprecated="not deprecated">
  11975. </field>
  11976. <field name="SCM_APP_CHECKER_CLASS" type="java.lang.String"
  11977. transient="false" volatile="false"
  11978. static="true" final="true" visibility="public"
  11979. deprecated="not deprecated">
  11980. </field>
  11981. <field name="DEFAULT_SCM_APP_CHECKER_CLASS" type="java.lang.String"
  11982. transient="false" volatile="false"
  11983. static="true" final="true" visibility="public"
  11984. deprecated="not deprecated">
  11985. </field>
  11986. <field name="SCM_ADMIN_ADDRESS" type="java.lang.String"
  11987. transient="false" volatile="false"
  11988. static="true" final="true" visibility="public"
  11989. deprecated="not deprecated">
  11990. <doc>
  11991. <![CDATA[The address of the SCM admin interface.]]>
  11992. </doc>
  11993. </field>
  11994. <field name="DEFAULT_SCM_ADMIN_PORT" type="int"
  11995. transient="false" volatile="false"
  11996. static="true" final="true" visibility="public"
  11997. deprecated="not deprecated">
  11998. </field>
  11999. <field name="DEFAULT_SCM_ADMIN_ADDRESS" type="java.lang.String"
  12000. transient="false" volatile="false"
  12001. static="true" final="true" visibility="public"
  12002. deprecated="not deprecated">
  12003. </field>
  12004. <field name="SCM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
  12005. transient="false" volatile="false"
  12006. static="true" final="true" visibility="public"
  12007. deprecated="not deprecated">
  12008. <doc>
  12009. <![CDATA[Number of threads used to handle SCM admin interface.]]>
  12010. </doc>
  12011. </field>
  12012. <field name="DEFAULT_SCM_ADMIN_CLIENT_THREAD_COUNT" type="int"
  12013. transient="false" volatile="false"
  12014. static="true" final="true" visibility="public"
  12015. deprecated="not deprecated">
  12016. </field>
  12017. <field name="SCM_WEBAPP_ADDRESS" type="java.lang.String"
  12018. transient="false" volatile="false"
  12019. static="true" final="true" visibility="public"
  12020. deprecated="not deprecated">
  12021. <doc>
  12022. <![CDATA[The address of the SCM web application.]]>
  12023. </doc>
  12024. </field>
  12025. <field name="DEFAULT_SCM_WEBAPP_PORT" type="int"
  12026. transient="false" volatile="false"
  12027. static="true" final="true" visibility="public"
  12028. deprecated="not deprecated">
  12029. </field>
  12030. <field name="DEFAULT_SCM_WEBAPP_ADDRESS" type="java.lang.String"
  12031. transient="false" volatile="false"
  12032. static="true" final="true" visibility="public"
  12033. deprecated="not deprecated">
  12034. </field>
  12035. <field name="IN_MEMORY_STORE_PREFIX" type="java.lang.String"
  12036. transient="false" volatile="false"
  12037. static="true" final="true" visibility="public"
  12038. deprecated="not deprecated">
  12039. </field>
  12040. <field name="IN_MEMORY_STALENESS_PERIOD_MINS" type="java.lang.String"
  12041. transient="false" volatile="false"
  12042. static="true" final="true" visibility="public"
  12043. deprecated="not deprecated">
  12044. <doc>
  12045. <![CDATA[A resource in the InMemorySCMStore is considered stale if the time since
  12046. the last reference exceeds the staleness period. This value is specified in
  12047. minutes.]]>
  12048. </doc>
  12049. </field>
  12050. <field name="DEFAULT_IN_MEMORY_STALENESS_PERIOD_MINS" type="int"
  12051. transient="false" volatile="false"
  12052. static="true" final="true" visibility="public"
  12053. deprecated="not deprecated">
  12054. </field>
  12055. <field name="IN_MEMORY_INITIAL_DELAY_MINS" type="java.lang.String"
  12056. transient="false" volatile="false"
  12057. static="true" final="true" visibility="public"
  12058. deprecated="not deprecated">
  12059. <doc>
  12060. <![CDATA[Initial delay before the in-memory store runs its first check to remove
  12061. dead initial applications. Specified in minutes.]]>
  12062. </doc>
  12063. </field>
  12064. <field name="DEFAULT_IN_MEMORY_INITIAL_DELAY_MINS" type="int"
  12065. transient="false" volatile="false"
  12066. static="true" final="true" visibility="public"
  12067. deprecated="not deprecated">
  12068. </field>
  12069. <field name="IN_MEMORY_CHECK_PERIOD_MINS" type="java.lang.String"
  12070. transient="false" volatile="false"
  12071. static="true" final="true" visibility="public"
  12072. deprecated="not deprecated">
  12073. <doc>
  12074. <![CDATA[The frequency at which the in-memory store checks to remove dead initial
  12075. applications. Specified in minutes.]]>
  12076. </doc>
  12077. </field>
  12078. <field name="DEFAULT_IN_MEMORY_CHECK_PERIOD_MINS" type="int"
  12079. transient="false" volatile="false"
  12080. static="true" final="true" visibility="public"
  12081. deprecated="not deprecated">
  12082. </field>
  12083. <field name="SCM_CLEANER_PERIOD_MINS" type="java.lang.String"
  12084. transient="false" volatile="false"
  12085. static="true" final="true" visibility="public"
  12086. deprecated="not deprecated">
  12087. <doc>
  12088. <![CDATA[The frequency at which a cleaner task runs. Specified in minutes.]]>
  12089. </doc>
  12090. </field>
  12091. <field name="DEFAULT_SCM_CLEANER_PERIOD_MINS" type="int"
  12092. transient="false" volatile="false"
  12093. static="true" final="true" visibility="public"
  12094. deprecated="not deprecated">
  12095. </field>
  12096. <field name="SCM_CLEANER_INITIAL_DELAY_MINS" type="java.lang.String"
  12097. transient="false" volatile="false"
  12098. static="true" final="true" visibility="public"
  12099. deprecated="not deprecated">
  12100. <doc>
  12101. <![CDATA[Initial delay before the first cleaner task is scheduled. Specified in
  12102. minutes.]]>
  12103. </doc>
  12104. </field>
  12105. <field name="DEFAULT_SCM_CLEANER_INITIAL_DELAY_MINS" type="int"
  12106. transient="false" volatile="false"
  12107. static="true" final="true" visibility="public"
  12108. deprecated="not deprecated">
  12109. </field>
  12110. <field name="SCM_CLEANER_RESOURCE_SLEEP_MS" type="java.lang.String"
  12111. transient="false" volatile="false"
  12112. static="true" final="true" visibility="public"
  12113. deprecated="not deprecated">
  12114. <doc>
  12115. <![CDATA[The time to sleep between processing each shared cache resource. Specified
  12116. in milliseconds.]]>
  12117. </doc>
  12118. </field>
  12119. <field name="DEFAULT_SCM_CLEANER_RESOURCE_SLEEP_MS" type="long"
  12120. transient="false" volatile="false"
  12121. static="true" final="true" visibility="public"
  12122. deprecated="not deprecated">
  12123. </field>
  12124. <field name="SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
  12125. transient="false" volatile="false"
  12126. static="true" final="true" visibility="public"
  12127. deprecated="not deprecated">
  12128. <doc>
  12129. <![CDATA[The address of the node manager interface in the SCM.]]>
  12130. </doc>
  12131. </field>
  12132. <field name="DEFAULT_SCM_UPLOADER_SERVER_PORT" type="int"
  12133. transient="false" volatile="false"
  12134. static="true" final="true" visibility="public"
  12135. deprecated="not deprecated">
  12136. </field>
  12137. <field name="DEFAULT_SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
  12138. transient="false" volatile="false"
  12139. static="true" final="true" visibility="public"
  12140. deprecated="not deprecated">
  12141. </field>
  12142. <field name="SCM_UPLOADER_SERVER_THREAD_COUNT" type="java.lang.String"
  12143. transient="false" volatile="false"
  12144. static="true" final="true" visibility="public"
  12145. deprecated="not deprecated">
  12146. <doc>
  12147. <![CDATA[The number of SCM threads used to handle notify requests from the node
  12148. manager.]]>
  12149. </doc>
  12150. </field>
  12151. <field name="DEFAULT_SCM_UPLOADER_SERVER_THREAD_COUNT" type="int"
  12152. transient="false" volatile="false"
  12153. static="true" final="true" visibility="public"
  12154. deprecated="not deprecated">
  12155. </field>
  12156. <field name="SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
  12157. transient="false" volatile="false"
  12158. static="true" final="true" visibility="public"
  12159. deprecated="not deprecated">
  12160. <doc>
  12161. <![CDATA[The address of the client interface in the SCM.]]>
  12162. </doc>
  12163. </field>
  12164. <field name="DEFAULT_SCM_CLIENT_SERVER_PORT" type="int"
  12165. transient="false" volatile="false"
  12166. static="true" final="true" visibility="public"
  12167. deprecated="not deprecated">
  12168. </field>
  12169. <field name="DEFAULT_SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
  12170. transient="false" volatile="false"
  12171. static="true" final="true" visibility="public"
  12172. deprecated="not deprecated">
  12173. </field>
  12174. <field name="SCM_CLIENT_SERVER_THREAD_COUNT" type="java.lang.String"
  12175. transient="false" volatile="false"
  12176. static="true" final="true" visibility="public"
  12177. deprecated="not deprecated">
  12178. <doc>
  12179. <![CDATA[The number of threads used to handle shared cache manager requests.]]>
  12180. </doc>
  12181. </field>
  12182. <field name="DEFAULT_SCM_CLIENT_SERVER_THREAD_COUNT" type="int"
  12183. transient="false" volatile="false"
  12184. static="true" final="true" visibility="public"
  12185. deprecated="not deprecated">
  12186. </field>
  12187. <field name="SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
  12188. transient="false" volatile="false"
  12189. static="true" final="true" visibility="public"
  12190. deprecated="not deprecated">
  12191. <doc>
  12192. <![CDATA[the checksum algorithm implementation]]>
  12193. </doc>
  12194. </field>
  12195. <field name="DEFAULT_SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
  12196. transient="false" volatile="false"
  12197. static="true" final="true" visibility="public"
  12198. deprecated="not deprecated">
  12199. </field>
  12200. <field name="SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="java.lang.String"
  12201. transient="false" volatile="false"
  12202. static="true" final="true" visibility="public"
  12203. deprecated="not deprecated">
  12204. <doc>
  12205. <![CDATA[The replication factor for the node manager uploader for the shared cache.]]>
  12206. </doc>
  12207. </field>
  12208. <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="int"
  12209. transient="false" volatile="false"
  12210. static="true" final="true" visibility="public"
  12211. deprecated="not deprecated">
  12212. </field>
  12213. <field name="SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="java.lang.String"
  12214. transient="false" volatile="false"
  12215. static="true" final="true" visibility="public"
  12216. deprecated="not deprecated">
  12217. </field>
  12218. <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="int"
  12219. transient="false" volatile="false"
  12220. static="true" final="true" visibility="public"
  12221. deprecated="not deprecated">
  12222. </field>
  12223. <field name="YARN_CLIENT_APP_SUBMISSION_POLL_INTERVAL_MS" type="java.lang.String"
  12224. transient="false" volatile="false"
  12225. static="true" final="true" visibility="public"
  12226. deprecated="not deprecated">
  12227. <doc>
  12228. <![CDATA[Use YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS instead.
  12229. The interval of the yarn client's querying application state after
  12230. application submission. The unit is millisecond.]]>
  12231. </doc>
  12232. </field>
  12233. <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="java.lang.String"
  12234. transient="false" volatile="false"
  12235. static="true" final="true" visibility="public"
  12236. deprecated="not deprecated">
  12237. <doc>
  12238. <![CDATA[The interval that the yarn client library uses to poll the completion
  12239. status of the asynchronous API of application client protocol.]]>
  12240. </doc>
  12241. </field>
  12242. <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="long"
  12243. transient="false" volatile="false"
  12244. static="true" final="true" visibility="public"
  12245. deprecated="not deprecated">
  12246. </field>
  12247. <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="java.lang.String"
  12248. transient="false" volatile="false"
  12249. static="true" final="true" visibility="public"
  12250. deprecated="not deprecated">
  12251. <doc>
  12252. <![CDATA[The duration that the yarn client library waits, cumulatively across polls,
  12253. for an expected state change to occur. Defaults to -1, which indicates no
  12254. limit.]]>
  12255. </doc>
  12256. </field>
  12257. <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="long"
  12258. transient="false" volatile="false"
  12259. static="true" final="true" visibility="public"
  12260. deprecated="not deprecated">
  12261. </field>
  12262. <field name="NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="java.lang.String"
  12263. transient="false" volatile="false"
  12264. static="true" final="true" visibility="public"
  12265. deprecated="not deprecated">
  12266. <doc>
  12267. <![CDATA[Max number of threads in NMClientAsync to process container management
  12268. events]]>
  12269. </doc>
  12270. </field>
  12271. <field name="DEFAULT_NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="int"
  12272. transient="false" volatile="false"
  12273. static="true" final="true" visibility="public"
  12274. deprecated="not deprecated">
  12275. </field>
  12276. <field name="NM_CLIENT_MAX_NM_PROXIES" type="java.lang.String"
  12277. transient="false" volatile="false"
  12278. static="true" final="true" visibility="public"
  12279. deprecated="not deprecated">
  12280. <doc>
  12281. <![CDATA[Maximum number of proxy connections to cache for node managers. If set
  12282. to a value greater than zero then the cache is enabled and the NMClient
  12283. and MRAppMaster will cache the specified number of node manager proxies.
  12284. There will be at max one proxy per node manager. Ex. configuring it to a
  12285. value of 5 will make sure that client will at max have 5 proxies cached
  12286. with 5 different node managers. These connections for these proxies will
  12287. be timed out if idle for more than the system wide idle timeout period.
  12288. Note that this could cause issues on large clusters as many connections
  12289. could linger simultaneously and lead to a large number of connection
  12290. threads. The token used for authentication will be used only at
  12291. connection creation time. If a new token is received then the earlier
  12292. connection should be closed in order to use the new token. This and
  12293. {@link YarnConfiguration#NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE} are related
  12294. and should be in sync (no need for them to be equal).
  12295. If the value of this property is zero then the connection cache is
  12296. disabled and connections will use a zero idle timeout to prevent too
  12297. many connection threads on large clusters.]]>
  12298. </doc>
  12299. </field>
  12300. <field name="DEFAULT_NM_CLIENT_MAX_NM_PROXIES" type="int"
  12301. transient="false" volatile="false"
  12302. static="true" final="true" visibility="public"
  12303. deprecated="not deprecated">
  12304. </field>
  12305. <field name="CLIENT_NM_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  12306. transient="false" volatile="false"
  12307. static="true" final="true" visibility="public"
  12308. deprecated="not deprecated">
  12309. <doc>
  12310. <![CDATA[Max time to wait to establish a connection to NM]]>
  12311. </doc>
  12312. </field>
  12313. <field name="DEFAULT_CLIENT_NM_CONNECT_MAX_WAIT_MS" type="long"
  12314. transient="false" volatile="false"
  12315. static="true" final="true" visibility="public"
  12316. deprecated="not deprecated">
  12317. </field>
  12318. <field name="CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  12319. transient="false" volatile="false"
  12320. static="true" final="true" visibility="public"
  12321. deprecated="not deprecated">
  12322. <doc>
  12323. <![CDATA[Time interval between each attempt to connect to NM]]>
  12324. </doc>
  12325. </field>
  12326. <field name="DEFAULT_CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="long"
  12327. transient="false" volatile="false"
  12328. static="true" final="true" visibility="public"
  12329. deprecated="not deprecated">
  12330. </field>
  12331. <field name="YARN_HTTP_POLICY_KEY" type="java.lang.String"
  12332. transient="false" volatile="false"
  12333. static="true" final="true" visibility="public"
  12334. deprecated="not deprecated">
  12335. </field>
  12336. <field name="YARN_HTTP_POLICY_DEFAULT" type="java.lang.String"
  12337. transient="false" volatile="false"
  12338. static="true" final="true" visibility="public"
  12339. deprecated="not deprecated">
  12340. </field>
  12341. <field name="NODE_LABELS_PREFIX" type="java.lang.String"
  12342. transient="false" volatile="false"
  12343. static="true" final="true" visibility="public"
  12344. deprecated="not deprecated">
  12345. <doc>
  12346. <![CDATA[Node-labels configurations]]>
  12347. </doc>
  12348. </field>
  12349. <field name="FS_NODE_LABELS_STORE_ROOT_DIR" type="java.lang.String"
  12350. transient="false" volatile="false"
  12351. static="true" final="true" visibility="public"
  12352. deprecated="not deprecated">
  12353. <doc>
  12354. <![CDATA[URI for NodeLabelManager]]>
  12355. </doc>
  12356. </field>
  12357. <field name="FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  12358. transient="false" volatile="false"
  12359. static="true" final="true" visibility="public"
  12360. deprecated="not deprecated">
  12361. </field>
  12362. <field name="DEFAULT_FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  12363. transient="false" volatile="false"
  12364. static="true" final="true" visibility="public"
  12365. deprecated="not deprecated">
  12366. </field>
  12367. <field name="NODE_LABELS_ENABLED" type="java.lang.String"
  12368. transient="false" volatile="false"
  12369. static="true" final="true" visibility="public"
  12370. deprecated="not deprecated">
  12371. <doc>
  12372. <![CDATA[Flag to indicate if the node labels feature enabled, by default it's
  12373. disabled]]>
  12374. </doc>
  12375. </field>
  12376. <field name="DEFAULT_NODE_LABELS_ENABLED" type="boolean"
  12377. transient="false" volatile="false"
  12378. static="true" final="true" visibility="public"
  12379. deprecated="not deprecated">
  12380. </field>
  12381. </class>
  12382. <!-- end class org.apache.hadoop.yarn.conf.YarnConfiguration -->
  12383. </package>
  12384. <package name="org.apache.hadoop.yarn.exceptions">
  12385. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
  12386. <class name="ApplicationAttemptNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12387. abstract="false"
  12388. static="false" final="false" visibility="public"
  12389. deprecated="not deprecated">
  12390. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.Throwable"
  12391. static="false" final="false" visibility="public"
  12392. deprecated="not deprecated">
  12393. </constructor>
  12394. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String"
  12395. static="false" final="false" visibility="public"
  12396. deprecated="not deprecated">
  12397. </constructor>
  12398. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String, java.lang.Throwable"
  12399. static="false" final="false" visibility="public"
  12400. deprecated="not deprecated">
  12401. </constructor>
  12402. <doc>
  12403. <![CDATA[This exception is thrown on
  12404. {@link ApplicationHistoryProtocol#getApplicationAttemptReport (GetApplicationAttemptReportRequest)}
  12405. API when the Application Attempt doesn't exist in Application History Server or
  12406. {@link ApplicationMasterProtocol#allocate(AllocateRequest)} if application
  12407. doesn't exist in RM.]]>
  12408. </doc>
  12409. </class>
  12410. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
  12411. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
  12412. <class name="ApplicationIdNotProvidedException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12413. abstract="false"
  12414. static="false" final="false" visibility="public"
  12415. deprecated="not deprecated">
  12416. <constructor name="ApplicationIdNotProvidedException" type="java.lang.Throwable"
  12417. static="false" final="false" visibility="public"
  12418. deprecated="not deprecated">
  12419. </constructor>
  12420. <constructor name="ApplicationIdNotProvidedException" type="java.lang.String"
  12421. static="false" final="false" visibility="public"
  12422. deprecated="not deprecated">
  12423. </constructor>
  12424. <constructor name="ApplicationIdNotProvidedException" type="java.lang.String, java.lang.Throwable"
  12425. static="false" final="false" visibility="public"
  12426. deprecated="not deprecated">
  12427. </constructor>
  12428. <doc>
  12429. <![CDATA[Exception to be thrown when Client submit an application without
  12430. providing {@link ApplicationId} in {@link ApplicationSubmissionContext}.]]>
  12431. </doc>
  12432. </class>
  12433. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
  12434. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
  12435. <class name="ApplicationNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12436. abstract="false"
  12437. static="false" final="false" visibility="public"
  12438. deprecated="not deprecated">
  12439. <constructor name="ApplicationNotFoundException" type="java.lang.Throwable"
  12440. static="false" final="false" visibility="public"
  12441. deprecated="not deprecated">
  12442. </constructor>
  12443. <constructor name="ApplicationNotFoundException" type="java.lang.String"
  12444. static="false" final="false" visibility="public"
  12445. deprecated="not deprecated">
  12446. </constructor>
  12447. <constructor name="ApplicationNotFoundException" type="java.lang.String, java.lang.Throwable"
  12448. static="false" final="false" visibility="public"
  12449. deprecated="not deprecated">
  12450. </constructor>
  12451. <doc>
  12452. <![CDATA[This exception is thrown on
  12453. {@link ApplicationClientProtocol#getApplicationReport
  12454. (GetApplicationReportRequest)} API
  12455. when the Application doesn't exist in RM and AHS]]>
  12456. </doc>
  12457. </class>
  12458. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
  12459. <!-- start class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
  12460. <class name="ContainerNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12461. abstract="false"
  12462. static="false" final="false" visibility="public"
  12463. deprecated="not deprecated">
  12464. <constructor name="ContainerNotFoundException" type="java.lang.Throwable"
  12465. static="false" final="false" visibility="public"
  12466. deprecated="not deprecated">
  12467. </constructor>
  12468. <constructor name="ContainerNotFoundException" type="java.lang.String"
  12469. static="false" final="false" visibility="public"
  12470. deprecated="not deprecated">
  12471. </constructor>
  12472. <constructor name="ContainerNotFoundException" type="java.lang.String, java.lang.Throwable"
  12473. static="false" final="false" visibility="public"
  12474. deprecated="not deprecated">
  12475. </constructor>
  12476. <doc>
  12477. <![CDATA[This exception is thrown on
  12478. {@link ApplicationHistoryProtocol#getContainerReport (GetContainerReportRequest)}
  12479. API when the container doesn't exist in AHS]]>
  12480. </doc>
  12481. </class>
  12482. <!-- end class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
  12483. <!-- start class org.apache.hadoop.yarn.exceptions.YarnException -->
  12484. <class name="YarnException" extends="java.lang.Exception"
  12485. abstract="false"
  12486. static="false" final="false" visibility="public"
  12487. deprecated="not deprecated">
  12488. <constructor name="YarnException"
  12489. static="false" final="false" visibility="public"
  12490. deprecated="not deprecated">
  12491. </constructor>
  12492. <constructor name="YarnException" type="java.lang.String"
  12493. static="false" final="false" visibility="public"
  12494. deprecated="not deprecated">
  12495. </constructor>
  12496. <constructor name="YarnException" type="java.lang.Throwable"
  12497. static="false" final="false" visibility="public"
  12498. deprecated="not deprecated">
  12499. </constructor>
  12500. <constructor name="YarnException" type="java.lang.String, java.lang.Throwable"
  12501. static="false" final="false" visibility="public"
  12502. deprecated="not deprecated">
  12503. </constructor>
  12504. <doc>
  12505. <![CDATA[YarnException indicates exceptions from yarn servers. On the other hand,
  12506. IOExceptions indicates exceptions from RPC layer.]]>
  12507. </doc>
  12508. </class>
  12509. <!-- end class org.apache.hadoop.yarn.exceptions.YarnException -->
  12510. </package>
  12511. <package name="org.apache.hadoop.yarn.server.api">
  12512. <!-- start class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
  12513. <class name="ApplicationInitializationContext" extends="java.lang.Object"
  12514. abstract="false"
  12515. static="false" final="false" visibility="public"
  12516. deprecated="not deprecated">
  12517. <constructor name="ApplicationInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ApplicationId, java.nio.ByteBuffer"
  12518. static="false" final="false" visibility="public"
  12519. deprecated="not deprecated">
  12520. </constructor>
  12521. <method name="getUser" return="java.lang.String"
  12522. abstract="false" native="false" synchronized="false"
  12523. static="false" final="false" visibility="public"
  12524. deprecated="not deprecated">
  12525. <doc>
  12526. <![CDATA[Get the user-name of the application-submitter
  12527. @return user-name]]>
  12528. </doc>
  12529. </method>
  12530. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  12531. abstract="false" native="false" synchronized="false"
  12532. static="false" final="false" visibility="public"
  12533. deprecated="not deprecated">
  12534. <doc>
  12535. <![CDATA[Get {@link ApplicationId} of the application
  12536. @return applications ID]]>
  12537. </doc>
  12538. </method>
  12539. <method name="getApplicationDataForService" return="java.nio.ByteBuffer"
  12540. abstract="false" native="false" synchronized="false"
  12541. static="false" final="false" visibility="public"
  12542. deprecated="not deprecated">
  12543. <doc>
  12544. <![CDATA[Get the data sent to the NodeManager via
  12545. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  12546. as part of {@link ContainerLaunchContext#getServiceData()}
  12547. @return the servicesData for this application.]]>
  12548. </doc>
  12549. </method>
  12550. <doc>
  12551. <![CDATA[Initialization context for {@link AuxiliaryService} when starting an
  12552. application.]]>
  12553. </doc>
  12554. </class>
  12555. <!-- end class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
  12556. <!-- start class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
  12557. <class name="ApplicationTerminationContext" extends="java.lang.Object"
  12558. abstract="false"
  12559. static="false" final="false" visibility="public"
  12560. deprecated="not deprecated">
  12561. <constructor name="ApplicationTerminationContext" type="org.apache.hadoop.yarn.api.records.ApplicationId"
  12562. static="false" final="false" visibility="public"
  12563. deprecated="not deprecated">
  12564. </constructor>
  12565. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  12566. abstract="false" native="false" synchronized="false"
  12567. static="false" final="false" visibility="public"
  12568. deprecated="not deprecated">
  12569. <doc>
  12570. <![CDATA[Get {@link ApplicationId} of the application being stopped.
  12571. @return applications ID]]>
  12572. </doc>
  12573. </method>
  12574. <doc>
  12575. <![CDATA[Initialization context for {@link AuxiliaryService} when stopping an
  12576. application.]]>
  12577. </doc>
  12578. </class>
  12579. <!-- end class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
  12580. <!-- start class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
  12581. <class name="AuxiliaryService" extends="org.apache.hadoop.service.AbstractService"
  12582. abstract="true"
  12583. static="false" final="false" visibility="public"
  12584. deprecated="not deprecated">
  12585. <constructor name="AuxiliaryService" type="java.lang.String"
  12586. static="false" final="false" visibility="protected"
  12587. deprecated="not deprecated">
  12588. </constructor>
  12589. <method name="getRecoveryPath" return="org.apache.hadoop.fs.Path"
  12590. abstract="false" native="false" synchronized="false"
  12591. static="false" final="false" visibility="protected"
  12592. deprecated="not deprecated">
  12593. <doc>
  12594. <![CDATA[Get the path specific to this auxiliary service to use for recovery.
  12595. @return state storage path or null if recovery is not enabled]]>
  12596. </doc>
  12597. </method>
  12598. <method name="initializeApplication"
  12599. abstract="true" native="false" synchronized="false"
  12600. static="false" final="false" visibility="public"
  12601. deprecated="not deprecated">
  12602. <param name="initAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationInitializationContext"/>
  12603. <doc>
  12604. <![CDATA[A new application is started on this NodeManager. This is a signal to
  12605. this {@link AuxiliaryService} about the application initialization.
  12606. @param initAppContext context for the application's initialization]]>
  12607. </doc>
  12608. </method>
  12609. <method name="stopApplication"
  12610. abstract="true" native="false" synchronized="false"
  12611. static="false" final="false" visibility="public"
  12612. deprecated="not deprecated">
  12613. <param name="stopAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationTerminationContext"/>
  12614. <doc>
  12615. <![CDATA[An application is finishing on this NodeManager. This is a signal to this
  12616. {@link AuxiliaryService} about the same.
  12617. @param stopAppContext context for the application termination]]>
  12618. </doc>
  12619. </method>
  12620. <method name="getMetaData" return="java.nio.ByteBuffer"
  12621. abstract="true" native="false" synchronized="false"
  12622. static="false" final="false" visibility="public"
  12623. deprecated="not deprecated">
  12624. <doc>
  12625. <![CDATA[Retrieve meta-data for this {@link AuxiliaryService}. Applications using
  12626. this {@link AuxiliaryService} SHOULD know the format of the meta-data -
  12627. ideally each service should provide a method to parse out the information
  12628. to the applications. One example of meta-data is contact information so
  12629. that applications can access the service remotely. This will only be called
  12630. after the service's {@link #start()} method has finished. the result may be
  12631. cached.
  12632. <p>
  12633. The information is passed along to applications via
  12634. {@link StartContainersResponse#getAllServicesMetaData()} that is returned by
  12635. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  12636. </p>
  12637. @return meta-data for this service that should be made available to
  12638. applications.]]>
  12639. </doc>
  12640. </method>
  12641. <method name="initializeContainer"
  12642. abstract="false" native="false" synchronized="false"
  12643. static="false" final="false" visibility="public"
  12644. deprecated="not deprecated">
  12645. <param name="initContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerInitializationContext"/>
  12646. <doc>
  12647. <![CDATA[A new container is started on this NodeManager. This is a signal to
  12648. this {@link AuxiliaryService} about the container initialization.
  12649. This method is called when the NodeManager receives the container launch
  12650. command from the ApplicationMaster and before the container process is
  12651. launched.
  12652. @param initContainerContext context for the container's initialization]]>
  12653. </doc>
  12654. </method>
  12655. <method name="stopContainer"
  12656. abstract="false" native="false" synchronized="false"
  12657. static="false" final="false" visibility="public"
  12658. deprecated="not deprecated">
  12659. <param name="stopContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerTerminationContext"/>
  12660. <doc>
  12661. <![CDATA[A container is finishing on this NodeManager. This is a signal to this
  12662. {@link AuxiliaryService} about the same.
  12663. @param stopContainerContext context for the container termination]]>
  12664. </doc>
  12665. </method>
  12666. <method name="setRecoveryPath"
  12667. abstract="false" native="false" synchronized="false"
  12668. static="false" final="false" visibility="public"
  12669. deprecated="not deprecated">
  12670. <param name="recoveryPath" type="org.apache.hadoop.fs.Path"/>
  12671. <doc>
  12672. <![CDATA[Set the path for this auxiliary service to use for storing state
  12673. that will be used during recovery.
  12674. @param recoveryPath where recoverable state should be stored]]>
  12675. </doc>
  12676. </method>
  12677. <doc>
  12678. <![CDATA[A generic service that will be started by the NodeManager. This is a service
  12679. that administrators have to configure on each node by setting
  12680. {@link YarnConfiguration#NM_AUX_SERVICES}.]]>
  12681. </doc>
  12682. </class>
  12683. <!-- end class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
  12684. <!-- start class org.apache.hadoop.yarn.server.api.ContainerContext -->
  12685. <class name="ContainerContext" extends="java.lang.Object"
  12686. abstract="false"
  12687. static="false" final="false" visibility="public"
  12688. deprecated="not deprecated">
  12689. <constructor name="ContainerContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  12690. static="false" final="false" visibility="public"
  12691. deprecated="not deprecated">
  12692. </constructor>
  12693. <method name="getUser" return="java.lang.String"
  12694. abstract="false" native="false" synchronized="false"
  12695. static="false" final="false" visibility="public"
  12696. deprecated="not deprecated">
  12697. <doc>
  12698. <![CDATA[Get user of the container being initialized or stopped.
  12699. @return the user]]>
  12700. </doc>
  12701. </method>
  12702. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  12703. abstract="false" native="false" synchronized="false"
  12704. static="false" final="false" visibility="public"
  12705. deprecated="not deprecated">
  12706. <doc>
  12707. <![CDATA[Get {@link ContainerId} of the container being initialized or stopped.
  12708. @return the container ID]]>
  12709. </doc>
  12710. </method>
  12711. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  12712. abstract="false" native="false" synchronized="false"
  12713. static="false" final="false" visibility="public"
  12714. deprecated="not deprecated">
  12715. <doc>
  12716. <![CDATA[Get {@link Resource} the resource capability allocated to the container
  12717. being initialized or stopped.
  12718. @return the resource capability.]]>
  12719. </doc>
  12720. </method>
  12721. <doc>
  12722. <![CDATA[Base context class for {@link AuxiliaryService} initializing and stopping a
  12723. container.]]>
  12724. </doc>
  12725. </class>
  12726. <!-- end class org.apache.hadoop.yarn.server.api.ContainerContext -->
  12727. <!-- start class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
  12728. <class name="ContainerInitializationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
  12729. abstract="false"
  12730. static="false" final="false" visibility="public"
  12731. deprecated="not deprecated">
  12732. <constructor name="ContainerInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  12733. static="false" final="false" visibility="public"
  12734. deprecated="not deprecated">
  12735. </constructor>
  12736. <doc>
  12737. <![CDATA[Initialization context for {@link AuxiliaryService} when starting a
  12738. container.]]>
  12739. </doc>
  12740. </class>
  12741. <!-- end class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
  12742. <!-- start class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
  12743. <class name="ContainerTerminationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
  12744. abstract="false"
  12745. static="false" final="false" visibility="public"
  12746. deprecated="not deprecated">
  12747. <constructor name="ContainerTerminationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  12748. static="false" final="false" visibility="public"
  12749. deprecated="not deprecated">
  12750. </constructor>
  12751. <doc>
  12752. <![CDATA[Termination context for {@link AuxiliaryService} when stopping a
  12753. container.]]>
  12754. </doc>
  12755. </class>
  12756. <!-- end class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
  12757. <!-- start interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
  12758. <interface name="SCMAdminProtocol" abstract="true"
  12759. static="false" final="false" visibility="public"
  12760. deprecated="not deprecated">
  12761. <method name="runCleanerTask" return="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskResponse"
  12762. abstract="true" native="false" synchronized="false"
  12763. static="false" final="false" visibility="public"
  12764. deprecated="not deprecated">
  12765. <param name="request" type="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskRequest"/>
  12766. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  12767. <exception name="IOException" type="java.io.IOException"/>
  12768. <doc>
  12769. <![CDATA[<p>
  12770. The method used by administrators to ask SCM to run cleaner task right away
  12771. </p>
  12772. @param request request <code>SharedCacheManager</code> to run a cleaner task
  12773. @return <code>SharedCacheManager</code> returns an empty response
  12774. on success and throws an exception on rejecting the request
  12775. @throws YarnException
  12776. @throws IOException]]>
  12777. </doc>
  12778. </method>
  12779. <doc>
  12780. <![CDATA[<p>
  12781. The protocol between administrators and the <code>SharedCacheManager</code>
  12782. </p>]]>
  12783. </doc>
  12784. </interface>
  12785. <!-- end interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
  12786. </package>
  12787. <package name="org.apache.hadoop.yarn.util">
  12788. </package>
  12789. </api>