Apache_Hadoop_YARN_API_2.6.0.xml 543 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076
  1. <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
  2. <!--
  3. Licensed to the Apache Software Foundation (ASF) under one or more
  4. contributor license agreements. See the NOTICE file distributed with
  5. this work for additional information regarding copyright ownership.
  6. The ASF licenses this file to You under the Apache License, Version 2.0
  7. (the "License"); you may not use this file except in compliance with
  8. the License. You may obtain a copy of the License at
  9. http://www.apache.org/licenses/LICENSE-2.0
  10. Unless required by applicable law or agreed to in writing, software
  11. distributed under the License is distributed on an "AS IS" BASIS,
  12. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. See the License for the specific language governing permissions and
  14. limitations under the License.
  15. -->
  16. <!-- Generated by the JDiff Javadoc doclet -->
  17. <!-- (http://www.jdiff.org) -->
  18. <!-- on Wed Apr 08 11:29:43 PDT 2015 -->
  19. <api
  20. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  21. xsi:noNamespaceSchemaLocation='api.xsd'
  22. name="hadoop-yarn-api 2.6.0"
  23. jdversion="1.0.9">
  24. <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet -docletpath /Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-annotations.jar:/Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/jdiff.jar -verbose -classpath /Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/classes:/Users/llu/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/Users/llu/.m2/repository/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/Users/llu/.m2/repository/com/google/code/findbugs/jsr305/1.3.9/jsr305-1.3.9.jar:/Users/llu/.m2/repository/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/Users/llu/.m2/repository/org/apache/hadoop/hadoop-common/2.6.0/hadoop-common-2.6.0.jar:/Users/llu/.m2/repository/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/Users/llu/.m2/repository/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/Users/llu/.m2/repository/xmlenc/xmlenc/0.52/xmlenc-0.52.jar:/Users/llu/.m2/repository/commons-httpclient/commons-httpclient/3.1/commons-httpclient-3.1.jar:/Users/llu/.m2/repository/commons-codec/commons-codec/1.4/commons-codec-1.4.jar:/Users/llu/.m2/repository/commons-io/commons-io/2.4/commons-io-2.4.jar:/Users/llu/.m2/repository/commons-net/commons-net/3.1/commons-net-3.1.jar:/Users/llu/.m2/repository/commons-collections/commons-collections/3.2.1/commons-collections-3.2.1.jar:/Users/llu/.m2/repository/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar:/Users/llu/.m2/repository/org/mortbay/jetty/jetty/6.1.26/jetty-6.1.26.jar:/Users/llu/.m2/repository/org/mortbay/jetty/jetty-util/6.1.26/jetty-util-6.1.26.jar:/Users/llu/.m2/repository/com/sun/jersey/jersey-core/1.9/jersey-core-1.9.jar:/Users/llu/.m2/repository/com/sun/jersey/jersey-json/1.9/jersey-json-1.9.jar:/Users/llu/.m2/repository/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/Users/llu/.m2/repository/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/Users/llu/.m2/repository/javax/xml/bind/jaxb-api/2.2.2/jaxb-api-2.2.2.jar:/Users/llu/.m2/repository/javax/xml/stream/stax-api/1.0-2/stax-api-1.0-2.jar:/Users/llu/.m2/repository/javax/activation/activation/1.1/activation-1.1.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/Users/llu/.m2/repository/com/sun/jersey/jersey-server/1.9/jersey-server-1.9.jar:/Users/llu/.m2/repository/asm/asm/3.2/asm-3.2.jar:/Users/llu/.m2/repository/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/Users/llu/.m2/repository/log4j/log4j/1.2.17/log4j-1.2.17.jar:/Users/llu/.m2/repository/net/java/dev/jets3t/jets3t/0.9.0/jets3t-0.9.0.jar:/Users/llu/.m2/repository/org/apache/httpcomponents/httpclient/4.2.5/httpclient-4.2.5.jar:/Users/llu/.m2/repository/org/apache/httpcomponents/httpcore/4.2.5/httpcore-4.2.5.jar:/Users/llu/.m2/repository/com/jamesmurty/utils/java-xmlbuilder/0.4/java-xmlbuilder-0.4.jar:/Users/llu/.m2/repository/commons-configuration/commons-configuration/1.6/commons-configuration-1.6.jar:/Users/llu/.m2/repository/commons-digester/commons-digester/1.8/commons-digester-1.8.jar:/Users/llu/.m2/repository/commons-beanutils/commons-beanutils/1.7.0/commons-beanutils-1.7.0.jar:/Users/llu/.m2/repository/commons-beanutils/commons-beanutils-core/1.8.0/commons-beanutils-core-1.8.0.jar:/Users/llu/.m2/repository/org/slf4j/slf4j-api/1.7.5/slf4j-api-1.7.5.jar:/Users/llu/.m2/repository/org/slf4j/slf4j-log4j12/1.7.5/slf4j-log4j12-1.7.5.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/Users/llu/.m2/repository/org/apache/avro/avro/1.7.4/avro-1.7.4.jar:/Users/llu/.m2/repository/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/Users/llu/.m2/repository/org/xerial/snappy/snappy-java/1.0.4.1/snappy-java-1.0.4.1.jar:/Users/llu/.m2/repository/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/Users/llu/.m2/repository/org/apache/hadoop/hadoop-auth/2.6.0/hadoop-auth-2.6.0.jar:/Users/llu/.m2/repository/org/apache/directory/server/apacheds-kerberos-codec/2.0.0-M15/apacheds-kerberos-codec-2.0.0-M15.jar:/Users/llu/.m2/repository/org/apache/directory/server/apacheds-i18n/2.0.0-M15/apacheds-i18n-2.0.0-M15.jar:/Users/llu/.m2/repository/org/apache/directory/api/api-asn1-api/1.0.0-M20/api-asn1-api-1.0.0-M20.jar:/Users/llu/.m2/repository/org/apache/directory/api/api-util/1.0.0-M20/api-util-1.0.0-M20.jar:/Users/llu/.m2/repository/org/apache/curator/curator-framework/2.6.0/curator-framework-2.6.0.jar:/Users/llu/.m2/repository/com/jcraft/jsch/0.1.42/jsch-0.1.42.jar:/Users/llu/.m2/repository/org/apache/curator/curator-client/2.6.0/curator-client-2.6.0.jar:/Users/llu/.m2/repository/org/apache/curator/curator-recipes/2.6.0/curator-recipes-2.6.0.jar:/Users/llu/.m2/repository/org/htrace/htrace-core/3.0.4/htrace-core-3.0.4.jar:/Users/llu/.m2/repository/org/apache/zookeeper/zookeeper/3.4.6/zookeeper-3.4.6.jar:/Users/llu/.m2/repository/io/netty/netty/3.6.2.Final/netty-3.6.2.Final.jar:/Users/llu/.m2/repository/org/apache/commons/commons-compress/1.4.1/commons-compress-1.4.1.jar:/Users/llu/.m2/repository/org/tukaani/xz/1.0/xz-1.0.jar:/Users/llu/.m2/repository/org/apache/hadoop/hadoop-annotations/2.6.0/hadoop-annotations-2.6.0.jar:/Library/Java/JavaVirtualMachines/jdk1.7.0_67.jdk/Contents/Home/lib/tools.jar:/Users/llu/.m2/repository/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar -sourcepath /Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java -apidir /Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/jdiff/xml -apiname hadoop-yarn-api 2.6.0 -->
  25. <package name="org.apache.hadoop.yarn.api">
  26. <!-- start interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
  27. <interface name="ApplicationClientProtocol" abstract="true"
  28. static="false" final="false" visibility="public"
  29. deprecated="not deprecated">
  30. <method name="getNewApplication" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse"
  31. abstract="false" native="false" synchronized="false"
  32. static="false" final="false" visibility="public"
  33. deprecated="not deprecated">
  34. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"/>
  35. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  36. <exception name="IOException" type="java.io.IOException"/>
  37. <doc>
  38. <![CDATA[<p>The interface used by clients to obtain a new {@link ApplicationId} for
  39. submitting new applications.</p>
  40. <p>The <code>ResourceManager</code> responds with a new, monotonically
  41. increasing, {@link ApplicationId} which is used by the client to submit
  42. a new application.</p>
  43. <p>The <code>ResourceManager</code> also responds with details such
  44. as maximum resource capabilities in the cluster as specified in
  45. {@link GetNewApplicationResponse}.</p>
  46. @param request request to get a new <code>ApplicationId</code>
  47. @return response containing the new <code>ApplicationId</code> to be used
  48. to submit an application
  49. @throws YarnException
  50. @throws IOException
  51. @see #submitApplication(SubmitApplicationRequest)]]>
  52. </doc>
  53. </method>
  54. <method name="submitApplication" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse"
  55. abstract="false" native="false" synchronized="false"
  56. static="false" final="false" visibility="public"
  57. deprecated="not deprecated">
  58. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"/>
  59. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  60. <exception name="IOException" type="java.io.IOException"/>
  61. <doc>
  62. <![CDATA[<p>The interface used by clients to submit a new application to the
  63. <code>ResourceManager.</code></p>
  64. <p>The client is required to provide details such as queue,
  65. {@link Resource} required to run the <code>ApplicationMaster</code>,
  66. the equivalent of {@link ContainerLaunchContext} for launching
  67. the <code>ApplicationMaster</code> etc. via the
  68. {@link SubmitApplicationRequest}.</p>
  69. <p>Currently the <code>ResourceManager</code> sends an immediate (empty)
  70. {@link SubmitApplicationResponse} on accepting the submission and throws
  71. an exception if it rejects the submission. However, this call needs to be
  72. followed by {@link #getApplicationReport(GetApplicationReportRequest)}
  73. to make sure that the application gets properly submitted - obtaining a
  74. {@link SubmitApplicationResponse} from ResourceManager doesn't guarantee
  75. that RM 'remembers' this application beyond failover or restart. If RM
  76. failover or RM restart happens before ResourceManager saves the
  77. application's state successfully, the subsequent
  78. {@link #getApplicationReport(GetApplicationReportRequest)} will throw
  79. a {@link ApplicationNotFoundException}. The Clients need to re-submit
  80. the application with the same {@link ApplicationSubmissionContext} when
  81. it encounters the {@link ApplicationNotFoundException} on the
  82. {@link #getApplicationReport(GetApplicationReportRequest)} call.</p>
  83. <p>During the submission process, it checks whether the application
  84. already exists. If the application exists, it will simply return
  85. SubmitApplicationResponse</p>
  86. <p> In secure mode,the <code>ResourceManager</code> verifies access to
  87. queues etc. before accepting the application submission.</p>
  88. @param request request to submit a new application
  89. @return (empty) response on accepting the submission
  90. @throws YarnException
  91. @throws IOException
  92. @throws InvalidResourceRequestException
  93. The exception is thrown when a {@link ResourceRequest} is out of
  94. the range of the configured lower and upper resource boundaries.
  95. @see #getNewApplication(GetNewApplicationRequest)]]>
  96. </doc>
  97. </method>
  98. <method name="forceKillApplication" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse"
  99. abstract="false" native="false" synchronized="false"
  100. static="false" final="false" visibility="public"
  101. deprecated="not deprecated">
  102. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"/>
  103. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  104. <exception name="IOException" type="java.io.IOException"/>
  105. <doc>
  106. <![CDATA[<p>The interface used by clients to request the
  107. <code>ResourceManager</code> to abort submitted application.</p>
  108. <p>The client, via {@link KillApplicationRequest} provides the
  109. {@link ApplicationId} of the application to be aborted.</p>
  110. <p> In secure mode,the <code>ResourceManager</code> verifies access to the
  111. application, queue etc. before terminating the application.</p>
  112. <p>Currently, the <code>ResourceManager</code> returns an empty response
  113. on success and throws an exception on rejecting the request.</p>
  114. @param request request to abort a submitted application
  115. @return <code>ResourceManager</code> returns an empty response
  116. on success and throws an exception on rejecting the request
  117. @throws YarnException
  118. @throws IOException
  119. @see #getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  120. </doc>
  121. </method>
  122. <method name="getApplicationReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse"
  123. abstract="false" native="false" synchronized="false"
  124. static="false" final="false" visibility="public"
  125. deprecated="not deprecated">
  126. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"/>
  127. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  128. <exception name="IOException" type="java.io.IOException"/>
  129. <doc>
  130. <![CDATA[<p>The interface used by clients to get a report of an Application from
  131. the <code>ResourceManager</code>.</p>
  132. <p>The client, via {@link GetApplicationReportRequest} provides the
  133. {@link ApplicationId} of the application.</p>
  134. <p> In secure mode,the <code>ResourceManager</code> verifies access to the
  135. application, queue etc. before accepting the request.</p>
  136. <p>The <code>ResourceManager</code> responds with a
  137. {@link GetApplicationReportResponse} which includes the
  138. {@link ApplicationReport} for the application.</p>
  139. <p>If the user does not have <code>VIEW_APP</code> access then the
  140. following fields in the report will be set to stubbed values:
  141. <ul>
  142. <li>host - set to "N/A"</li>
  143. <li>RPC port - set to -1</li>
  144. <li>client token - set to "N/A"</li>
  145. <li>diagnostics - set to "N/A"</li>
  146. <li>tracking URL - set to "N/A"</li>
  147. <li>original tracking URL - set to "N/A"</li>
  148. <li>resource usage report - all values are -1</li>
  149. </ul></p>
  150. @param request request for an application report
  151. @return application report
  152. @throws YarnException
  153. @throws IOException]]>
  154. </doc>
  155. </method>
  156. <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse"
  157. abstract="false" native="false" synchronized="false"
  158. static="false" final="false" visibility="public"
  159. deprecated="not deprecated">
  160. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"/>
  161. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  162. <exception name="IOException" type="java.io.IOException"/>
  163. <doc>
  164. <![CDATA[<p>The interface used by clients to get metrics about the cluster from
  165. the <code>ResourceManager</code>.</p>
  166. <p>The <code>ResourceManager</code> responds with a
  167. {@link GetClusterMetricsResponse} which includes the
  168. {@link YarnClusterMetrics} with details such as number of current
  169. nodes in the cluster.</p>
  170. @param request request for cluster metrics
  171. @return cluster metrics
  172. @throws YarnException
  173. @throws IOException]]>
  174. </doc>
  175. </method>
  176. <method name="getApplications" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse"
  177. abstract="false" native="false" synchronized="false"
  178. static="false" final="false" visibility="public"
  179. deprecated="not deprecated">
  180. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"/>
  181. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  182. <exception name="IOException" type="java.io.IOException"/>
  183. <doc>
  184. <![CDATA[<p>The interface used by clients to get a report of Applications
  185. matching the filters defined by {@link GetApplicationsRequest}
  186. in the cluster from the <code>ResourceManager</code>.</p>
  187. <p>The <code>ResourceManager</code> responds with a
  188. {@link GetApplicationsResponse} which includes the
  189. {@link ApplicationReport} for the applications.</p>
  190. <p>If the user does not have <code>VIEW_APP</code> access for an
  191. application then the corresponding report will be filtered as
  192. described in {@link #getApplicationReport(GetApplicationReportRequest)}.
  193. </p>
  194. @param request request for report on applications
  195. @return report on applications matching the given application types
  196. defined in the request
  197. @throws YarnException
  198. @throws IOException
  199. @see GetApplicationsRequest]]>
  200. </doc>
  201. </method>
  202. <method name="getClusterNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse"
  203. abstract="false" native="false" synchronized="false"
  204. static="false" final="false" visibility="public"
  205. deprecated="not deprecated">
  206. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"/>
  207. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  208. <exception name="IOException" type="java.io.IOException"/>
  209. <doc>
  210. <![CDATA[<p>The interface used by clients to get a report of all nodes
  211. in the cluster from the <code>ResourceManager</code>.</p>
  212. <p>The <code>ResourceManager</code> responds with a
  213. {@link GetClusterNodesResponse} which includes the
  214. {@link NodeReport} for all the nodes in the cluster.</p>
  215. @param request request for report on all nodes
  216. @return report on all nodes
  217. @throws YarnException
  218. @throws IOException]]>
  219. </doc>
  220. </method>
  221. <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse"
  222. abstract="false" native="false" synchronized="false"
  223. static="false" final="false" visibility="public"
  224. deprecated="not deprecated">
  225. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"/>
  226. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  227. <exception name="IOException" type="java.io.IOException"/>
  228. <doc>
  229. <![CDATA[<p>The interface used by clients to get information about <em>queues</em>
  230. from the <code>ResourceManager</code>.</p>
  231. <p>The client, via {@link GetQueueInfoRequest}, can ask for details such
  232. as used/total resources, child queues, running applications etc.</p>
  233. <p> In secure mode,the <code>ResourceManager</code> verifies access before
  234. providing the information.</p>
  235. @param request request to get queue information
  236. @return queue information
  237. @throws YarnException
  238. @throws IOException]]>
  239. </doc>
  240. </method>
  241. <method name="getQueueUserAcls" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse"
  242. abstract="false" native="false" synchronized="false"
  243. static="false" final="false" visibility="public"
  244. deprecated="not deprecated">
  245. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"/>
  246. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  247. <exception name="IOException" type="java.io.IOException"/>
  248. <doc>
  249. <![CDATA[<p>The interface used by clients to get information about <em>queue
  250. acls</em> for <em>current user</em> from the <code>ResourceManager</code>.
  251. </p>
  252. <p>The <code>ResourceManager</code> responds with queue acls for all
  253. existing queues.</p>
  254. @param request request to get queue acls for <em>current user</em>
  255. @return queue acls for <em>current user</em>
  256. @throws YarnException
  257. @throws IOException]]>
  258. </doc>
  259. </method>
  260. <method name="getDelegationToken" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse"
  261. abstract="false" native="false" synchronized="false"
  262. static="false" final="false" visibility="public"
  263. deprecated="not deprecated">
  264. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"/>
  265. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  266. <exception name="IOException" type="java.io.IOException"/>
  267. <doc>
  268. <![CDATA[<p>The interface used by clients to get delegation token, enabling the
  269. containers to be able to talk to the service using those tokens.
  270. <p> The <code>ResourceManager</code> responds with the delegation
  271. {@link Token} that can be used by the client to speak to this
  272. service.
  273. @param request request to get a delegation token for the client.
  274. @return delegation token that can be used to talk to this service
  275. @throws YarnException
  276. @throws IOException]]>
  277. </doc>
  278. </method>
  279. <method name="moveApplicationAcrossQueues" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse"
  280. abstract="false" 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.MoveApplicationAcrossQueuesRequest"/>
  284. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  285. <exception name="IOException" type="java.io.IOException"/>
  286. <doc>
  287. <![CDATA[Move an application to a new queue.
  288. @param request the application ID and the target queue
  289. @return an empty response
  290. @throws YarnException
  291. @throws IOException]]>
  292. </doc>
  293. </method>
  294. <method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
  295. abstract="false" native="false" synchronized="false"
  296. static="false" final="false" visibility="public"
  297. deprecated="not deprecated">
  298. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"/>
  299. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  300. <exception name="IOException" type="java.io.IOException"/>
  301. <doc>
  302. <![CDATA[<p>
  303. The interface used by clients to get a report of an Application Attempt
  304. from the <code>ResourceManager</code>
  305. </p>
  306. <p>
  307. The client, via {@link GetApplicationAttemptReportRequest} provides the
  308. {@link ApplicationAttemptId} of the application attempt.
  309. </p>
  310. <p>
  311. In secure mode,the <code>ResourceManager</code> verifies access to
  312. the method before accepting the request.
  313. </p>
  314. <p>
  315. The <code>ResourceManager</code> responds with a
  316. {@link GetApplicationAttemptReportResponse} which includes the
  317. {@link ApplicationAttemptReport} for the application attempt.
  318. </p>
  319. <p>
  320. If the user does not have <code>VIEW_APP</code> access then the following
  321. fields in the report will be set to stubbed values:
  322. <ul>
  323. <li>host</li>
  324. <li>RPC port</li>
  325. <li>client token</li>
  326. <li>diagnostics - set to "N/A"</li>
  327. <li>tracking URL</li>
  328. </ul>
  329. </p>
  330. @param request
  331. request for an application attempt report
  332. @return application attempt report
  333. @throws YarnException
  334. @throws IOException]]>
  335. </doc>
  336. </method>
  337. <method name="getApplicationAttempts" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
  338. abstract="false" native="false" synchronized="false"
  339. static="false" final="false" visibility="public"
  340. deprecated="not deprecated">
  341. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"/>
  342. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  343. <exception name="IOException" type="java.io.IOException"/>
  344. <doc>
  345. <![CDATA[<p>
  346. The interface used by clients to get a report of all Application attempts
  347. in the cluster from the <code>ResourceManager</code>
  348. </p>
  349. <p>
  350. The <code>ResourceManager</code> responds with a
  351. {@link GetApplicationAttemptsRequest} which includes the
  352. {@link ApplicationAttemptReport} for all the applications attempts of a
  353. specified application attempt.
  354. </p>
  355. <p>
  356. If the user does not have <code>VIEW_APP</code> access for an application
  357. then the corresponding report will be filtered as described in
  358. {@link #getApplicationAttemptReport(GetApplicationAttemptReportRequest)}.
  359. </p>
  360. @param request
  361. request for reports on all application attempts of an application
  362. @return reports on all application attempts of an application
  363. @throws YarnException
  364. @throws IOException]]>
  365. </doc>
  366. </method>
  367. <method name="getContainerReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
  368. abstract="false" native="false" synchronized="false"
  369. static="false" final="false" visibility="public"
  370. deprecated="not deprecated">
  371. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"/>
  372. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  373. <exception name="IOException" type="java.io.IOException"/>
  374. <doc>
  375. <![CDATA[<p>
  376. The interface used by clients to get a report of an Container from the
  377. <code>ResourceManager</code>
  378. </p>
  379. <p>
  380. The client, via {@link GetContainerReportRequest} provides the
  381. {@link ContainerId} of the container.
  382. </p>
  383. <p>
  384. In secure mode,the <code>ResourceManager</code> verifies access to the
  385. method before accepting the request.
  386. </p>
  387. <p>
  388. The <code>ResourceManager</code> responds with a
  389. {@link GetContainerReportResponse} which includes the
  390. {@link ContainerReport} for the container.
  391. </p>
  392. @param request
  393. request for a container report
  394. @return container report
  395. @throws YarnException
  396. @throws IOException]]>
  397. </doc>
  398. </method>
  399. <method name="getContainers" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
  400. abstract="false" native="false" synchronized="false"
  401. static="false" final="false" visibility="public"
  402. deprecated="not deprecated">
  403. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"/>
  404. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  405. <exception name="IOException" type="java.io.IOException"/>
  406. <doc>
  407. <![CDATA[<p>
  408. The interface used by clients to get a report of Containers for an
  409. application attempt from the <code>ResourceManager</code>
  410. </p>
  411. <p>
  412. The client, via {@link GetContainersRequest} provides the
  413. {@link ApplicationAttemptId} of the application attempt.
  414. </p>
  415. <p>
  416. In secure mode,the <code>ResourceManager</code> verifies access to the
  417. method before accepting the request.
  418. </p>
  419. <p>
  420. The <code>ResourceManager</code> responds with a
  421. {@link GetContainersResponse} which includes a list of
  422. {@link ContainerReport} for all the containers of a specific application
  423. attempt.
  424. </p>
  425. @param request
  426. request for a list of container reports of an application attempt.
  427. @return reports on all containers of an application attempt
  428. @throws YarnException
  429. @throws IOException]]>
  430. </doc>
  431. </method>
  432. <method name="submitReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse"
  433. abstract="false" native="false" synchronized="false"
  434. static="false" final="false" visibility="public"
  435. deprecated="not deprecated">
  436. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"/>
  437. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  438. <exception name="IOException" type="java.io.IOException"/>
  439. <doc>
  440. <![CDATA[<p>
  441. The interface used by clients to submit a new reservation to the
  442. {@code ResourceManager}.
  443. </p>
  444. <p>
  445. The client packages all details of its request in a
  446. {@link ReservationSubmissionRequest} object. This contains information
  447. about the amount of capacity, temporal constraints, and concurrency needs.
  448. Furthermore, the reservation might be composed of multiple stages, with
  449. ordering dependencies among them.
  450. </p>
  451. <p>
  452. In order to respond, a new admission control component in the
  453. {@code ResourceManager} performs an analysis of the resources that have
  454. been committed over the period of time the user is requesting, verify that
  455. the user requests can be fulfilled, and that it respect a sharing policy
  456. (e.g., {@code CapacityOverTimePolicy}). Once it has positively determined
  457. that the ReservationSubmissionRequest is satisfiable the
  458. {@code ResourceManager} answers with a
  459. {@link ReservationSubmissionResponse} that include a non-null
  460. {@link ReservationId}. Upon failure to find a valid allocation the response
  461. is an exception with the reason.
  462. On application submission the client can use this {@link ReservationId} to
  463. obtain access to the reserved resources.
  464. </p>
  465. <p>
  466. The system guarantees that during the time-range specified by the user, the
  467. reservationID will be corresponding to a valid reservation. The amount of
  468. capacity dedicated to such queue can vary overtime, depending of the
  469. allocation that has been determined. But it is guaranteed to satisfy all
  470. the constraint expressed by the user in the
  471. {@link ReservationSubmissionRequest}.
  472. </p>
  473. @param request the request to submit a new Reservation
  474. @return response the {@link ReservationId} on accepting the submission
  475. @throws YarnException if the request is invalid or reservation cannot be
  476. created successfully
  477. @throws IOException]]>
  478. </doc>
  479. </method>
  480. <method name="updateReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse"
  481. abstract="false" native="false" synchronized="false"
  482. static="false" final="false" visibility="public"
  483. deprecated="not deprecated">
  484. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"/>
  485. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  486. <exception name="IOException" type="java.io.IOException"/>
  487. <doc>
  488. <![CDATA[<p>
  489. The interface used by clients to update an existing Reservation. This is
  490. referred to as a re-negotiation process, in which a user that has
  491. previously submitted a Reservation.
  492. </p>
  493. <p>
  494. The allocation is attempted by virtually substituting all previous
  495. allocations related to this Reservation with new ones, that satisfy the new
  496. {@link ReservationUpdateRequest}. Upon success the previous allocation is
  497. substituted by the new one, and on failure (i.e., if the system cannot find
  498. a valid allocation for the updated request), the previous allocation
  499. remains valid.
  500. The {@link ReservationId} is not changed, and applications currently
  501. running within this reservation will automatically receive the resources
  502. based on the new allocation.
  503. </p>
  504. @param request to update an existing Reservation (the ReservationRequest
  505. should refer to an existing valid {@link ReservationId})
  506. @return response empty on successfully updating the existing reservation
  507. @throws YarnException if the request is invalid or reservation cannot be
  508. updated successfully
  509. @throws IOException]]>
  510. </doc>
  511. </method>
  512. <method name="deleteReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse"
  513. abstract="false" native="false" synchronized="false"
  514. static="false" final="false" visibility="public"
  515. deprecated="not deprecated">
  516. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"/>
  517. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  518. <exception name="IOException" type="java.io.IOException"/>
  519. <doc>
  520. <![CDATA[<p>
  521. The interface used by clients to remove an existing Reservation.
  522. Upon deletion of a reservation applications running with this reservation,
  523. are automatically downgraded to normal jobs running without any dedicated
  524. reservation.
  525. </p>
  526. @param request to remove an existing Reservation (the ReservationRequest
  527. should refer to an existing valid {@link ReservationId})
  528. @return response empty on successfully deleting the existing reservation
  529. @throws YarnException if the request is invalid or reservation cannot be
  530. deleted successfully
  531. @throws IOException]]>
  532. </doc>
  533. </method>
  534. <method name="getNodeToLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse"
  535. abstract="false" native="false" synchronized="false"
  536. static="false" final="false" visibility="public"
  537. deprecated="not deprecated">
  538. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest"/>
  539. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  540. <exception name="IOException" type="java.io.IOException"/>
  541. <doc>
  542. <![CDATA[<p>
  543. The interface used by client to get node to labels mappings in existing cluster
  544. </p>
  545. @param request
  546. @return node to labels mappings
  547. @throws YarnException
  548. @throws IOException]]>
  549. </doc>
  550. </method>
  551. <method name="getClusterNodeLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  552. abstract="false" native="false" synchronized="false"
  553. static="false" final="false" visibility="public"
  554. deprecated="not deprecated">
  555. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"/>
  556. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  557. <exception name="IOException" type="java.io.IOException"/>
  558. <doc>
  559. <![CDATA[<p>
  560. The interface used by client to get node labels in the cluster
  561. </p>
  562. @param request to get node labels collection of this cluster
  563. @return node labels collection of this cluster
  564. @throws YarnException
  565. @throws IOException]]>
  566. </doc>
  567. </method>
  568. <doc>
  569. <![CDATA[<p>The protocol between clients and the <code>ResourceManager</code>
  570. to submit/abort jobs and to get information on applications, cluster metrics,
  571. nodes, queues and ACLs.</p>]]>
  572. </doc>
  573. </interface>
  574. <!-- end interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
  575. <!-- start interface org.apache.hadoop.yarn.api.ApplicationConstants -->
  576. <interface name="ApplicationConstants" abstract="true"
  577. static="false" final="false" visibility="public"
  578. deprecated="not deprecated">
  579. <field name="APP_SUBMIT_TIME_ENV" type="java.lang.String"
  580. transient="false" volatile="false"
  581. static="true" final="true" visibility="public"
  582. deprecated="not deprecated">
  583. <doc>
  584. <![CDATA[The environment variable for APP_SUBMIT_TIME. Set in AppMaster environment
  585. only]]>
  586. </doc>
  587. </field>
  588. <field name="CONTAINER_TOKEN_FILE_ENV_NAME" type="java.lang.String"
  589. transient="false" volatile="false"
  590. static="true" final="true" visibility="public"
  591. deprecated="not deprecated">
  592. <doc>
  593. <![CDATA[The cache file into which container token is written]]>
  594. </doc>
  595. </field>
  596. <field name="APPLICATION_WEB_PROXY_BASE_ENV" type="java.lang.String"
  597. transient="false" volatile="false"
  598. static="true" final="true" visibility="public"
  599. deprecated="not deprecated">
  600. <doc>
  601. <![CDATA[The environmental variable for APPLICATION_WEB_PROXY_BASE. Set in
  602. ApplicationMaster's environment only. This states that for all non-relative
  603. web URLs in the app masters web UI what base should they have.]]>
  604. </doc>
  605. </field>
  606. <field name="LOG_DIR_EXPANSION_VAR" type="java.lang.String"
  607. transient="false" volatile="false"
  608. static="true" final="true" visibility="public"
  609. deprecated="not deprecated">
  610. <doc>
  611. <![CDATA[The temporary environmental variable for container log directory. This
  612. should be replaced by real container log directory on container launch.]]>
  613. </doc>
  614. </field>
  615. <field name="CLASS_PATH_SEPARATOR" type="java.lang.String"
  616. transient="false" volatile="false"
  617. static="true" final="true" visibility="public"
  618. deprecated="not deprecated">
  619. <doc>
  620. <![CDATA[This constant is used to construct class path and it will be replaced with
  621. real class path separator(':' for Linux and ';' for Windows) by
  622. NodeManager on container launch. User has to use this constant to construct
  623. class path if user wants cross-platform practice i.e. submit an application
  624. from a Windows client to a Linux/Unix server or vice versa.]]>
  625. </doc>
  626. </field>
  627. <field name="PARAMETER_EXPANSION_LEFT" type="java.lang.String"
  628. transient="false" volatile="false"
  629. static="true" final="true" visibility="public"
  630. deprecated="not deprecated">
  631. <doc>
  632. <![CDATA[The following two constants are used to expand parameter and it will be
  633. replaced with real parameter expansion marker ('%' for Windows and '$' for
  634. Linux) by NodeManager on container launch. For example: {{VAR}} will be
  635. replaced as $VAR on Linux, and %VAR% on Windows. User has to use this
  636. constant to construct class path if user wants cross-platform practice i.e.
  637. submit an application from a Windows client to a Linux/Unix server or vice
  638. versa.]]>
  639. </doc>
  640. </field>
  641. <field name="PARAMETER_EXPANSION_RIGHT" type="java.lang.String"
  642. transient="false" volatile="false"
  643. static="true" final="true" visibility="public"
  644. deprecated="not deprecated">
  645. <doc>
  646. <![CDATA[User has to use this constant to construct class path if user wants
  647. cross-platform practice i.e. submit an application from a Windows client to
  648. a Linux/Unix server or vice versa.]]>
  649. </doc>
  650. </field>
  651. <field name="STDERR" type="java.lang.String"
  652. transient="false" volatile="false"
  653. static="true" final="true" visibility="public"
  654. deprecated="not deprecated">
  655. </field>
  656. <field name="STDOUT" type="java.lang.String"
  657. transient="false" volatile="false"
  658. static="true" final="true" visibility="public"
  659. deprecated="not deprecated">
  660. </field>
  661. <field name="MAX_APP_ATTEMPTS_ENV" type="java.lang.String"
  662. transient="false" volatile="false"
  663. static="true" final="true" visibility="public"
  664. deprecated="not deprecated">
  665. <doc>
  666. <![CDATA[The environment variable for MAX_APP_ATTEMPTS. Set in AppMaster environment
  667. only]]>
  668. </doc>
  669. </field>
  670. <doc>
  671. <![CDATA[This is the API for the applications comprising of constants that YARN sets
  672. up for the applications and the containers.
  673. TODO: Investigate the semantics and security of each cross-boundary refs.]]>
  674. </doc>
  675. </interface>
  676. <!-- end interface org.apache.hadoop.yarn.api.ApplicationConstants -->
  677. <!-- start class org.apache.hadoop.yarn.api.ApplicationConstants.Environment -->
  678. <class name="ApplicationConstants.Environment" extends="java.lang.Enum"
  679. abstract="false"
  680. static="true" final="true" visibility="public"
  681. deprecated="not deprecated">
  682. <method name="values" return="org.apache.hadoop.yarn.api.ApplicationConstants.Environment[]"
  683. abstract="false" native="false" synchronized="false"
  684. static="true" final="false" visibility="public"
  685. deprecated="not deprecated">
  686. </method>
  687. <method name="valueOf" return="org.apache.hadoop.yarn.api.ApplicationConstants.Environment"
  688. abstract="false" native="false" synchronized="false"
  689. static="true" final="false" visibility="public"
  690. deprecated="not deprecated">
  691. <param name="name" type="java.lang.String"/>
  692. </method>
  693. <method name="key" return="java.lang.String"
  694. abstract="false" native="false" synchronized="false"
  695. static="false" final="false" visibility="public"
  696. deprecated="not deprecated">
  697. </method>
  698. <method name="toString" return="java.lang.String"
  699. abstract="false" native="false" synchronized="false"
  700. static="false" final="false" visibility="public"
  701. deprecated="not deprecated">
  702. </method>
  703. <method name="$" return="java.lang.String"
  704. abstract="false" native="false" synchronized="false"
  705. static="false" final="false" visibility="public"
  706. deprecated="not deprecated">
  707. <doc>
  708. <![CDATA[Expand the environment variable based on client OS environment variable
  709. expansion syntax (e.g. $VAR for Linux and %VAR% for Windows).
  710. <p>
  711. Note: Use $$() method for cross-platform practice i.e. submit an
  712. application from a Windows client to a Linux/Unix server or vice versa.
  713. </p>]]>
  714. </doc>
  715. </method>
  716. <method name="$$" return="java.lang.String"
  717. abstract="false" native="false" synchronized="false"
  718. static="false" final="false" visibility="public"
  719. deprecated="not deprecated">
  720. <doc>
  721. <![CDATA[Expand the environment variable in platform-agnostic syntax. The
  722. parameter expansion marker "{{VAR}}" will be replaced with real parameter
  723. expansion marker ('%' for Windows and '$' for Linux) by NodeManager on
  724. container launch. For example: {{VAR}} will be replaced as $VAR on Linux,
  725. and %VAR% on Windows.]]>
  726. </doc>
  727. </method>
  728. <doc>
  729. <![CDATA[Environment for Applications.
  730. Some of the environment variables for applications are <em>final</em>
  731. i.e. they cannot be modified by the applications.]]>
  732. </doc>
  733. </class>
  734. <!-- end class org.apache.hadoop.yarn.api.ApplicationConstants.Environment -->
  735. <!-- start interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
  736. <interface name="ApplicationHistoryProtocol" abstract="true"
  737. static="false" final="false" visibility="public"
  738. deprecated="not deprecated">
  739. <method name="getApplicationReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse"
  740. abstract="false" native="false" synchronized="false"
  741. static="false" final="false" visibility="public"
  742. deprecated="not deprecated">
  743. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"/>
  744. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  745. <exception name="IOException" type="java.io.IOException"/>
  746. <doc>
  747. <![CDATA[<p>
  748. The interface used by clients to get a report of an Application from the
  749. <code>ResourceManager</code>.
  750. </p>
  751. <p>
  752. The client, via {@link GetApplicationReportRequest} provides the
  753. {@link ApplicationId} of the application.
  754. </p>
  755. <p>
  756. In secure mode,the <code>ApplicationHistoryServer</code> verifies access to
  757. the application, queue etc. before accepting the request.
  758. </p>
  759. <p>
  760. The <code>ApplicationHistoryServer</code> responds with a
  761. {@link GetApplicationReportResponse} which includes the
  762. {@link ApplicationReport} for the application.
  763. </p>
  764. <p>
  765. If the user does not have <code>VIEW_APP</code> access then the following
  766. fields in the report will be set to stubbed values:
  767. <ul>
  768. <li>host - set to "N/A"</li>
  769. <li>RPC port - set to -1</li>
  770. <li>client token - set to "N/A"</li>
  771. <li>diagnostics - set to "N/A"</li>
  772. <li>tracking URL - set to "N/A"</li>
  773. <li>original tracking URL - set to "N/A"</li>
  774. <li>resource usage report - all values are -1</li>
  775. </ul>
  776. </p>
  777. @param request
  778. request for an application report
  779. @return application report
  780. @throws YarnException
  781. @throws IOException]]>
  782. </doc>
  783. </method>
  784. <method name="getApplications" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse"
  785. abstract="false" native="false" synchronized="false"
  786. static="false" final="false" visibility="public"
  787. deprecated="not deprecated">
  788. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"/>
  789. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  790. <exception name="IOException" type="java.io.IOException"/>
  791. <doc>
  792. <![CDATA[<p>
  793. The interface used by clients to get a report of all Applications in the
  794. cluster from the <code>ApplicationHistoryServer</code>.
  795. </p>
  796. <p>
  797. The <code>ApplicationHistoryServer</code> responds with a
  798. {@link GetApplicationsResponse} which includes a list of
  799. {@link ApplicationReport} for all the applications.
  800. </p>
  801. <p>
  802. If the user does not have <code>VIEW_APP</code> access for an application
  803. then the corresponding report will be filtered as described in
  804. {@link #getApplicationReport(GetApplicationReportRequest)}.
  805. </p>
  806. @param request
  807. request for reports on all the applications
  808. @return report on applications matching the given application types defined
  809. in the request
  810. @throws YarnException
  811. @throws IOException]]>
  812. </doc>
  813. </method>
  814. <method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
  815. abstract="false" native="false" synchronized="false"
  816. static="false" final="false" visibility="public"
  817. deprecated="not deprecated">
  818. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"/>
  819. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  820. <exception name="IOException" type="java.io.IOException"/>
  821. <doc>
  822. <![CDATA[<p>
  823. The interface used by clients to get a report of an Application Attempt
  824. from the <code>ApplicationHistoryServer</code>.
  825. </p>
  826. <p>
  827. The client, via {@link GetApplicationAttemptReportRequest} provides the
  828. {@link ApplicationAttemptId} of the application attempt.
  829. </p>
  830. <p>
  831. In secure mode,the <code>ApplicationHistoryServer</code> verifies access to
  832. the method before accepting the request.
  833. </p>
  834. <p>
  835. The <code>ApplicationHistoryServer</code> responds with a
  836. {@link GetApplicationAttemptReportResponse} which includes the
  837. {@link ApplicationAttemptReport} for the application attempt.
  838. </p>
  839. <p>
  840. If the user does not have <code>VIEW_APP</code> access then the following
  841. fields in the report will be set to stubbed values:
  842. <ul>
  843. <li>host</li>
  844. <li>RPC port</li>
  845. <li>client token</li>
  846. <li>diagnostics - set to "N/A"</li>
  847. <li>tracking URL</li>
  848. </ul>
  849. </p>
  850. @param request
  851. request for an application attempt report
  852. @return application attempt report
  853. @throws YarnException
  854. @throws IOException]]>
  855. </doc>
  856. </method>
  857. <method name="getApplicationAttempts" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
  858. abstract="false" native="false" synchronized="false"
  859. static="false" final="false" visibility="public"
  860. deprecated="not deprecated">
  861. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"/>
  862. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  863. <exception name="IOException" type="java.io.IOException"/>
  864. <doc>
  865. <![CDATA[<p>
  866. The interface used by clients to get a report of all Application attempts
  867. in the cluster from the <code>ApplicationHistoryServer</code>.
  868. </p>
  869. <p>
  870. The <code>ApplicationHistoryServer</code> responds with a
  871. {@link GetApplicationAttemptsRequest} which includes the
  872. {@link ApplicationAttemptReport} for all the applications attempts of a
  873. specified application attempt.
  874. </p>
  875. <p>
  876. If the user does not have <code>VIEW_APP</code> access for an application
  877. then the corresponding report will be filtered as described in
  878. {@link #getApplicationAttemptReport(GetApplicationAttemptReportRequest)}.
  879. </p>
  880. @param request
  881. request for reports on all application attempts of an application
  882. @return reports on all application attempts of an application
  883. @throws YarnException
  884. @throws IOException]]>
  885. </doc>
  886. </method>
  887. <method name="getContainerReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
  888. abstract="false" native="false" synchronized="false"
  889. static="false" final="false" visibility="public"
  890. deprecated="not deprecated">
  891. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"/>
  892. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  893. <exception name="IOException" type="java.io.IOException"/>
  894. <doc>
  895. <![CDATA[<p>
  896. The interface used by clients to get a report of an Container from the
  897. <code>ApplicationHistoryServer</code>.
  898. </p>
  899. <p>
  900. The client, via {@link GetContainerReportRequest} provides the
  901. {@link ContainerId} of the container.
  902. </p>
  903. <p>
  904. In secure mode,the <code>ApplicationHistoryServer</code> verifies access to
  905. the method before accepting the request.
  906. </p>
  907. <p>
  908. The <code>ApplicationHistoryServer</code> responds with a
  909. {@link GetContainerReportResponse} which includes the
  910. {@link ContainerReport} for the container.
  911. </p>
  912. @param request
  913. request for a container report
  914. @return container report
  915. @throws YarnException
  916. @throws IOException]]>
  917. </doc>
  918. </method>
  919. <method name="getContainers" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
  920. abstract="false" native="false" synchronized="false"
  921. static="false" final="false" visibility="public"
  922. deprecated="not deprecated">
  923. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"/>
  924. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  925. <exception name="IOException" type="java.io.IOException"/>
  926. <doc>
  927. <![CDATA[<p>
  928. The interface used by clients to get a report of Containers for an
  929. application attempt from the <code>ApplciationHistoryServer</code>.
  930. </p>
  931. <p>
  932. The client, via {@link GetContainersRequest} provides the
  933. {@link ApplicationAttemptId} of the application attempt.
  934. </p>
  935. <p>
  936. In secure mode,the <code>ApplicationHistoryServer</code> verifies access to
  937. the method before accepting the request.
  938. </p>
  939. <p>
  940. The <code>ApplicationHistoryServer</code> responds with a
  941. {@link GetContainersResponse} which includes a list of
  942. {@link ContainerReport} for all the containers of a specific application
  943. attempt.
  944. </p>
  945. @param request
  946. request for a list of container reports of an application attempt.
  947. @return reports on all containers of an application attempt
  948. @throws YarnException
  949. @throws IOException]]>
  950. </doc>
  951. </method>
  952. <method name="getDelegationToken" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse"
  953. abstract="false" native="false" synchronized="false"
  954. static="false" final="false" visibility="public"
  955. deprecated="not deprecated">
  956. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"/>
  957. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  958. <exception name="IOException" type="java.io.IOException"/>
  959. <doc>
  960. <![CDATA[<p>
  961. The interface used by clients to get delegation token, enabling the
  962. containers to be able to talk to the service using those tokens.
  963. </p>
  964. <p>
  965. The <code>ApplicationHistoryServer</code> responds with the delegation
  966. token {@link Token} that can be used by the client to speak to this
  967. service.
  968. </p>
  969. @param request
  970. request to get a delegation token for the client.
  971. @return delegation token that can be used to talk to this service
  972. @throws YarnException
  973. @throws IOException]]>
  974. </doc>
  975. </method>
  976. <doc>
  977. <![CDATA[<p>
  978. The protocol between clients and the <code>ApplicationHistoryServer</code> to
  979. get the information of completed applications etc.
  980. </p>]]>
  981. </doc>
  982. </interface>
  983. <!-- end interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
  984. <!-- start interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
  985. <interface name="ApplicationMasterProtocol" abstract="true"
  986. static="false" final="false" visibility="public"
  987. deprecated="not deprecated">
  988. <method name="registerApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse"
  989. abstract="false" native="false" synchronized="false"
  990. static="false" final="false" visibility="public"
  991. deprecated="not deprecated">
  992. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"/>
  993. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  994. <exception name="IOException" type="java.io.IOException"/>
  995. <doc>
  996. <![CDATA[<p>
  997. The interface used by a new <code>ApplicationMaster</code> to register with
  998. the <code>ResourceManager</code>.
  999. </p>
  1000. <p>
  1001. The <code>ApplicationMaster</code> needs to provide details such as RPC
  1002. Port, HTTP tracking url etc. as specified in
  1003. {@link RegisterApplicationMasterRequest}.
  1004. </p>
  1005. <p>
  1006. The <code>ResourceManager</code> responds with critical details such as
  1007. maximum resource capabilities in the cluster as specified in
  1008. {@link RegisterApplicationMasterResponse}.
  1009. </p>
  1010. @param request
  1011. registration request
  1012. @return registration respose
  1013. @throws YarnException
  1014. @throws IOException
  1015. @throws InvalidApplicationMasterRequestException
  1016. The exception is thrown when an ApplicationMaster tries to
  1017. register more then once.
  1018. @see RegisterApplicationMasterRequest
  1019. @see RegisterApplicationMasterResponse]]>
  1020. </doc>
  1021. </method>
  1022. <method name="finishApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse"
  1023. abstract="false" native="false" synchronized="false"
  1024. static="false" final="false" visibility="public"
  1025. deprecated="not deprecated">
  1026. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"/>
  1027. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1028. <exception name="IOException" type="java.io.IOException"/>
  1029. <doc>
  1030. <![CDATA[<p>The interface used by an <code>ApplicationMaster</code> to notify the
  1031. <code>ResourceManager</code> about its completion (success or failed).</p>
  1032. <p>The <code>ApplicationMaster</code> has to provide details such as
  1033. final state, diagnostics (in case of failures) etc. as specified in
  1034. {@link FinishApplicationMasterRequest}.</p>
  1035. <p>The <code>ResourceManager</code> responds with
  1036. {@link FinishApplicationMasterResponse}.</p>
  1037. @param request completion request
  1038. @return completion response
  1039. @throws YarnException
  1040. @throws IOException
  1041. @see FinishApplicationMasterRequest
  1042. @see FinishApplicationMasterResponse]]>
  1043. </doc>
  1044. </method>
  1045. <method name="allocate" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1046. abstract="false" native="false" synchronized="false"
  1047. static="false" final="false" visibility="public"
  1048. deprecated="not deprecated">
  1049. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"/>
  1050. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1051. <exception name="IOException" type="java.io.IOException"/>
  1052. <doc>
  1053. <![CDATA[<p>
  1054. The main interface between an <code>ApplicationMaster</code> and the
  1055. <code>ResourceManager</code>.
  1056. </p>
  1057. <p>
  1058. The <code>ApplicationMaster</code> uses this interface to provide a list of
  1059. {@link ResourceRequest} and returns unused {@link Container} allocated to
  1060. it via {@link AllocateRequest}. Optionally, the
  1061. <code>ApplicationMaster</code> can also <em>blacklist</em> resources which
  1062. it doesn't want to use.
  1063. </p>
  1064. <p>
  1065. This also doubles up as a <em>heartbeat</em> to let the
  1066. <code>ResourceManager</code> know that the <code>ApplicationMaster</code>
  1067. is alive. Thus, applications should periodically make this call to be kept
  1068. alive. The frequency depends on
  1069. {@link YarnConfiguration#RM_AM_EXPIRY_INTERVAL_MS} which defaults to
  1070. {@link YarnConfiguration#DEFAULT_RM_AM_EXPIRY_INTERVAL_MS}.
  1071. </p>
  1072. <p>
  1073. The <code>ResourceManager</code> responds with list of allocated
  1074. {@link Container}, status of completed containers and headroom information
  1075. for the application.
  1076. </p>
  1077. <p>
  1078. The <code>ApplicationMaster</code> can use the available headroom
  1079. (resources) to decide how to utilized allocated resources and make informed
  1080. decisions about future resource requests.
  1081. </p>
  1082. @param request
  1083. allocation request
  1084. @return allocation response
  1085. @throws YarnException
  1086. @throws IOException
  1087. @throws InvalidApplicationMasterRequestException
  1088. This exception is thrown when an ApplicationMaster calls allocate
  1089. without registering first.
  1090. @throws InvalidResourceBlacklistRequestException
  1091. This exception is thrown when an application provides an invalid
  1092. specification for blacklist of resources.
  1093. @throws InvalidResourceRequestException
  1094. This exception is thrown when a {@link ResourceRequest} is out of
  1095. the range of the configured lower and upper limits on the
  1096. resources.
  1097. @see AllocateRequest
  1098. @see AllocateResponse]]>
  1099. </doc>
  1100. </method>
  1101. <doc>
  1102. <![CDATA[<p>The protocol between a live instance of <code>ApplicationMaster</code>
  1103. and the <code>ResourceManager</code>.</p>
  1104. <p>This is used by the <code>ApplicationMaster</code> to register/unregister
  1105. and to request and obtain resources in the cluster from the
  1106. <code>ResourceManager</code>.</p>]]>
  1107. </doc>
  1108. </interface>
  1109. <!-- end interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
  1110. <!-- start interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
  1111. <interface name="ContainerManagementProtocol" abstract="true"
  1112. static="false" final="false" visibility="public"
  1113. deprecated="not deprecated">
  1114. <method name="startContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse"
  1115. abstract="false" native="false" synchronized="false"
  1116. static="false" final="false" visibility="public"
  1117. deprecated="not deprecated">
  1118. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"/>
  1119. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1120. <exception name="IOException" type="java.io.IOException"/>
  1121. <doc>
  1122. <![CDATA[<p>
  1123. The <code>ApplicationMaster</code> provides a list of
  1124. {@link StartContainerRequest}s to a <code>NodeManager</code> to
  1125. <em>start</em> {@link Container}s allocated to it using this interface.
  1126. </p>
  1127. <p>
  1128. The <code>ApplicationMaster</code> has to provide details such as allocated
  1129. resource capability, security tokens (if enabled), command to be executed
  1130. to start the container, environment for the process, necessary
  1131. binaries/jar/shared-objects etc. via the {@link ContainerLaunchContext} in
  1132. the {@link StartContainerRequest}.
  1133. </p>
  1134. <p>
  1135. The <code>NodeManager</code> sends a response via
  1136. {@link StartContainersResponse} which includes a list of
  1137. {@link Container}s of successfully launched {@link Container}s, a
  1138. containerId-to-exception map for each failed {@link StartContainerRequest} in
  1139. which the exception indicates errors from per container and a
  1140. allServicesMetaData map between the names of auxiliary services and their
  1141. corresponding meta-data. Note: None-container-specific exceptions will
  1142. still be thrown by the API method itself.
  1143. </p>
  1144. <p>
  1145. The <code>ApplicationMaster</code> can use
  1146. {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
  1147. statuses of the to-be-launched or launched containers.
  1148. </p>
  1149. @param request
  1150. request to start a list of containers
  1151. @return response including conatinerIds of all successfully launched
  1152. containers, a containerId-to-exception map for failed requests and
  1153. a allServicesMetaData map.
  1154. @throws YarnException
  1155. @throws IOException
  1156. @throws NMNotYetReadyException
  1157. This exception is thrown when NM starts from scratch but has not
  1158. yet connected with RM.]]>
  1159. </doc>
  1160. </method>
  1161. <method name="stopContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse"
  1162. abstract="false" native="false" synchronized="false"
  1163. static="false" final="false" visibility="public"
  1164. deprecated="not deprecated">
  1165. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"/>
  1166. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1167. <exception name="IOException" type="java.io.IOException"/>
  1168. <doc>
  1169. <![CDATA[<p>
  1170. The <code>ApplicationMaster</code> requests a <code>NodeManager</code> to
  1171. <em>stop</em> a list of {@link Container}s allocated to it using this
  1172. interface.
  1173. </p>
  1174. <p>
  1175. The <code>ApplicationMaster</code> sends a {@link StopContainersRequest}
  1176. which includes the {@link ContainerId}s of the containers to be stopped.
  1177. </p>
  1178. <p>
  1179. The <code>NodeManager</code> sends a response via
  1180. {@link StopContainersResponse} which includes a list of {@link ContainerId}
  1181. s of successfully stopped containers, a containerId-to-exception map for
  1182. each failed request in which the exception indicates errors from per
  1183. container. Note: None-container-specific exceptions will still be thrown by
  1184. the API method itself. <code>ApplicationMaster</code> can use
  1185. {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
  1186. statuses of the containers.
  1187. </p>
  1188. @param request
  1189. request to stop a list of containers
  1190. @return response which includes a list of containerIds of successfully
  1191. stopped containers, a containerId-to-exception map for failed
  1192. requests.
  1193. @throws YarnException
  1194. @throws IOException]]>
  1195. </doc>
  1196. </method>
  1197. <method name="getContainerStatuses" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse"
  1198. abstract="false" native="false" synchronized="false"
  1199. static="false" final="false" visibility="public"
  1200. deprecated="not deprecated">
  1201. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"/>
  1202. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1203. <exception name="IOException" type="java.io.IOException"/>
  1204. <doc>
  1205. <![CDATA[<p>
  1206. The API used by the <code>ApplicationMaster</code> to request for current
  1207. statuses of <code>Container</code>s from the <code>NodeManager</code>.
  1208. </p>
  1209. <p>
  1210. The <code>ApplicationMaster</code> sends a
  1211. {@link GetContainerStatusesRequest} which includes the {@link ContainerId}s
  1212. of all containers whose statuses are needed.
  1213. </p>
  1214. <p>
  1215. The <code>NodeManager</code> responds with
  1216. {@link GetContainerStatusesResponse} which includes a list of
  1217. {@link ContainerStatus} of the successfully queried containers and a
  1218. containerId-to-exception map for each failed request in which the exception
  1219. indicates errors from per container. Note: None-container-specific
  1220. exceptions will still be thrown by the API method itself.
  1221. </p>
  1222. @param request
  1223. request to get <code>ContainerStatus</code>es of containers with
  1224. the specified <code>ContainerId</code>s
  1225. @return response containing the list of <code>ContainerStatus</code> of the
  1226. successfully queried containers and a containerId-to-exception map
  1227. for failed requests.
  1228. @throws YarnException
  1229. @throws IOException]]>
  1230. </doc>
  1231. </method>
  1232. <doc>
  1233. <![CDATA[<p>The protocol between an <code>ApplicationMaster</code> and a
  1234. <code>NodeManager</code> to start/stop containers and to get status
  1235. of running containers.</p>
  1236. <p>If security is enabled the <code>NodeManager</code> verifies that the
  1237. <code>ApplicationMaster</code> has truly been allocated the container
  1238. by the <code>ResourceManager</code> and also verifies all interactions such
  1239. as stopping the container or obtaining status information for the container.
  1240. </p>]]>
  1241. </doc>
  1242. </interface>
  1243. <!-- end interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
  1244. </package>
  1245. <package name="org.apache.hadoop.yarn.api.protocolrecords">
  1246. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
  1247. <class name="AllocateRequest" extends="java.lang.Object"
  1248. abstract="true"
  1249. static="false" final="false" visibility="public"
  1250. deprecated="not deprecated">
  1251. <constructor name="AllocateRequest"
  1252. static="false" final="false" visibility="public"
  1253. deprecated="not deprecated">
  1254. </constructor>
  1255. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1256. abstract="false" native="false" synchronized="false"
  1257. static="true" final="false" visibility="public"
  1258. deprecated="not deprecated">
  1259. <param name="responseID" type="int"/>
  1260. <param name="appProgress" type="float"/>
  1261. <param name="resourceAsk" type="java.util.List"/>
  1262. <param name="containersToBeReleased" type="java.util.List"/>
  1263. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1264. </method>
  1265. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1266. abstract="false" native="false" synchronized="false"
  1267. static="true" final="false" visibility="public"
  1268. deprecated="not deprecated">
  1269. <param name="responseID" type="int"/>
  1270. <param name="appProgress" type="float"/>
  1271. <param name="resourceAsk" type="java.util.List"/>
  1272. <param name="containersToBeReleased" type="java.util.List"/>
  1273. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1274. <param name="increaseRequests" type="java.util.List"/>
  1275. </method>
  1276. <method name="getResponseId" return="int"
  1277. abstract="true" native="false" synchronized="false"
  1278. static="false" final="false" visibility="public"
  1279. deprecated="not deprecated">
  1280. <doc>
  1281. <![CDATA[Get the <em>response id</em> used to track duplicate responses.
  1282. @return <em>response id</em>]]>
  1283. </doc>
  1284. </method>
  1285. <method name="setResponseId"
  1286. abstract="true" native="false" synchronized="false"
  1287. static="false" final="false" visibility="public"
  1288. deprecated="not deprecated">
  1289. <param name="id" type="int"/>
  1290. <doc>
  1291. <![CDATA[Set the <em>response id</em> used to track duplicate responses.
  1292. @param id <em>response id</em>]]>
  1293. </doc>
  1294. </method>
  1295. <method name="getProgress" return="float"
  1296. abstract="true" native="false" synchronized="false"
  1297. static="false" final="false" visibility="public"
  1298. deprecated="not deprecated">
  1299. <doc>
  1300. <![CDATA[Get the <em>current progress</em> of application.
  1301. @return <em>current progress</em> of application]]>
  1302. </doc>
  1303. </method>
  1304. <method name="setProgress"
  1305. abstract="true" native="false" synchronized="false"
  1306. static="false" final="false" visibility="public"
  1307. deprecated="not deprecated">
  1308. <param name="progress" type="float"/>
  1309. <doc>
  1310. <![CDATA[Set the <em>current progress</em> of application
  1311. @param progress <em>current progress</em> of application]]>
  1312. </doc>
  1313. </method>
  1314. <method name="getAskList" return="java.util.List"
  1315. abstract="true" native="false" synchronized="false"
  1316. static="false" final="false" visibility="public"
  1317. deprecated="not deprecated">
  1318. <doc>
  1319. <![CDATA[Get the list of <code>ResourceRequest</code> to update the
  1320. <code>ResourceManager</code> about the application's resource requirements.
  1321. @return the list of <code>ResourceRequest</code>
  1322. @see ResourceRequest]]>
  1323. </doc>
  1324. </method>
  1325. <method name="setAskList"
  1326. abstract="true" native="false" synchronized="false"
  1327. static="false" final="false" visibility="public"
  1328. deprecated="not deprecated">
  1329. <param name="resourceRequests" type="java.util.List"/>
  1330. <doc>
  1331. <![CDATA[Set list of <code>ResourceRequest</code> to update the
  1332. <code>ResourceManager</code> about the application's resource requirements.
  1333. @param resourceRequests list of <code>ResourceRequest</code> to update the
  1334. <code>ResourceManager</code> about the application's
  1335. resource requirements
  1336. @see ResourceRequest]]>
  1337. </doc>
  1338. </method>
  1339. <method name="getReleaseList" return="java.util.List"
  1340. abstract="true" native="false" synchronized="false"
  1341. static="false" final="false" visibility="public"
  1342. deprecated="not deprecated">
  1343. <doc>
  1344. <![CDATA[Get the list of <code>ContainerId</code> of containers being
  1345. released by the <code>ApplicationMaster</code>.
  1346. @return list of <code>ContainerId</code> of containers being
  1347. released by the <code>ApplicationMaster</code>]]>
  1348. </doc>
  1349. </method>
  1350. <method name="setReleaseList"
  1351. abstract="true" native="false" synchronized="false"
  1352. static="false" final="false" visibility="public"
  1353. deprecated="not deprecated">
  1354. <param name="releaseContainers" type="java.util.List"/>
  1355. <doc>
  1356. <![CDATA[Set the list of <code>ContainerId</code> of containers being
  1357. released by the <code>ApplicationMaster</code>
  1358. @param releaseContainers list of <code>ContainerId</code> of
  1359. containers being released by the
  1360. <code>ApplicationMaster</code>]]>
  1361. </doc>
  1362. </method>
  1363. <method name="getResourceBlacklistRequest" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
  1364. abstract="true" native="false" synchronized="false"
  1365. static="false" final="false" visibility="public"
  1366. deprecated="not deprecated">
  1367. <doc>
  1368. <![CDATA[Get the <code>ResourceBlacklistRequest</code> being sent by the
  1369. <code>ApplicationMaster</code>.
  1370. @return the <code>ResourceBlacklistRequest</code> being sent by the
  1371. <code>ApplicationMaster</code>
  1372. @see ResourceBlacklistRequest]]>
  1373. </doc>
  1374. </method>
  1375. <method name="setResourceBlacklistRequest"
  1376. abstract="true" native="false" synchronized="false"
  1377. static="false" final="false" visibility="public"
  1378. deprecated="not deprecated">
  1379. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1380. <doc>
  1381. <![CDATA[Set the <code>ResourceBlacklistRequest</code> to inform the
  1382. <code>ResourceManager</code> about the blacklist additions and removals
  1383. per the <code>ApplicationMaster</code>.
  1384. @param resourceBlacklistRequest the <code>ResourceBlacklistRequest</code>
  1385. to inform the <code>ResourceManager</code> about
  1386. the blacklist additions and removals
  1387. per the <code>ApplicationMaster</code>
  1388. @see ResourceBlacklistRequest]]>
  1389. </doc>
  1390. </method>
  1391. <method name="getIncreaseRequests" return="java.util.List"
  1392. abstract="true" native="false" synchronized="false"
  1393. static="false" final="false" visibility="public"
  1394. deprecated="not deprecated">
  1395. <doc>
  1396. <![CDATA[Get the <code>ContainerResourceIncreaseRequest</code> being sent by the
  1397. <code>ApplicationMaster</code>]]>
  1398. </doc>
  1399. </method>
  1400. <method name="setIncreaseRequests"
  1401. abstract="true" native="false" synchronized="false"
  1402. static="false" final="false" visibility="public"
  1403. deprecated="not deprecated">
  1404. <param name="increaseRequests" type="java.util.List"/>
  1405. <doc>
  1406. <![CDATA[Set the <code>ContainerResourceIncreaseRequest</code> to inform the
  1407. <code>ResourceManager</code> about some container's resources need to be
  1408. increased]]>
  1409. </doc>
  1410. </method>
  1411. <doc>
  1412. <![CDATA[<p>The core request sent by the <code>ApplicationMaster</code> to the
  1413. <code>ResourceManager</code> to obtain resources in the cluster.</p>
  1414. <p>The request includes:
  1415. <ul>
  1416. <li>A response id to track duplicate responses.</li>
  1417. <li>Progress information.</li>
  1418. <li>
  1419. A list of {@link ResourceRequest} to inform the
  1420. <code>ResourceManager</code> about the application's
  1421. resource requirements.
  1422. </li>
  1423. <li>
  1424. A list of unused {@link Container} which are being returned.
  1425. </li>
  1426. </ul>
  1427. </p>
  1428. @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
  1429. </doc>
  1430. </class>
  1431. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
  1432. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
  1433. <class name="AllocateResponse" extends="java.lang.Object"
  1434. abstract="true"
  1435. static="false" final="false" visibility="public"
  1436. deprecated="not deprecated">
  1437. <constructor name="AllocateResponse"
  1438. static="false" final="false" visibility="public"
  1439. deprecated="not deprecated">
  1440. </constructor>
  1441. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1442. abstract="false" native="false" synchronized="false"
  1443. static="true" final="false" visibility="public"
  1444. deprecated="not deprecated">
  1445. <param name="responseId" type="int"/>
  1446. <param name="completedContainers" type="java.util.List"/>
  1447. <param name="allocatedContainers" type="java.util.List"/>
  1448. <param name="updatedNodes" type="java.util.List"/>
  1449. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1450. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1451. <param name="numClusterNodes" type="int"/>
  1452. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1453. <param name="nmTokens" type="java.util.List"/>
  1454. </method>
  1455. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1456. abstract="false" native="false" synchronized="false"
  1457. static="true" final="false" visibility="public"
  1458. deprecated="not deprecated">
  1459. <param name="responseId" type="int"/>
  1460. <param name="completedContainers" type="java.util.List"/>
  1461. <param name="allocatedContainers" type="java.util.List"/>
  1462. <param name="updatedNodes" type="java.util.List"/>
  1463. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1464. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1465. <param name="numClusterNodes" type="int"/>
  1466. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1467. <param name="nmTokens" type="java.util.List"/>
  1468. <param name="increasedContainers" type="java.util.List"/>
  1469. <param name="decreasedContainers" type="java.util.List"/>
  1470. </method>
  1471. <method name="getAMCommand" return="org.apache.hadoop.yarn.api.records.AMCommand"
  1472. abstract="true" native="false" synchronized="false"
  1473. static="false" final="false" visibility="public"
  1474. deprecated="not deprecated">
  1475. <doc>
  1476. <![CDATA[If the <code>ResourceManager</code> needs the
  1477. <code>ApplicationMaster</code> to take some action then it will send an
  1478. AMCommand to the <code>ApplicationMaster</code>. See <code>AMCommand</code>
  1479. for details on commands and actions for them.
  1480. @return <code>AMCommand</code> if the <code>ApplicationMaster</code> should
  1481. take action, <code>null</code> otherwise
  1482. @see AMCommand]]>
  1483. </doc>
  1484. </method>
  1485. <method name="getResponseId" return="int"
  1486. abstract="true" native="false" synchronized="false"
  1487. static="false" final="false" visibility="public"
  1488. deprecated="not deprecated">
  1489. <doc>
  1490. <![CDATA[Get the <em>last response id</em>.
  1491. @return <em>last response id</em>]]>
  1492. </doc>
  1493. </method>
  1494. <method name="getAllocatedContainers" return="java.util.List"
  1495. abstract="true" native="false" synchronized="false"
  1496. static="false" final="false" visibility="public"
  1497. deprecated="not deprecated">
  1498. <doc>
  1499. <![CDATA[Get the list of <em>newly allocated</em> <code>Container</code> by the
  1500. <code>ResourceManager</code>.
  1501. @return list of <em>newly allocated</em> <code>Container</code>]]>
  1502. </doc>
  1503. </method>
  1504. <method name="getAvailableResources" return="org.apache.hadoop.yarn.api.records.Resource"
  1505. abstract="true" native="false" synchronized="false"
  1506. static="false" final="false" visibility="public"
  1507. deprecated="not deprecated">
  1508. <doc>
  1509. <![CDATA[Get the <em>available headroom</em> for resources in the cluster for the
  1510. application.
  1511. @return limit of available headroom for resources in the cluster for the
  1512. application]]>
  1513. </doc>
  1514. </method>
  1515. <method name="getCompletedContainersStatuses" return="java.util.List"
  1516. abstract="true" native="false" synchronized="false"
  1517. static="false" final="false" visibility="public"
  1518. deprecated="not deprecated">
  1519. <doc>
  1520. <![CDATA[Get the list of <em>completed containers' statuses</em>.
  1521. @return the list of <em>completed containers' statuses</em>]]>
  1522. </doc>
  1523. </method>
  1524. <method name="getUpdatedNodes" return="java.util.List"
  1525. abstract="true" native="false" synchronized="false"
  1526. static="false" final="false" visibility="public"
  1527. deprecated="not deprecated">
  1528. <doc>
  1529. <![CDATA[Get the list of <em>updated <code>NodeReport</code>s</em>. Updates could
  1530. be changes in health, availability etc of the nodes.
  1531. @return The delta of updated nodes since the last response]]>
  1532. </doc>
  1533. </method>
  1534. <method name="getNumClusterNodes" return="int"
  1535. abstract="true" native="false" synchronized="false"
  1536. static="false" final="false" visibility="public"
  1537. deprecated="not deprecated">
  1538. <doc>
  1539. <![CDATA[Get the number of hosts available on the cluster.
  1540. @return the available host count.]]>
  1541. </doc>
  1542. </method>
  1543. <method name="getPreemptionMessage" return="org.apache.hadoop.yarn.api.records.PreemptionMessage"
  1544. abstract="true" native="false" synchronized="false"
  1545. static="false" final="false" visibility="public"
  1546. deprecated="not deprecated">
  1547. <doc>
  1548. <![CDATA[<p>Get the description of containers owned by the AM, but requested back by
  1549. the cluster. Note that the RM may have an inconsistent view of the
  1550. resources owned by the AM. These messages are advisory, and the AM may
  1551. elect to ignore them.<p>
  1552. <p>The message is a snapshot of the resources the RM wants back from the AM.
  1553. While demand persists, the RM will repeat its request; applications should
  1554. not interpret each message as a request for <em>additional<em>
  1555. resources on top of previous messages. Resources requested consistently
  1556. over some duration may be forcibly killed by the RM.<p>
  1557. @return A specification of the resources to reclaim from this AM.]]>
  1558. </doc>
  1559. </method>
  1560. <method name="getNMTokens" return="java.util.List"
  1561. abstract="true" native="false" synchronized="false"
  1562. static="false" final="false" visibility="public"
  1563. deprecated="not deprecated">
  1564. <doc>
  1565. <![CDATA[<p>Get the list of NMTokens required for communicating with NM. New NMTokens
  1566. issued only if<p>
  1567. <p>1) AM is receiving first container on underlying NodeManager.<br>
  1568. OR<br>
  1569. 2) NMToken master key rolled over in ResourceManager and AM is getting new
  1570. container on the same underlying NodeManager.<p>
  1571. <p>AM will receive one NMToken per NM irrespective of the number of containers
  1572. issued on same NM. AM is expected to store these tokens until issued a
  1573. new token for the same NM.<p>]]>
  1574. </doc>
  1575. </method>
  1576. <method name="getIncreasedContainers" return="java.util.List"
  1577. abstract="true" native="false" synchronized="false"
  1578. static="false" final="false" visibility="public"
  1579. deprecated="not deprecated">
  1580. <doc>
  1581. <![CDATA[Get the list of newly increased containers by <code>ResourceManager</code>]]>
  1582. </doc>
  1583. </method>
  1584. <method name="getDecreasedContainers" return="java.util.List"
  1585. abstract="true" native="false" synchronized="false"
  1586. static="false" final="false" visibility="public"
  1587. deprecated="not deprecated">
  1588. <doc>
  1589. <![CDATA[Get the list of newly decreased containers by <code>NodeManager</code>]]>
  1590. </doc>
  1591. </method>
  1592. <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
  1593. abstract="true" native="false" synchronized="false"
  1594. static="false" final="false" visibility="public"
  1595. deprecated="not deprecated">
  1596. <doc>
  1597. <![CDATA[The AMRMToken that belong to this attempt
  1598. @return The AMRMToken that belong to this attempt]]>
  1599. </doc>
  1600. </method>
  1601. <doc>
  1602. <![CDATA[<p>The response sent by the <code>ResourceManager</code> the
  1603. <code>ApplicationMaster</code> during resource negotiation.</p>
  1604. <p>The response, includes:
  1605. <ul>
  1606. <li>Response ID to track duplicate responses.</li>
  1607. <li>
  1608. An AMCommand sent by ResourceManager to let the <code>ApplicationMaster</code>
  1609. take some actions (resync, shutdown etc.).
  1610. <li>A list of newly allocated {@link Container}.</li>
  1611. <li>A list of completed {@link Container}s' statuses.</li>
  1612. <li>
  1613. The available headroom for resources in the cluster for the
  1614. application.
  1615. </li>
  1616. <li>A list of nodes whose status has been updated.</li>
  1617. <li>The number of available nodes in a cluster.</li>
  1618. <li>A description of resources requested back by the cluster</li>
  1619. <li>AMRMToken, if AMRMToken has been rolled over</li>
  1620. </ul>
  1621. </p>
  1622. @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
  1623. </doc>
  1624. </class>
  1625. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
  1626. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
  1627. <class name="ApplicationsRequestScope" extends="java.lang.Enum"
  1628. abstract="false"
  1629. static="false" final="true" visibility="public"
  1630. deprecated="not deprecated">
  1631. <method name="values" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope[]"
  1632. abstract="false" native="false" synchronized="false"
  1633. static="true" final="false" visibility="public"
  1634. deprecated="not deprecated">
  1635. </method>
  1636. <method name="valueOf" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"
  1637. abstract="false" native="false" synchronized="false"
  1638. static="true" final="false" visibility="public"
  1639. deprecated="not deprecated">
  1640. <param name="name" type="java.lang.String"/>
  1641. </method>
  1642. <doc>
  1643. <![CDATA[Enumeration that controls the scope of applications fetched]]>
  1644. </doc>
  1645. </class>
  1646. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
  1647. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
  1648. <class name="FinishApplicationMasterRequest" extends="java.lang.Object"
  1649. abstract="true"
  1650. static="false" final="false" visibility="public"
  1651. deprecated="not deprecated">
  1652. <constructor name="FinishApplicationMasterRequest"
  1653. static="false" final="false" visibility="public"
  1654. deprecated="not deprecated">
  1655. </constructor>
  1656. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"
  1657. abstract="false" native="false" synchronized="false"
  1658. static="true" final="false" visibility="public"
  1659. deprecated="not deprecated">
  1660. <param name="finalAppStatus" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
  1661. <param name="diagnostics" type="java.lang.String"/>
  1662. <param name="url" type="java.lang.String"/>
  1663. </method>
  1664. <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  1665. abstract="true" native="false" synchronized="false"
  1666. static="false" final="false" visibility="public"
  1667. deprecated="not deprecated">
  1668. <doc>
  1669. <![CDATA[Get <em>final state</em> of the <code>ApplicationMaster</code>.
  1670. @return <em>final state</em> of the <code>ApplicationMaster</code>]]>
  1671. </doc>
  1672. </method>
  1673. <method name="setFinalApplicationStatus"
  1674. abstract="true" native="false" synchronized="false"
  1675. static="false" final="false" visibility="public"
  1676. deprecated="not deprecated">
  1677. <param name="finalState" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
  1678. <doc>
  1679. <![CDATA[Set the <em>final state</em> of the <code>ApplicationMaster</code>
  1680. @param finalState <em>final state</em> of the <code>ApplicationMaster</code>]]>
  1681. </doc>
  1682. </method>
  1683. <method name="getDiagnostics" return="java.lang.String"
  1684. abstract="true" native="false" synchronized="false"
  1685. static="false" final="false" visibility="public"
  1686. deprecated="not deprecated">
  1687. <doc>
  1688. <![CDATA[Get <em>diagnostic information</em> on application failure.
  1689. @return <em>diagnostic information</em> on application failure]]>
  1690. </doc>
  1691. </method>
  1692. <method name="setDiagnostics"
  1693. abstract="true" native="false" synchronized="false"
  1694. static="false" final="false" visibility="public"
  1695. deprecated="not deprecated">
  1696. <param name="diagnostics" type="java.lang.String"/>
  1697. <doc>
  1698. <![CDATA[Set <em>diagnostic information</em> on application failure.
  1699. @param diagnostics <em>diagnostic information</em> on application failure]]>
  1700. </doc>
  1701. </method>
  1702. <method name="getTrackingUrl" return="java.lang.String"
  1703. abstract="true" native="false" synchronized="false"
  1704. static="false" final="false" visibility="public"
  1705. deprecated="not deprecated">
  1706. <doc>
  1707. <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
  1708. This url if contains scheme then that will be used by resource manager
  1709. web application proxy otherwise it will default to http.
  1710. @return <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  1711. </doc>
  1712. </method>
  1713. <method name="setTrackingUrl"
  1714. abstract="true" native="false" synchronized="false"
  1715. static="false" final="false" visibility="public"
  1716. deprecated="not deprecated">
  1717. <param name="url" type="java.lang.String"/>
  1718. <doc>
  1719. <![CDATA[Set the <em>final tracking URL</em>for the <code>ApplicationMaster</code>.
  1720. This is the web-URL to which ResourceManager or web-application proxy will
  1721. redirect client/users once the application is finished and the
  1722. <code>ApplicationMaster</code> is gone.
  1723. <p>
  1724. If the passed url has a scheme then that will be used by the
  1725. ResourceManager and web-application proxy, otherwise the scheme will
  1726. default to http.
  1727. </p>
  1728. <p>
  1729. Empty, null, "N/A" strings are all valid besides a real URL. In case an url
  1730. isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
  1731. <p>
  1732. @param url
  1733. <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  1734. </doc>
  1735. </method>
  1736. <doc>
  1737. <![CDATA[<p>The finalization request sent by the <code>ApplicationMaster</code> to
  1738. inform the <code>ResourceManager</code> about its completion.</p>
  1739. <p>The final request includes details such:
  1740. <ul>
  1741. <li>Final state of the <code>ApplicationMaster</code></li>
  1742. <li>
  1743. Diagnostic information in case of failure of the
  1744. <code>ApplicationMaster</code>
  1745. </li>
  1746. <li>Tracking URL</li>
  1747. </ul>
  1748. </p>
  1749. @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
  1750. </doc>
  1751. </class>
  1752. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
  1753. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
  1754. <class name="FinishApplicationMasterResponse" extends="java.lang.Object"
  1755. abstract="true"
  1756. static="false" final="false" visibility="public"
  1757. deprecated="not deprecated">
  1758. <constructor name="FinishApplicationMasterResponse"
  1759. static="false" final="false" visibility="public"
  1760. deprecated="not deprecated">
  1761. </constructor>
  1762. <method name="getIsUnregistered" return="boolean"
  1763. abstract="true" native="false" synchronized="false"
  1764. static="false" final="false" visibility="public"
  1765. deprecated="not deprecated">
  1766. <doc>
  1767. <![CDATA[Get the flag which indicates that the application has successfully
  1768. unregistered with the RM and the application can safely stop.]]>
  1769. </doc>
  1770. </method>
  1771. <doc>
  1772. <![CDATA[<p>
  1773. The response sent by the <code>ResourceManager</code> to a
  1774. <code>ApplicationMaster</code> on it's completion.
  1775. </p>
  1776. <p>
  1777. The response, includes:
  1778. <ul>
  1779. <li>A flag which indicates that the application has successfully unregistered
  1780. with the RM and the application can safely stop.</li>
  1781. </ul>
  1782. </p>
  1783. Note: The flag indicates whether the application has successfully
  1784. unregistered and is safe to stop. The application may stop after the flag is
  1785. true. If the application stops before the flag is true then the RM may retry
  1786. the application .
  1787. @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
  1788. </doc>
  1789. </class>
  1790. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
  1791. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
  1792. <class name="GetApplicationAttemptReportRequest" extends="java.lang.Object"
  1793. abstract="true"
  1794. static="false" final="false" visibility="public"
  1795. deprecated="not deprecated">
  1796. <constructor name="GetApplicationAttemptReportRequest"
  1797. static="false" final="false" visibility="public"
  1798. deprecated="not deprecated">
  1799. </constructor>
  1800. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"
  1801. abstract="false" native="false" synchronized="false"
  1802. static="true" final="false" visibility="public"
  1803. deprecated="not deprecated">
  1804. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1805. </method>
  1806. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  1807. abstract="true" native="false" synchronized="false"
  1808. static="false" final="false" visibility="public"
  1809. deprecated="not deprecated">
  1810. <doc>
  1811. <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
  1812. @return <code>ApplicationAttemptId</code> of an application attempt]]>
  1813. </doc>
  1814. </method>
  1815. <method name="setApplicationAttemptId"
  1816. abstract="true" native="false" synchronized="false"
  1817. static="false" final="false" visibility="public"
  1818. deprecated="not deprecated">
  1819. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1820. <doc>
  1821. <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
  1822. @param applicationAttemptId
  1823. <code>ApplicationAttemptId</code> of an application attempt]]>
  1824. </doc>
  1825. </method>
  1826. <doc>
  1827. <![CDATA[<p>
  1828. The request sent by a client to the <code>ResourceManager</code> to get an
  1829. {@link ApplicationAttemptReport} for an application attempt.
  1830. </p>
  1831. <p>
  1832. The request should include the {@link ApplicationAttemptId} of the
  1833. application attempt.
  1834. </p>
  1835. @see ApplicationAttemptReport
  1836. @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
  1837. </doc>
  1838. </class>
  1839. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
  1840. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
  1841. <class name="GetApplicationAttemptReportResponse" extends="java.lang.Object"
  1842. abstract="true"
  1843. static="false" final="false" visibility="public"
  1844. deprecated="not deprecated">
  1845. <constructor name="GetApplicationAttemptReportResponse"
  1846. static="false" final="false" visibility="public"
  1847. deprecated="not deprecated">
  1848. </constructor>
  1849. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
  1850. abstract="false" native="false" synchronized="false"
  1851. static="true" final="false" visibility="public"
  1852. deprecated="not deprecated">
  1853. <param name="ApplicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
  1854. </method>
  1855. <method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
  1856. abstract="true" native="false" synchronized="false"
  1857. static="false" final="false" visibility="public"
  1858. deprecated="not deprecated">
  1859. <doc>
  1860. <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
  1861. @return <code>ApplicationAttemptReport</code> for the application attempt]]>
  1862. </doc>
  1863. </method>
  1864. <method name="setApplicationAttemptReport"
  1865. abstract="true" native="false" synchronized="false"
  1866. static="false" final="false" visibility="public"
  1867. deprecated="not deprecated">
  1868. <param name="applicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
  1869. <doc>
  1870. <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
  1871. @param applicationAttemptReport
  1872. <code>ApplicationAttemptReport</code> for the application attempt]]>
  1873. </doc>
  1874. </method>
  1875. <doc>
  1876. <![CDATA[<p>
  1877. The response sent by the <code>ResourceManager</code> to a client requesting
  1878. an application attempt report.
  1879. </p>
  1880. <p>
  1881. The response includes an {@link ApplicationAttemptReport} which has the
  1882. details about the particular application attempt
  1883. </p>
  1884. @see ApplicationAttemptReport
  1885. @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
  1886. </doc>
  1887. </class>
  1888. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
  1889. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
  1890. <class name="GetApplicationAttemptsRequest" extends="java.lang.Object"
  1891. abstract="true"
  1892. static="false" final="false" visibility="public"
  1893. deprecated="not deprecated">
  1894. <constructor name="GetApplicationAttemptsRequest"
  1895. static="false" final="false" visibility="public"
  1896. deprecated="not deprecated">
  1897. </constructor>
  1898. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"
  1899. abstract="false" native="false" synchronized="false"
  1900. static="true" final="false" visibility="public"
  1901. deprecated="not deprecated">
  1902. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1903. </method>
  1904. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  1905. abstract="true" native="false" synchronized="false"
  1906. static="false" final="false" visibility="public"
  1907. deprecated="not deprecated">
  1908. <doc>
  1909. <![CDATA[Get the <code>ApplicationId</code> of an application
  1910. @return <code>ApplicationId</code> of an application]]>
  1911. </doc>
  1912. </method>
  1913. <method name="setApplicationId"
  1914. abstract="true" native="false" synchronized="false"
  1915. static="false" final="false" visibility="public"
  1916. deprecated="not deprecated">
  1917. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1918. <doc>
  1919. <![CDATA[Set the <code>ApplicationId</code> of an application
  1920. @param applicationId
  1921. <code>ApplicationId</code> of an application]]>
  1922. </doc>
  1923. </method>
  1924. <doc>
  1925. <![CDATA[<p>
  1926. The request from clients to get a list of application attempt reports of an
  1927. application from the <code>ResourceManager</code>.
  1928. </p>
  1929. @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
  1930. </doc>
  1931. </class>
  1932. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
  1933. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
  1934. <class name="GetApplicationAttemptsResponse" extends="java.lang.Object"
  1935. abstract="true"
  1936. static="false" final="false" visibility="public"
  1937. deprecated="not deprecated">
  1938. <constructor name="GetApplicationAttemptsResponse"
  1939. static="false" final="false" visibility="public"
  1940. deprecated="not deprecated">
  1941. </constructor>
  1942. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
  1943. abstract="false" native="false" synchronized="false"
  1944. static="true" final="false" visibility="public"
  1945. deprecated="not deprecated">
  1946. <param name="applicationAttempts" type="java.util.List"/>
  1947. </method>
  1948. <method name="getApplicationAttemptList" return="java.util.List"
  1949. abstract="true" native="false" synchronized="false"
  1950. static="false" final="false" visibility="public"
  1951. deprecated="not deprecated">
  1952. <doc>
  1953. <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
  1954. @return a list of <code>ApplicationReport</code> of an application]]>
  1955. </doc>
  1956. </method>
  1957. <method name="setApplicationAttemptList"
  1958. abstract="true" native="false" synchronized="false"
  1959. static="false" final="false" visibility="public"
  1960. deprecated="not deprecated">
  1961. <param name="applicationAttempts" type="java.util.List"/>
  1962. <doc>
  1963. <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
  1964. @param applicationAttempts
  1965. a list of <code>ApplicationReport</code> of an application]]>
  1966. </doc>
  1967. </method>
  1968. <doc>
  1969. <![CDATA[<p>
  1970. The response sent by the <code>ResourceManager</code> to a client requesting
  1971. a list of {@link ApplicationAttemptReport} for application attempts.
  1972. </p>
  1973. <p>
  1974. The <code>ApplicationAttemptReport</code> for each application includes the
  1975. details of an application attempt.
  1976. </p>
  1977. @see ApplicationAttemptReport
  1978. @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
  1979. </doc>
  1980. </class>
  1981. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
  1982. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
  1983. <class name="GetApplicationReportRequest" extends="java.lang.Object"
  1984. abstract="true"
  1985. static="false" final="false" visibility="public"
  1986. deprecated="not deprecated">
  1987. <constructor name="GetApplicationReportRequest"
  1988. static="false" final="false" visibility="public"
  1989. deprecated="not deprecated">
  1990. </constructor>
  1991. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"
  1992. abstract="false" native="false" synchronized="false"
  1993. static="true" final="false" visibility="public"
  1994. deprecated="not deprecated">
  1995. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1996. </method>
  1997. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  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>ApplicationId</code> of the application.
  2003. @return <code>ApplicationId</code> of the application]]>
  2004. </doc>
  2005. </method>
  2006. <method name="setApplicationId"
  2007. abstract="true" native="false" synchronized="false"
  2008. static="false" final="false" visibility="public"
  2009. deprecated="not deprecated">
  2010. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2011. <doc>
  2012. <![CDATA[Set the <code>ApplicationId</code> of the application
  2013. @param applicationId <code>ApplicationId</code> of the application]]>
  2014. </doc>
  2015. </method>
  2016. <doc>
  2017. <![CDATA[<p>The request sent by a client to the <code>ResourceManager</code> to
  2018. get an {@link ApplicationReport} for an application.</p>
  2019. <p>The request should include the {@link ApplicationId} of the
  2020. application.</p>
  2021. @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)
  2022. @see ApplicationReport]]>
  2023. </doc>
  2024. </class>
  2025. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
  2026. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
  2027. <class name="GetApplicationReportResponse" extends="java.lang.Object"
  2028. abstract="true"
  2029. static="false" final="false" visibility="public"
  2030. deprecated="not deprecated">
  2031. <constructor name="GetApplicationReportResponse"
  2032. static="false" final="false" visibility="public"
  2033. deprecated="not deprecated">
  2034. </constructor>
  2035. <method name="getApplicationReport" return="org.apache.hadoop.yarn.api.records.ApplicationReport"
  2036. abstract="true" native="false" synchronized="false"
  2037. static="false" final="false" visibility="public"
  2038. deprecated="not deprecated">
  2039. <doc>
  2040. <![CDATA[Get the <code>ApplicationReport</code> for the application.
  2041. @return <code>ApplicationReport</code> for the application]]>
  2042. </doc>
  2043. </method>
  2044. <doc>
  2045. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  2046. requesting an application report.</p>
  2047. <p>The response includes an {@link ApplicationReport} which has details such
  2048. as user, queue, name, host on which the <code>ApplicationMaster</code> is
  2049. running, RPC port, tracking URL, diagnostics, start time etc.</p>
  2050. @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)]]>
  2051. </doc>
  2052. </class>
  2053. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
  2054. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
  2055. <class name="GetApplicationsRequest" extends="java.lang.Object"
  2056. abstract="true"
  2057. static="false" final="false" visibility="public"
  2058. deprecated="not deprecated">
  2059. <constructor name="GetApplicationsRequest"
  2060. static="false" final="false" visibility="public"
  2061. deprecated="not deprecated">
  2062. </constructor>
  2063. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2064. abstract="false" native="false" synchronized="false"
  2065. static="true" final="false" visibility="public"
  2066. deprecated="not deprecated">
  2067. </method>
  2068. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2069. abstract="false" native="false" synchronized="false"
  2070. static="true" final="false" visibility="public"
  2071. deprecated="not deprecated">
  2072. <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
  2073. <param name="users" type="java.util.Set"/>
  2074. <param name="queues" type="java.util.Set"/>
  2075. <param name="applicationTypes" type="java.util.Set"/>
  2076. <param name="applicationTags" type="java.util.Set"/>
  2077. <param name="applicationStates" type="java.util.EnumSet"/>
  2078. <param name="startRange" type="org.apache.commons.lang.math.LongRange"/>
  2079. <param name="finishRange" type="org.apache.commons.lang.math.LongRange"/>
  2080. <param name="limit" type="java.lang.Long"/>
  2081. <doc>
  2082. <![CDATA[<p>
  2083. The request from clients to get a report of Applications matching the
  2084. giving application types in the cluster from the
  2085. <code>ResourceManager</code>.
  2086. </p>
  2087. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2088. <p>Setting any of the parameters to null, would just disable that
  2089. filter</p>
  2090. @param scope {@link ApplicationsRequestScope} to filter by
  2091. @param users list of users to filter by
  2092. @param queues list of scheduler queues to filter by
  2093. @param applicationTypes types of applications
  2094. @param applicationTags application tags to filter by
  2095. @param applicationStates application states to filter by
  2096. @param startRange range of application start times to filter by
  2097. @param finishRange range of application finish times to filter by
  2098. @param limit number of applications to limit to
  2099. @return {@link GetApplicationsRequest} to be used with
  2100. {@link ApplicationClientProtocol#getApplications(GetApplicationsRequest)}]]>
  2101. </doc>
  2102. </method>
  2103. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2104. abstract="false" native="false" synchronized="false"
  2105. static="true" final="false" visibility="public"
  2106. deprecated="not deprecated">
  2107. <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
  2108. <doc>
  2109. <![CDATA[<p>
  2110. The request from clients to get a report of Applications matching the
  2111. giving application types in the cluster from the
  2112. <code>ResourceManager</code>.
  2113. </p>
  2114. @param scope {@link ApplicationsRequestScope} to filter by
  2115. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2116. </doc>
  2117. </method>
  2118. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2119. abstract="false" native="false" synchronized="false"
  2120. static="true" final="false" visibility="public"
  2121. deprecated="not deprecated">
  2122. <param name="applicationTypes" type="java.util.Set"/>
  2123. <doc>
  2124. <![CDATA[<p>
  2125. The request from clients to get a report of Applications matching the
  2126. giving application types in the cluster from the
  2127. <code>ResourceManager</code>.
  2128. </p>
  2129. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2130. </doc>
  2131. </method>
  2132. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2133. abstract="false" native="false" synchronized="false"
  2134. static="true" final="false" visibility="public"
  2135. deprecated="not deprecated">
  2136. <param name="applicationStates" type="java.util.EnumSet"/>
  2137. <doc>
  2138. <![CDATA[<p>
  2139. The request from clients to get a report of Applications matching the
  2140. giving application states in the cluster from the
  2141. <code>ResourceManager</code>.
  2142. </p>
  2143. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2144. </doc>
  2145. </method>
  2146. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2147. abstract="false" native="false" synchronized="false"
  2148. static="true" final="false" visibility="public"
  2149. deprecated="not deprecated">
  2150. <param name="applicationTypes" type="java.util.Set"/>
  2151. <param name="applicationStates" type="java.util.EnumSet"/>
  2152. <doc>
  2153. <![CDATA[<p>
  2154. The request from clients to get a report of Applications matching the
  2155. giving and application types and application types in the cluster from the
  2156. <code>ResourceManager</code>.
  2157. </p>
  2158. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2159. </doc>
  2160. </method>
  2161. <method name="getApplicationTypes" return="java.util.Set"
  2162. abstract="true" native="false" synchronized="false"
  2163. static="false" final="false" visibility="public"
  2164. deprecated="not deprecated">
  2165. <doc>
  2166. <![CDATA[Get the application types to filter applications on
  2167. @return Set of Application Types to filter on]]>
  2168. </doc>
  2169. </method>
  2170. <method name="getApplicationStates" return="java.util.EnumSet"
  2171. abstract="true" native="false" synchronized="false"
  2172. static="false" final="false" visibility="public"
  2173. deprecated="not deprecated">
  2174. <doc>
  2175. <![CDATA[Get the application states to filter applications on
  2176. @return Set of Application states to filter on]]>
  2177. </doc>
  2178. </method>
  2179. <doc>
  2180. <![CDATA[<p>The request from clients to get a report of Applications
  2181. in the cluster from the <code>ResourceManager</code>.</p>
  2182. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2183. </doc>
  2184. </class>
  2185. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
  2186. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
  2187. <class name="GetApplicationsResponse" extends="java.lang.Object"
  2188. abstract="true"
  2189. static="false" final="false" visibility="public"
  2190. deprecated="not deprecated">
  2191. <constructor name="GetApplicationsResponse"
  2192. static="false" final="false" visibility="public"
  2193. deprecated="not deprecated">
  2194. </constructor>
  2195. <method name="getApplicationList" return="java.util.List"
  2196. abstract="true" native="false" synchronized="false"
  2197. static="false" final="false" visibility="public"
  2198. deprecated="not deprecated">
  2199. <doc>
  2200. <![CDATA[Get <code>ApplicationReport</code> for applications.
  2201. @return <code>ApplicationReport</code> for applications]]>
  2202. </doc>
  2203. </method>
  2204. <doc>
  2205. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  2206. requesting an {@link ApplicationReport} for applications.</p>
  2207. <p>The <code>ApplicationReport</code> for each application includes details
  2208. such as user, queue, name, host on which the <code>ApplicationMaster</code>
  2209. is running, RPC port, tracking URL, diagnostics, start time etc.</p>
  2210. @see ApplicationReport
  2211. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2212. </doc>
  2213. </class>
  2214. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
  2215. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
  2216. <class name="GetClusterMetricsRequest" extends="java.lang.Object"
  2217. abstract="true"
  2218. static="false" final="false" visibility="public"
  2219. deprecated="not deprecated">
  2220. <constructor name="GetClusterMetricsRequest"
  2221. static="false" final="false" visibility="public"
  2222. deprecated="not deprecated">
  2223. </constructor>
  2224. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"
  2225. abstract="false" native="false" synchronized="false"
  2226. static="true" final="false" visibility="public"
  2227. deprecated="not deprecated">
  2228. </method>
  2229. <doc>
  2230. <![CDATA[<p>The request sent by clients to get cluster metrics from the
  2231. <code>ResourceManager</code>.</p>
  2232. <p>Currently, this is empty.</p>
  2233. @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
  2234. </doc>
  2235. </class>
  2236. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
  2237. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
  2238. <class name="GetClusterMetricsResponse" extends="java.lang.Object"
  2239. abstract="true"
  2240. static="false" final="false" visibility="public"
  2241. deprecated="not deprecated">
  2242. <constructor name="GetClusterMetricsResponse"
  2243. static="false" final="false" visibility="public"
  2244. deprecated="not deprecated">
  2245. </constructor>
  2246. <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.records.YarnClusterMetrics"
  2247. abstract="true" native="false" synchronized="false"
  2248. static="false" final="false" visibility="public"
  2249. deprecated="not deprecated">
  2250. <doc>
  2251. <![CDATA[Get the <code>YarnClusterMetrics</code> for the cluster.
  2252. @return <code>YarnClusterMetrics</code> for the cluster]]>
  2253. </doc>
  2254. </method>
  2255. <doc>
  2256. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  2257. requesting cluster metrics.<p>
  2258. @see YarnClusterMetrics
  2259. @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
  2260. </doc>
  2261. </class>
  2262. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
  2263. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
  2264. <class name="GetClusterNodeLabelsRequest" extends="java.lang.Object"
  2265. abstract="true"
  2266. static="false" final="false" visibility="public"
  2267. deprecated="not deprecated">
  2268. <constructor name="GetClusterNodeLabelsRequest"
  2269. static="false" final="false" visibility="public"
  2270. deprecated="not deprecated">
  2271. </constructor>
  2272. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"
  2273. abstract="false" native="false" synchronized="false"
  2274. static="true" final="false" visibility="public"
  2275. deprecated="not deprecated">
  2276. </method>
  2277. </class>
  2278. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
  2279. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
  2280. <class name="GetClusterNodeLabelsResponse" extends="java.lang.Object"
  2281. abstract="true"
  2282. static="false" final="false" visibility="public"
  2283. deprecated="not deprecated">
  2284. <constructor name="GetClusterNodeLabelsResponse"
  2285. static="false" final="false" visibility="public"
  2286. deprecated="not deprecated">
  2287. </constructor>
  2288. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  2289. abstract="false" native="false" synchronized="false"
  2290. static="true" final="false" visibility="public"
  2291. deprecated="not deprecated">
  2292. <param name="labels" type="java.util.Set"/>
  2293. </method>
  2294. <method name="setNodeLabels"
  2295. abstract="true" native="false" synchronized="false"
  2296. static="false" final="false" visibility="public"
  2297. deprecated="not deprecated">
  2298. <param name="labels" type="java.util.Set"/>
  2299. </method>
  2300. <method name="getNodeLabels" return="java.util.Set"
  2301. abstract="true" native="false" synchronized="false"
  2302. static="false" final="false" visibility="public"
  2303. deprecated="not deprecated">
  2304. </method>
  2305. </class>
  2306. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
  2307. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
  2308. <class name="GetClusterNodesRequest" extends="java.lang.Object"
  2309. abstract="true"
  2310. static="false" final="false" visibility="public"
  2311. deprecated="not deprecated">
  2312. <constructor name="GetClusterNodesRequest"
  2313. static="false" final="false" visibility="public"
  2314. deprecated="not deprecated">
  2315. </constructor>
  2316. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
  2317. abstract="false" native="false" synchronized="false"
  2318. static="true" final="false" visibility="public"
  2319. deprecated="not deprecated">
  2320. <param name="states" type="java.util.EnumSet"/>
  2321. </method>
  2322. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
  2323. abstract="false" native="false" synchronized="false"
  2324. static="true" final="false" visibility="public"
  2325. deprecated="not deprecated">
  2326. </method>
  2327. <method name="getNodeStates" return="java.util.EnumSet"
  2328. abstract="true" native="false" synchronized="false"
  2329. static="false" final="false" visibility="public"
  2330. deprecated="not deprecated">
  2331. <doc>
  2332. <![CDATA[The state to filter the cluster nodes with.]]>
  2333. </doc>
  2334. </method>
  2335. <method name="setNodeStates"
  2336. abstract="true" native="false" synchronized="false"
  2337. static="false" final="false" visibility="public"
  2338. deprecated="not deprecated">
  2339. <param name="states" type="java.util.EnumSet"/>
  2340. <doc>
  2341. <![CDATA[The state to filter the cluster nodes with.]]>
  2342. </doc>
  2343. </method>
  2344. <doc>
  2345. <![CDATA[<p>The request from clients to get a report of all nodes
  2346. in the cluster from the <code>ResourceManager</code>.</p>
  2347. The request will ask for all nodes in the given {@link NodeState}s.
  2348. @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
  2349. </doc>
  2350. </class>
  2351. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
  2352. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
  2353. <class name="GetClusterNodesResponse" extends="java.lang.Object"
  2354. abstract="true"
  2355. static="false" final="false" visibility="public"
  2356. deprecated="not deprecated">
  2357. <constructor name="GetClusterNodesResponse"
  2358. static="false" final="false" visibility="public"
  2359. deprecated="not deprecated">
  2360. </constructor>
  2361. <method name="getNodeReports" return="java.util.List"
  2362. abstract="true" native="false" synchronized="false"
  2363. static="false" final="false" visibility="public"
  2364. deprecated="not deprecated">
  2365. <doc>
  2366. <![CDATA[Get <code>NodeReport</code> for all nodes in the cluster.
  2367. @return <code>NodeReport</code> for all nodes in the cluster]]>
  2368. </doc>
  2369. </method>
  2370. <doc>
  2371. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  2372. requesting a {@link NodeReport} for all nodes.</p>
  2373. <p>The <code>NodeReport</code> contains per-node information such as
  2374. available resources, number of containers, tracking url, rack name, health
  2375. status etc.
  2376. @see NodeReport
  2377. @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
  2378. </doc>
  2379. </class>
  2380. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
  2381. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
  2382. <class name="GetContainerReportRequest" extends="java.lang.Object"
  2383. abstract="true"
  2384. static="false" final="false" visibility="public"
  2385. deprecated="not deprecated">
  2386. <constructor name="GetContainerReportRequest"
  2387. static="false" final="false" visibility="public"
  2388. deprecated="not deprecated">
  2389. </constructor>
  2390. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"
  2391. abstract="false" native="false" synchronized="false"
  2392. static="true" final="false" visibility="public"
  2393. deprecated="not deprecated">
  2394. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  2395. </method>
  2396. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  2397. abstract="true" native="false" synchronized="false"
  2398. static="false" final="false" visibility="public"
  2399. deprecated="not deprecated">
  2400. <doc>
  2401. <![CDATA[Get the <code>ContainerId</code> of the Container.
  2402. @return <code>ContainerId</code> of the Container]]>
  2403. </doc>
  2404. </method>
  2405. <method name="setContainerId"
  2406. abstract="true" native="false" synchronized="false"
  2407. static="false" final="false" visibility="public"
  2408. deprecated="not deprecated">
  2409. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  2410. <doc>
  2411. <![CDATA[Set the <code>ContainerId</code> of the container
  2412. @param containerId
  2413. <code>ContainerId</code> of the container]]>
  2414. </doc>
  2415. </method>
  2416. <doc>
  2417. <![CDATA[<p>
  2418. The request sent by a client to the <code>ResourceManager</code> to get an
  2419. {@link ContainerReport} for a container.
  2420. </p>]]>
  2421. </doc>
  2422. </class>
  2423. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
  2424. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
  2425. <class name="GetContainerReportResponse" extends="java.lang.Object"
  2426. abstract="true"
  2427. static="false" final="false" visibility="public"
  2428. deprecated="not deprecated">
  2429. <constructor name="GetContainerReportResponse"
  2430. static="false" final="false" visibility="public"
  2431. deprecated="not deprecated">
  2432. </constructor>
  2433. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
  2434. abstract="false" native="false" synchronized="false"
  2435. static="true" final="false" visibility="public"
  2436. deprecated="not deprecated">
  2437. <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
  2438. </method>
  2439. <method name="getContainerReport" return="org.apache.hadoop.yarn.api.records.ContainerReport"
  2440. abstract="true" native="false" synchronized="false"
  2441. static="false" final="false" visibility="public"
  2442. deprecated="not deprecated">
  2443. <doc>
  2444. <![CDATA[Get the <code>ContainerReport</code> for the container.
  2445. @return <code>ContainerReport</code> for the container]]>
  2446. </doc>
  2447. </method>
  2448. <method name="setContainerReport"
  2449. abstract="true" native="false" synchronized="false"
  2450. static="false" final="false" visibility="public"
  2451. deprecated="not deprecated">
  2452. <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
  2453. </method>
  2454. <doc>
  2455. <![CDATA[<p>
  2456. The response sent by the <code>ResourceManager</code> to a client requesting
  2457. a container report.
  2458. </p>
  2459. <p>
  2460. The response includes a {@link ContainerReport} which has details of a
  2461. container.
  2462. </p>]]>
  2463. </doc>
  2464. </class>
  2465. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
  2466. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
  2467. <class name="GetContainersRequest" extends="java.lang.Object"
  2468. abstract="true"
  2469. static="false" final="false" visibility="public"
  2470. deprecated="not deprecated">
  2471. <constructor name="GetContainersRequest"
  2472. static="false" final="false" visibility="public"
  2473. deprecated="not deprecated">
  2474. </constructor>
  2475. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"
  2476. abstract="false" native="false" synchronized="false"
  2477. static="true" final="false" visibility="public"
  2478. deprecated="not deprecated">
  2479. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2480. </method>
  2481. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2482. abstract="true" native="false" synchronized="false"
  2483. static="false" final="false" visibility="public"
  2484. deprecated="not deprecated">
  2485. <doc>
  2486. <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
  2487. @return <code>ApplicationAttemptId</code> of an application attempt]]>
  2488. </doc>
  2489. </method>
  2490. <method name="setApplicationAttemptId"
  2491. abstract="true" native="false" synchronized="false"
  2492. static="false" final="false" visibility="public"
  2493. deprecated="not deprecated">
  2494. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2495. <doc>
  2496. <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
  2497. @param applicationAttemptId
  2498. <code>ApplicationAttemptId</code> of an application attempt]]>
  2499. </doc>
  2500. </method>
  2501. <doc>
  2502. <![CDATA[<p>
  2503. The request from clients to get a list of container reports, which belong to
  2504. an application attempt from the <code>ResourceManager</code>.
  2505. </p>
  2506. @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
  2507. </doc>
  2508. </class>
  2509. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
  2510. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
  2511. <class name="GetContainersResponse" extends="java.lang.Object"
  2512. abstract="true"
  2513. static="false" final="false" visibility="public"
  2514. deprecated="not deprecated">
  2515. <constructor name="GetContainersResponse"
  2516. static="false" final="false" visibility="public"
  2517. deprecated="not deprecated">
  2518. </constructor>
  2519. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
  2520. abstract="false" native="false" synchronized="false"
  2521. static="true" final="false" visibility="public"
  2522. deprecated="not deprecated">
  2523. <param name="containers" type="java.util.List"/>
  2524. </method>
  2525. <method name="getContainerList" return="java.util.List"
  2526. abstract="true" native="false" synchronized="false"
  2527. static="false" final="false" visibility="public"
  2528. deprecated="not deprecated">
  2529. <doc>
  2530. <![CDATA[Get a list of <code>ContainerReport</code> for all the containers of an
  2531. application attempt.
  2532. @return a list of <code>ContainerReport</code> for all the containers of an
  2533. application attempt]]>
  2534. </doc>
  2535. </method>
  2536. <method name="setContainerList"
  2537. abstract="true" native="false" synchronized="false"
  2538. static="false" final="false" visibility="public"
  2539. deprecated="not deprecated">
  2540. <param name="containers" type="java.util.List"/>
  2541. <doc>
  2542. <![CDATA[Set a list of <code>ContainerReport</code> for all the containers of an
  2543. application attempt.
  2544. @param containers
  2545. a list of <code>ContainerReport</code> for all the containers of
  2546. an application attempt]]>
  2547. </doc>
  2548. </method>
  2549. <doc>
  2550. <![CDATA[<p>
  2551. The response sent by the <code>ResourceManager</code> to a client requesting
  2552. a list of {@link ContainerReport} for containers.
  2553. </p>
  2554. <p>
  2555. The <code>ContainerReport</code> for each container includes the container
  2556. details.
  2557. </p>
  2558. @see ContainerReport
  2559. @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
  2560. </doc>
  2561. </class>
  2562. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
  2563. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
  2564. <class name="GetContainerStatusesRequest" extends="java.lang.Object"
  2565. abstract="true"
  2566. static="false" final="false" visibility="public"
  2567. deprecated="not deprecated">
  2568. <constructor name="GetContainerStatusesRequest"
  2569. static="false" final="false" visibility="public"
  2570. deprecated="not deprecated">
  2571. </constructor>
  2572. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"
  2573. abstract="false" native="false" synchronized="false"
  2574. static="true" final="false" visibility="public"
  2575. deprecated="not deprecated">
  2576. <param name="containerIds" type="java.util.List"/>
  2577. </method>
  2578. <method name="getContainerIds" return="java.util.List"
  2579. abstract="true" native="false" synchronized="false"
  2580. static="false" final="false" visibility="public"
  2581. deprecated="not deprecated">
  2582. <doc>
  2583. <![CDATA[Get the list of <code>ContainerId</code>s of containers for which to obtain
  2584. the <code>ContainerStatus</code>.
  2585. @return the list of <code>ContainerId</code>s of containers for which to
  2586. obtain the <code>ContainerStatus</code>.]]>
  2587. </doc>
  2588. </method>
  2589. <method name="setContainerIds"
  2590. abstract="true" native="false" synchronized="false"
  2591. static="false" final="false" visibility="public"
  2592. deprecated="not deprecated">
  2593. <param name="containerIds" type="java.util.List"/>
  2594. <doc>
  2595. <![CDATA[Set a list of <code>ContainerId</code>s of containers for which to obtain
  2596. the <code>ContainerStatus</code>
  2597. @param containerIds
  2598. a list of <code>ContainerId</code>s of containers for which to
  2599. obtain the <code>ContainerStatus</code>]]>
  2600. </doc>
  2601. </method>
  2602. <doc>
  2603. <![CDATA[<p>
  2604. The request sent by the <code>ApplicationMaster</code> to the
  2605. <code>NodeManager</code> to get {@link ContainerStatus} of requested
  2606. containers.
  2607. </p>
  2608. @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
  2609. </doc>
  2610. </class>
  2611. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
  2612. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
  2613. <class name="GetContainerStatusesResponse" extends="java.lang.Object"
  2614. abstract="true"
  2615. static="false" final="false" visibility="public"
  2616. deprecated="not deprecated">
  2617. <constructor name="GetContainerStatusesResponse"
  2618. static="false" final="false" visibility="public"
  2619. deprecated="not deprecated">
  2620. </constructor>
  2621. <method name="getContainerStatuses" return="java.util.List"
  2622. abstract="true" native="false" synchronized="false"
  2623. static="false" final="false" visibility="public"
  2624. deprecated="not deprecated">
  2625. <doc>
  2626. <![CDATA[Get the <code>ContainerStatus</code>es of the requested containers.
  2627. @return <code>ContainerStatus</code>es of the requested containers.]]>
  2628. </doc>
  2629. </method>
  2630. <method name="getFailedRequests" return="java.util.Map"
  2631. abstract="true" native="false" synchronized="false"
  2632. static="false" final="false" visibility="public"
  2633. deprecated="not deprecated">
  2634. <doc>
  2635. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  2636. from per container for failed requests]]>
  2637. </doc>
  2638. </method>
  2639. <doc>
  2640. <![CDATA[<p>
  2641. The response sent by the <code>NodeManager</code> to the
  2642. <code>ApplicationMaster</code> when asked to obtain the
  2643. <code>ContainerStatus</code> of requested containers.
  2644. </p>
  2645. @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
  2646. </doc>
  2647. </class>
  2648. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
  2649. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
  2650. <class name="GetDelegationTokenRequest" extends="java.lang.Object"
  2651. abstract="true"
  2652. static="false" final="false" visibility="public"
  2653. deprecated="not deprecated">
  2654. <constructor name="GetDelegationTokenRequest"
  2655. static="false" final="false" visibility="public"
  2656. deprecated="not deprecated">
  2657. </constructor>
  2658. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"
  2659. abstract="false" native="false" synchronized="false"
  2660. static="true" final="false" visibility="public"
  2661. deprecated="not deprecated">
  2662. <param name="renewer" type="java.lang.String"/>
  2663. </method>
  2664. <method name="getRenewer" return="java.lang.String"
  2665. abstract="true" native="false" synchronized="false"
  2666. static="false" final="false" visibility="public"
  2667. deprecated="not deprecated">
  2668. </method>
  2669. <method name="setRenewer"
  2670. abstract="true" native="false" synchronized="false"
  2671. static="false" final="false" visibility="public"
  2672. deprecated="not deprecated">
  2673. <param name="renewer" type="java.lang.String"/>
  2674. </method>
  2675. <doc>
  2676. <![CDATA[The request issued by the client to get a delegation token from
  2677. the {@code ResourceManager}.
  2678. for more information.]]>
  2679. </doc>
  2680. </class>
  2681. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
  2682. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
  2683. <class name="GetDelegationTokenResponse" extends="java.lang.Object"
  2684. abstract="true"
  2685. static="false" final="false" visibility="public"
  2686. deprecated="not deprecated">
  2687. <constructor name="GetDelegationTokenResponse"
  2688. static="false" final="false" visibility="public"
  2689. deprecated="not deprecated">
  2690. </constructor>
  2691. <method name="getRMDelegationToken" return="org.apache.hadoop.yarn.api.records.Token"
  2692. abstract="true" native="false" synchronized="false"
  2693. static="false" final="false" visibility="public"
  2694. deprecated="not deprecated">
  2695. <doc>
  2696. <![CDATA[The Delegation tokens have a identifier which maps to
  2697. {@link AbstractDelegationTokenIdentifier}.]]>
  2698. </doc>
  2699. </method>
  2700. <doc>
  2701. <![CDATA[Response to a {@link GetDelegationTokenRequest} request
  2702. from the client. The response contains the token that
  2703. can be used by the containers to talk to ClientRMService.]]>
  2704. </doc>
  2705. </class>
  2706. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
  2707. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
  2708. <class name="GetNewApplicationRequest" extends="java.lang.Object"
  2709. abstract="true"
  2710. static="false" final="false" visibility="public"
  2711. deprecated="not deprecated">
  2712. <constructor name="GetNewApplicationRequest"
  2713. static="false" final="false" visibility="public"
  2714. deprecated="not deprecated">
  2715. </constructor>
  2716. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"
  2717. abstract="false" native="false" synchronized="false"
  2718. static="true" final="false" visibility="public"
  2719. deprecated="not deprecated">
  2720. </method>
  2721. <doc>
  2722. <![CDATA[<p>The request sent by clients to get a new {@link ApplicationId} for
  2723. submitting an application.</p>
  2724. <p>Currently, this is empty.</p>
  2725. @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
  2726. </doc>
  2727. </class>
  2728. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
  2729. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
  2730. <class name="GetNewApplicationResponse" extends="java.lang.Object"
  2731. abstract="true"
  2732. static="false" final="false" visibility="public"
  2733. deprecated="not deprecated">
  2734. <constructor name="GetNewApplicationResponse"
  2735. static="false" final="false" visibility="public"
  2736. deprecated="not deprecated">
  2737. </constructor>
  2738. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2739. abstract="true" native="false" synchronized="false"
  2740. static="false" final="false" visibility="public"
  2741. deprecated="not deprecated">
  2742. <doc>
  2743. <![CDATA[Get the <em>new</em> <code>ApplicationId</code> allocated by the
  2744. <code>ResourceManager</code>.
  2745. @return <em>new</em> <code>ApplicationId</code> allocated by the
  2746. <code>ResourceManager</code>]]>
  2747. </doc>
  2748. </method>
  2749. <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  2750. abstract="true" native="false" synchronized="false"
  2751. static="false" final="false" visibility="public"
  2752. deprecated="not deprecated">
  2753. <doc>
  2754. <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
  2755. <code>ResourceManager</code> in the cluster.
  2756. @return maximum capability of allocated resources in the cluster]]>
  2757. </doc>
  2758. </method>
  2759. <doc>
  2760. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client for
  2761. a request to get a new {@link ApplicationId} for submitting applications.</p>
  2762. <p>Clients can submit an application with the returned
  2763. {@link ApplicationId}.</p>
  2764. @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
  2765. </doc>
  2766. </class>
  2767. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
  2768. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest -->
  2769. <class name="GetNodesToLabelsRequest" extends="java.lang.Object"
  2770. abstract="true"
  2771. static="false" final="false" visibility="public"
  2772. deprecated="not deprecated">
  2773. <constructor name="GetNodesToLabelsRequest"
  2774. static="false" final="false" visibility="public"
  2775. deprecated="not deprecated">
  2776. </constructor>
  2777. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest"
  2778. abstract="false" native="false" synchronized="false"
  2779. static="true" final="false" visibility="public"
  2780. deprecated="not deprecated">
  2781. </method>
  2782. </class>
  2783. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest -->
  2784. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse -->
  2785. <class name="GetNodesToLabelsResponse" extends="java.lang.Object"
  2786. abstract="true"
  2787. static="false" final="false" visibility="public"
  2788. deprecated="not deprecated">
  2789. <constructor name="GetNodesToLabelsResponse"
  2790. static="false" final="false" visibility="public"
  2791. deprecated="not deprecated">
  2792. </constructor>
  2793. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse"
  2794. abstract="false" native="false" synchronized="false"
  2795. static="true" final="false" visibility="public"
  2796. deprecated="not deprecated">
  2797. <param name="map" type="java.util.Map"/>
  2798. </method>
  2799. <method name="setNodeToLabels"
  2800. abstract="true" native="false" synchronized="false"
  2801. static="false" final="false" visibility="public"
  2802. deprecated="not deprecated">
  2803. <param name="map" type="java.util.Map"/>
  2804. </method>
  2805. <method name="getNodeToLabels" return="java.util.Map"
  2806. abstract="true" native="false" synchronized="false"
  2807. static="false" final="false" visibility="public"
  2808. deprecated="not deprecated">
  2809. </method>
  2810. </class>
  2811. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse -->
  2812. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
  2813. <class name="GetQueueInfoRequest" extends="java.lang.Object"
  2814. abstract="true"
  2815. static="false" final="false" visibility="public"
  2816. deprecated="not deprecated">
  2817. <constructor name="GetQueueInfoRequest"
  2818. static="false" final="false" visibility="public"
  2819. deprecated="not deprecated">
  2820. </constructor>
  2821. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"
  2822. abstract="false" native="false" synchronized="false"
  2823. static="true" final="false" visibility="public"
  2824. deprecated="not deprecated">
  2825. <param name="queueName" type="java.lang.String"/>
  2826. <param name="includeApplications" type="boolean"/>
  2827. <param name="includeChildQueues" type="boolean"/>
  2828. <param name="recursive" type="boolean"/>
  2829. </method>
  2830. <method name="getQueueName" return="java.lang.String"
  2831. abstract="true" native="false" synchronized="false"
  2832. static="false" final="false" visibility="public"
  2833. deprecated="not deprecated">
  2834. <doc>
  2835. <![CDATA[Get the <em>queue name</em> for which to get queue information.
  2836. @return <em>queue name</em> for which to get queue information]]>
  2837. </doc>
  2838. </method>
  2839. <method name="setQueueName"
  2840. abstract="true" native="false" synchronized="false"
  2841. static="false" final="false" visibility="public"
  2842. deprecated="not deprecated">
  2843. <param name="queueName" type="java.lang.String"/>
  2844. <doc>
  2845. <![CDATA[Set the <em>queue name</em> for which to get queue information
  2846. @param queueName <em>queue name</em> for which to get queue information]]>
  2847. </doc>
  2848. </method>
  2849. <method name="getIncludeApplications" return="boolean"
  2850. abstract="true" native="false" synchronized="false"
  2851. static="false" final="false" visibility="public"
  2852. deprecated="not deprecated">
  2853. <doc>
  2854. <![CDATA[Is information about <em>active applications<e/m> required?
  2855. @return <code>true</code> if applications' information is to be included,
  2856. else <code>false</code>]]>
  2857. </doc>
  2858. </method>
  2859. <method name="setIncludeApplications"
  2860. abstract="true" native="false" synchronized="false"
  2861. static="false" final="false" visibility="public"
  2862. deprecated="not deprecated">
  2863. <param name="includeApplications" type="boolean"/>
  2864. <doc>
  2865. <![CDATA[Should we get fetch information about <em>active applications</em>?
  2866. @param includeApplications fetch information about <em>active
  2867. applications</em>?]]>
  2868. </doc>
  2869. </method>
  2870. <method name="getIncludeChildQueues" return="boolean"
  2871. abstract="true" native="false" synchronized="false"
  2872. static="false" final="false" visibility="public"
  2873. deprecated="not deprecated">
  2874. <doc>
  2875. <![CDATA[Is information about <em>child queues</em> required?
  2876. @return <code>true</code> if information about child queues is required,
  2877. else <code>false</code>]]>
  2878. </doc>
  2879. </method>
  2880. <method name="setIncludeChildQueues"
  2881. abstract="true" native="false" synchronized="false"
  2882. static="false" final="false" visibility="public"
  2883. deprecated="not deprecated">
  2884. <param name="includeChildQueues" type="boolean"/>
  2885. <doc>
  2886. <![CDATA[Should we fetch information about <em>child queues</em>?
  2887. @param includeChildQueues fetch information about <em>child queues</em>?]]>
  2888. </doc>
  2889. </method>
  2890. <method name="getRecursive" return="boolean"
  2891. abstract="true" native="false" synchronized="false"
  2892. static="false" final="false" visibility="public"
  2893. deprecated="not deprecated">
  2894. <doc>
  2895. <![CDATA[Is information on the entire <em>child queue hierarchy</em> required?
  2896. @return <code>true</code> if information about entire hierarchy is
  2897. required, <code>false</code> otherwise]]>
  2898. </doc>
  2899. </method>
  2900. <method name="setRecursive"
  2901. abstract="true" native="false" synchronized="false"
  2902. static="false" final="false" visibility="public"
  2903. deprecated="not deprecated">
  2904. <param name="recursive" type="boolean"/>
  2905. <doc>
  2906. <![CDATA[Should we fetch information on the entire <em>child queue hierarchy</em>?
  2907. @param recursive fetch information on the entire <em>child queue
  2908. hierarchy</em>?]]>
  2909. </doc>
  2910. </method>
  2911. <doc>
  2912. <![CDATA[<p>The request sent by clients to get <em>queue information</em>
  2913. from the <code>ResourceManager</code>.</p>
  2914. @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
  2915. </doc>
  2916. </class>
  2917. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
  2918. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
  2919. <class name="GetQueueInfoResponse" extends="java.lang.Object"
  2920. abstract="true"
  2921. static="false" final="false" visibility="public"
  2922. deprecated="not deprecated">
  2923. <constructor name="GetQueueInfoResponse"
  2924. static="false" final="false" visibility="public"
  2925. deprecated="not deprecated">
  2926. </constructor>
  2927. <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.records.QueueInfo"
  2928. abstract="true" native="false" synchronized="false"
  2929. static="false" final="false" visibility="public"
  2930. deprecated="not deprecated">
  2931. <doc>
  2932. <![CDATA[Get the <code>QueueInfo</code> for the specified queue.
  2933. @return <code>QueueInfo</code> for the specified queue]]>
  2934. </doc>
  2935. </method>
  2936. <doc>
  2937. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  2938. requesting information about queues in the system.</p>
  2939. <p>The response includes a {@link QueueInfo} which has details such as
  2940. queue name, used/total capacities, running applications, child queues etc
  2941. .</p>
  2942. @see QueueInfo
  2943. @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
  2944. </doc>
  2945. </class>
  2946. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
  2947. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
  2948. <class name="GetQueueUserAclsInfoRequest" extends="java.lang.Object"
  2949. abstract="true"
  2950. static="false" final="false" visibility="public"
  2951. deprecated="not deprecated">
  2952. <constructor name="GetQueueUserAclsInfoRequest"
  2953. static="false" final="false" visibility="public"
  2954. deprecated="not deprecated">
  2955. </constructor>
  2956. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"
  2957. abstract="false" native="false" synchronized="false"
  2958. static="true" final="false" visibility="public"
  2959. deprecated="not deprecated">
  2960. </method>
  2961. <doc>
  2962. <![CDATA[<p>The request sent by clients to the <code>ResourceManager</code> to
  2963. get queue acls for the <em>current user</em>.</p>
  2964. <p>Currently, this is empty.</p>
  2965. @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  2966. </doc>
  2967. </class>
  2968. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
  2969. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
  2970. <class name="GetQueueUserAclsInfoResponse" extends="java.lang.Object"
  2971. abstract="true"
  2972. static="false" final="false" visibility="public"
  2973. deprecated="not deprecated">
  2974. <constructor name="GetQueueUserAclsInfoResponse"
  2975. static="false" final="false" visibility="public"
  2976. deprecated="not deprecated">
  2977. </constructor>
  2978. <method name="getUserAclsInfoList" return="java.util.List"
  2979. abstract="true" native="false" synchronized="false"
  2980. static="false" final="false" visibility="public"
  2981. deprecated="not deprecated">
  2982. <doc>
  2983. <![CDATA[Get the <code>QueueUserACLInfo</code> per queue for the user.
  2984. @return <code>QueueUserACLInfo</code> per queue for the user]]>
  2985. </doc>
  2986. </method>
  2987. <doc>
  2988. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to clients
  2989. seeking queue acls for the user.</p>
  2990. <p>The response contains a list of {@link QueueUserACLInfo} which
  2991. provides information about {@link QueueACL} per queue.</p>
  2992. @see QueueACL
  2993. @see QueueUserACLInfo
  2994. @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  2995. </doc>
  2996. </class>
  2997. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
  2998. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
  2999. <class name="KillApplicationRequest" extends="java.lang.Object"
  3000. abstract="true"
  3001. static="false" final="false" visibility="public"
  3002. deprecated="not deprecated">
  3003. <constructor name="KillApplicationRequest"
  3004. static="false" final="false" visibility="public"
  3005. deprecated="not deprecated">
  3006. </constructor>
  3007. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"
  3008. abstract="false" native="false" synchronized="false"
  3009. static="true" final="false" visibility="public"
  3010. deprecated="not deprecated">
  3011. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3012. </method>
  3013. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3014. abstract="true" native="false" synchronized="false"
  3015. static="false" final="false" visibility="public"
  3016. deprecated="not deprecated">
  3017. <doc>
  3018. <![CDATA[Get the <code>ApplicationId</code> of the application to be aborted.
  3019. @return <code>ApplicationId</code> of the application to be aborted]]>
  3020. </doc>
  3021. </method>
  3022. <method name="setApplicationId"
  3023. abstract="true" native="false" synchronized="false"
  3024. static="false" final="false" visibility="public"
  3025. deprecated="not deprecated">
  3026. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3027. </method>
  3028. <doc>
  3029. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  3030. to abort a submitted application.</p>
  3031. <p>The request includes the {@link ApplicationId} of the application to be
  3032. aborted.</p>
  3033. @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
  3034. </doc>
  3035. </class>
  3036. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
  3037. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
  3038. <class name="KillApplicationResponse" extends="java.lang.Object"
  3039. abstract="true"
  3040. static="false" final="false" visibility="public"
  3041. deprecated="not deprecated">
  3042. <constructor name="KillApplicationResponse"
  3043. static="false" final="false" visibility="public"
  3044. deprecated="not deprecated">
  3045. </constructor>
  3046. <method name="getIsKillCompleted" return="boolean"
  3047. abstract="true" native="false" synchronized="false"
  3048. static="false" final="false" visibility="public"
  3049. deprecated="not deprecated">
  3050. <doc>
  3051. <![CDATA[Get the flag which indicates that the process of killing application is completed or not.]]>
  3052. </doc>
  3053. </method>
  3054. <doc>
  3055. <![CDATA[<p>
  3056. The response sent by the <code>ResourceManager</code> to the client aborting
  3057. a submitted application.
  3058. </p>
  3059. <p>
  3060. The response, includes:
  3061. <ul>
  3062. <li>A flag which indicates that the process of killing the application is
  3063. completed or not.</li>
  3064. </ul>
  3065. Note: user is recommended to wait until this flag becomes true, otherwise if
  3066. the <code>ResourceManager</code> crashes before the process of killing the
  3067. application is completed, the <code>ResourceManager</code> may retry this
  3068. application on recovery.
  3069. </p>
  3070. @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
  3071. </doc>
  3072. </class>
  3073. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
  3074. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
  3075. <class name="MoveApplicationAcrossQueuesRequest" extends="java.lang.Object"
  3076. abstract="true"
  3077. static="false" final="false" visibility="public"
  3078. deprecated="not deprecated">
  3079. <constructor name="MoveApplicationAcrossQueuesRequest"
  3080. static="false" final="false" visibility="public"
  3081. deprecated="not deprecated">
  3082. </constructor>
  3083. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"
  3084. abstract="false" native="false" synchronized="false"
  3085. static="true" final="false" visibility="public"
  3086. deprecated="not deprecated">
  3087. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3088. <param name="queue" type="java.lang.String"/>
  3089. </method>
  3090. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3091. abstract="true" native="false" synchronized="false"
  3092. static="false" final="false" visibility="public"
  3093. deprecated="not deprecated">
  3094. <doc>
  3095. <![CDATA[Get the <code>ApplicationId</code> of the application to be moved.
  3096. @return <code>ApplicationId</code> of the application to be moved]]>
  3097. </doc>
  3098. </method>
  3099. <method name="setApplicationId"
  3100. abstract="true" native="false" synchronized="false"
  3101. static="false" final="false" visibility="public"
  3102. deprecated="not deprecated">
  3103. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3104. <doc>
  3105. <![CDATA[Set the <code>ApplicationId</code> of the application to be moved.
  3106. @param appId <code>ApplicationId</code> of the application to be moved]]>
  3107. </doc>
  3108. </method>
  3109. <method name="getTargetQueue" return="java.lang.String"
  3110. abstract="true" native="false" synchronized="false"
  3111. static="false" final="false" visibility="public"
  3112. deprecated="not deprecated">
  3113. <doc>
  3114. <![CDATA[Get the queue to place the application in.
  3115. @return the name of the queue to place the application in]]>
  3116. </doc>
  3117. </method>
  3118. <method name="setTargetQueue"
  3119. abstract="true" native="false" synchronized="false"
  3120. static="false" final="false" visibility="public"
  3121. deprecated="not deprecated">
  3122. <param name="queue" type="java.lang.String"/>
  3123. <doc>
  3124. <![CDATA[Get the queue to place the application in.
  3125. @param queue the name of the queue to place the application in]]>
  3126. </doc>
  3127. </method>
  3128. <doc>
  3129. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  3130. to move a submitted application to a different queue.</p>
  3131. <p>The request includes the {@link ApplicationId} of the application to be
  3132. moved and the queue to place it in.</p>
  3133. @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
  3134. </doc>
  3135. </class>
  3136. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
  3137. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
  3138. <class name="MoveApplicationAcrossQueuesResponse" extends="java.lang.Object"
  3139. abstract="false"
  3140. static="false" final="false" visibility="public"
  3141. deprecated="not deprecated">
  3142. <constructor name="MoveApplicationAcrossQueuesResponse"
  3143. static="false" final="false" visibility="public"
  3144. deprecated="not deprecated">
  3145. </constructor>
  3146. <doc>
  3147. <![CDATA[<p>
  3148. The response sent by the <code>ResourceManager</code> to the client moving
  3149. a submitted application to a different queue.
  3150. </p>
  3151. <p>
  3152. A response without exception means that the move has completed successfully.
  3153. </p>
  3154. @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
  3155. </doc>
  3156. </class>
  3157. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
  3158. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
  3159. <class name="RegisterApplicationMasterRequest" extends="java.lang.Object"
  3160. abstract="true"
  3161. static="false" final="false" visibility="public"
  3162. deprecated="not deprecated">
  3163. <constructor name="RegisterApplicationMasterRequest"
  3164. static="false" final="false" visibility="public"
  3165. deprecated="not deprecated">
  3166. </constructor>
  3167. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"
  3168. abstract="false" native="false" synchronized="false"
  3169. static="true" final="false" visibility="public"
  3170. deprecated="not deprecated">
  3171. <param name="host" type="java.lang.String"/>
  3172. <param name="port" type="int"/>
  3173. <param name="trackingUrl" type="java.lang.String"/>
  3174. <doc>
  3175. <![CDATA[Create a new instance of <code>RegisterApplicationMasterRequest</code>.
  3176. If <em>port, trackingUrl</em> is not used, use the following default value:
  3177. <ul>
  3178. <li>port: -1</li>
  3179. <li>trackingUrl: null</li>
  3180. </ul>
  3181. The port is allowed to be any integer larger than or equal to -1.
  3182. @return the new instance of <code>RegisterApplicationMasterRequest</code>]]>
  3183. </doc>
  3184. </method>
  3185. <method name="getHost" return="java.lang.String"
  3186. abstract="true" native="false" synchronized="false"
  3187. static="false" final="false" visibility="public"
  3188. deprecated="not deprecated">
  3189. <doc>
  3190. <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code> is
  3191. running.
  3192. @return <em>host</em> on which the <code>ApplicationMaster</code> is running]]>
  3193. </doc>
  3194. </method>
  3195. <method name="setHost"
  3196. abstract="true" native="false" synchronized="false"
  3197. static="false" final="false" visibility="public"
  3198. deprecated="not deprecated">
  3199. <param name="host" type="java.lang.String"/>
  3200. <doc>
  3201. <![CDATA[Set the <em>host</em> on which the <code>ApplicationMaster</code> is
  3202. running.
  3203. @param host <em>host</em> on which the <code>ApplicationMaster</code>
  3204. is running]]>
  3205. </doc>
  3206. </method>
  3207. <method name="getRpcPort" return="int"
  3208. abstract="true" native="false" synchronized="false"
  3209. static="false" final="false" visibility="public"
  3210. deprecated="not deprecated">
  3211. <doc>
  3212. <![CDATA[Get the <em>RPC port</em> on which the <code>ApplicationMaster</code>
  3213. is responding.
  3214. @return the <em>RPC port<em> on which the <code>ApplicationMaster</code> is
  3215. responding]]>
  3216. </doc>
  3217. </method>
  3218. <method name="setRpcPort"
  3219. abstract="true" native="false" synchronized="false"
  3220. static="false" final="false" visibility="public"
  3221. deprecated="not deprecated">
  3222. <param name="port" type="int"/>
  3223. <doc>
  3224. <![CDATA[Set the <em>RPC port<em> on which the <code>ApplicationMaster</code> is
  3225. responding.
  3226. @param port <em>RPC port<em> on which the <code>ApplicationMaster</code> is
  3227. responding]]>
  3228. </doc>
  3229. </method>
  3230. <method name="getTrackingUrl" return="java.lang.String"
  3231. abstract="true" native="false" synchronized="false"
  3232. static="false" final="false" visibility="public"
  3233. deprecated="not deprecated">
  3234. <doc>
  3235. <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
  3236. This url if contains scheme then that will be used by resource manager
  3237. web application proxy otherwise it will default to http.
  3238. @return <em>tracking URL</em> for the <code>ApplicationMaster</code>]]>
  3239. </doc>
  3240. </method>
  3241. <method name="setTrackingUrl"
  3242. abstract="true" native="false" synchronized="false"
  3243. static="false" final="false" visibility="public"
  3244. deprecated="not deprecated">
  3245. <param name="trackingUrl" type="java.lang.String"/>
  3246. <doc>
  3247. <![CDATA[Set the <em>tracking URL</em>for the <code>ApplicationMaster</code> while
  3248. it is running. This is the web-URL to which ResourceManager or
  3249. web-application proxy will redirect client/users while the application and
  3250. the <code>ApplicationMaster</code> are still running.
  3251. <p>
  3252. If the passed url has a scheme then that will be used by the
  3253. ResourceManager and web-application proxy, otherwise the scheme will
  3254. default to http.
  3255. </p>
  3256. <p>
  3257. Empty, null, "N/A" strings are all valid besides a real URL. In case an url
  3258. isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
  3259. <p>
  3260. @param trackingUrl
  3261. <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  3262. </doc>
  3263. </method>
  3264. <doc>
  3265. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to
  3266. <code>ResourceManager</code> on registration.</p>
  3267. <p>The registration includes details such as:
  3268. <ul>
  3269. <li>Hostname on which the AM is running.</li>
  3270. <li>RPC Port</li>
  3271. <li>Tracking URL</li>
  3272. </ul>
  3273. </p>
  3274. @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
  3275. </doc>
  3276. </class>
  3277. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
  3278. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
  3279. <class name="RegisterApplicationMasterResponse" extends="java.lang.Object"
  3280. abstract="true"
  3281. static="false" final="false" visibility="public"
  3282. deprecated="not deprecated">
  3283. <constructor name="RegisterApplicationMasterResponse"
  3284. static="false" final="false" visibility="public"
  3285. deprecated="not deprecated">
  3286. </constructor>
  3287. <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  3288. abstract="true" native="false" synchronized="false"
  3289. static="false" final="false" visibility="public"
  3290. deprecated="not deprecated">
  3291. <doc>
  3292. <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
  3293. <code>ResourceManager</code> in the cluster.
  3294. @return maximum capability of allocated resources in the cluster]]>
  3295. </doc>
  3296. </method>
  3297. <method name="getApplicationACLs" return="java.util.Map"
  3298. abstract="true" native="false" synchronized="false"
  3299. static="false" final="false" visibility="public"
  3300. deprecated="not deprecated">
  3301. <doc>
  3302. <![CDATA[Get the <code>ApplicationACL</code>s for the application.
  3303. @return all the <code>ApplicationACL</code>s]]>
  3304. </doc>
  3305. </method>
  3306. <method name="getClientToAMTokenMasterKey" return="java.nio.ByteBuffer"
  3307. abstract="true" native="false" synchronized="false"
  3308. static="false" final="false" visibility="public"
  3309. deprecated="not deprecated">
  3310. <doc>
  3311. <![CDATA[<p>Get ClientToAMToken master key.</p>
  3312. <p>The ClientToAMToken master key is sent to <code>ApplicationMaster</code>
  3313. by <code>ResourceManager</code> via {@link RegisterApplicationMasterResponse}
  3314. , used to verify corresponding ClientToAMToken.</p>]]>
  3315. </doc>
  3316. </method>
  3317. <method name="setClientToAMTokenMasterKey"
  3318. abstract="true" native="false" synchronized="false"
  3319. static="false" final="false" visibility="public"
  3320. deprecated="not deprecated">
  3321. <param name="key" type="java.nio.ByteBuffer"/>
  3322. <doc>
  3323. <![CDATA[Set ClientToAMToken master key.]]>
  3324. </doc>
  3325. </method>
  3326. <method name="getQueue" return="java.lang.String"
  3327. abstract="true" native="false" synchronized="false"
  3328. static="false" final="false" visibility="public"
  3329. deprecated="not deprecated">
  3330. <doc>
  3331. <![CDATA[<p>Get the queue that the application was placed in.<p>]]>
  3332. </doc>
  3333. </method>
  3334. <method name="setQueue"
  3335. abstract="true" native="false" synchronized="false"
  3336. static="false" final="false" visibility="public"
  3337. deprecated="not deprecated">
  3338. <param name="queue" type="java.lang.String"/>
  3339. <doc>
  3340. <![CDATA[<p>Set the queue that the application was placed in.<p>]]>
  3341. </doc>
  3342. </method>
  3343. <method name="getContainersFromPreviousAttempts" return="java.util.List"
  3344. abstract="true" native="false" synchronized="false"
  3345. static="false" final="false" visibility="public"
  3346. deprecated="not deprecated">
  3347. <doc>
  3348. <![CDATA[<p>
  3349. Get the list of running containers as viewed by
  3350. <code>ResourceManager</code> from previous application attempts.
  3351. </p>
  3352. @return the list of running containers as viewed by
  3353. <code>ResourceManager</code> from previous application attempts
  3354. @see RegisterApplicationMasterResponse#getNMTokensFromPreviousAttempts()]]>
  3355. </doc>
  3356. </method>
  3357. <method name="getNMTokensFromPreviousAttempts" return="java.util.List"
  3358. abstract="true" native="false" synchronized="false"
  3359. static="false" final="false" visibility="public"
  3360. deprecated="not deprecated">
  3361. <doc>
  3362. <![CDATA[Get the list of NMTokens for communicating with the NMs where the
  3363. containers of previous application attempts are running.
  3364. @return the list of NMTokens for communicating with the NMs where the
  3365. containers of previous application attempts are running.
  3366. @see RegisterApplicationMasterResponse#getContainersFromPreviousAttempts()]]>
  3367. </doc>
  3368. </method>
  3369. <method name="getSchedulerResourceTypes" return="java.util.EnumSet"
  3370. abstract="true" native="false" synchronized="false"
  3371. static="false" final="false" visibility="public"
  3372. deprecated="not deprecated">
  3373. <doc>
  3374. <![CDATA[Get a set of the resource types considered by the scheduler.
  3375. @return a Map of RM settings]]>
  3376. </doc>
  3377. </method>
  3378. <doc>
  3379. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a new
  3380. <code>ApplicationMaster</code> on registration.</p>
  3381. <p>The response contains critical details such as:
  3382. <ul>
  3383. <li>Maximum capability for allocated resources in the cluster.</li>
  3384. <li><code>ApplicationACL</code>s for the application.</li>
  3385. <li>ClientToAMToken master key.</li>
  3386. </ul>
  3387. </p>
  3388. @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
  3389. </doc>
  3390. </class>
  3391. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
  3392. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
  3393. <class name="ReservationDeleteRequest" extends="java.lang.Object"
  3394. abstract="true"
  3395. static="false" final="false" visibility="public"
  3396. deprecated="not deprecated">
  3397. <constructor name="ReservationDeleteRequest"
  3398. static="false" final="false" visibility="public"
  3399. deprecated="not deprecated">
  3400. </constructor>
  3401. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"
  3402. abstract="false" native="false" synchronized="false"
  3403. static="true" final="false" visibility="public"
  3404. deprecated="not deprecated">
  3405. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3406. </method>
  3407. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  3408. abstract="true" native="false" synchronized="false"
  3409. static="false" final="false" visibility="public"
  3410. deprecated="not deprecated">
  3411. <doc>
  3412. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  3413. allocation in the scheduler (between start and end time of this
  3414. reservation)
  3415. @return the {@link ReservationId} representing the unique id of the
  3416. corresponding reserved resource allocation in the scheduler]]>
  3417. </doc>
  3418. </method>
  3419. <method name="setReservationId"
  3420. abstract="true" native="false" synchronized="false"
  3421. static="false" final="false" visibility="public"
  3422. deprecated="not deprecated">
  3423. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3424. <doc>
  3425. <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
  3426. allocation in the scheduler (between start and end time of this
  3427. reservation)
  3428. @param reservationId the {@link ReservationId} representing the the unique
  3429. id of the corresponding reserved resource allocation in the
  3430. scheduler]]>
  3431. </doc>
  3432. </method>
  3433. <doc>
  3434. <![CDATA[{@link ReservationDeleteRequest} captures the set of requirements the user
  3435. has to delete an existing reservation.
  3436. @see ReservationDefinition]]>
  3437. </doc>
  3438. </class>
  3439. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
  3440. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
  3441. <class name="ReservationDeleteResponse" extends="java.lang.Object"
  3442. abstract="true"
  3443. static="false" final="false" visibility="public"
  3444. deprecated="not deprecated">
  3445. <constructor name="ReservationDeleteResponse"
  3446. static="false" final="false" visibility="public"
  3447. deprecated="not deprecated">
  3448. </constructor>
  3449. <doc>
  3450. <![CDATA[{@link ReservationDeleteResponse} contains the answer of the admission
  3451. control system in the {@code ResourceManager} to a reservation delete
  3452. operation. Currently response is empty if the operation was successful, if
  3453. not an exception reporting reason for a failure.
  3454. @see ReservationDefinition]]>
  3455. </doc>
  3456. </class>
  3457. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
  3458. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
  3459. <class name="ReservationSubmissionRequest" extends="java.lang.Object"
  3460. abstract="true"
  3461. static="false" final="false" visibility="public"
  3462. deprecated="not deprecated">
  3463. <constructor name="ReservationSubmissionRequest"
  3464. static="false" final="false" visibility="public"
  3465. deprecated="not deprecated">
  3466. </constructor>
  3467. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"
  3468. abstract="false" native="false" synchronized="false"
  3469. static="true" final="false" visibility="public"
  3470. deprecated="not deprecated">
  3471. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3472. <param name="queueName" type="java.lang.String"/>
  3473. </method>
  3474. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  3475. abstract="true" native="false" synchronized="false"
  3476. static="false" final="false" visibility="public"
  3477. deprecated="not deprecated">
  3478. <doc>
  3479. <![CDATA[Get the {@link ReservationDefinition} representing the user constraints for
  3480. this reservation
  3481. @return the reservation definition representing user constraints]]>
  3482. </doc>
  3483. </method>
  3484. <method name="setReservationDefinition"
  3485. abstract="true" native="false" synchronized="false"
  3486. static="false" final="false" visibility="public"
  3487. deprecated="not deprecated">
  3488. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3489. <doc>
  3490. <![CDATA[Set the {@link ReservationDefinition} representing the user constraints for
  3491. this reservation
  3492. @param reservationDefinition the reservation request representing the
  3493. reservation]]>
  3494. </doc>
  3495. </method>
  3496. <method name="getQueue" return="java.lang.String"
  3497. abstract="true" native="false" synchronized="false"
  3498. static="false" final="false" visibility="public"
  3499. deprecated="not deprecated">
  3500. <doc>
  3501. <![CDATA[Get the name of the {@code Plan} that corresponds to the name of the
  3502. {@link QueueInfo} in the scheduler to which the reservation will be
  3503. submitted to.
  3504. @return the name of the {@code Plan} that corresponds to the name of the
  3505. {@link QueueInfo} in the scheduler to which the reservation will be
  3506. submitted to]]>
  3507. </doc>
  3508. </method>
  3509. <method name="setQueue"
  3510. abstract="true" native="false" synchronized="false"
  3511. static="false" final="false" visibility="public"
  3512. deprecated="not deprecated">
  3513. <param name="queueName" type="java.lang.String"/>
  3514. <doc>
  3515. <![CDATA[Set the name of the {@code Plan} that corresponds to the name of the
  3516. {@link QueueInfo} in the scheduler to which the reservation will be
  3517. submitted to
  3518. @param queueName the name of the parent {@code Plan} that corresponds to
  3519. the name of the {@link QueueInfo} in the scheduler to which the
  3520. reservation will be submitted to]]>
  3521. </doc>
  3522. </method>
  3523. <doc>
  3524. <![CDATA[{@link ReservationSubmissionRequest} captures the set of requirements the
  3525. user has to create a reservation.
  3526. @see ReservationDefinition]]>
  3527. </doc>
  3528. </class>
  3529. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
  3530. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
  3531. <class name="ReservationSubmissionResponse" extends="java.lang.Object"
  3532. abstract="true"
  3533. static="false" final="false" visibility="public"
  3534. deprecated="not deprecated">
  3535. <constructor name="ReservationSubmissionResponse"
  3536. static="false" final="false" visibility="public"
  3537. deprecated="not deprecated">
  3538. </constructor>
  3539. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  3540. abstract="true" native="false" synchronized="false"
  3541. static="false" final="false" visibility="public"
  3542. deprecated="not deprecated">
  3543. <doc>
  3544. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  3545. allocation in the scheduler (between start and end time of this
  3546. reservation)
  3547. @return the {@link ReservationId} representing the unique id of the
  3548. corresponding reserved resource allocation in the scheduler]]>
  3549. </doc>
  3550. </method>
  3551. <doc>
  3552. <![CDATA[{@link ReservationSubmissionResponse} contains the answer of the admission
  3553. control system in the {@code ResourceManager} to a reservation create
  3554. operation. Response contains a {@link ReservationId} if the operation was
  3555. successful, if not an exception reporting reason for a failure.
  3556. @see ReservationDefinition]]>
  3557. </doc>
  3558. </class>
  3559. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
  3560. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
  3561. <class name="ReservationUpdateRequest" extends="java.lang.Object"
  3562. abstract="true"
  3563. static="false" final="false" visibility="public"
  3564. deprecated="not deprecated">
  3565. <constructor name="ReservationUpdateRequest"
  3566. static="false" final="false" visibility="public"
  3567. deprecated="not deprecated">
  3568. </constructor>
  3569. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"
  3570. abstract="false" native="false" synchronized="false"
  3571. static="true" final="false" visibility="public"
  3572. deprecated="not deprecated">
  3573. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3574. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3575. </method>
  3576. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  3577. abstract="true" native="false" synchronized="false"
  3578. static="false" final="false" visibility="public"
  3579. deprecated="not deprecated">
  3580. <doc>
  3581. <![CDATA[Get the {@link ReservationDefinition} representing the updated user
  3582. constraints for this reservation
  3583. @return the reservation definition representing user constraints]]>
  3584. </doc>
  3585. </method>
  3586. <method name="setReservationDefinition"
  3587. abstract="true" native="false" synchronized="false"
  3588. static="false" final="false" visibility="public"
  3589. deprecated="not deprecated">
  3590. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3591. <doc>
  3592. <![CDATA[Set the {@link ReservationDefinition} representing the updated user
  3593. constraints for this reservation
  3594. @param reservationDefinition the reservation request representing the
  3595. reservation]]>
  3596. </doc>
  3597. </method>
  3598. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  3599. abstract="true" native="false" synchronized="false"
  3600. static="false" final="false" visibility="public"
  3601. deprecated="not deprecated">
  3602. <doc>
  3603. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  3604. allocation in the scheduler (between start and end time of this
  3605. reservation)
  3606. @return the {@link ReservationId} representing the unique id of the
  3607. corresponding reserved resource allocation in the scheduler]]>
  3608. </doc>
  3609. </method>
  3610. <method name="setReservationId"
  3611. abstract="true" native="false" synchronized="false"
  3612. static="false" final="false" visibility="public"
  3613. deprecated="not deprecated">
  3614. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3615. <doc>
  3616. <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
  3617. allocation in the scheduler (between start and end time of this
  3618. reservation)
  3619. @param reservationId the {@link ReservationId} representing the the unique
  3620. id of the corresponding reserved resource allocation in the
  3621. scheduler]]>
  3622. </doc>
  3623. </method>
  3624. <doc>
  3625. <![CDATA[{@link ReservationUpdateRequest} captures the set of requirements the user
  3626. has to update an existing reservation.
  3627. @see ReservationDefinition]]>
  3628. </doc>
  3629. </class>
  3630. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
  3631. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
  3632. <class name="ReservationUpdateResponse" extends="java.lang.Object"
  3633. abstract="true"
  3634. static="false" final="false" visibility="public"
  3635. deprecated="not deprecated">
  3636. <constructor name="ReservationUpdateResponse"
  3637. static="false" final="false" visibility="public"
  3638. deprecated="not deprecated">
  3639. </constructor>
  3640. <doc>
  3641. <![CDATA[{@link ReservationUpdateResponse} contains the answer of the admission
  3642. control system in the {@code ResourceManager} to a reservation update
  3643. operation. Currently response is empty if the operation was successful, if
  3644. not an exception reporting reason for a failure.
  3645. @see ReservationDefinition]]>
  3646. </doc>
  3647. </class>
  3648. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
  3649. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
  3650. <class name="StartContainerRequest" extends="java.lang.Object"
  3651. abstract="true"
  3652. static="false" final="false" visibility="public"
  3653. deprecated="not deprecated">
  3654. <constructor name="StartContainerRequest"
  3655. static="false" final="false" visibility="public"
  3656. deprecated="not deprecated">
  3657. </constructor>
  3658. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest"
  3659. abstract="false" native="false" synchronized="false"
  3660. static="true" final="false" visibility="public"
  3661. deprecated="not deprecated">
  3662. <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  3663. <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
  3664. </method>
  3665. <method name="getContainerLaunchContext" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  3666. abstract="true" native="false" synchronized="false"
  3667. static="false" final="false" visibility="public"
  3668. deprecated="not deprecated">
  3669. <doc>
  3670. <![CDATA[Get the <code>ContainerLaunchContext</code> for the container to be started
  3671. by the <code>NodeManager</code>.
  3672. @return <code>ContainerLaunchContext</code> for the container to be started
  3673. by the <code>NodeManager</code>]]>
  3674. </doc>
  3675. </method>
  3676. <method name="setContainerLaunchContext"
  3677. abstract="true" native="false" synchronized="false"
  3678. static="false" final="false" visibility="public"
  3679. deprecated="not deprecated">
  3680. <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  3681. <doc>
  3682. <![CDATA[Set the <code>ContainerLaunchContext</code> for the container to be started
  3683. by the <code>NodeManager</code>
  3684. @param context <code>ContainerLaunchContext</code> for the container to be
  3685. started by the <code>NodeManager</code>]]>
  3686. </doc>
  3687. </method>
  3688. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  3689. abstract="true" native="false" synchronized="false"
  3690. static="false" final="false" visibility="public"
  3691. deprecated="not deprecated">
  3692. <doc>
  3693. <![CDATA[<p>Get the container token to be used for authorization during starting
  3694. container.</p>
  3695. <p>Note: {@link NMToken} will be used for authenticating communication with </code>
  3696. NodeManager</code>.</p>
  3697. @return the container token to be used for authorization during starting
  3698. container.
  3699. @see NMToken
  3700. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3701. </doc>
  3702. </method>
  3703. <method name="setContainerToken"
  3704. abstract="true" native="false" synchronized="false"
  3705. static="false" final="false" visibility="public"
  3706. deprecated="not deprecated">
  3707. <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
  3708. </method>
  3709. <doc>
  3710. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
  3711. <code>NodeManager</code> to <em>start</em> a container.</p>
  3712. <p>The <code>ApplicationMaster</code> has to provide details such as
  3713. allocated resource capability, security tokens (if enabled), command
  3714. to be executed to start the container, environment for the process,
  3715. necessary binaries/jar/shared-objects etc. via the
  3716. {@link ContainerLaunchContext}.</p>
  3717. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3718. </doc>
  3719. </class>
  3720. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
  3721. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
  3722. <class name="StartContainersRequest" extends="java.lang.Object"
  3723. abstract="true"
  3724. static="false" final="false" visibility="public"
  3725. deprecated="not deprecated">
  3726. <constructor name="StartContainersRequest"
  3727. static="false" final="false" visibility="public"
  3728. deprecated="not deprecated">
  3729. </constructor>
  3730. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"
  3731. abstract="false" native="false" synchronized="false"
  3732. static="true" final="false" visibility="public"
  3733. deprecated="not deprecated">
  3734. <param name="requests" type="java.util.List"/>
  3735. </method>
  3736. <method name="getStartContainerRequests" return="java.util.List"
  3737. abstract="true" native="false" synchronized="false"
  3738. static="false" final="false" visibility="public"
  3739. deprecated="not deprecated">
  3740. <doc>
  3741. <![CDATA[Get a list of {@link StartContainerRequest} to start containers.
  3742. @return a list of {@link StartContainerRequest} to start containers.]]>
  3743. </doc>
  3744. </method>
  3745. <method name="setStartContainerRequests"
  3746. abstract="true" native="false" synchronized="false"
  3747. static="false" final="false" visibility="public"
  3748. deprecated="not deprecated">
  3749. <param name="request" type="java.util.List"/>
  3750. <doc>
  3751. <![CDATA[Set a list of {@link StartContainerRequest} to start containers.
  3752. @param request a list of {@link StartContainerRequest} to start containers]]>
  3753. </doc>
  3754. </method>
  3755. <doc>
  3756. <![CDATA[<p>
  3757. The request which contains a list of {@link StartContainerRequest} sent by
  3758. the <code>ApplicationMaster</code> to the <code>NodeManager</code> to
  3759. <em>start</em> containers.
  3760. </p>
  3761. <p>
  3762. In each {@link StartContainerRequest}, the <code>ApplicationMaster</code> has
  3763. to provide details such as allocated resource capability, security tokens (if
  3764. enabled), command to be executed to start the container, environment for the
  3765. process, necessary binaries/jar/shared-objects etc. via the
  3766. {@link ContainerLaunchContext}.
  3767. </p>
  3768. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3769. </doc>
  3770. </class>
  3771. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
  3772. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
  3773. <class name="StartContainersResponse" extends="java.lang.Object"
  3774. abstract="true"
  3775. static="false" final="false" visibility="public"
  3776. deprecated="not deprecated">
  3777. <constructor name="StartContainersResponse"
  3778. static="false" final="false" visibility="public"
  3779. deprecated="not deprecated">
  3780. </constructor>
  3781. <method name="getSuccessfullyStartedContainers" return="java.util.List"
  3782. abstract="true" native="false" synchronized="false"
  3783. static="false" final="false" visibility="public"
  3784. deprecated="not deprecated">
  3785. <doc>
  3786. <![CDATA[Get the list of <code>ContainerId</code> s of the containers that are
  3787. started successfully.
  3788. @return the list of <code>ContainerId</code> s of the containers that are
  3789. started successfully.
  3790. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3791. </doc>
  3792. </method>
  3793. <method name="getFailedRequests" return="java.util.Map"
  3794. abstract="true" native="false" synchronized="false"
  3795. static="false" final="false" visibility="public"
  3796. deprecated="not deprecated">
  3797. <doc>
  3798. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  3799. from per container for failed requests]]>
  3800. </doc>
  3801. </method>
  3802. <method name="getAllServicesMetaData" return="java.util.Map"
  3803. abstract="true" native="false" synchronized="false"
  3804. static="false" final="false" visibility="public"
  3805. deprecated="not deprecated">
  3806. <doc>
  3807. <![CDATA[<p>
  3808. Get the meta-data from all auxiliary services running on the
  3809. <code>NodeManager</code>.
  3810. </p>
  3811. <p>
  3812. The meta-data is returned as a Map between the auxiliary service names and
  3813. their corresponding per service meta-data as an opaque blob
  3814. <code>ByteBuffer</code>
  3815. </p>
  3816. <p>
  3817. To be able to interpret the per-service meta-data, you should consult the
  3818. documentation for the Auxiliary-service configured on the NodeManager
  3819. </p>
  3820. @return a Map between the names of auxiliary services and their
  3821. corresponding meta-data]]>
  3822. </doc>
  3823. </method>
  3824. <doc>
  3825. <![CDATA[<p>
  3826. The response sent by the <code>NodeManager</code> to the
  3827. <code>ApplicationMaster</code> when asked to <em>start</em> an allocated
  3828. container.
  3829. </p>
  3830. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3831. </doc>
  3832. </class>
  3833. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
  3834. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
  3835. <class name="StopContainersRequest" extends="java.lang.Object"
  3836. abstract="true"
  3837. static="false" final="false" visibility="public"
  3838. deprecated="not deprecated">
  3839. <constructor name="StopContainersRequest"
  3840. static="false" final="false" visibility="public"
  3841. deprecated="not deprecated">
  3842. </constructor>
  3843. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"
  3844. abstract="false" native="false" synchronized="false"
  3845. static="true" final="false" visibility="public"
  3846. deprecated="not deprecated">
  3847. <param name="containerIds" type="java.util.List"/>
  3848. </method>
  3849. <method name="getContainerIds" return="java.util.List"
  3850. abstract="true" native="false" synchronized="false"
  3851. static="false" final="false" visibility="public"
  3852. deprecated="not deprecated">
  3853. <doc>
  3854. <![CDATA[Get the <code>ContainerId</code>s of the containers to be stopped.
  3855. @return <code>ContainerId</code>s of containers to be stopped]]>
  3856. </doc>
  3857. </method>
  3858. <method name="setContainerIds"
  3859. abstract="true" native="false" synchronized="false"
  3860. static="false" final="false" visibility="public"
  3861. deprecated="not deprecated">
  3862. <param name="containerIds" type="java.util.List"/>
  3863. <doc>
  3864. <![CDATA[Set the <code>ContainerId</code>s of the containers to be stopped.
  3865. @param containerIds <code>ContainerId</code>s of the containers to be stopped]]>
  3866. </doc>
  3867. </method>
  3868. <doc>
  3869. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
  3870. <code>NodeManager</code> to <em>stop</em> containers.</p>
  3871. @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
  3872. </doc>
  3873. </class>
  3874. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
  3875. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
  3876. <class name="StopContainersResponse" extends="java.lang.Object"
  3877. abstract="true"
  3878. static="false" final="false" visibility="public"
  3879. deprecated="not deprecated">
  3880. <constructor name="StopContainersResponse"
  3881. static="false" final="false" visibility="public"
  3882. deprecated="not deprecated">
  3883. </constructor>
  3884. <method name="getSuccessfullyStoppedContainers" return="java.util.List"
  3885. abstract="true" native="false" synchronized="false"
  3886. static="false" final="false" visibility="public"
  3887. deprecated="not deprecated">
  3888. <doc>
  3889. <![CDATA[Get the list of containerIds of successfully stopped containers.
  3890. @return the list of containerIds of successfully stopped containers.]]>
  3891. </doc>
  3892. </method>
  3893. <method name="getFailedRequests" return="java.util.Map"
  3894. abstract="true" native="false" synchronized="false"
  3895. static="false" final="false" visibility="public"
  3896. deprecated="not deprecated">
  3897. <doc>
  3898. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  3899. from per container for failed requests]]>
  3900. </doc>
  3901. </method>
  3902. <doc>
  3903. <![CDATA[<p>
  3904. The response sent by the <code>NodeManager</code> to the
  3905. <code>ApplicationMaster</code> when asked to <em>stop</em> allocated
  3906. containers.
  3907. </p>
  3908. @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
  3909. </doc>
  3910. </class>
  3911. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
  3912. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
  3913. <class name="SubmitApplicationRequest" extends="java.lang.Object"
  3914. abstract="true"
  3915. static="false" final="false" visibility="public"
  3916. deprecated="not deprecated">
  3917. <constructor name="SubmitApplicationRequest"
  3918. static="false" final="false" visibility="public"
  3919. deprecated="not deprecated">
  3920. </constructor>
  3921. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"
  3922. abstract="false" native="false" synchronized="false"
  3923. static="true" final="false" visibility="public"
  3924. deprecated="not deprecated">
  3925. <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
  3926. </method>
  3927. <method name="getApplicationSubmissionContext" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  3928. abstract="true" native="false" synchronized="false"
  3929. static="false" final="false" visibility="public"
  3930. deprecated="not deprecated">
  3931. <doc>
  3932. <![CDATA[Get the <code>ApplicationSubmissionContext</code> for the application.
  3933. @return <code>ApplicationSubmissionContext</code> for the application]]>
  3934. </doc>
  3935. </method>
  3936. <method name="setApplicationSubmissionContext"
  3937. abstract="true" native="false" synchronized="false"
  3938. static="false" final="false" visibility="public"
  3939. deprecated="not deprecated">
  3940. <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
  3941. <doc>
  3942. <![CDATA[Set the <code>ApplicationSubmissionContext</code> for the application.
  3943. @param context <code>ApplicationSubmissionContext</code> for the
  3944. application]]>
  3945. </doc>
  3946. </method>
  3947. <doc>
  3948. <![CDATA[<p>The request sent by a client to <em>submit an application</em> to the
  3949. <code>ResourceManager</code>.</p>
  3950. <p>The request, via {@link ApplicationSubmissionContext}, contains
  3951. details such as queue, {@link Resource} required to run the
  3952. <code>ApplicationMaster</code>, the equivalent of
  3953. {@link ContainerLaunchContext} for launching the
  3954. <code>ApplicationMaster</code> etc.
  3955. @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
  3956. </doc>
  3957. </class>
  3958. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
  3959. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
  3960. <class name="SubmitApplicationResponse" extends="java.lang.Object"
  3961. abstract="true"
  3962. static="false" final="false" visibility="public"
  3963. deprecated="not deprecated">
  3964. <constructor name="SubmitApplicationResponse"
  3965. static="false" final="false" visibility="public"
  3966. deprecated="not deprecated">
  3967. </constructor>
  3968. <doc>
  3969. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client on
  3970. application submission.</p>
  3971. <p>Currently, this is empty.</p>
  3972. @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
  3973. </doc>
  3974. </class>
  3975. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
  3976. </package>
  3977. <package name="org.apache.hadoop.yarn.api.records">
  3978. <!-- start class org.apache.hadoop.yarn.api.records.AMCommand -->
  3979. <class name="AMCommand" extends="java.lang.Enum"
  3980. abstract="false"
  3981. static="false" final="true" visibility="public"
  3982. deprecated="not deprecated">
  3983. <method name="values" return="org.apache.hadoop.yarn.api.records.AMCommand[]"
  3984. abstract="false" native="false" synchronized="false"
  3985. static="true" final="false" visibility="public"
  3986. deprecated="not deprecated">
  3987. </method>
  3988. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.AMCommand"
  3989. abstract="false" native="false" synchronized="false"
  3990. static="true" final="false" visibility="public"
  3991. deprecated="not deprecated">
  3992. <param name="name" type="java.lang.String"/>
  3993. </method>
  3994. <doc>
  3995. <![CDATA[Command sent by the Resource Manager to the Application Master in the
  3996. AllocateResponse
  3997. @see AllocateResponse]]>
  3998. </doc>
  3999. </class>
  4000. <!-- end class org.apache.hadoop.yarn.api.records.AMCommand -->
  4001. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
  4002. <class name="ApplicationAccessType" extends="java.lang.Enum"
  4003. abstract="false"
  4004. static="false" final="true" visibility="public"
  4005. deprecated="not deprecated">
  4006. <method name="values" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType[]"
  4007. abstract="false" native="false" synchronized="false"
  4008. static="true" final="false" visibility="public"
  4009. deprecated="not deprecated">
  4010. </method>
  4011. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType"
  4012. abstract="false" native="false" synchronized="false"
  4013. static="true" final="false" visibility="public"
  4014. deprecated="not deprecated">
  4015. <param name="name" type="java.lang.String"/>
  4016. </method>
  4017. <doc>
  4018. <![CDATA[Application access types.]]>
  4019. </doc>
  4020. </class>
  4021. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
  4022. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
  4023. <class name="ApplicationAttemptId" extends="java.lang.Object"
  4024. abstract="true"
  4025. static="false" final="false" visibility="public"
  4026. deprecated="not deprecated">
  4027. <implements name="java.lang.Comparable"/>
  4028. <constructor name="ApplicationAttemptId"
  4029. static="false" final="false" visibility="public"
  4030. deprecated="not deprecated">
  4031. </constructor>
  4032. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4033. abstract="true" native="false" synchronized="false"
  4034. static="false" final="false" visibility="public"
  4035. deprecated="not deprecated">
  4036. <doc>
  4037. <![CDATA[Get the <code>ApplicationId</code> of the <code>ApplicationAttempId</code>.
  4038. @return <code>ApplicationId</code> of the <code>ApplicationAttempId</code>]]>
  4039. </doc>
  4040. </method>
  4041. <method name="getAttemptId" return="int"
  4042. abstract="true" native="false" synchronized="false"
  4043. static="false" final="false" visibility="public"
  4044. deprecated="not deprecated">
  4045. <doc>
  4046. <![CDATA[Get the <code>attempt id</code> of the <code>Application</code>.
  4047. @return <code>attempt id</code> of the <code>Application</code>]]>
  4048. </doc>
  4049. </method>
  4050. <method name="hashCode" return="int"
  4051. abstract="false" native="false" synchronized="false"
  4052. static="false" final="false" visibility="public"
  4053. deprecated="not deprecated">
  4054. </method>
  4055. <method name="equals" return="boolean"
  4056. abstract="false" native="false" synchronized="false"
  4057. static="false" final="false" visibility="public"
  4058. deprecated="not deprecated">
  4059. <param name="obj" type="java.lang.Object"/>
  4060. </method>
  4061. <method name="compareTo" return="int"
  4062. abstract="false" native="false" synchronized="false"
  4063. static="false" final="false" visibility="public"
  4064. deprecated="not deprecated">
  4065. <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  4066. </method>
  4067. <method name="toString" return="java.lang.String"
  4068. abstract="false" native="false" synchronized="false"
  4069. static="false" final="false" visibility="public"
  4070. deprecated="not deprecated">
  4071. </method>
  4072. <method name="build"
  4073. abstract="true" native="false" synchronized="false"
  4074. static="false" final="false" visibility="protected"
  4075. deprecated="not deprecated">
  4076. </method>
  4077. <field name="appAttemptIdStrPrefix" type="java.lang.String"
  4078. transient="false" volatile="false"
  4079. static="true" final="true" visibility="public"
  4080. deprecated="not deprecated">
  4081. </field>
  4082. <doc>
  4083. <![CDATA[<p><code>ApplicationAttemptId</code> denotes the particular <em>attempt</em>
  4084. of an <code>ApplicationMaster</code> for a given {@link ApplicationId}.</p>
  4085. <p>Multiple attempts might be needed to run an application to completion due
  4086. to temporal failures of the <code>ApplicationMaster</code> such as hardware
  4087. failures, connectivity issues etc. on the node on which it was scheduled.</p>]]>
  4088. </doc>
  4089. </class>
  4090. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
  4091. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
  4092. <class name="ApplicationAttemptReport" extends="java.lang.Object"
  4093. abstract="true"
  4094. static="false" final="false" visibility="public"
  4095. deprecated="not deprecated">
  4096. <constructor name="ApplicationAttemptReport"
  4097. static="false" final="false" visibility="public"
  4098. deprecated="not deprecated">
  4099. </constructor>
  4100. <method name="getYarnApplicationAttemptState" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
  4101. abstract="true" native="false" synchronized="false"
  4102. static="false" final="false" visibility="public"
  4103. deprecated="not deprecated">
  4104. <doc>
  4105. <![CDATA[Get the <em>YarnApplicationAttemptState</em> of the application attempt.
  4106. @return <em>YarnApplicationAttemptState</em> of the application attempt]]>
  4107. </doc>
  4108. </method>
  4109. <method name="getRpcPort" return="int"
  4110. abstract="true" native="false" synchronized="false"
  4111. static="false" final="false" visibility="public"
  4112. deprecated="not deprecated">
  4113. <doc>
  4114. <![CDATA[Get the <em>RPC port</em> of this attempt <code>ApplicationMaster</code>.
  4115. @return <em>RPC port</em> of this attempt <code>ApplicationMaster</code>]]>
  4116. </doc>
  4117. </method>
  4118. <method name="getHost" return="java.lang.String"
  4119. abstract="true" native="false" synchronized="false"
  4120. static="false" final="false" visibility="public"
  4121. deprecated="not deprecated">
  4122. <doc>
  4123. <![CDATA[Get the <em>host</em> on which this attempt of
  4124. <code>ApplicationMaster</code> is running.
  4125. @return <em>host</em> on which this attempt of
  4126. <code>ApplicationMaster</code> is running]]>
  4127. </doc>
  4128. </method>
  4129. <method name="getDiagnostics" return="java.lang.String"
  4130. abstract="true" native="false" synchronized="false"
  4131. static="false" final="false" visibility="public"
  4132. deprecated="not deprecated">
  4133. <doc>
  4134. <![CDATA[Get the <em>diagnositic information</em> of the application attempt in case
  4135. of errors.
  4136. @return <em>diagnositic information</em> of the application attempt in case
  4137. of errors]]>
  4138. </doc>
  4139. </method>
  4140. <method name="getTrackingUrl" return="java.lang.String"
  4141. abstract="true" native="false" synchronized="false"
  4142. static="false" final="false" visibility="public"
  4143. deprecated="not deprecated">
  4144. <doc>
  4145. <![CDATA[Get the <em>tracking url</em> for the application attempt.
  4146. @return <em>tracking url</em> for the application attempt]]>
  4147. </doc>
  4148. </method>
  4149. <method name="getOriginalTrackingUrl" return="java.lang.String"
  4150. abstract="true" native="false" synchronized="false"
  4151. static="false" final="false" visibility="public"
  4152. deprecated="not deprecated">
  4153. <doc>
  4154. <![CDATA[Get the <em>original tracking url</em> for the application attempt.
  4155. @return <em>original tracking url</em> for the application attempt]]>
  4156. </doc>
  4157. </method>
  4158. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  4159. abstract="true" native="false" synchronized="false"
  4160. static="false" final="false" visibility="public"
  4161. deprecated="not deprecated">
  4162. <doc>
  4163. <![CDATA[Get the <code>ApplicationAttemptId</code> of this attempt of the
  4164. application
  4165. @return <code>ApplicationAttemptId</code> of the attempt]]>
  4166. </doc>
  4167. </method>
  4168. <method name="getAMContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  4169. abstract="true" native="false" synchronized="false"
  4170. static="false" final="false" visibility="public"
  4171. deprecated="not deprecated">
  4172. <doc>
  4173. <![CDATA[Get the <code>ContainerId</code> of AMContainer for this attempt
  4174. @return <code>ContainerId</code> of the attempt]]>
  4175. </doc>
  4176. </method>
  4177. <doc>
  4178. <![CDATA[<p>
  4179. <code>ApplicationAttemptReport</code> is a report of an application attempt.
  4180. </p>
  4181. <p>
  4182. It includes details such as:
  4183. <ul>
  4184. <li>{@link ApplicationAttemptId} of the application.</li>
  4185. <li>Host on which the <code>ApplicationMaster</code> of this attempt is
  4186. running.</li>
  4187. <li>RPC port of the <code>ApplicationMaster</code> of this attempt.</li>
  4188. <li>Tracking URL.</li>
  4189. <li>Diagnostic information in case of errors.</li>
  4190. <li>{@link YarnApplicationAttemptState} of the application attempt.</li>
  4191. <li>{@link ContainerId} of the master Container.</li>
  4192. </ul>
  4193. </p>]]>
  4194. </doc>
  4195. </class>
  4196. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
  4197. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationId -->
  4198. <class name="ApplicationId" extends="java.lang.Object"
  4199. abstract="true"
  4200. static="false" final="false" visibility="public"
  4201. deprecated="not deprecated">
  4202. <implements name="java.lang.Comparable"/>
  4203. <constructor name="ApplicationId"
  4204. static="false" final="false" visibility="public"
  4205. deprecated="not deprecated">
  4206. </constructor>
  4207. <method name="getId" return="int"
  4208. abstract="true" native="false" synchronized="false"
  4209. static="false" final="false" visibility="public"
  4210. deprecated="not deprecated">
  4211. <doc>
  4212. <![CDATA[Get the short integer identifier of the <code>ApplicationId</code>
  4213. which is unique for all applications started by a particular instance
  4214. of the <code>ResourceManager</code>.
  4215. @return short integer identifier of the <code>ApplicationId</code>]]>
  4216. </doc>
  4217. </method>
  4218. <method name="getClusterTimestamp" return="long"
  4219. abstract="true" native="false" synchronized="false"
  4220. static="false" final="false" visibility="public"
  4221. deprecated="not deprecated">
  4222. <doc>
  4223. <![CDATA[Get the <em>start time</em> of the <code>ResourceManager</code> which is
  4224. used to generate globally unique <code>ApplicationId</code>.
  4225. @return <em>start time</em> of the <code>ResourceManager</code>]]>
  4226. </doc>
  4227. </method>
  4228. <method name="build"
  4229. abstract="true" native="false" synchronized="false"
  4230. static="false" final="false" visibility="protected"
  4231. deprecated="not deprecated">
  4232. </method>
  4233. <method name="compareTo" return="int"
  4234. abstract="false" native="false" synchronized="false"
  4235. static="false" final="false" visibility="public"
  4236. deprecated="not deprecated">
  4237. <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4238. </method>
  4239. <method name="toString" return="java.lang.String"
  4240. abstract="false" native="false" synchronized="false"
  4241. static="false" final="false" visibility="public"
  4242. deprecated="not deprecated">
  4243. </method>
  4244. <method name="hashCode" return="int"
  4245. abstract="false" native="false" synchronized="false"
  4246. static="false" final="false" visibility="public"
  4247. deprecated="not deprecated">
  4248. </method>
  4249. <method name="equals" return="boolean"
  4250. abstract="false" native="false" synchronized="false"
  4251. static="false" final="false" visibility="public"
  4252. deprecated="not deprecated">
  4253. <param name="obj" type="java.lang.Object"/>
  4254. </method>
  4255. <field name="appIdStrPrefix" type="java.lang.String"
  4256. transient="false" volatile="false"
  4257. static="true" final="true" visibility="public"
  4258. deprecated="not deprecated">
  4259. </field>
  4260. <doc>
  4261. <![CDATA[<p><code>ApplicationId</code> represents the <em>globally unique</em>
  4262. identifier for an application.</p>
  4263. <p>The globally unique nature of the identifier is achieved by using the
  4264. <em>cluster timestamp</em> i.e. start-time of the
  4265. <code>ResourceManager</code> along with a monotonically increasing counter
  4266. for the application.</p>]]>
  4267. </doc>
  4268. </class>
  4269. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationId -->
  4270. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationReport -->
  4271. <class name="ApplicationReport" extends="java.lang.Object"
  4272. abstract="true"
  4273. static="false" final="false" visibility="public"
  4274. deprecated="not deprecated">
  4275. <constructor name="ApplicationReport"
  4276. static="false" final="false" visibility="public"
  4277. deprecated="not deprecated">
  4278. </constructor>
  4279. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4280. abstract="true" native="false" synchronized="false"
  4281. static="false" final="false" visibility="public"
  4282. deprecated="not deprecated">
  4283. <doc>
  4284. <![CDATA[Get the <code>ApplicationId</code> of the application.
  4285. @return <code>ApplicationId</code> of the application]]>
  4286. </doc>
  4287. </method>
  4288. <method name="getCurrentApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  4289. abstract="true" native="false" synchronized="false"
  4290. static="false" final="false" visibility="public"
  4291. deprecated="not deprecated">
  4292. <doc>
  4293. <![CDATA[Get the <code>ApplicationAttemptId</code> of the current
  4294. attempt of the application
  4295. @return <code>ApplicationAttemptId</code> of the attempt]]>
  4296. </doc>
  4297. </method>
  4298. <method name="getUser" return="java.lang.String"
  4299. abstract="true" native="false" synchronized="false"
  4300. static="false" final="false" visibility="public"
  4301. deprecated="not deprecated">
  4302. <doc>
  4303. <![CDATA[Get the <em>user</em> who submitted the application.
  4304. @return <em>user</em> who submitted the application]]>
  4305. </doc>
  4306. </method>
  4307. <method name="getQueue" return="java.lang.String"
  4308. abstract="true" native="false" synchronized="false"
  4309. static="false" final="false" visibility="public"
  4310. deprecated="not deprecated">
  4311. <doc>
  4312. <![CDATA[Get the <em>queue</em> to which the application was submitted.
  4313. @return <em>queue</em> to which the application was submitted]]>
  4314. </doc>
  4315. </method>
  4316. <method name="getName" return="java.lang.String"
  4317. abstract="true" native="false" synchronized="false"
  4318. static="false" final="false" visibility="public"
  4319. deprecated="not deprecated">
  4320. <doc>
  4321. <![CDATA[Get the user-defined <em>name</em> of the application.
  4322. @return <em>name</em> of the application]]>
  4323. </doc>
  4324. </method>
  4325. <method name="getHost" return="java.lang.String"
  4326. abstract="true" native="false" synchronized="false"
  4327. static="false" final="false" visibility="public"
  4328. deprecated="not deprecated">
  4329. <doc>
  4330. <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code>
  4331. is running.
  4332. @return <em>host</em> on which the <code>ApplicationMaster</code>
  4333. is running]]>
  4334. </doc>
  4335. </method>
  4336. <method name="getRpcPort" return="int"
  4337. abstract="true" native="false" synchronized="false"
  4338. static="false" final="false" visibility="public"
  4339. deprecated="not deprecated">
  4340. <doc>
  4341. <![CDATA[Get the <em>RPC port</em> of the <code>ApplicationMaster</code>.
  4342. @return <em>RPC port</em> of the <code>ApplicationMaster</code>]]>
  4343. </doc>
  4344. </method>
  4345. <method name="getClientToAMToken" return="org.apache.hadoop.yarn.api.records.Token"
  4346. abstract="true" native="false" synchronized="false"
  4347. static="false" final="false" visibility="public"
  4348. deprecated="not deprecated">
  4349. <doc>
  4350. <![CDATA[Get the <em>client token</em> for communicating with the
  4351. <code>ApplicationMaster</code>.
  4352. <p>
  4353. <em>ClientToAMToken</em> is the security token used by the AMs to verify
  4354. authenticity of any <code>client</code>.
  4355. </p>
  4356. <p>
  4357. The <code>ResourceManager</code>, provides a secure token (via
  4358. {@link ApplicationReport#getClientToAMToken()}) which is verified by the
  4359. ApplicationMaster when the client directly talks to an AM.
  4360. </p>
  4361. @return <em>client token</em> for communicating with the
  4362. <code>ApplicationMaster</code>]]>
  4363. </doc>
  4364. </method>
  4365. <method name="getYarnApplicationState" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
  4366. abstract="true" native="false" synchronized="false"
  4367. static="false" final="false" visibility="public"
  4368. deprecated="not deprecated">
  4369. <doc>
  4370. <![CDATA[Get the <code>YarnApplicationState</code> of the application.
  4371. @return <code>YarnApplicationState</code> of the application]]>
  4372. </doc>
  4373. </method>
  4374. <method name="getDiagnostics" return="java.lang.String"
  4375. abstract="true" native="false" synchronized="false"
  4376. static="false" final="false" visibility="public"
  4377. deprecated="not deprecated">
  4378. <doc>
  4379. <![CDATA[Get the <em>diagnositic information</em> of the application in case of
  4380. errors.
  4381. @return <em>diagnositic information</em> of the application in case
  4382. of errors]]>
  4383. </doc>
  4384. </method>
  4385. <method name="getTrackingUrl" return="java.lang.String"
  4386. abstract="true" native="false" synchronized="false"
  4387. static="false" final="false" visibility="public"
  4388. deprecated="not deprecated">
  4389. <doc>
  4390. <![CDATA[Get the <em>tracking url</em> for the application.
  4391. @return <em>tracking url</em> for the application]]>
  4392. </doc>
  4393. </method>
  4394. <method name="getStartTime" return="long"
  4395. abstract="true" native="false" synchronized="false"
  4396. static="false" final="false" visibility="public"
  4397. deprecated="not deprecated">
  4398. <doc>
  4399. <![CDATA[Get the <em>start time</em> of the application.
  4400. @return <em>start time</em> of the application]]>
  4401. </doc>
  4402. </method>
  4403. <method name="getFinishTime" return="long"
  4404. abstract="true" native="false" synchronized="false"
  4405. static="false" final="false" visibility="public"
  4406. deprecated="not deprecated">
  4407. <doc>
  4408. <![CDATA[Get the <em>finish time</em> of the application.
  4409. @return <em>finish time</em> of the application]]>
  4410. </doc>
  4411. </method>
  4412. <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  4413. abstract="true" native="false" synchronized="false"
  4414. static="false" final="false" visibility="public"
  4415. deprecated="not deprecated">
  4416. <doc>
  4417. <![CDATA[Get the <em>final finish status</em> of the application.
  4418. @return <em>final finish status</em> of the application]]>
  4419. </doc>
  4420. </method>
  4421. <method name="getApplicationResourceUsageReport" return="org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport"
  4422. abstract="true" native="false" synchronized="false"
  4423. static="false" final="false" visibility="public"
  4424. deprecated="not deprecated">
  4425. <doc>
  4426. <![CDATA[Retrieve the structure containing the job resources for this application
  4427. @return the job resources structure for this application]]>
  4428. </doc>
  4429. </method>
  4430. <method name="getProgress" return="float"
  4431. abstract="true" native="false" synchronized="false"
  4432. static="false" final="false" visibility="public"
  4433. deprecated="not deprecated">
  4434. <doc>
  4435. <![CDATA[Get the application's progress ( range 0.0 to 1.0 )
  4436. @return application's progress]]>
  4437. </doc>
  4438. </method>
  4439. <method name="getApplicationType" return="java.lang.String"
  4440. abstract="true" native="false" synchronized="false"
  4441. static="false" final="false" visibility="public"
  4442. deprecated="not deprecated">
  4443. <doc>
  4444. <![CDATA[Get the application's Type
  4445. @return application's Type]]>
  4446. </doc>
  4447. </method>
  4448. <method name="getApplicationTags" return="java.util.Set"
  4449. abstract="true" native="false" synchronized="false"
  4450. static="false" final="false" visibility="public"
  4451. deprecated="not deprecated">
  4452. <doc>
  4453. <![CDATA[Get all tags corresponding to the application
  4454. @return Application's tags]]>
  4455. </doc>
  4456. </method>
  4457. <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
  4458. abstract="true" native="false" synchronized="false"
  4459. static="false" final="false" visibility="public"
  4460. deprecated="not deprecated">
  4461. <doc>
  4462. <![CDATA[Get the AMRM token of the application.
  4463. <p/>
  4464. The AMRM token is required for AM to RM scheduling operations. For
  4465. managed Application Masters Yarn takes care of injecting it. For unmanaged
  4466. Applications Masters, the token must be obtained via this method and set
  4467. in the {@link org.apache.hadoop.security.UserGroupInformation} of the
  4468. current user.
  4469. <p/>
  4470. The AMRM token will be returned only if all the following conditions are
  4471. met:
  4472. <li>
  4473. <ul>the requester is the owner of the ApplicationMaster</ul>
  4474. <ul>the application master is an unmanaged ApplicationMaster</ul>
  4475. <ul>the application master is in ACCEPTED state</ul>
  4476. </li>
  4477. Else this method returns NULL.
  4478. @return the AM to RM token if available.]]>
  4479. </doc>
  4480. </method>
  4481. <doc>
  4482. <![CDATA[<p><code>ApplicationReport</code> is a report of an application.</p>
  4483. <p>It includes details such as:
  4484. <ul>
  4485. <li>{@link ApplicationId} of the application.</li>
  4486. <li>Applications user.</li>
  4487. <li>Application queue.</li>
  4488. <li>Application name.</li>
  4489. <li>Host on which the <code>ApplicationMaster</code> is running.</li>
  4490. <li>RPC port of the <code>ApplicationMaster</code>.</li>
  4491. <li>Tracking URL.</li>
  4492. <li>{@link YarnApplicationState} of the application.</li>
  4493. <li>Diagnostic information in case of errors.</li>
  4494. <li>Start time of the application.</li>
  4495. <li>Client {@link Token} of the application (if security is enabled).</li>
  4496. </ul>
  4497. </p>
  4498. @see ApplicationClientProtocol#getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest)]]>
  4499. </doc>
  4500. </class>
  4501. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationReport -->
  4502. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
  4503. <class name="ApplicationResourceUsageReport" extends="java.lang.Object"
  4504. abstract="true"
  4505. static="false" final="false" visibility="public"
  4506. deprecated="not deprecated">
  4507. <constructor name="ApplicationResourceUsageReport"
  4508. static="false" final="false" visibility="public"
  4509. deprecated="not deprecated">
  4510. </constructor>
  4511. <method name="getNumUsedContainers" return="int"
  4512. abstract="true" native="false" synchronized="false"
  4513. static="false" final="false" visibility="public"
  4514. deprecated="not deprecated">
  4515. <doc>
  4516. <![CDATA[Get the number of used containers. -1 for invalid/inaccessible reports.
  4517. @return the number of used containers]]>
  4518. </doc>
  4519. </method>
  4520. <method name="getUsedResources" return="org.apache.hadoop.yarn.api.records.Resource"
  4521. abstract="true" native="false" synchronized="false"
  4522. static="false" final="false" visibility="public"
  4523. deprecated="not deprecated">
  4524. <doc>
  4525. <![CDATA[Get the used <code>Resource</code>. -1 for invalid/inaccessible reports.
  4526. @return the used <code>Resource</code>]]>
  4527. </doc>
  4528. </method>
  4529. <method name="getReservedResources" return="org.apache.hadoop.yarn.api.records.Resource"
  4530. abstract="true" native="false" synchronized="false"
  4531. static="false" final="false" visibility="public"
  4532. deprecated="not deprecated">
  4533. <doc>
  4534. <![CDATA[Get the reserved <code>Resource</code>. -1 for invalid/inaccessible reports.
  4535. @return the reserved <code>Resource</code>]]>
  4536. </doc>
  4537. </method>
  4538. <method name="getNeededResources" return="org.apache.hadoop.yarn.api.records.Resource"
  4539. abstract="true" native="false" synchronized="false"
  4540. static="false" final="false" visibility="public"
  4541. deprecated="not deprecated">
  4542. <doc>
  4543. <![CDATA[Get the needed <code>Resource</code>. -1 for invalid/inaccessible reports.
  4544. @return the needed <code>Resource</code>]]>
  4545. </doc>
  4546. </method>
  4547. <method name="getMemorySeconds" return="long"
  4548. abstract="true" native="false" synchronized="false"
  4549. static="false" final="false" visibility="public"
  4550. deprecated="not deprecated">
  4551. <doc>
  4552. <![CDATA[Get the aggregated amount of memory (in megabytes) the application has
  4553. allocated times the number of seconds the application has been running.
  4554. @return the aggregated amount of memory seconds]]>
  4555. </doc>
  4556. </method>
  4557. <method name="getVcoreSeconds" return="long"
  4558. abstract="true" native="false" synchronized="false"
  4559. static="false" final="false" visibility="public"
  4560. deprecated="not deprecated">
  4561. <doc>
  4562. <![CDATA[Get the aggregated number of vcores that the application has allocated
  4563. times the number of seconds the application has been running.
  4564. @return the aggregated number of vcore seconds]]>
  4565. </doc>
  4566. </method>
  4567. <doc>
  4568. <![CDATA[Contains various scheduling metrics to be reported by UI and CLI.]]>
  4569. </doc>
  4570. </class>
  4571. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
  4572. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
  4573. <class name="ApplicationSubmissionContext" extends="java.lang.Object"
  4574. abstract="true"
  4575. static="false" final="false" visibility="public"
  4576. deprecated="not deprecated">
  4577. <constructor name="ApplicationSubmissionContext"
  4578. static="false" final="false" visibility="public"
  4579. deprecated="not deprecated">
  4580. </constructor>
  4581. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4582. abstract="false" native="false" synchronized="false"
  4583. static="true" final="false" visibility="public"
  4584. deprecated="not deprecated">
  4585. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4586. <param name="applicationName" type="java.lang.String"/>
  4587. <param name="queue" type="java.lang.String"/>
  4588. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4589. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4590. <param name="isUnmanagedAM" type="boolean"/>
  4591. <param name="cancelTokensWhenComplete" type="boolean"/>
  4592. <param name="maxAppAttempts" type="int"/>
  4593. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4594. <param name="applicationType" type="java.lang.String"/>
  4595. <param name="keepContainers" type="boolean"/>
  4596. <param name="appLabelExpression" type="java.lang.String"/>
  4597. <param name="amContainerLabelExpression" type="java.lang.String"/>
  4598. </method>
  4599. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4600. abstract="false" native="false" synchronized="false"
  4601. static="true" final="false" visibility="public"
  4602. deprecated="not deprecated">
  4603. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4604. <param name="applicationName" type="java.lang.String"/>
  4605. <param name="queue" type="java.lang.String"/>
  4606. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4607. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4608. <param name="isUnmanagedAM" type="boolean"/>
  4609. <param name="cancelTokensWhenComplete" type="boolean"/>
  4610. <param name="maxAppAttempts" type="int"/>
  4611. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4612. <param name="applicationType" type="java.lang.String"/>
  4613. <param name="keepContainers" type="boolean"/>
  4614. </method>
  4615. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4616. abstract="false" native="false" synchronized="false"
  4617. static="true" final="false" visibility="public"
  4618. deprecated="not deprecated">
  4619. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4620. <param name="applicationName" type="java.lang.String"/>
  4621. <param name="queue" type="java.lang.String"/>
  4622. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4623. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4624. <param name="isUnmanagedAM" type="boolean"/>
  4625. <param name="cancelTokensWhenComplete" type="boolean"/>
  4626. <param name="maxAppAttempts" type="int"/>
  4627. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4628. <param name="applicationType" type="java.lang.String"/>
  4629. </method>
  4630. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4631. abstract="false" native="false" synchronized="false"
  4632. static="true" final="false" visibility="public"
  4633. deprecated="not deprecated">
  4634. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4635. <param name="applicationName" type="java.lang.String"/>
  4636. <param name="queue" type="java.lang.String"/>
  4637. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4638. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4639. <param name="isUnmanagedAM" type="boolean"/>
  4640. <param name="cancelTokensWhenComplete" type="boolean"/>
  4641. <param name="maxAppAttempts" type="int"/>
  4642. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4643. </method>
  4644. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4645. abstract="false" native="false" synchronized="false"
  4646. static="true" final="false" visibility="public"
  4647. deprecated="not deprecated">
  4648. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4649. <param name="applicationName" type="java.lang.String"/>
  4650. <param name="queue" type="java.lang.String"/>
  4651. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4652. <param name="isUnmanagedAM" type="boolean"/>
  4653. <param name="cancelTokensWhenComplete" type="boolean"/>
  4654. <param name="maxAppAttempts" type="int"/>
  4655. <param name="applicationType" type="java.lang.String"/>
  4656. <param name="keepContainers" type="boolean"/>
  4657. <param name="appLabelExpression" type="java.lang.String"/>
  4658. <param name="resourceRequest" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  4659. </method>
  4660. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4661. abstract="false" native="false" synchronized="false"
  4662. static="true" final="false" visibility="public"
  4663. deprecated="not deprecated">
  4664. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4665. <param name="applicationName" type="java.lang.String"/>
  4666. <param name="queue" type="java.lang.String"/>
  4667. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4668. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4669. <param name="isUnmanagedAM" type="boolean"/>
  4670. <param name="cancelTokensWhenComplete" type="boolean"/>
  4671. <param name="maxAppAttempts" type="int"/>
  4672. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4673. <param name="applicationType" type="java.lang.String"/>
  4674. <param name="keepContainers" type="boolean"/>
  4675. <param name="attemptFailuresValidityInterval" type="long"/>
  4676. </method>
  4677. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4678. abstract="false" native="false" synchronized="false"
  4679. static="true" final="false" visibility="public"
  4680. deprecated="not deprecated">
  4681. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4682. <param name="applicationName" type="java.lang.String"/>
  4683. <param name="queue" type="java.lang.String"/>
  4684. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4685. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4686. <param name="isUnmanagedAM" type="boolean"/>
  4687. <param name="cancelTokensWhenComplete" type="boolean"/>
  4688. <param name="maxAppAttempts" type="int"/>
  4689. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4690. <param name="applicationType" type="java.lang.String"/>
  4691. <param name="keepContainers" type="boolean"/>
  4692. <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
  4693. </method>
  4694. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4695. abstract="true" native="false" synchronized="false"
  4696. static="false" final="false" visibility="public"
  4697. deprecated="not deprecated">
  4698. <doc>
  4699. <![CDATA[Get the <code>ApplicationId</code> of the submitted application.
  4700. @return <code>ApplicationId</code> of the submitted application]]>
  4701. </doc>
  4702. </method>
  4703. <method name="setApplicationId"
  4704. abstract="true" native="false" synchronized="false"
  4705. static="false" final="false" visibility="public"
  4706. deprecated="not deprecated">
  4707. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4708. <doc>
  4709. <![CDATA[Set the <code>ApplicationId</code> of the submitted application.
  4710. @param applicationId <code>ApplicationId</code> of the submitted
  4711. application]]>
  4712. </doc>
  4713. </method>
  4714. <method name="getApplicationName" return="java.lang.String"
  4715. abstract="true" native="false" synchronized="false"
  4716. static="false" final="false" visibility="public"
  4717. deprecated="not deprecated">
  4718. <doc>
  4719. <![CDATA[Get the application <em>name</em>.
  4720. @return application name]]>
  4721. </doc>
  4722. </method>
  4723. <method name="setApplicationName"
  4724. abstract="true" native="false" synchronized="false"
  4725. static="false" final="false" visibility="public"
  4726. deprecated="not deprecated">
  4727. <param name="applicationName" type="java.lang.String"/>
  4728. <doc>
  4729. <![CDATA[Set the application <em>name</em>.
  4730. @param applicationName application name]]>
  4731. </doc>
  4732. </method>
  4733. <method name="getQueue" return="java.lang.String"
  4734. abstract="true" native="false" synchronized="false"
  4735. static="false" final="false" visibility="public"
  4736. deprecated="not deprecated">
  4737. <doc>
  4738. <![CDATA[Get the <em>queue</em> to which the application is being submitted.
  4739. @return <em>queue</em> to which the application is being submitted]]>
  4740. </doc>
  4741. </method>
  4742. <method name="setQueue"
  4743. abstract="true" native="false" synchronized="false"
  4744. static="false" final="false" visibility="public"
  4745. deprecated="not deprecated">
  4746. <param name="queue" type="java.lang.String"/>
  4747. <doc>
  4748. <![CDATA[Set the <em>queue</em> to which the application is being submitted
  4749. @param queue <em>queue</em> to which the application is being submitted]]>
  4750. </doc>
  4751. </method>
  4752. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  4753. abstract="true" native="false" synchronized="false"
  4754. static="false" final="false" visibility="public"
  4755. deprecated="not deprecated">
  4756. <doc>
  4757. <![CDATA[Get the <code>Priority</code> of the application.
  4758. @return <code>Priority</code> of the application]]>
  4759. </doc>
  4760. </method>
  4761. <method name="getAMContainerSpec" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  4762. abstract="true" native="false" synchronized="false"
  4763. static="false" final="false" visibility="public"
  4764. deprecated="not deprecated">
  4765. <doc>
  4766. <![CDATA[Get the <code>ContainerLaunchContext</code> to describe the
  4767. <code>Container</code> with which the <code>ApplicationMaster</code> is
  4768. launched.
  4769. @return <code>ContainerLaunchContext</code> for the
  4770. <code>ApplicationMaster</code> container]]>
  4771. </doc>
  4772. </method>
  4773. <method name="setAMContainerSpec"
  4774. abstract="true" native="false" synchronized="false"
  4775. static="false" final="false" visibility="public"
  4776. deprecated="not deprecated">
  4777. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4778. <doc>
  4779. <![CDATA[Set the <code>ContainerLaunchContext</code> to describe the
  4780. <code>Container</code> with which the <code>ApplicationMaster</code> is
  4781. launched.
  4782. @param amContainer <code>ContainerLaunchContext</code> for the
  4783. <code>ApplicationMaster</code> container]]>
  4784. </doc>
  4785. </method>
  4786. <method name="getUnmanagedAM" return="boolean"
  4787. abstract="true" native="false" synchronized="false"
  4788. static="false" final="false" visibility="public"
  4789. deprecated="not deprecated">
  4790. <doc>
  4791. <![CDATA[Get if the RM should manage the execution of the AM.
  4792. If true, then the RM
  4793. will not allocate a container for the AM and start it. It will expect the
  4794. AM to be launched and connect to the RM within the AM liveliness period and
  4795. fail the app otherwise. The client should launch the AM only after the RM
  4796. has ACCEPTED the application and changed the <code>YarnApplicationState</code>.
  4797. Such apps will not be retried by the RM on app attempt failure.
  4798. The default value is false.
  4799. @return true if the AM is not managed by the RM]]>
  4800. </doc>
  4801. </method>
  4802. <method name="setUnmanagedAM"
  4803. abstract="true" native="false" synchronized="false"
  4804. static="false" final="false" visibility="public"
  4805. deprecated="not deprecated">
  4806. <param name="value" type="boolean"/>
  4807. <doc>
  4808. <![CDATA[@param value true if RM should not manage the AM]]>
  4809. </doc>
  4810. </method>
  4811. <method name="getMaxAppAttempts" return="int"
  4812. abstract="true" native="false" synchronized="false"
  4813. static="false" final="false" visibility="public"
  4814. deprecated="not deprecated">
  4815. <doc>
  4816. <![CDATA[@return the number of max attempts of the application to be submitted]]>
  4817. </doc>
  4818. </method>
  4819. <method name="setMaxAppAttempts"
  4820. abstract="true" native="false" synchronized="false"
  4821. static="false" final="false" visibility="public"
  4822. deprecated="not deprecated">
  4823. <param name="maxAppAttempts" type="int"/>
  4824. <doc>
  4825. <![CDATA[Set the number of max attempts of the application to be submitted. WARNING:
  4826. it should be no larger than the global number of max attempts in the Yarn
  4827. configuration.
  4828. @param maxAppAttempts the number of max attempts of the application
  4829. to be submitted.]]>
  4830. </doc>
  4831. </method>
  4832. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  4833. abstract="true" native="false" synchronized="false"
  4834. static="false" final="false" visibility="public"
  4835. deprecated="not deprecated">
  4836. <doc>
  4837. <![CDATA[Get the resource required by the <code>ApplicationMaster</code> for this
  4838. application. Please note this will be DEPRECATED, use <em>getResource</em>
  4839. in <em>getAMContainerResourceRequest</em> instead.
  4840. @return the resource required by the <code>ApplicationMaster</code> for
  4841. this application.]]>
  4842. </doc>
  4843. </method>
  4844. <method name="setResource"
  4845. abstract="true" native="false" synchronized="false"
  4846. static="false" final="false" visibility="public"
  4847. deprecated="not deprecated">
  4848. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4849. <doc>
  4850. <![CDATA[Set the resource required by the <code>ApplicationMaster</code> for this
  4851. application.
  4852. @param resource the resource required by the <code>ApplicationMaster</code>
  4853. for this application.]]>
  4854. </doc>
  4855. </method>
  4856. <method name="getApplicationType" return="java.lang.String"
  4857. abstract="true" native="false" synchronized="false"
  4858. static="false" final="false" visibility="public"
  4859. deprecated="not deprecated">
  4860. <doc>
  4861. <![CDATA[Get the application type
  4862. @return the application type]]>
  4863. </doc>
  4864. </method>
  4865. <method name="setApplicationType"
  4866. abstract="true" native="false" synchronized="false"
  4867. static="false" final="false" visibility="public"
  4868. deprecated="not deprecated">
  4869. <param name="applicationType" type="java.lang.String"/>
  4870. <doc>
  4871. <![CDATA[Set the application type
  4872. @param applicationType the application type]]>
  4873. </doc>
  4874. </method>
  4875. <method name="getKeepContainersAcrossApplicationAttempts" return="boolean"
  4876. abstract="true" native="false" synchronized="false"
  4877. static="false" final="false" visibility="public"
  4878. deprecated="not deprecated">
  4879. <doc>
  4880. <![CDATA[Get the flag which indicates whether to keep containers across application
  4881. attempts or not.
  4882. @return the flag which indicates whether to keep containers across
  4883. application attempts or not.]]>
  4884. </doc>
  4885. </method>
  4886. <method name="setKeepContainersAcrossApplicationAttempts"
  4887. abstract="true" native="false" synchronized="false"
  4888. static="false" final="false" visibility="public"
  4889. deprecated="not deprecated">
  4890. <param name="keepContainers" type="boolean"/>
  4891. <doc>
  4892. <![CDATA[Set the flag which indicates whether to keep containers across application
  4893. attempts.
  4894. <p>
  4895. If the flag is true, running containers will not be killed when application
  4896. attempt fails and these containers will be retrieved by the new application
  4897. attempt on registration via
  4898. {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}.
  4899. </p>
  4900. @param keepContainers
  4901. the flag which indicates whether to keep containers across
  4902. application attempts.]]>
  4903. </doc>
  4904. </method>
  4905. <method name="getApplicationTags" return="java.util.Set"
  4906. abstract="true" native="false" synchronized="false"
  4907. static="false" final="false" visibility="public"
  4908. deprecated="not deprecated">
  4909. <doc>
  4910. <![CDATA[Get tags for the application
  4911. @return the application tags]]>
  4912. </doc>
  4913. </method>
  4914. <method name="setApplicationTags"
  4915. abstract="true" native="false" synchronized="false"
  4916. static="false" final="false" visibility="public"
  4917. deprecated="not deprecated">
  4918. <param name="tags" type="java.util.Set"/>
  4919. <doc>
  4920. <![CDATA[Set tags for the application. A maximum of
  4921. {@link YarnConfiguration#APPLICATION_MAX_TAGS} are allowed
  4922. per application. Each tag can be at most
  4923. {@link YarnConfiguration#APPLICATION_MAX_TAG_LENGTH}
  4924. characters, and can contain only ASCII characters.
  4925. @param tags tags to set]]>
  4926. </doc>
  4927. </method>
  4928. <method name="getNodeLabelExpression" return="java.lang.String"
  4929. abstract="true" native="false" synchronized="false"
  4930. static="false" final="false" visibility="public"
  4931. deprecated="not deprecated">
  4932. <doc>
  4933. <![CDATA[Get node-label-expression for this app. If this is set, all containers of
  4934. this application without setting node-label-expression in ResurceRequest
  4935. will get allocated resources on only those nodes that satisfy this
  4936. node-label-expression.
  4937. If different node-label-expression of this app and ResourceRequest are set
  4938. at the same time, the one set in ResourceRequest will be used when
  4939. allocating container
  4940. @return node-label-expression for this app]]>
  4941. </doc>
  4942. </method>
  4943. <method name="setNodeLabelExpression"
  4944. abstract="true" native="false" synchronized="false"
  4945. static="false" final="false" visibility="public"
  4946. deprecated="not deprecated">
  4947. <param name="nodeLabelExpression" type="java.lang.String"/>
  4948. <doc>
  4949. <![CDATA[Set node-label-expression for this app
  4950. @param nodeLabelExpression node-label-expression of this app]]>
  4951. </doc>
  4952. </method>
  4953. <method name="getAMContainerResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  4954. abstract="true" native="false" synchronized="false"
  4955. static="false" final="false" visibility="public"
  4956. deprecated="not deprecated">
  4957. <doc>
  4958. <![CDATA[Get ResourceRequest of AM container, if this is not null, scheduler will
  4959. use this to acquire resource for AM container.
  4960. If this is null, scheduler will assemble a ResourceRequest by using
  4961. <em>getResource</em> and <em>getPriority</em> of
  4962. <em>ApplicationSubmissionContext</em>.
  4963. Number of containers and Priority will be ignore.
  4964. @return ResourceRequest of AM container]]>
  4965. </doc>
  4966. </method>
  4967. <method name="setAMContainerResourceRequest"
  4968. abstract="true" native="false" synchronized="false"
  4969. static="false" final="false" visibility="public"
  4970. deprecated="not deprecated">
  4971. <param name="request" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  4972. <doc>
  4973. <![CDATA[Set ResourceRequest of AM container
  4974. @param request of AM container]]>
  4975. </doc>
  4976. </method>
  4977. <method name="getAttemptFailuresValidityInterval" return="long"
  4978. abstract="true" native="false" synchronized="false"
  4979. static="false" final="false" visibility="public"
  4980. deprecated="not deprecated">
  4981. <doc>
  4982. <![CDATA[Get the attemptFailuresValidityInterval in milliseconds for the application
  4983. @return the attemptFailuresValidityInterval]]>
  4984. </doc>
  4985. </method>
  4986. <method name="setAttemptFailuresValidityInterval"
  4987. abstract="true" native="false" synchronized="false"
  4988. static="false" final="false" visibility="public"
  4989. deprecated="not deprecated">
  4990. <param name="attemptFailuresValidityInterval" type="long"/>
  4991. <doc>
  4992. <![CDATA[Set the attemptFailuresValidityInterval in milliseconds for the application
  4993. @param attemptFailuresValidityInterval]]>
  4994. </doc>
  4995. </method>
  4996. <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  4997. abstract="true" native="false" synchronized="false"
  4998. static="false" final="false" visibility="public"
  4999. deprecated="not deprecated">
  5000. <doc>
  5001. <![CDATA[Get <code>LogAggregationContext</code> of the application
  5002. @return <code>LogAggregationContext</code> of the application]]>
  5003. </doc>
  5004. </method>
  5005. <method name="setLogAggregationContext"
  5006. abstract="true" native="false" synchronized="false"
  5007. static="false" final="false" visibility="public"
  5008. deprecated="not deprecated">
  5009. <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
  5010. <doc>
  5011. <![CDATA[Set <code>LogAggregationContext</code> for the application
  5012. @param logAggregationContext
  5013. for the application]]>
  5014. </doc>
  5015. </method>
  5016. <method name="getReservationID" return="org.apache.hadoop.yarn.api.records.ReservationId"
  5017. abstract="true" native="false" synchronized="false"
  5018. static="false" final="false" visibility="public"
  5019. deprecated="not deprecated">
  5020. <doc>
  5021. <![CDATA[Get the reservation id, that corresponds to a valid resource allocation in
  5022. the scheduler (between start and end time of the corresponding reservation)
  5023. @return the reservation id representing the unique id of the corresponding
  5024. reserved resource allocation in the scheduler]]>
  5025. </doc>
  5026. </method>
  5027. <method name="setReservationID"
  5028. abstract="true" native="false" synchronized="false"
  5029. static="false" final="false" visibility="public"
  5030. deprecated="not deprecated">
  5031. <param name="reservationID" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  5032. <doc>
  5033. <![CDATA[Set the reservation id, that correspond to a valid resource allocation in
  5034. the scheduler (between start and end time of the corresponding reservation)
  5035. @param reservationID representing the unique id of the
  5036. corresponding reserved resource allocation in the scheduler]]>
  5037. </doc>
  5038. </method>
  5039. <doc>
  5040. <![CDATA[<p><code>ApplicationSubmissionContext</code> represents all of the
  5041. information needed by the <code>ResourceManager</code> to launch
  5042. the <code>ApplicationMaster</code> for an application.</p>
  5043. <p>It includes details such as:
  5044. <ul>
  5045. <li>{@link ApplicationId} of the application.</li>
  5046. <li>Application user.</li>
  5047. <li>Application name.</li>
  5048. <li>{@link Priority} of the application.</li>
  5049. <li>
  5050. {@link ContainerLaunchContext} of the container in which the
  5051. <code>ApplicationMaster</code> is executed.
  5052. </li>
  5053. <li>maxAppAttempts. The maximum number of application attempts.
  5054. It should be no larger than the global number of max attempts in the
  5055. Yarn configuration.</li>
  5056. <li>attemptFailuresValidityInterval. The default value is -1.
  5057. when attemptFailuresValidityInterval in milliseconds is set to > 0,
  5058. the failure number will no take failures which happen out of the
  5059. validityInterval into failure count. If failure count reaches to
  5060. maxAppAttempts, the application will be failed.
  5061. </li>
  5062. <li>Optional, application-specific {@link LogAggregationContext}</li>
  5063. </ul>
  5064. </p>
  5065. @see ContainerLaunchContext
  5066. @see ApplicationClientProtocol#submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest)]]>
  5067. </doc>
  5068. </class>
  5069. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
  5070. <!-- start class org.apache.hadoop.yarn.api.records.Container -->
  5071. <class name="Container" extends="java.lang.Object"
  5072. abstract="true"
  5073. static="false" final="false" visibility="public"
  5074. deprecated="not deprecated">
  5075. <implements name="java.lang.Comparable"/>
  5076. <constructor name="Container"
  5077. static="false" final="false" visibility="public"
  5078. deprecated="not deprecated">
  5079. </constructor>
  5080. <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5081. abstract="true" native="false" synchronized="false"
  5082. static="false" final="false" visibility="public"
  5083. deprecated="not deprecated">
  5084. <doc>
  5085. <![CDATA[Get the globally unique identifier for the container.
  5086. @return globally unique identifier for the container]]>
  5087. </doc>
  5088. </method>
  5089. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  5090. abstract="true" native="false" synchronized="false"
  5091. static="false" final="false" visibility="public"
  5092. deprecated="not deprecated">
  5093. <doc>
  5094. <![CDATA[Get the identifier of the node on which the container is allocated.
  5095. @return identifier of the node on which the container is allocated]]>
  5096. </doc>
  5097. </method>
  5098. <method name="getNodeHttpAddress" return="java.lang.String"
  5099. abstract="true" native="false" synchronized="false"
  5100. static="false" final="false" visibility="public"
  5101. deprecated="not deprecated">
  5102. <doc>
  5103. <![CDATA[Get the http uri of the node on which the container is allocated.
  5104. @return http uri of the node on which the container is allocated]]>
  5105. </doc>
  5106. </method>
  5107. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  5108. abstract="true" native="false" synchronized="false"
  5109. static="false" final="false" visibility="public"
  5110. deprecated="not deprecated">
  5111. <doc>
  5112. <![CDATA[Get the <code>Resource</code> allocated to the container.
  5113. @return <code>Resource</code> allocated to the container]]>
  5114. </doc>
  5115. </method>
  5116. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  5117. abstract="true" native="false" synchronized="false"
  5118. static="false" final="false" visibility="public"
  5119. deprecated="not deprecated">
  5120. <doc>
  5121. <![CDATA[Get the <code>Priority</code> at which the <code>Container</code> was
  5122. allocated.
  5123. @return <code>Priority</code> at which the <code>Container</code> was
  5124. allocated]]>
  5125. </doc>
  5126. </method>
  5127. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  5128. abstract="true" native="false" synchronized="false"
  5129. static="false" final="false" visibility="public"
  5130. deprecated="not deprecated">
  5131. <doc>
  5132. <![CDATA[Get the <code>ContainerToken</code> for the container.
  5133. <p><code>ContainerToken</code> is the security token used by the framework
  5134. to verify authenticity of any <code>Container</code>.</p>
  5135. <p>The <code>ResourceManager</code>, on container allocation provides a
  5136. secure token which is verified by the <code>NodeManager</code> on
  5137. container launch.</p>
  5138. <p>Applications do not need to care about <code>ContainerToken</code>, they
  5139. are transparently handled by the framework - the allocated
  5140. <code>Container</code> includes the <code>ContainerToken</code>.</p>
  5141. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
  5142. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
  5143. @return <code>ContainerToken</code> for the container]]>
  5144. </doc>
  5145. </method>
  5146. <doc>
  5147. <![CDATA[<p><code>Container</code> represents an allocated resource in the cluster.
  5148. </p>
  5149. <p>The <code>ResourceManager</code> is the sole authority to allocate any
  5150. <code>Container</code> to applications. The allocated <code>Container</code>
  5151. is always on a single node and has a unique {@link ContainerId}. It has
  5152. a specific amount of {@link Resource} allocated.</p>
  5153. <p>It includes details such as:
  5154. <ul>
  5155. <li>{@link ContainerId} for the container, which is globally unique.</li>
  5156. <li>
  5157. {@link NodeId} of the node on which it is allocated.
  5158. </li>
  5159. <li>HTTP uri of the node.</li>
  5160. <li>{@link Resource} allocated to the container.</li>
  5161. <li>{@link Priority} at which the container was allocated.</li>
  5162. <li>
  5163. Container {@link Token} of the container, used to securely verify
  5164. authenticity of the allocation.
  5165. </li>
  5166. </ul>
  5167. </p>
  5168. <p>Typically, an <code>ApplicationMaster</code> receives the
  5169. <code>Container</code> from the <code>ResourceManager</code> during
  5170. resource-negotiation and then talks to the <code>NodeManager</code> to
  5171. start/stop containers.</p>
  5172. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
  5173. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
  5174. @see ContainerManagementProtocol#stopContainers(org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest)]]>
  5175. </doc>
  5176. </class>
  5177. <!-- end class org.apache.hadoop.yarn.api.records.Container -->
  5178. <!-- start class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
  5179. <class name="ContainerExitStatus" extends="java.lang.Object"
  5180. abstract="false"
  5181. static="false" final="false" visibility="public"
  5182. deprecated="not deprecated">
  5183. <constructor name="ContainerExitStatus"
  5184. static="false" final="false" visibility="public"
  5185. deprecated="not deprecated">
  5186. </constructor>
  5187. <field name="SUCCESS" type="int"
  5188. transient="false" volatile="false"
  5189. static="true" final="true" visibility="public"
  5190. deprecated="not deprecated">
  5191. </field>
  5192. <field name="INVALID" type="int"
  5193. transient="false" volatile="false"
  5194. static="true" final="true" visibility="public"
  5195. deprecated="not deprecated">
  5196. </field>
  5197. <field name="ABORTED" type="int"
  5198. transient="false" volatile="false"
  5199. static="true" final="true" visibility="public"
  5200. deprecated="not deprecated">
  5201. <doc>
  5202. <![CDATA[Containers killed by the framework, either due to being released by
  5203. the application or being 'lost' due to node failures etc.]]>
  5204. </doc>
  5205. </field>
  5206. <field name="DISKS_FAILED" type="int"
  5207. transient="false" volatile="false"
  5208. static="true" final="true" visibility="public"
  5209. deprecated="not deprecated">
  5210. <doc>
  5211. <![CDATA[When threshold number of the nodemanager-local-directories or
  5212. threshold number of the nodemanager-log-directories become bad.]]>
  5213. </doc>
  5214. </field>
  5215. <field name="PREEMPTED" type="int"
  5216. transient="false" volatile="false"
  5217. static="true" final="true" visibility="public"
  5218. deprecated="not deprecated">
  5219. <doc>
  5220. <![CDATA[Containers preempted by the framework.]]>
  5221. </doc>
  5222. </field>
  5223. <field name="KILLED_EXCEEDED_VMEM" type="int"
  5224. transient="false" volatile="false"
  5225. static="true" final="true" visibility="public"
  5226. deprecated="not deprecated">
  5227. <doc>
  5228. <![CDATA[Container terminated because of exceeding allocated virtual memory.]]>
  5229. </doc>
  5230. </field>
  5231. <field name="KILLED_EXCEEDED_PMEM" type="int"
  5232. transient="false" volatile="false"
  5233. static="true" final="true" visibility="public"
  5234. deprecated="not deprecated">
  5235. <doc>
  5236. <![CDATA[Container terminated because of exceeding allocated physical memory.]]>
  5237. </doc>
  5238. </field>
  5239. <field name="KILLED_BY_APPMASTER" type="int"
  5240. transient="false" volatile="false"
  5241. static="true" final="true" visibility="public"
  5242. deprecated="not deprecated">
  5243. <doc>
  5244. <![CDATA[Container was terminated by stop request by the app master.]]>
  5245. </doc>
  5246. </field>
  5247. <field name="KILLED_BY_RESOURCEMANAGER" type="int"
  5248. transient="false" volatile="false"
  5249. static="true" final="true" visibility="public"
  5250. deprecated="not deprecated">
  5251. <doc>
  5252. <![CDATA[Container was terminated by the resource manager.]]>
  5253. </doc>
  5254. </field>
  5255. <field name="KILLED_AFTER_APP_COMPLETION" type="int"
  5256. transient="false" volatile="false"
  5257. static="true" final="true" visibility="public"
  5258. deprecated="not deprecated">
  5259. <doc>
  5260. <![CDATA[Container was terminated after the application finished.]]>
  5261. </doc>
  5262. </field>
  5263. <doc>
  5264. <![CDATA[Container exit statuses indicating special exit circumstances.]]>
  5265. </doc>
  5266. </class>
  5267. <!-- end class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
  5268. <!-- start class org.apache.hadoop.yarn.api.records.ContainerId -->
  5269. <class name="ContainerId" extends="java.lang.Object"
  5270. abstract="true"
  5271. static="false" final="false" visibility="public"
  5272. deprecated="not deprecated">
  5273. <implements name="java.lang.Comparable"/>
  5274. <constructor name="ContainerId"
  5275. static="false" final="false" visibility="public"
  5276. deprecated="not deprecated">
  5277. </constructor>
  5278. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  5279. abstract="true" native="false" synchronized="false"
  5280. static="false" final="false" visibility="public"
  5281. deprecated="not deprecated">
  5282. <doc>
  5283. <![CDATA[Get the <code>ApplicationAttemptId</code> of the application to which the
  5284. <code>Container</code> was assigned.
  5285. <p>
  5286. Note: If containers are kept alive across application attempts via
  5287. {@link ApplicationSubmissionContext#setKeepContainersAcrossApplicationAttempts(boolean)}
  5288. the <code>ContainerId</code> does not necessarily contain the current
  5289. running application attempt's <code>ApplicationAttemptId</code> This
  5290. container can be allocated by previously exited application attempt and
  5291. managed by the current running attempt thus have the previous application
  5292. attempt's <code>ApplicationAttemptId</code>.
  5293. </p>
  5294. @return <code>ApplicationAttemptId</code> of the application to which the
  5295. <code>Container</code> was assigned]]>
  5296. </doc>
  5297. </method>
  5298. <method name="getId" return="int"
  5299. abstract="true" native="false" synchronized="false"
  5300. static="false" final="false" visibility="public"
  5301. deprecated="not deprecated">
  5302. <doc>
  5303. <![CDATA[Get the lower 32 bits of identifier of the <code>ContainerId</code>,
  5304. which doesn't include epoch. Note that this method will be marked as
  5305. deprecated, so please use <code>getContainerId</code> instead.
  5306. @return lower 32 bits of identifier of the <code>ContainerId</code>]]>
  5307. </doc>
  5308. </method>
  5309. <method name="getContainerId" return="long"
  5310. abstract="true" native="false" synchronized="false"
  5311. static="false" final="false" visibility="public"
  5312. deprecated="not deprecated">
  5313. <doc>
  5314. <![CDATA[Get the identifier of the <code>ContainerId</code>. Upper 24 bits are
  5315. reserved as epoch of cluster, and lower 40 bits are reserved as
  5316. sequential number of containers.
  5317. @return identifier of the <code>ContainerId</code>]]>
  5318. </doc>
  5319. </method>
  5320. <method name="hashCode" return="int"
  5321. abstract="false" native="false" synchronized="false"
  5322. static="false" final="false" visibility="public"
  5323. deprecated="not deprecated">
  5324. </method>
  5325. <method name="equals" return="boolean"
  5326. abstract="false" native="false" synchronized="false"
  5327. static="false" final="false" visibility="public"
  5328. deprecated="not deprecated">
  5329. <param name="obj" type="java.lang.Object"/>
  5330. </method>
  5331. <method name="compareTo" return="int"
  5332. abstract="false" native="false" synchronized="false"
  5333. static="false" final="false" visibility="public"
  5334. deprecated="not deprecated">
  5335. <param name="other" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5336. </method>
  5337. <method name="toString" return="java.lang.String"
  5338. abstract="false" native="false" synchronized="false"
  5339. static="false" final="false" visibility="public"
  5340. deprecated="not deprecated">
  5341. <doc>
  5342. <![CDATA[@return A string representation of containerId. The format is
  5343. container_e*epoch*_*clusterTimestamp*_*appId*_*attemptId*_*containerId*
  5344. when epoch is larger than 0
  5345. (e.g. container_e17_1410901177871_0001_01_000005).
  5346. *epoch* is increased when RM restarts or fails over.
  5347. When epoch is 0, epoch is omitted
  5348. (e.g. container_1410901177871_0001_01_000005).]]>
  5349. </doc>
  5350. </method>
  5351. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5352. abstract="false" native="false" synchronized="false"
  5353. static="true" final="false" visibility="public"
  5354. deprecated="not deprecated">
  5355. <param name="containerIdStr" type="java.lang.String"/>
  5356. </method>
  5357. <method name="build"
  5358. abstract="true" native="false" synchronized="false"
  5359. static="false" final="false" visibility="protected"
  5360. deprecated="not deprecated">
  5361. </method>
  5362. <field name="CONTAINER_ID_BITMASK" type="long"
  5363. transient="false" volatile="false"
  5364. static="true" final="true" visibility="public"
  5365. deprecated="not deprecated">
  5366. </field>
  5367. <doc>
  5368. <![CDATA[<p><code>ContainerId</code> represents a globally unique identifier
  5369. for a {@link Container} in the cluster.</p>]]>
  5370. </doc>
  5371. </class>
  5372. <!-- end class org.apache.hadoop.yarn.api.records.ContainerId -->
  5373. <!-- start class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
  5374. <class name="ContainerLaunchContext" extends="java.lang.Object"
  5375. abstract="true"
  5376. static="false" final="false" visibility="public"
  5377. deprecated="not deprecated">
  5378. <constructor name="ContainerLaunchContext"
  5379. static="false" final="false" visibility="public"
  5380. deprecated="not deprecated">
  5381. </constructor>
  5382. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  5383. abstract="false" native="false" synchronized="false"
  5384. static="true" final="false" visibility="public"
  5385. deprecated="not deprecated">
  5386. <param name="localResources" type="java.util.Map"/>
  5387. <param name="environment" type="java.util.Map"/>
  5388. <param name="commands" type="java.util.List"/>
  5389. <param name="serviceData" type="java.util.Map"/>
  5390. <param name="tokens" type="java.nio.ByteBuffer"/>
  5391. <param name="acls" type="java.util.Map"/>
  5392. </method>
  5393. <method name="getTokens" return="java.nio.ByteBuffer"
  5394. abstract="true" native="false" synchronized="false"
  5395. static="false" final="false" visibility="public"
  5396. deprecated="not deprecated">
  5397. <doc>
  5398. <![CDATA[Get all the tokens needed by this container. It may include file-system
  5399. tokens, ApplicationMaster related tokens if this container is an
  5400. ApplicationMaster or framework level tokens needed by this container to
  5401. communicate to various services in a secure manner.
  5402. @return tokens needed by this container.]]>
  5403. </doc>
  5404. </method>
  5405. <method name="setTokens"
  5406. abstract="true" native="false" synchronized="false"
  5407. static="false" final="false" visibility="public"
  5408. deprecated="not deprecated">
  5409. <param name="tokens" type="java.nio.ByteBuffer"/>
  5410. <doc>
  5411. <![CDATA[Set security tokens needed by this container.
  5412. @param tokens security tokens]]>
  5413. </doc>
  5414. </method>
  5415. <method name="getLocalResources" return="java.util.Map"
  5416. abstract="true" native="false" synchronized="false"
  5417. static="false" final="false" visibility="public"
  5418. deprecated="not deprecated">
  5419. <doc>
  5420. <![CDATA[Get <code>LocalResource</code> required by the container.
  5421. @return all <code>LocalResource</code> required by the container]]>
  5422. </doc>
  5423. </method>
  5424. <method name="setLocalResources"
  5425. abstract="true" native="false" synchronized="false"
  5426. static="false" final="false" visibility="public"
  5427. deprecated="not deprecated">
  5428. <param name="localResources" type="java.util.Map"/>
  5429. <doc>
  5430. <![CDATA[Set <code>LocalResource</code> required by the container. All pre-existing
  5431. Map entries are cleared before adding the new Map
  5432. @param localResources <code>LocalResource</code> required by the container]]>
  5433. </doc>
  5434. </method>
  5435. <method name="getServiceData" return="java.util.Map"
  5436. abstract="true" native="false" synchronized="false"
  5437. static="false" final="false" visibility="public"
  5438. deprecated="not deprecated">
  5439. <doc>
  5440. <![CDATA[<p>
  5441. Get application-specific binary <em>service data</em>. This is a map keyed
  5442. by the name of each {@link AuxiliaryService} that is configured on a
  5443. NodeManager and value correspond to the application specific data targeted
  5444. for the keyed {@link AuxiliaryService}.
  5445. </p>
  5446. <p>
  5447. This will be used to initialize this application on the specific
  5448. {@link AuxiliaryService} running on the NodeManager by calling
  5449. {@link AuxiliaryService#initializeApplication(ApplicationInitializationContext)}
  5450. </p>
  5451. @return application-specific binary <em>service data</em>]]>
  5452. </doc>
  5453. </method>
  5454. <method name="setServiceData"
  5455. abstract="true" native="false" synchronized="false"
  5456. static="false" final="false" visibility="public"
  5457. deprecated="not deprecated">
  5458. <param name="serviceData" type="java.util.Map"/>
  5459. <doc>
  5460. <![CDATA[<p>
  5461. Set application-specific binary <em>service data</em>. This is a map keyed
  5462. by the name of each {@link AuxiliaryService} that is configured on a
  5463. NodeManager and value correspond to the application specific data targeted
  5464. for the keyed {@link AuxiliaryService}. All pre-existing Map entries are
  5465. preserved.
  5466. </p>
  5467. @param serviceData
  5468. application-specific binary <em>service data</em>]]>
  5469. </doc>
  5470. </method>
  5471. <method name="getEnvironment" return="java.util.Map"
  5472. abstract="true" native="false" synchronized="false"
  5473. static="false" final="false" visibility="public"
  5474. deprecated="not deprecated">
  5475. <doc>
  5476. <![CDATA[Get <em>environment variables</em> for the container.
  5477. @return <em>environment variables</em> for the container]]>
  5478. </doc>
  5479. </method>
  5480. <method name="setEnvironment"
  5481. abstract="true" native="false" synchronized="false"
  5482. static="false" final="false" visibility="public"
  5483. deprecated="not deprecated">
  5484. <param name="environment" type="java.util.Map"/>
  5485. <doc>
  5486. <![CDATA[Add <em>environment variables</em> for the container. All pre-existing Map
  5487. entries are cleared before adding the new Map
  5488. @param environment <em>environment variables</em> for the container]]>
  5489. </doc>
  5490. </method>
  5491. <method name="getCommands" return="java.util.List"
  5492. abstract="true" native="false" synchronized="false"
  5493. static="false" final="false" visibility="public"
  5494. deprecated="not deprecated">
  5495. <doc>
  5496. <![CDATA[Get the list of <em>commands</em> for launching the container.
  5497. @return the list of <em>commands</em> for launching the container]]>
  5498. </doc>
  5499. </method>
  5500. <method name="setCommands"
  5501. abstract="true" native="false" synchronized="false"
  5502. static="false" final="false" visibility="public"
  5503. deprecated="not deprecated">
  5504. <param name="commands" type="java.util.List"/>
  5505. <doc>
  5506. <![CDATA[Add the list of <em>commands</em> for launching the container. All
  5507. pre-existing List entries are cleared before adding the new List
  5508. @param commands the list of <em>commands</em> for launching the container]]>
  5509. </doc>
  5510. </method>
  5511. <method name="getApplicationACLs" return="java.util.Map"
  5512. abstract="true" native="false" synchronized="false"
  5513. static="false" final="false" visibility="public"
  5514. deprecated="not deprecated">
  5515. <doc>
  5516. <![CDATA[Get the <code>ApplicationACL</code>s for the application.
  5517. @return all the <code>ApplicationACL</code>s]]>
  5518. </doc>
  5519. </method>
  5520. <method name="setApplicationACLs"
  5521. abstract="true" native="false" synchronized="false"
  5522. static="false" final="false" visibility="public"
  5523. deprecated="not deprecated">
  5524. <param name="acls" type="java.util.Map"/>
  5525. <doc>
  5526. <![CDATA[Set the <code>ApplicationACL</code>s for the application. All pre-existing
  5527. Map entries are cleared before adding the new Map
  5528. @param acls <code>ApplicationACL</code>s for the application]]>
  5529. </doc>
  5530. </method>
  5531. <doc>
  5532. <![CDATA[<p><code>ContainerLaunchContext</code> represents all of the information
  5533. needed by the <code>NodeManager</code> to launch a container.</p>
  5534. <p>It includes details such as:
  5535. <ul>
  5536. <li>{@link ContainerId} of the container.</li>
  5537. <li>{@link Resource} allocated to the container.</li>
  5538. <li>User to whom the container is allocated.</li>
  5539. <li>Security tokens (if security is enabled).</li>
  5540. <li>
  5541. {@link LocalResource} necessary for running the container such
  5542. as binaries, jar, shared-objects, side-files etc.
  5543. </li>
  5544. <li>Optional, application-specific binary service data.</li>
  5545. <li>Environment variables for the launched process.</li>
  5546. <li>Command to launch the container.</li>
  5547. </ul>
  5548. </p>
  5549. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  5550. </doc>
  5551. </class>
  5552. <!-- end class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
  5553. <!-- start class org.apache.hadoop.yarn.api.records.ContainerReport -->
  5554. <class name="ContainerReport" extends="java.lang.Object"
  5555. abstract="true"
  5556. static="false" final="false" visibility="public"
  5557. deprecated="not deprecated">
  5558. <constructor name="ContainerReport"
  5559. static="false" final="false" visibility="public"
  5560. deprecated="not deprecated">
  5561. </constructor>
  5562. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5563. abstract="true" native="false" synchronized="false"
  5564. static="false" final="false" visibility="public"
  5565. deprecated="not deprecated">
  5566. <doc>
  5567. <![CDATA[Get the <code>ContainerId</code> of the container.
  5568. @return <code>ContainerId</code> of the container.]]>
  5569. </doc>
  5570. </method>
  5571. <method name="setContainerId"
  5572. abstract="true" native="false" synchronized="false"
  5573. static="false" final="false" visibility="public"
  5574. deprecated="not deprecated">
  5575. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5576. </method>
  5577. <method name="getAllocatedResource" return="org.apache.hadoop.yarn.api.records.Resource"
  5578. abstract="true" native="false" synchronized="false"
  5579. static="false" final="false" visibility="public"
  5580. deprecated="not deprecated">
  5581. <doc>
  5582. <![CDATA[Get the allocated <code>Resource</code> of the container.
  5583. @return allocated <code>Resource</code> of the container.]]>
  5584. </doc>
  5585. </method>
  5586. <method name="setAllocatedResource"
  5587. abstract="true" native="false" synchronized="false"
  5588. static="false" final="false" visibility="public"
  5589. deprecated="not deprecated">
  5590. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5591. </method>
  5592. <method name="getAssignedNode" return="org.apache.hadoop.yarn.api.records.NodeId"
  5593. abstract="true" native="false" synchronized="false"
  5594. static="false" final="false" visibility="public"
  5595. deprecated="not deprecated">
  5596. <doc>
  5597. <![CDATA[Get the allocated <code>NodeId</code> where container is running.
  5598. @return allocated <code>NodeId</code> where container is running.]]>
  5599. </doc>
  5600. </method>
  5601. <method name="setAssignedNode"
  5602. abstract="true" native="false" synchronized="false"
  5603. static="false" final="false" visibility="public"
  5604. deprecated="not deprecated">
  5605. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  5606. </method>
  5607. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  5608. abstract="true" native="false" synchronized="false"
  5609. static="false" final="false" visibility="public"
  5610. deprecated="not deprecated">
  5611. <doc>
  5612. <![CDATA[Get the allocated <code>Priority</code> of the container.
  5613. @return allocated <code>Priority</code> of the container.]]>
  5614. </doc>
  5615. </method>
  5616. <method name="setPriority"
  5617. abstract="true" native="false" synchronized="false"
  5618. static="false" final="false" visibility="public"
  5619. deprecated="not deprecated">
  5620. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5621. </method>
  5622. <method name="getCreationTime" return="long"
  5623. abstract="true" native="false" synchronized="false"
  5624. static="false" final="false" visibility="public"
  5625. deprecated="not deprecated">
  5626. <doc>
  5627. <![CDATA[Get the creation time of the container.
  5628. @return creation time of the container]]>
  5629. </doc>
  5630. </method>
  5631. <method name="setCreationTime"
  5632. abstract="true" native="false" synchronized="false"
  5633. static="false" final="false" visibility="public"
  5634. deprecated="not deprecated">
  5635. <param name="creationTime" type="long"/>
  5636. </method>
  5637. <method name="getFinishTime" return="long"
  5638. abstract="true" native="false" synchronized="false"
  5639. static="false" final="false" visibility="public"
  5640. deprecated="not deprecated">
  5641. <doc>
  5642. <![CDATA[Get the Finish time of the container.
  5643. @return Finish time of the container]]>
  5644. </doc>
  5645. </method>
  5646. <method name="setFinishTime"
  5647. abstract="true" native="false" synchronized="false"
  5648. static="false" final="false" visibility="public"
  5649. deprecated="not deprecated">
  5650. <param name="finishTime" type="long"/>
  5651. </method>
  5652. <method name="getDiagnosticsInfo" return="java.lang.String"
  5653. abstract="true" native="false" synchronized="false"
  5654. static="false" final="false" visibility="public"
  5655. deprecated="not deprecated">
  5656. <doc>
  5657. <![CDATA[Get the DiagnosticsInfo of the container.
  5658. @return DiagnosticsInfo of the container]]>
  5659. </doc>
  5660. </method>
  5661. <method name="setDiagnosticsInfo"
  5662. abstract="true" native="false" synchronized="false"
  5663. static="false" final="false" visibility="public"
  5664. deprecated="not deprecated">
  5665. <param name="diagnosticsInfo" type="java.lang.String"/>
  5666. </method>
  5667. <method name="getLogUrl" return="java.lang.String"
  5668. abstract="true" native="false" synchronized="false"
  5669. static="false" final="false" visibility="public"
  5670. deprecated="not deprecated">
  5671. <doc>
  5672. <![CDATA[Get the LogURL of the container.
  5673. @return LogURL of the container]]>
  5674. </doc>
  5675. </method>
  5676. <method name="setLogUrl"
  5677. abstract="true" native="false" synchronized="false"
  5678. static="false" final="false" visibility="public"
  5679. deprecated="not deprecated">
  5680. <param name="logUrl" type="java.lang.String"/>
  5681. </method>
  5682. <method name="getContainerState" return="org.apache.hadoop.yarn.api.records.ContainerState"
  5683. abstract="true" native="false" synchronized="false"
  5684. static="false" final="false" visibility="public"
  5685. deprecated="not deprecated">
  5686. <doc>
  5687. <![CDATA[Get the final <code>ContainerState</code> of the container.
  5688. @return final <code>ContainerState</code> of the container.]]>
  5689. </doc>
  5690. </method>
  5691. <method name="setContainerState"
  5692. abstract="true" native="false" synchronized="false"
  5693. static="false" final="false" visibility="public"
  5694. deprecated="not deprecated">
  5695. <param name="containerState" type="org.apache.hadoop.yarn.api.records.ContainerState"/>
  5696. </method>
  5697. <method name="getContainerExitStatus" return="int"
  5698. abstract="true" native="false" synchronized="false"
  5699. static="false" final="false" visibility="public"
  5700. deprecated="not deprecated">
  5701. <doc>
  5702. <![CDATA[Get the final <code>exit status</code> of the container.
  5703. @return final <code>exit status</code> of the container.]]>
  5704. </doc>
  5705. </method>
  5706. <method name="setContainerExitStatus"
  5707. abstract="true" native="false" synchronized="false"
  5708. static="false" final="false" visibility="public"
  5709. deprecated="not deprecated">
  5710. <param name="containerExitStatus" type="int"/>
  5711. </method>
  5712. <doc>
  5713. <![CDATA[<p>
  5714. <code>ContainerReport</code> is a report of an container.
  5715. </p>
  5716. <p>
  5717. It includes details such as:
  5718. <ul>
  5719. <li>{@link ContainerId} of the container.</li>
  5720. <li>Allocated Resources to the container.</li>
  5721. <li>Assigned Node id.</li>
  5722. <li>Assigned Priority.</li>
  5723. <li>Creation Time.</li>
  5724. <li>Finish Time.</li>
  5725. <li>Container Exit Status.</li>
  5726. <li>{@link ContainerState} of the container.</li>
  5727. <li>Diagnostic information in case of errors.</li>
  5728. <li>Log URL.</li>
  5729. </ul>
  5730. </p>]]>
  5731. </doc>
  5732. </class>
  5733. <!-- end class org.apache.hadoop.yarn.api.records.ContainerReport -->
  5734. <!-- start class org.apache.hadoop.yarn.api.records.ContainerResourceDecrease -->
  5735. <class name="ContainerResourceDecrease" extends="java.lang.Object"
  5736. abstract="true"
  5737. static="false" final="false" visibility="public"
  5738. deprecated="not deprecated">
  5739. <constructor name="ContainerResourceDecrease"
  5740. static="false" final="false" visibility="public"
  5741. deprecated="not deprecated">
  5742. </constructor>
  5743. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerResourceDecrease"
  5744. abstract="false" native="false" synchronized="false"
  5745. static="true" final="false" visibility="public"
  5746. deprecated="not deprecated">
  5747. <param name="existingContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5748. <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5749. </method>
  5750. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5751. abstract="true" native="false" synchronized="false"
  5752. static="false" final="false" visibility="public"
  5753. deprecated="not deprecated">
  5754. </method>
  5755. <method name="setContainerId"
  5756. abstract="true" native="false" synchronized="false"
  5757. static="false" final="false" visibility="public"
  5758. deprecated="not deprecated">
  5759. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5760. </method>
  5761. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  5762. abstract="true" native="false" synchronized="false"
  5763. static="false" final="false" visibility="public"
  5764. deprecated="not deprecated">
  5765. </method>
  5766. <method name="setCapability"
  5767. abstract="true" native="false" synchronized="false"
  5768. static="false" final="false" visibility="public"
  5769. deprecated="not deprecated">
  5770. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5771. </method>
  5772. <method name="hashCode" return="int"
  5773. abstract="false" native="false" synchronized="false"
  5774. static="false" final="false" visibility="public"
  5775. deprecated="not deprecated">
  5776. </method>
  5777. <method name="equals" return="boolean"
  5778. abstract="false" native="false" synchronized="false"
  5779. static="false" final="false" visibility="public"
  5780. deprecated="not deprecated">
  5781. <param name="other" type="java.lang.Object"/>
  5782. </method>
  5783. <doc>
  5784. <![CDATA[Used by Application Master to ask Node Manager reduce size of a specified
  5785. container]]>
  5786. </doc>
  5787. </class>
  5788. <!-- end class org.apache.hadoop.yarn.api.records.ContainerResourceDecrease -->
  5789. <!-- start class org.apache.hadoop.yarn.api.records.ContainerResourceIncrease -->
  5790. <class name="ContainerResourceIncrease" extends="java.lang.Object"
  5791. abstract="true"
  5792. static="false" final="false" visibility="public"
  5793. deprecated="not deprecated">
  5794. <constructor name="ContainerResourceIncrease"
  5795. static="false" final="false" visibility="public"
  5796. deprecated="not deprecated">
  5797. </constructor>
  5798. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerResourceIncrease"
  5799. abstract="false" native="false" synchronized="false"
  5800. static="true" final="false" visibility="public"
  5801. deprecated="not deprecated">
  5802. <param name="existingContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5803. <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5804. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  5805. </method>
  5806. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5807. abstract="true" native="false" synchronized="false"
  5808. static="false" final="false" visibility="public"
  5809. deprecated="not deprecated">
  5810. </method>
  5811. <method name="setContainerId"
  5812. abstract="true" native="false" synchronized="false"
  5813. static="false" final="false" visibility="public"
  5814. deprecated="not deprecated">
  5815. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5816. </method>
  5817. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  5818. abstract="true" native="false" synchronized="false"
  5819. static="false" final="false" visibility="public"
  5820. deprecated="not deprecated">
  5821. </method>
  5822. <method name="setCapability"
  5823. abstract="true" native="false" synchronized="false"
  5824. static="false" final="false" visibility="public"
  5825. deprecated="not deprecated">
  5826. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5827. </method>
  5828. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  5829. abstract="true" native="false" synchronized="false"
  5830. static="false" final="false" visibility="public"
  5831. deprecated="not deprecated">
  5832. </method>
  5833. <method name="setContainerToken"
  5834. abstract="true" native="false" synchronized="false"
  5835. static="false" final="false" visibility="public"
  5836. deprecated="not deprecated">
  5837. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  5838. </method>
  5839. <method name="hashCode" return="int"
  5840. abstract="false" native="false" synchronized="false"
  5841. static="false" final="false" visibility="public"
  5842. deprecated="not deprecated">
  5843. </method>
  5844. <method name="equals" return="boolean"
  5845. abstract="false" native="false" synchronized="false"
  5846. static="false" final="false" visibility="public"
  5847. deprecated="not deprecated">
  5848. <param name="other" type="java.lang.Object"/>
  5849. </method>
  5850. <doc>
  5851. <![CDATA[Represent a new increased container accepted by Resource Manager]]>
  5852. </doc>
  5853. </class>
  5854. <!-- end class org.apache.hadoop.yarn.api.records.ContainerResourceIncrease -->
  5855. <!-- start class org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest -->
  5856. <class name="ContainerResourceIncreaseRequest" extends="java.lang.Object"
  5857. abstract="true"
  5858. static="false" final="false" visibility="public"
  5859. deprecated="not deprecated">
  5860. <constructor name="ContainerResourceIncreaseRequest"
  5861. static="false" final="false" visibility="public"
  5862. deprecated="not deprecated">
  5863. </constructor>
  5864. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest"
  5865. abstract="false" native="false" synchronized="false"
  5866. static="true" final="false" visibility="public"
  5867. deprecated="not deprecated">
  5868. <param name="existingContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5869. <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5870. </method>
  5871. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5872. abstract="true" native="false" synchronized="false"
  5873. static="false" final="false" visibility="public"
  5874. deprecated="not deprecated">
  5875. </method>
  5876. <method name="setContainerId"
  5877. abstract="true" native="false" synchronized="false"
  5878. static="false" final="false" visibility="public"
  5879. deprecated="not deprecated">
  5880. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5881. </method>
  5882. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  5883. abstract="true" native="false" synchronized="false"
  5884. static="false" final="false" visibility="public"
  5885. deprecated="not deprecated">
  5886. </method>
  5887. <method name="setCapability"
  5888. abstract="true" native="false" synchronized="false"
  5889. static="false" final="false" visibility="public"
  5890. deprecated="not deprecated">
  5891. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5892. </method>
  5893. <method name="hashCode" return="int"
  5894. abstract="false" native="false" synchronized="false"
  5895. static="false" final="false" visibility="public"
  5896. deprecated="not deprecated">
  5897. </method>
  5898. <method name="equals" return="boolean"
  5899. abstract="false" native="false" synchronized="false"
  5900. static="false" final="false" visibility="public"
  5901. deprecated="not deprecated">
  5902. <param name="other" type="java.lang.Object"/>
  5903. </method>
  5904. <doc>
  5905. <![CDATA[Used by Application Master, send a container resource increase request to
  5906. Resource Manager]]>
  5907. </doc>
  5908. </class>
  5909. <!-- end class org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest -->
  5910. <!-- start class org.apache.hadoop.yarn.api.records.ContainerState -->
  5911. <class name="ContainerState" extends="java.lang.Enum"
  5912. abstract="false"
  5913. static="false" final="true" visibility="public"
  5914. deprecated="not deprecated">
  5915. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerState[]"
  5916. abstract="false" native="false" synchronized="false"
  5917. static="true" final="false" visibility="public"
  5918. deprecated="not deprecated">
  5919. </method>
  5920. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerState"
  5921. abstract="false" native="false" synchronized="false"
  5922. static="true" final="false" visibility="public"
  5923. deprecated="not deprecated">
  5924. <param name="name" type="java.lang.String"/>
  5925. </method>
  5926. <doc>
  5927. <![CDATA[<p>State of a <code>Container</code>.</p>]]>
  5928. </doc>
  5929. </class>
  5930. <!-- end class org.apache.hadoop.yarn.api.records.ContainerState -->
  5931. <!-- start class org.apache.hadoop.yarn.api.records.ContainerStatus -->
  5932. <class name="ContainerStatus" extends="java.lang.Object"
  5933. abstract="true"
  5934. static="false" final="false" visibility="public"
  5935. deprecated="not deprecated">
  5936. <constructor name="ContainerStatus"
  5937. static="false" final="false" visibility="public"
  5938. deprecated="not deprecated">
  5939. </constructor>
  5940. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5941. abstract="true" native="false" synchronized="false"
  5942. static="false" final="false" visibility="public"
  5943. deprecated="not deprecated">
  5944. <doc>
  5945. <![CDATA[Get the <code>ContainerId</code> of the container.
  5946. @return <code>ContainerId</code> of the container]]>
  5947. </doc>
  5948. </method>
  5949. <method name="getState" return="org.apache.hadoop.yarn.api.records.ContainerState"
  5950. abstract="true" native="false" synchronized="false"
  5951. static="false" final="false" visibility="public"
  5952. deprecated="not deprecated">
  5953. <doc>
  5954. <![CDATA[Get the <code>ContainerState</code> of the container.
  5955. @return <code>ContainerState</code> of the container]]>
  5956. </doc>
  5957. </method>
  5958. <method name="getExitStatus" return="int"
  5959. abstract="true" native="false" synchronized="false"
  5960. static="false" final="false" visibility="public"
  5961. deprecated="not deprecated">
  5962. <doc>
  5963. <![CDATA[<p>Get the <em>exit status</em> for the container.</p>
  5964. <p>Note: This is valid only for completed containers i.e. containers
  5965. with state {@link ContainerState#COMPLETE}.
  5966. Otherwise, it returns an ContainerExitStatus.INVALID.
  5967. </p>
  5968. <p>Containers killed by the framework, either due to being released by
  5969. the application or being 'lost' due to node failures etc. have a special
  5970. exit code of ContainerExitStatus.ABORTED.</p>
  5971. <p>When threshold number of the nodemanager-local-directories or
  5972. threshold number of the nodemanager-log-directories become bad, then
  5973. container is not launched and is exited with ContainersExitStatus.DISKS_FAILED.
  5974. </p>
  5975. @return <em>exit status</em> for the container]]>
  5976. </doc>
  5977. </method>
  5978. <method name="getDiagnostics" return="java.lang.String"
  5979. abstract="true" native="false" synchronized="false"
  5980. static="false" final="false" visibility="public"
  5981. deprecated="not deprecated">
  5982. <doc>
  5983. <![CDATA[Get <em>diagnostic messages</em> for failed containers.
  5984. @return <em>diagnostic messages</em> for failed containers]]>
  5985. </doc>
  5986. </method>
  5987. <doc>
  5988. <![CDATA[<p><code>ContainerStatus</code> represents the current status of a
  5989. <code>Container</code>.</p>
  5990. <p>It provides details such as:
  5991. <ul>
  5992. <li><code>ContainerId</code> of the container.</li>
  5993. <li><code>ContainerState</code> of the container.</li>
  5994. <li><em>Exit status</em> of a completed container.</li>
  5995. <li><em>Diagnostic</em> message for a failed container.</li>
  5996. </ul>
  5997. </p>]]>
  5998. </doc>
  5999. </class>
  6000. <!-- end class org.apache.hadoop.yarn.api.records.ContainerStatus -->
  6001. <!-- start class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
  6002. <class name="FinalApplicationStatus" extends="java.lang.Enum"
  6003. abstract="false"
  6004. static="false" final="true" visibility="public"
  6005. deprecated="not deprecated">
  6006. <method name="values" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus[]"
  6007. abstract="false" native="false" synchronized="false"
  6008. static="true" final="false" visibility="public"
  6009. deprecated="not deprecated">
  6010. </method>
  6011. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  6012. abstract="false" native="false" synchronized="false"
  6013. static="true" final="false" visibility="public"
  6014. deprecated="not deprecated">
  6015. <param name="name" type="java.lang.String"/>
  6016. </method>
  6017. <doc>
  6018. <![CDATA[Enumeration of various final states of an <code>Application</code>.]]>
  6019. </doc>
  6020. </class>
  6021. <!-- end class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
  6022. <!-- start class org.apache.hadoop.yarn.api.records.LocalResource -->
  6023. <class name="LocalResource" extends="java.lang.Object"
  6024. abstract="true"
  6025. static="false" final="false" visibility="public"
  6026. deprecated="not deprecated">
  6027. <constructor name="LocalResource"
  6028. static="false" final="false" visibility="public"
  6029. deprecated="not deprecated">
  6030. </constructor>
  6031. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  6032. abstract="false" native="false" synchronized="false"
  6033. static="true" final="false" visibility="public"
  6034. deprecated="not deprecated">
  6035. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  6036. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  6037. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  6038. <param name="size" type="long"/>
  6039. <param name="timestamp" type="long"/>
  6040. <param name="pattern" type="java.lang.String"/>
  6041. </method>
  6042. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  6043. abstract="false" native="false" synchronized="false"
  6044. static="true" final="false" visibility="public"
  6045. deprecated="not deprecated">
  6046. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  6047. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  6048. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  6049. <param name="size" type="long"/>
  6050. <param name="timestamp" type="long"/>
  6051. </method>
  6052. <method name="getResource" return="org.apache.hadoop.yarn.api.records.URL"
  6053. abstract="true" native="false" synchronized="false"
  6054. static="false" final="false" visibility="public"
  6055. deprecated="not deprecated">
  6056. <doc>
  6057. <![CDATA[Get the <em>location</em> of the resource to be localized.
  6058. @return <em>location</em> of the resource to be localized]]>
  6059. </doc>
  6060. </method>
  6061. <method name="setResource"
  6062. abstract="true" native="false" synchronized="false"
  6063. static="false" final="false" visibility="public"
  6064. deprecated="not deprecated">
  6065. <param name="resource" type="org.apache.hadoop.yarn.api.records.URL"/>
  6066. <doc>
  6067. <![CDATA[Set <em>location</em> of the resource to be localized.
  6068. @param resource <em>location</em> of the resource to be localized]]>
  6069. </doc>
  6070. </method>
  6071. <method name="getSize" return="long"
  6072. abstract="true" native="false" synchronized="false"
  6073. static="false" final="false" visibility="public"
  6074. deprecated="not deprecated">
  6075. <doc>
  6076. <![CDATA[Get the <em>size</em> of the resource to be localized.
  6077. @return <em>size</em> of the resource to be localized]]>
  6078. </doc>
  6079. </method>
  6080. <method name="setSize"
  6081. abstract="true" native="false" synchronized="false"
  6082. static="false" final="false" visibility="public"
  6083. deprecated="not deprecated">
  6084. <param name="size" type="long"/>
  6085. <doc>
  6086. <![CDATA[Set the <em>size</em> of the resource to be localized.
  6087. @param size <em>size</em> of the resource to be localized]]>
  6088. </doc>
  6089. </method>
  6090. <method name="getTimestamp" return="long"
  6091. abstract="true" native="false" synchronized="false"
  6092. static="false" final="false" visibility="public"
  6093. deprecated="not deprecated">
  6094. <doc>
  6095. <![CDATA[Get the original <em>timestamp</em> of the resource to be localized, used
  6096. for verification.
  6097. @return <em>timestamp</em> of the resource to be localized]]>
  6098. </doc>
  6099. </method>
  6100. <method name="setTimestamp"
  6101. abstract="true" native="false" synchronized="false"
  6102. static="false" final="false" visibility="public"
  6103. deprecated="not deprecated">
  6104. <param name="timestamp" type="long"/>
  6105. <doc>
  6106. <![CDATA[Set the <em>timestamp</em> of the resource to be localized, used
  6107. for verification.
  6108. @param timestamp <em>timestamp</em> of the resource to be localized]]>
  6109. </doc>
  6110. </method>
  6111. <method name="getType" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
  6112. abstract="true" native="false" synchronized="false"
  6113. static="false" final="false" visibility="public"
  6114. deprecated="not deprecated">
  6115. <doc>
  6116. <![CDATA[Get the <code>LocalResourceType</code> of the resource to be localized.
  6117. @return <code>LocalResourceType</code> of the resource to be localized]]>
  6118. </doc>
  6119. </method>
  6120. <method name="setType"
  6121. abstract="true" native="false" synchronized="false"
  6122. static="false" final="false" visibility="public"
  6123. deprecated="not deprecated">
  6124. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  6125. <doc>
  6126. <![CDATA[Set the <code>LocalResourceType</code> of the resource to be localized.
  6127. @param type <code>LocalResourceType</code> of the resource to be localized]]>
  6128. </doc>
  6129. </method>
  6130. <method name="getVisibility" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
  6131. abstract="true" native="false" synchronized="false"
  6132. static="false" final="false" visibility="public"
  6133. deprecated="not deprecated">
  6134. <doc>
  6135. <![CDATA[Get the <code>LocalResourceVisibility</code> of the resource to be
  6136. localized.
  6137. @return <code>LocalResourceVisibility</code> of the resource to be
  6138. localized]]>
  6139. </doc>
  6140. </method>
  6141. <method name="setVisibility"
  6142. abstract="true" native="false" synchronized="false"
  6143. static="false" final="false" visibility="public"
  6144. deprecated="not deprecated">
  6145. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  6146. <doc>
  6147. <![CDATA[Set the <code>LocalResourceVisibility</code> of the resource to be
  6148. localized.
  6149. @param visibility <code>LocalResourceVisibility</code> of the resource to be
  6150. localized]]>
  6151. </doc>
  6152. </method>
  6153. <method name="getPattern" return="java.lang.String"
  6154. abstract="true" native="false" synchronized="false"
  6155. static="false" final="false" visibility="public"
  6156. deprecated="not deprecated">
  6157. <doc>
  6158. <![CDATA[Get the <em>pattern</em> that should be used to extract entries from the
  6159. archive (only used when type is <code>PATTERN</code>).
  6160. @return <em>pattern</em> that should be used to extract entries from the
  6161. archive.]]>
  6162. </doc>
  6163. </method>
  6164. <method name="setPattern"
  6165. abstract="true" native="false" synchronized="false"
  6166. static="false" final="false" visibility="public"
  6167. deprecated="not deprecated">
  6168. <param name="pattern" type="java.lang.String"/>
  6169. <doc>
  6170. <![CDATA[Set the <em>pattern</em> that should be used to extract entries from the
  6171. archive (only used when type is <code>PATTERN</code>).
  6172. @param pattern <em>pattern</em> that should be used to extract entries
  6173. from the archive.]]>
  6174. </doc>
  6175. </method>
  6176. <doc>
  6177. <![CDATA[<p><code>LocalResource</code> represents a local resource required to
  6178. run a container.</p>
  6179. <p>The <code>NodeManager</code> is responsible for localizing the resource
  6180. prior to launching the container.</p>
  6181. <p>Applications can specify {@link LocalResourceType} and
  6182. {@link LocalResourceVisibility}.</p>
  6183. @see LocalResourceType
  6184. @see LocalResourceVisibility
  6185. @see ContainerLaunchContext
  6186. @see ApplicationSubmissionContext
  6187. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  6188. </doc>
  6189. </class>
  6190. <!-- end class org.apache.hadoop.yarn.api.records.LocalResource -->
  6191. <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceType -->
  6192. <class name="LocalResourceType" extends="java.lang.Enum"
  6193. abstract="false"
  6194. static="false" final="true" visibility="public"
  6195. deprecated="not deprecated">
  6196. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceType[]"
  6197. abstract="false" native="false" synchronized="false"
  6198. static="true" final="false" visibility="public"
  6199. deprecated="not deprecated">
  6200. </method>
  6201. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
  6202. abstract="false" native="false" synchronized="false"
  6203. static="true" final="false" visibility="public"
  6204. deprecated="not deprecated">
  6205. <param name="name" type="java.lang.String"/>
  6206. </method>
  6207. <doc>
  6208. <![CDATA[<p><code>LocalResourceType</code> specifies the <em>type</em>
  6209. of a resource localized by the <code>NodeManager</code>.</p>
  6210. <p>The <em>type</em> can be one of:
  6211. <ul>
  6212. <li>
  6213. {@link #FILE} - Regular file i.e. uninterpreted bytes.
  6214. </li>
  6215. <li>
  6216. {@link #ARCHIVE} - Archive, which is automatically unarchived by the
  6217. <code>NodeManager</code>.
  6218. </li>
  6219. <li>
  6220. {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}.
  6221. </ul>
  6222. </p>
  6223. @see LocalResource
  6224. @see ContainerLaunchContext
  6225. @see ApplicationSubmissionContext
  6226. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  6227. </doc>
  6228. </class>
  6229. <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceType -->
  6230. <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
  6231. <class name="LocalResourceVisibility" extends="java.lang.Enum"
  6232. abstract="false"
  6233. static="false" final="true" visibility="public"
  6234. deprecated="not deprecated">
  6235. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility[]"
  6236. abstract="false" native="false" synchronized="false"
  6237. static="true" final="false" visibility="public"
  6238. deprecated="not deprecated">
  6239. </method>
  6240. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
  6241. abstract="false" native="false" synchronized="false"
  6242. static="true" final="false" visibility="public"
  6243. deprecated="not deprecated">
  6244. <param name="name" type="java.lang.String"/>
  6245. </method>
  6246. <doc>
  6247. <![CDATA[<p><code>LocalResourceVisibility</code> specifies the <em>visibility</em>
  6248. of a resource localized by the <code>NodeManager</code>.</p>
  6249. <p>The <em>visibility</em> can be one of:
  6250. <ul>
  6251. <li>{@link #PUBLIC} - Shared by all users on the node.</li>
  6252. <li>
  6253. {@link #PRIVATE} - Shared among all applications of the
  6254. <em>same user</em> on the node.
  6255. </li>
  6256. <li>
  6257. {@link #APPLICATION} - Shared only among containers of the
  6258. <em>same application</em> on the node.
  6259. </li>
  6260. </ul>
  6261. </p>
  6262. @see LocalResource
  6263. @see ContainerLaunchContext
  6264. @see ApplicationSubmissionContext
  6265. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  6266. </doc>
  6267. </class>
  6268. <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
  6269. <!-- start class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
  6270. <class name="LogAggregationContext" extends="java.lang.Object"
  6271. abstract="true"
  6272. static="false" final="false" visibility="public"
  6273. deprecated="not deprecated">
  6274. <constructor name="LogAggregationContext"
  6275. static="false" final="false" visibility="public"
  6276. deprecated="not deprecated">
  6277. </constructor>
  6278. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  6279. abstract="false" native="false" synchronized="false"
  6280. static="true" final="false" visibility="public"
  6281. deprecated="not deprecated">
  6282. <param name="includePattern" type="java.lang.String"/>
  6283. <param name="excludePattern" type="java.lang.String"/>
  6284. </method>
  6285. <method name="getIncludePattern" return="java.lang.String"
  6286. abstract="true" native="false" synchronized="false"
  6287. static="false" final="false" visibility="public"
  6288. deprecated="not deprecated">
  6289. <doc>
  6290. <![CDATA[Get include pattern
  6291. @return include pattern]]>
  6292. </doc>
  6293. </method>
  6294. <method name="setIncludePattern"
  6295. abstract="true" native="false" synchronized="false"
  6296. static="false" final="false" visibility="public"
  6297. deprecated="not deprecated">
  6298. <param name="includePattern" type="java.lang.String"/>
  6299. <doc>
  6300. <![CDATA[Set include pattern
  6301. @param includePattern]]>
  6302. </doc>
  6303. </method>
  6304. <method name="getExcludePattern" return="java.lang.String"
  6305. abstract="true" native="false" synchronized="false"
  6306. static="false" final="false" visibility="public"
  6307. deprecated="not deprecated">
  6308. <doc>
  6309. <![CDATA[Get exclude pattern
  6310. @return exclude pattern]]>
  6311. </doc>
  6312. </method>
  6313. <method name="setExcludePattern"
  6314. abstract="true" native="false" synchronized="false"
  6315. static="false" final="false" visibility="public"
  6316. deprecated="not deprecated">
  6317. <param name="excludePattern" type="java.lang.String"/>
  6318. <doc>
  6319. <![CDATA[Set exclude pattern
  6320. @param excludePattern]]>
  6321. </doc>
  6322. </method>
  6323. <doc>
  6324. <![CDATA[<p><code>LogAggregationContext</code> represents all of the
  6325. information needed by the <code>NodeManager</code> to handle
  6326. the logs for an application.</p>
  6327. <p>It includes details such as:
  6328. <ul>
  6329. <li>includePattern. It uses Java Regex to filter the log files
  6330. which match the defined include pattern and those log files
  6331. will be uploaded. </li>
  6332. <li>excludePattern. It uses Java Regex to filter the log files
  6333. which match the defined exclude pattern and those log files
  6334. will not be uploaded. If the log file name matches both the
  6335. include and the exclude pattern, this file will be excluded eventually</li>
  6336. </ul>
  6337. </p>
  6338. @see ApplicationSubmissionContext]]>
  6339. </doc>
  6340. </class>
  6341. <!-- end class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
  6342. <!-- start class org.apache.hadoop.yarn.api.records.NMToken -->
  6343. <class name="NMToken" extends="java.lang.Object"
  6344. abstract="true"
  6345. static="false" final="false" visibility="public"
  6346. deprecated="not deprecated">
  6347. <constructor name="NMToken"
  6348. static="false" final="false" visibility="public"
  6349. deprecated="not deprecated">
  6350. </constructor>
  6351. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  6352. abstract="true" native="false" synchronized="false"
  6353. static="false" final="false" visibility="public"
  6354. deprecated="not deprecated">
  6355. <doc>
  6356. <![CDATA[Get the {@link NodeId} of the <code>NodeManager</code> for which the NMToken
  6357. is used to authenticate.
  6358. @return the {@link NodeId} of the <code>NodeManager</code> for which the
  6359. NMToken is used to authenticate.]]>
  6360. </doc>
  6361. </method>
  6362. <method name="setNodeId"
  6363. abstract="true" native="false" synchronized="false"
  6364. static="false" final="false" visibility="public"
  6365. deprecated="not deprecated">
  6366. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  6367. </method>
  6368. <method name="getToken" return="org.apache.hadoop.yarn.api.records.Token"
  6369. abstract="true" native="false" synchronized="false"
  6370. static="false" final="false" visibility="public"
  6371. deprecated="not deprecated">
  6372. <doc>
  6373. <![CDATA[Get the {@link Token} used for authenticating with <code>NodeManager</code>
  6374. @return the {@link Token} used for authenticating with <code>NodeManager</code>]]>
  6375. </doc>
  6376. </method>
  6377. <method name="setToken"
  6378. abstract="true" native="false" synchronized="false"
  6379. static="false" final="false" visibility="public"
  6380. deprecated="not deprecated">
  6381. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  6382. </method>
  6383. <method name="hashCode" return="int"
  6384. abstract="false" native="false" synchronized="false"
  6385. static="false" final="false" visibility="public"
  6386. deprecated="not deprecated">
  6387. </method>
  6388. <method name="equals" return="boolean"
  6389. abstract="false" native="false" synchronized="false"
  6390. static="false" final="false" visibility="public"
  6391. deprecated="not deprecated">
  6392. <param name="obj" type="java.lang.Object"/>
  6393. </method>
  6394. <doc>
  6395. <![CDATA[<p>The NMToken is used for authenticating communication with
  6396. <code>NodeManager</code></p>
  6397. <p>It is issued by <code>ResourceMananger</code> when <code>ApplicationMaster</code>
  6398. negotiates resource with <code>ResourceManager</code> and
  6399. validated on <code>NodeManager</code> side.</p>
  6400. @see AllocateResponse#getNMTokens()]]>
  6401. </doc>
  6402. </class>
  6403. <!-- end class org.apache.hadoop.yarn.api.records.NMToken -->
  6404. <!-- start class org.apache.hadoop.yarn.api.records.NodeId -->
  6405. <class name="NodeId" extends="java.lang.Object"
  6406. abstract="true"
  6407. static="false" final="false" visibility="public"
  6408. deprecated="not deprecated">
  6409. <implements name="java.lang.Comparable"/>
  6410. <constructor name="NodeId"
  6411. static="false" final="false" visibility="public"
  6412. deprecated="not deprecated">
  6413. </constructor>
  6414. <method name="getHost" return="java.lang.String"
  6415. abstract="true" native="false" synchronized="false"
  6416. static="false" final="false" visibility="public"
  6417. deprecated="not deprecated">
  6418. <doc>
  6419. <![CDATA[Get the <em>hostname</em> of the node.
  6420. @return <em>hostname</em> of the node]]>
  6421. </doc>
  6422. </method>
  6423. <method name="getPort" return="int"
  6424. abstract="true" native="false" synchronized="false"
  6425. static="false" final="false" visibility="public"
  6426. deprecated="not deprecated">
  6427. <doc>
  6428. <![CDATA[Get the <em>port</em> for communicating with the node.
  6429. @return <em>port</em> for communicating with the node]]>
  6430. </doc>
  6431. </method>
  6432. <method name="toString" return="java.lang.String"
  6433. abstract="false" native="false" synchronized="false"
  6434. static="false" final="false" visibility="public"
  6435. deprecated="not deprecated">
  6436. </method>
  6437. <method name="hashCode" return="int"
  6438. abstract="false" native="false" synchronized="false"
  6439. static="false" final="false" visibility="public"
  6440. deprecated="not deprecated">
  6441. </method>
  6442. <method name="equals" return="boolean"
  6443. abstract="false" native="false" synchronized="false"
  6444. static="false" final="false" visibility="public"
  6445. deprecated="not deprecated">
  6446. <param name="obj" type="java.lang.Object"/>
  6447. </method>
  6448. <method name="compareTo" return="int"
  6449. abstract="false" native="false" synchronized="false"
  6450. static="false" final="false" visibility="public"
  6451. deprecated="not deprecated">
  6452. <param name="other" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  6453. </method>
  6454. <method name="build"
  6455. abstract="true" native="false" synchronized="false"
  6456. static="false" final="false" visibility="protected"
  6457. deprecated="not deprecated">
  6458. </method>
  6459. <doc>
  6460. <![CDATA[<p><code>NodeId</code> is the unique identifier for a node.</p>
  6461. <p>It includes the <em>hostname</em> and <em>port</em> to uniquely
  6462. identify the node. Thus, it is unique across restarts of any
  6463. <code>NodeManager</code>.</p>]]>
  6464. </doc>
  6465. </class>
  6466. <!-- end class org.apache.hadoop.yarn.api.records.NodeId -->
  6467. <!-- start class org.apache.hadoop.yarn.api.records.NodeReport -->
  6468. <class name="NodeReport" extends="java.lang.Object"
  6469. abstract="true"
  6470. static="false" final="false" visibility="public"
  6471. deprecated="not deprecated">
  6472. <constructor name="NodeReport"
  6473. static="false" final="false" visibility="public"
  6474. deprecated="not deprecated">
  6475. </constructor>
  6476. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  6477. abstract="true" native="false" synchronized="false"
  6478. static="false" final="false" visibility="public"
  6479. deprecated="not deprecated">
  6480. <doc>
  6481. <![CDATA[Get the <code>NodeId</code> of the node.
  6482. @return <code>NodeId</code> of the node]]>
  6483. </doc>
  6484. </method>
  6485. <method name="getNodeState" return="org.apache.hadoop.yarn.api.records.NodeState"
  6486. abstract="true" native="false" synchronized="false"
  6487. static="false" final="false" visibility="public"
  6488. deprecated="not deprecated">
  6489. <doc>
  6490. <![CDATA[Get the <code>NodeState</code> of the node.
  6491. @return <code>NodeState</code> of the node]]>
  6492. </doc>
  6493. </method>
  6494. <method name="getHttpAddress" return="java.lang.String"
  6495. abstract="true" native="false" synchronized="false"
  6496. static="false" final="false" visibility="public"
  6497. deprecated="not deprecated">
  6498. <doc>
  6499. <![CDATA[Get the <em>http address</em> of the node.
  6500. @return <em>http address</em> of the node]]>
  6501. </doc>
  6502. </method>
  6503. <method name="getRackName" return="java.lang.String"
  6504. abstract="true" native="false" synchronized="false"
  6505. static="false" final="false" visibility="public"
  6506. deprecated="not deprecated">
  6507. <doc>
  6508. <![CDATA[Get the <em>rack name</em> for the node.
  6509. @return <em>rack name</em> for the node]]>
  6510. </doc>
  6511. </method>
  6512. <method name="getUsed" return="org.apache.hadoop.yarn.api.records.Resource"
  6513. abstract="true" native="false" synchronized="false"
  6514. static="false" final="false" visibility="public"
  6515. deprecated="not deprecated">
  6516. <doc>
  6517. <![CDATA[Get <em>used</em> <code>Resource</code> on the node.
  6518. @return <em>used</em> <code>Resource</code> on the node]]>
  6519. </doc>
  6520. </method>
  6521. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  6522. abstract="true" native="false" synchronized="false"
  6523. static="false" final="false" visibility="public"
  6524. deprecated="not deprecated">
  6525. <doc>
  6526. <![CDATA[Get the <em>total</em> <code>Resource</code> on the node.
  6527. @return <em>total</em> <code>Resource</code> on the node]]>
  6528. </doc>
  6529. </method>
  6530. <method name="getHealthReport" return="java.lang.String"
  6531. abstract="true" native="false" synchronized="false"
  6532. static="false" final="false" visibility="public"
  6533. deprecated="not deprecated">
  6534. <doc>
  6535. <![CDATA[Get the <em>diagnostic health report</em> of the node.
  6536. @return <em>diagnostic health report</em> of the node]]>
  6537. </doc>
  6538. </method>
  6539. <method name="getLastHealthReportTime" return="long"
  6540. abstract="true" native="false" synchronized="false"
  6541. static="false" final="false" visibility="public"
  6542. deprecated="not deprecated">
  6543. <doc>
  6544. <![CDATA[Get the <em>last timestamp</em> at which the health report was received.
  6545. @return <em>last timestamp</em> at which the health report was received]]>
  6546. </doc>
  6547. </method>
  6548. <method name="getNodeLabels" return="java.util.Set"
  6549. abstract="true" native="false" synchronized="false"
  6550. static="false" final="false" visibility="public"
  6551. deprecated="not deprecated">
  6552. <doc>
  6553. <![CDATA[Get labels of this node
  6554. @return labels of this node]]>
  6555. </doc>
  6556. </method>
  6557. <doc>
  6558. <![CDATA[<p><code>NodeReport</code> is a summary of runtime information of a
  6559. node in the cluster.</p>
  6560. <p>It includes details such as:
  6561. <ul>
  6562. <li>{@link NodeId} of the node.</li>
  6563. <li>HTTP Tracking URL of the node.</li>
  6564. <li>Rack name for the node.</li>
  6565. <li>Used {@link Resource} on the node.</li>
  6566. <li>Total available {@link Resource} of the node.</li>
  6567. <li>Number of running containers on the node.</li>
  6568. </ul>
  6569. </p>
  6570. @see ApplicationClientProtocol#getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)]]>
  6571. </doc>
  6572. </class>
  6573. <!-- end class org.apache.hadoop.yarn.api.records.NodeReport -->
  6574. <!-- start class org.apache.hadoop.yarn.api.records.NodeState -->
  6575. <class name="NodeState" extends="java.lang.Enum"
  6576. abstract="false"
  6577. static="false" final="true" visibility="public"
  6578. deprecated="not deprecated">
  6579. <method name="values" return="org.apache.hadoop.yarn.api.records.NodeState[]"
  6580. abstract="false" native="false" synchronized="false"
  6581. static="true" final="false" visibility="public"
  6582. deprecated="not deprecated">
  6583. </method>
  6584. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.NodeState"
  6585. abstract="false" native="false" synchronized="false"
  6586. static="true" final="false" visibility="public"
  6587. deprecated="not deprecated">
  6588. <param name="name" type="java.lang.String"/>
  6589. </method>
  6590. <method name="isUnusable" return="boolean"
  6591. abstract="false" native="false" synchronized="false"
  6592. static="false" final="false" visibility="public"
  6593. deprecated="not deprecated">
  6594. </method>
  6595. <doc>
  6596. <![CDATA[<p>State of a <code>Node</code>.</p>]]>
  6597. </doc>
  6598. </class>
  6599. <!-- end class org.apache.hadoop.yarn.api.records.NodeState -->
  6600. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
  6601. <class name="PreemptionContainer" extends="java.lang.Object"
  6602. abstract="true"
  6603. static="false" final="false" visibility="public"
  6604. deprecated="not deprecated">
  6605. <constructor name="PreemptionContainer"
  6606. static="false" final="false" visibility="public"
  6607. deprecated="not deprecated">
  6608. </constructor>
  6609. <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  6610. abstract="true" native="false" synchronized="false"
  6611. static="false" final="false" visibility="public"
  6612. deprecated="not deprecated">
  6613. <doc>
  6614. <![CDATA[@return Container referenced by this handle.]]>
  6615. </doc>
  6616. </method>
  6617. <doc>
  6618. <![CDATA[Specific container requested back by the <code>ResourceManager</code>.
  6619. @see PreemptionContract
  6620. @see StrictPreemptionContract]]>
  6621. </doc>
  6622. </class>
  6623. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
  6624. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContract -->
  6625. <class name="PreemptionContract" extends="java.lang.Object"
  6626. abstract="true"
  6627. static="false" final="false" visibility="public"
  6628. deprecated="not deprecated">
  6629. <constructor name="PreemptionContract"
  6630. static="false" final="false" visibility="public"
  6631. deprecated="not deprecated">
  6632. </constructor>
  6633. <method name="getResourceRequest" return="java.util.List"
  6634. abstract="true" native="false" synchronized="false"
  6635. static="false" final="false" visibility="public"
  6636. deprecated="not deprecated">
  6637. <doc>
  6638. <![CDATA[If the AM releases resources matching these requests, then the {@link
  6639. PreemptionContainer}s enumerated in {@link #getContainers()} should not be
  6640. evicted from the cluster. Due to delays in propagating cluster state and
  6641. sending these messages, there are conditions where satisfied contracts may
  6642. not prevent the platform from killing containers.
  6643. @return List of {@link PreemptionResourceRequest} to update the
  6644. <code>ApplicationMaster</code> about resources requested back by the
  6645. <code>ResourceManager</code>.
  6646. @see AllocateRequest#setAskList(List)]]>
  6647. </doc>
  6648. </method>
  6649. <method name="getContainers" return="java.util.Set"
  6650. abstract="true" native="false" synchronized="false"
  6651. static="false" final="false" visibility="public"
  6652. deprecated="not deprecated">
  6653. <doc>
  6654. <![CDATA[Assign the set of {@link PreemptionContainer} specifying which containers
  6655. owned by the <code>ApplicationMaster</code> that may be reclaimed by the
  6656. <code>ResourceManager</code>. If the AM prefers a different set of
  6657. containers, then it may checkpoint or kill containers matching the
  6658. description in {@link #getResourceRequest}.
  6659. @return Set of containers at risk if the contract is not met.]]>
  6660. </doc>
  6661. </method>
  6662. <doc>
  6663. <![CDATA[Description of resources requested back by the <code>ResourceManager</code>.
  6664. The <code>ApplicationMaster</code> (AM) can satisfy this request according
  6665. to its own priorities to prevent containers from being forcibly killed by
  6666. the platform.
  6667. @see PreemptionMessage]]>
  6668. </doc>
  6669. </class>
  6670. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContract -->
  6671. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
  6672. <class name="PreemptionMessage" extends="java.lang.Object"
  6673. abstract="true"
  6674. static="false" final="false" visibility="public"
  6675. deprecated="not deprecated">
  6676. <constructor name="PreemptionMessage"
  6677. static="false" final="false" visibility="public"
  6678. deprecated="not deprecated">
  6679. </constructor>
  6680. <method name="getStrictContract" return="org.apache.hadoop.yarn.api.records.StrictPreemptionContract"
  6681. abstract="true" native="false" synchronized="false"
  6682. static="false" final="false" visibility="public"
  6683. deprecated="not deprecated">
  6684. <doc>
  6685. <![CDATA[@return Specific resources that may be killed by the
  6686. <code>ResourceManager</code>]]>
  6687. </doc>
  6688. </method>
  6689. <method name="getContract" return="org.apache.hadoop.yarn.api.records.PreemptionContract"
  6690. abstract="true" native="false" synchronized="false"
  6691. static="false" final="false" visibility="public"
  6692. deprecated="not deprecated">
  6693. <doc>
  6694. <![CDATA[@return Contract describing resources to return to the cluster.]]>
  6695. </doc>
  6696. </method>
  6697. <doc>
  6698. <![CDATA[<p>A {@link PreemptionMessage} is part of the RM-AM protocol, and it is used by
  6699. the RM to specify resources that the RM wants to reclaim from this
  6700. <code>ApplicationMaster</code> (AM). The AM receives a {@link
  6701. StrictPreemptionContract} message encoding which containers the platform may
  6702. forcibly kill, granting it an opportunity to checkpoint state or adjust its
  6703. execution plan. The message may also include a {@link PreemptionContract}
  6704. granting the AM more latitude in selecting which resources to return to the
  6705. cluster.<p>
  6706. <p>The AM should decode both parts of the message. The {@link
  6707. StrictPreemptionContract} specifies particular allocations that the RM
  6708. requires back. The AM can checkpoint containers' state, adjust its execution
  6709. plan to move the computation, or take no action and hope that conditions that
  6710. caused the RM to ask for the container will change.<p>
  6711. <p>In contrast, the {@link PreemptionContract} also includes a description of
  6712. resources with a set of containers. If the AM releases containers matching
  6713. that profile, then the containers enumerated in {@link
  6714. PreemptionContract#getContainers()} may not be killed.<p>
  6715. <p>Each preemption message reflects the RM's current understanding of the
  6716. cluster state, so a request to return <emph>N</emph> containers may not
  6717. reflect containers the AM is releasing, recently exited containers the RM has
  6718. yet to learn about, or new containers allocated before the message was
  6719. generated. Conversely, an RM may request a different profile of containers in
  6720. subsequent requests.<p>
  6721. <p>The policy enforced by the RM is part of the scheduler. Generally, only
  6722. containers that have been requested consistently should be killed, but the
  6723. details are not specified.<p>]]>
  6724. </doc>
  6725. </class>
  6726. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
  6727. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
  6728. <class name="PreemptionResourceRequest" extends="java.lang.Object"
  6729. abstract="true"
  6730. static="false" final="false" visibility="public"
  6731. deprecated="not deprecated">
  6732. <constructor name="PreemptionResourceRequest"
  6733. static="false" final="false" visibility="public"
  6734. deprecated="not deprecated">
  6735. </constructor>
  6736. <method name="getResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  6737. abstract="true" native="false" synchronized="false"
  6738. static="false" final="false" visibility="public"
  6739. deprecated="not deprecated">
  6740. <doc>
  6741. <![CDATA[@return Resource described in this request, to be matched against running
  6742. containers.]]>
  6743. </doc>
  6744. </method>
  6745. <doc>
  6746. <![CDATA[Description of resources requested back by the cluster.
  6747. @see PreemptionContract
  6748. @see AllocateRequest#setAskList(java.util.List)]]>
  6749. </doc>
  6750. </class>
  6751. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
  6752. <!-- start class org.apache.hadoop.yarn.api.records.Priority -->
  6753. <class name="Priority" extends="java.lang.Object"
  6754. abstract="true"
  6755. static="false" final="false" visibility="public"
  6756. deprecated="not deprecated">
  6757. <implements name="java.lang.Comparable"/>
  6758. <constructor name="Priority"
  6759. static="false" final="false" visibility="public"
  6760. deprecated="not deprecated">
  6761. </constructor>
  6762. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Priority"
  6763. abstract="false" native="false" synchronized="false"
  6764. static="true" final="false" visibility="public"
  6765. deprecated="not deprecated">
  6766. <param name="p" type="int"/>
  6767. </method>
  6768. <method name="getPriority" return="int"
  6769. abstract="true" native="false" synchronized="false"
  6770. static="false" final="false" visibility="public"
  6771. deprecated="not deprecated">
  6772. <doc>
  6773. <![CDATA[Get the assigned priority
  6774. @return the assigned priority]]>
  6775. </doc>
  6776. </method>
  6777. <method name="setPriority"
  6778. abstract="true" native="false" synchronized="false"
  6779. static="false" final="false" visibility="public"
  6780. deprecated="not deprecated">
  6781. <param name="priority" type="int"/>
  6782. <doc>
  6783. <![CDATA[Set the assigned priority
  6784. @param priority the assigned priority]]>
  6785. </doc>
  6786. </method>
  6787. <method name="hashCode" return="int"
  6788. abstract="false" native="false" synchronized="false"
  6789. static="false" final="false" visibility="public"
  6790. deprecated="not deprecated">
  6791. </method>
  6792. <method name="equals" return="boolean"
  6793. abstract="false" native="false" synchronized="false"
  6794. static="false" final="false" visibility="public"
  6795. deprecated="not deprecated">
  6796. <param name="obj" type="java.lang.Object"/>
  6797. </method>
  6798. <method name="compareTo" return="int"
  6799. abstract="false" native="false" synchronized="false"
  6800. static="false" final="false" visibility="public"
  6801. deprecated="not deprecated">
  6802. <param name="other" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6803. </method>
  6804. <method name="toString" return="java.lang.String"
  6805. abstract="false" native="false" synchronized="false"
  6806. static="false" final="false" visibility="public"
  6807. deprecated="not deprecated">
  6808. </method>
  6809. <field name="UNDEFINED" type="org.apache.hadoop.yarn.api.records.Priority"
  6810. transient="false" volatile="false"
  6811. static="true" final="true" visibility="public"
  6812. deprecated="not deprecated">
  6813. </field>
  6814. <doc>
  6815. <![CDATA[The priority assigned to a ResourceRequest or Application or Container
  6816. allocation]]>
  6817. </doc>
  6818. </class>
  6819. <!-- end class org.apache.hadoop.yarn.api.records.Priority -->
  6820. <!-- start class org.apache.hadoop.yarn.api.records.QueueACL -->
  6821. <class name="QueueACL" extends="java.lang.Enum"
  6822. abstract="false"
  6823. static="false" final="true" visibility="public"
  6824. deprecated="not deprecated">
  6825. <method name="values" return="org.apache.hadoop.yarn.api.records.QueueACL[]"
  6826. abstract="false" native="false" synchronized="false"
  6827. static="true" final="false" visibility="public"
  6828. deprecated="not deprecated">
  6829. </method>
  6830. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueACL"
  6831. abstract="false" native="false" synchronized="false"
  6832. static="true" final="false" visibility="public"
  6833. deprecated="not deprecated">
  6834. <param name="name" type="java.lang.String"/>
  6835. </method>
  6836. <doc>
  6837. <![CDATA[<p>
  6838. <code>QueueACL</code> enumerates the various ACLs for queues.
  6839. </p>
  6840. <p>
  6841. The ACL is one of:
  6842. <ul>
  6843. <li>{@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the
  6844. queue.</li>
  6845. <li>{@link #ADMINISTER_QUEUE} - ACL to administer the queue.</li>
  6846. </ul>
  6847. </p>
  6848. @see QueueInfo
  6849. @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
  6850. </doc>
  6851. </class>
  6852. <!-- end class org.apache.hadoop.yarn.api.records.QueueACL -->
  6853. <!-- start class org.apache.hadoop.yarn.api.records.QueueInfo -->
  6854. <class name="QueueInfo" extends="java.lang.Object"
  6855. abstract="true"
  6856. static="false" final="false" visibility="public"
  6857. deprecated="not deprecated">
  6858. <constructor name="QueueInfo"
  6859. static="false" final="false" visibility="public"
  6860. deprecated="not deprecated">
  6861. </constructor>
  6862. <method name="getQueueName" return="java.lang.String"
  6863. abstract="true" native="false" synchronized="false"
  6864. static="false" final="false" visibility="public"
  6865. deprecated="not deprecated">
  6866. <doc>
  6867. <![CDATA[Get the <em>name</em> of the queue.
  6868. @return <em>name</em> of the queue]]>
  6869. </doc>
  6870. </method>
  6871. <method name="getCapacity" return="float"
  6872. abstract="true" native="false" synchronized="false"
  6873. static="false" final="false" visibility="public"
  6874. deprecated="not deprecated">
  6875. <doc>
  6876. <![CDATA[Get the <em>configured capacity</em> of the queue.
  6877. @return <em>configured capacity</em> of the queue]]>
  6878. </doc>
  6879. </method>
  6880. <method name="getMaximumCapacity" return="float"
  6881. abstract="true" native="false" synchronized="false"
  6882. static="false" final="false" visibility="public"
  6883. deprecated="not deprecated">
  6884. <doc>
  6885. <![CDATA[Get the <em>maximum capacity</em> of the queue.
  6886. @return <em>maximum capacity</em> of the queue]]>
  6887. </doc>
  6888. </method>
  6889. <method name="getCurrentCapacity" return="float"
  6890. abstract="true" native="false" synchronized="false"
  6891. static="false" final="false" visibility="public"
  6892. deprecated="not deprecated">
  6893. <doc>
  6894. <![CDATA[Get the <em>current capacity</em> of the queue.
  6895. @return <em>current capacity</em> of the queue]]>
  6896. </doc>
  6897. </method>
  6898. <method name="getChildQueues" return="java.util.List"
  6899. abstract="true" native="false" synchronized="false"
  6900. static="false" final="false" visibility="public"
  6901. deprecated="not deprecated">
  6902. <doc>
  6903. <![CDATA[Get the <em>child queues</em> of the queue.
  6904. @return <em>child queues</em> of the queue]]>
  6905. </doc>
  6906. </method>
  6907. <method name="getApplications" return="java.util.List"
  6908. abstract="true" native="false" synchronized="false"
  6909. static="false" final="false" visibility="public"
  6910. deprecated="not deprecated">
  6911. <doc>
  6912. <![CDATA[Get the <em>running applications</em> of the queue.
  6913. @return <em>running applications</em> of the queue]]>
  6914. </doc>
  6915. </method>
  6916. <method name="getQueueState" return="org.apache.hadoop.yarn.api.records.QueueState"
  6917. abstract="true" native="false" synchronized="false"
  6918. static="false" final="false" visibility="public"
  6919. deprecated="not deprecated">
  6920. <doc>
  6921. <![CDATA[Get the <code>QueueState</code> of the queue.
  6922. @return <code>QueueState</code> of the queue]]>
  6923. </doc>
  6924. </method>
  6925. <method name="getAccessibleNodeLabels" return="java.util.Set"
  6926. abstract="true" native="false" synchronized="false"
  6927. static="false" final="false" visibility="public"
  6928. deprecated="not deprecated">
  6929. <doc>
  6930. <![CDATA[Get the <code>accessible node labels</code> of the queue.
  6931. @return <code>accessible node labels</code> of the queue]]>
  6932. </doc>
  6933. </method>
  6934. <method name="getDefaultNodeLabelExpression" return="java.lang.String"
  6935. abstract="true" native="false" synchronized="false"
  6936. static="false" final="false" visibility="public"
  6937. deprecated="not deprecated">
  6938. <doc>
  6939. <![CDATA[Get the <code>default node label expression</code> of the queue, this takes
  6940. affect only when the <code>ApplicationSubmissionContext</code> and
  6941. <code>ResourceRequest</code> don't specify their
  6942. <code>NodeLabelExpression</code>.
  6943. @return <code>default node label expression</code> of the queue]]>
  6944. </doc>
  6945. </method>
  6946. <method name="setDefaultNodeLabelExpression"
  6947. abstract="true" native="false" synchronized="false"
  6948. static="false" final="false" visibility="public"
  6949. deprecated="not deprecated">
  6950. <param name="defaultLabelExpression" type="java.lang.String"/>
  6951. </method>
  6952. <doc>
  6953. <![CDATA[<p>QueueInfo is a report of the runtime information of the queue.</p>
  6954. <p>It includes information such as:
  6955. <ul>
  6956. <li>Queue name.</li>
  6957. <li>Capacity of the queue.</li>
  6958. <li>Maximum capacity of the queue.</li>
  6959. <li>Current capacity of the queue.</li>
  6960. <li>Child queues.</li>
  6961. <li>Running applications.</li>
  6962. <li>{@link QueueState} of the queue.</li>
  6963. </ul>
  6964. </p>
  6965. @see QueueState
  6966. @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
  6967. </doc>
  6968. </class>
  6969. <!-- end class org.apache.hadoop.yarn.api.records.QueueInfo -->
  6970. <!-- start class org.apache.hadoop.yarn.api.records.QueueState -->
  6971. <class name="QueueState" extends="java.lang.Enum"
  6972. abstract="false"
  6973. static="false" final="true" visibility="public"
  6974. deprecated="not deprecated">
  6975. <method name="values" return="org.apache.hadoop.yarn.api.records.QueueState[]"
  6976. abstract="false" native="false" synchronized="false"
  6977. static="true" final="false" visibility="public"
  6978. deprecated="not deprecated">
  6979. </method>
  6980. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueState"
  6981. abstract="false" native="false" synchronized="false"
  6982. static="true" final="false" visibility="public"
  6983. deprecated="not deprecated">
  6984. <param name="name" type="java.lang.String"/>
  6985. </method>
  6986. <doc>
  6987. <![CDATA[<p>State of a Queue.</p>
  6988. <p>A queue is in one of:
  6989. <ul>
  6990. <li>{@link #RUNNING} - normal state.</li>
  6991. <li>{@link #STOPPED} - not accepting new application submissions.
  6992. </ul>
  6993. </p>
  6994. @see QueueInfo
  6995. @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
  6996. </doc>
  6997. </class>
  6998. <!-- end class org.apache.hadoop.yarn.api.records.QueueState -->
  6999. <!-- start class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
  7000. <class name="QueueUserACLInfo" extends="java.lang.Object"
  7001. abstract="true"
  7002. static="false" final="false" visibility="public"
  7003. deprecated="not deprecated">
  7004. <constructor name="QueueUserACLInfo"
  7005. static="false" final="false" visibility="public"
  7006. deprecated="not deprecated">
  7007. </constructor>
  7008. <method name="getQueueName" return="java.lang.String"
  7009. abstract="true" native="false" synchronized="false"
  7010. static="false" final="false" visibility="public"
  7011. deprecated="not deprecated">
  7012. <doc>
  7013. <![CDATA[Get the <em>queue name</em> of the queue.
  7014. @return <em>queue name</em> of the queue]]>
  7015. </doc>
  7016. </method>
  7017. <method name="getUserAcls" return="java.util.List"
  7018. abstract="true" native="false" synchronized="false"
  7019. static="false" final="false" visibility="public"
  7020. deprecated="not deprecated">
  7021. <doc>
  7022. <![CDATA[Get the list of <code>QueueACL</code> for the given user.
  7023. @return list of <code>QueueACL</code> for the given user]]>
  7024. </doc>
  7025. </method>
  7026. <doc>
  7027. <![CDATA[<p><code>QueueUserACLInfo</code> provides information {@link QueueACL} for
  7028. the given user.</p>
  7029. @see QueueACL
  7030. @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
  7031. </doc>
  7032. </class>
  7033. <!-- end class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
  7034. <!-- start class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
  7035. <class name="ReservationDefinition" extends="java.lang.Object"
  7036. abstract="true"
  7037. static="false" final="false" visibility="public"
  7038. deprecated="not deprecated">
  7039. <constructor name="ReservationDefinition"
  7040. static="false" final="false" visibility="public"
  7041. deprecated="not deprecated">
  7042. </constructor>
  7043. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  7044. abstract="false" native="false" synchronized="false"
  7045. static="true" final="false" visibility="public"
  7046. deprecated="not deprecated">
  7047. <param name="arrival" type="long"/>
  7048. <param name="deadline" type="long"/>
  7049. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  7050. <param name="name" type="java.lang.String"/>
  7051. </method>
  7052. <method name="getArrival" return="long"
  7053. abstract="true" native="false" synchronized="false"
  7054. static="false" final="false" visibility="public"
  7055. deprecated="not deprecated">
  7056. <doc>
  7057. <![CDATA[Get the arrival time or the earliest time from which the resource(s) can be
  7058. allocated. Time expressed as UTC.
  7059. @return the earliest valid time for this reservation]]>
  7060. </doc>
  7061. </method>
  7062. <method name="setArrival"
  7063. abstract="true" native="false" synchronized="false"
  7064. static="false" final="false" visibility="public"
  7065. deprecated="not deprecated">
  7066. <param name="earliestStartTime" type="long"/>
  7067. <doc>
  7068. <![CDATA[Set the arrival time or the earliest time from which the resource(s) can be
  7069. allocated. Time expressed as UTC.
  7070. @param earliestStartTime the earliest valid time for this reservation]]>
  7071. </doc>
  7072. </method>
  7073. <method name="getDeadline" return="long"
  7074. abstract="true" native="false" synchronized="false"
  7075. static="false" final="false" visibility="public"
  7076. deprecated="not deprecated">
  7077. <doc>
  7078. <![CDATA[Get the deadline or the latest time by when the resource(s) must be
  7079. allocated. Time expressed as UTC.
  7080. @return the deadline or the latest time by when the resource(s) must be
  7081. allocated]]>
  7082. </doc>
  7083. </method>
  7084. <method name="setDeadline"
  7085. abstract="true" native="false" synchronized="false"
  7086. static="false" final="false" visibility="public"
  7087. deprecated="not deprecated">
  7088. <param name="latestEndTime" type="long"/>
  7089. <doc>
  7090. <![CDATA[Set the deadline or the latest time by when the resource(s) must be
  7091. allocated. Time expressed as UTC.
  7092. @param latestEndTime the deadline or the latest time by when the
  7093. resource(s) should be allocated]]>
  7094. </doc>
  7095. </method>
  7096. <method name="getReservationRequests" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
  7097. abstract="true" native="false" synchronized="false"
  7098. static="false" final="false" visibility="public"
  7099. deprecated="not deprecated">
  7100. <doc>
  7101. <![CDATA[Get the list of {@link ReservationRequests} representing the resources
  7102. required by the application
  7103. @return the list of {@link ReservationRequests}]]>
  7104. </doc>
  7105. </method>
  7106. <method name="setReservationRequests"
  7107. abstract="true" native="false" synchronized="false"
  7108. static="false" final="false" visibility="public"
  7109. deprecated="not deprecated">
  7110. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  7111. <doc>
  7112. <![CDATA[Set the list of {@link ReservationRequests} representing the resources
  7113. required by the application
  7114. @param reservationRequests the list of {@link ReservationRequests}]]>
  7115. </doc>
  7116. </method>
  7117. <method name="getReservationName" return="java.lang.String"
  7118. abstract="true" native="false" synchronized="false"
  7119. static="false" final="false" visibility="public"
  7120. deprecated="not deprecated">
  7121. <doc>
  7122. <![CDATA[Get the name for this reservation. The name need-not be unique, and it is
  7123. just a mnemonic for the user (akin to job names). Accepted reservations are
  7124. uniquely identified by a system-generated ReservationId.
  7125. @return string representing the name of the corresponding reserved resource
  7126. allocation in the scheduler]]>
  7127. </doc>
  7128. </method>
  7129. <method name="setReservationName"
  7130. abstract="true" native="false" synchronized="false"
  7131. static="false" final="false" visibility="public"
  7132. deprecated="not deprecated">
  7133. <param name="name" type="java.lang.String"/>
  7134. <doc>
  7135. <![CDATA[Set the name for this reservation. The name need-not be unique, and it is
  7136. just a mnemonic for the user (akin to job names). Accepted reservations are
  7137. uniquely identified by a system-generated ReservationId.
  7138. @param name representing the name of the corresponding reserved resource
  7139. allocation in the scheduler]]>
  7140. </doc>
  7141. </method>
  7142. <doc>
  7143. <![CDATA[{@link ReservationDefinition} captures the set of resource and time
  7144. constraints the user cares about regarding a reservation.
  7145. @see ResourceRequest]]>
  7146. </doc>
  7147. </class>
  7148. <!-- end class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
  7149. <!-- start class org.apache.hadoop.yarn.api.records.ReservationId -->
  7150. <class name="ReservationId" extends="java.lang.Object"
  7151. abstract="true"
  7152. static="false" final="false" visibility="public"
  7153. deprecated="not deprecated">
  7154. <implements name="java.lang.Comparable"/>
  7155. <constructor name="ReservationId"
  7156. static="false" final="false" visibility="public"
  7157. deprecated="not deprecated">
  7158. </constructor>
  7159. <method name="getId" return="long"
  7160. abstract="true" native="false" synchronized="false"
  7161. static="false" final="false" visibility="public"
  7162. deprecated="not deprecated">
  7163. <doc>
  7164. <![CDATA[Get the long identifier of the {@link ReservationId} which is unique for
  7165. all Reservations started by a particular instance of the
  7166. {@code ResourceManager}.
  7167. @return long identifier of the {@link ReservationId}]]>
  7168. </doc>
  7169. </method>
  7170. <method name="getClusterTimestamp" return="long"
  7171. abstract="true" native="false" synchronized="false"
  7172. static="false" final="false" visibility="public"
  7173. deprecated="not deprecated">
  7174. <doc>
  7175. <![CDATA[Get the <em>start time</em> of the {@code ResourceManager} which is used to
  7176. generate globally unique {@link ReservationId}.
  7177. @return <em>start time</em> of the {@code ResourceManager}]]>
  7178. </doc>
  7179. </method>
  7180. <method name="build"
  7181. abstract="true" native="false" synchronized="false"
  7182. static="false" final="false" visibility="protected"
  7183. deprecated="not deprecated">
  7184. </method>
  7185. <method name="compareTo" return="int"
  7186. abstract="false" native="false" synchronized="false"
  7187. static="false" final="false" visibility="public"
  7188. deprecated="not deprecated">
  7189. <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  7190. </method>
  7191. <method name="toString" return="java.lang.String"
  7192. abstract="false" native="false" synchronized="false"
  7193. static="false" final="false" visibility="public"
  7194. deprecated="not deprecated">
  7195. </method>
  7196. <method name="parseReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  7197. abstract="false" native="false" synchronized="false"
  7198. static="true" final="false" visibility="public"
  7199. deprecated="not deprecated">
  7200. <param name="reservationId" type="java.lang.String"/>
  7201. <exception name="IOException" type="java.io.IOException"/>
  7202. <doc>
  7203. <![CDATA[Parse the string argument as a {@link ReservationId}
  7204. @param reservationId the string representation of the {@link ReservationId}
  7205. @return the {@link ReservationId} corresponding to the input string if
  7206. valid, null if input is null
  7207. @throws IOException if unable to parse the input string]]>
  7208. </doc>
  7209. </method>
  7210. <method name="hashCode" return="int"
  7211. abstract="false" native="false" synchronized="false"
  7212. static="false" final="false" visibility="public"
  7213. deprecated="not deprecated">
  7214. </method>
  7215. <method name="equals" return="boolean"
  7216. abstract="false" native="false" synchronized="false"
  7217. static="false" final="false" visibility="public"
  7218. deprecated="not deprecated">
  7219. <param name="obj" type="java.lang.Object"/>
  7220. </method>
  7221. <field name="reserveIdStrPrefix" type="java.lang.String"
  7222. transient="false" volatile="false"
  7223. static="true" final="true" visibility="public"
  7224. deprecated="not deprecated">
  7225. </field>
  7226. <field name="clusterTimestamp" type="long"
  7227. transient="false" volatile="false"
  7228. static="false" final="false" visibility="protected"
  7229. deprecated="not deprecated">
  7230. </field>
  7231. <field name="id" type="long"
  7232. transient="false" volatile="false"
  7233. static="false" final="false" visibility="protected"
  7234. deprecated="not deprecated">
  7235. </field>
  7236. <doc>
  7237. <![CDATA[<p>
  7238. {@link ReservationId} represents the <em>globally unique</em> identifier for
  7239. a reservation.
  7240. </p>
  7241. <p>
  7242. The globally unique nature of the identifier is achieved by using the
  7243. <em>cluster timestamp</em> i.e. start-time of the {@code ResourceManager}
  7244. along with a monotonically increasing counter for the reservation.
  7245. </p>]]>
  7246. </doc>
  7247. </class>
  7248. <!-- end class org.apache.hadoop.yarn.api.records.ReservationId -->
  7249. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest -->
  7250. <class name="ReservationRequest" extends="java.lang.Object"
  7251. abstract="true"
  7252. static="false" final="false" visibility="public"
  7253. deprecated="not deprecated">
  7254. <implements name="java.lang.Comparable"/>
  7255. <constructor name="ReservationRequest"
  7256. static="false" final="false" visibility="public"
  7257. deprecated="not deprecated">
  7258. </constructor>
  7259. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
  7260. abstract="false" native="false" synchronized="false"
  7261. static="true" final="false" visibility="public"
  7262. deprecated="not deprecated">
  7263. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7264. <param name="numContainers" type="int"/>
  7265. </method>
  7266. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
  7267. abstract="false" native="false" synchronized="false"
  7268. static="true" final="false" visibility="public"
  7269. deprecated="not deprecated">
  7270. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7271. <param name="numContainers" type="int"/>
  7272. <param name="concurrency" type="int"/>
  7273. <param name="duration" type="long"/>
  7274. </method>
  7275. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  7276. abstract="true" native="false" synchronized="false"
  7277. static="false" final="false" visibility="public"
  7278. deprecated="not deprecated">
  7279. <doc>
  7280. <![CDATA[Get the {@link Resource} capability of the request.
  7281. @return {@link Resource} capability of the request]]>
  7282. </doc>
  7283. </method>
  7284. <method name="setCapability"
  7285. abstract="true" native="false" synchronized="false"
  7286. static="false" final="false" visibility="public"
  7287. deprecated="not deprecated">
  7288. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7289. <doc>
  7290. <![CDATA[Set the {@link Resource} capability of the request
  7291. @param capability {@link Resource} capability of the request]]>
  7292. </doc>
  7293. </method>
  7294. <method name="getNumContainers" return="int"
  7295. abstract="true" native="false" synchronized="false"
  7296. static="false" final="false" visibility="public"
  7297. deprecated="not deprecated">
  7298. <doc>
  7299. <![CDATA[Get the number of containers required with the given specifications.
  7300. @return number of containers required with the given specifications]]>
  7301. </doc>
  7302. </method>
  7303. <method name="setNumContainers"
  7304. abstract="true" native="false" synchronized="false"
  7305. static="false" final="false" visibility="public"
  7306. deprecated="not deprecated">
  7307. <param name="numContainers" type="int"/>
  7308. <doc>
  7309. <![CDATA[Set the number of containers required with the given specifications
  7310. @param numContainers number of containers required with the given
  7311. specifications]]>
  7312. </doc>
  7313. </method>
  7314. <method name="getConcurrency" return="int"
  7315. abstract="true" native="false" synchronized="false"
  7316. static="false" final="false" visibility="public"
  7317. deprecated="not deprecated">
  7318. <doc>
  7319. <![CDATA[Get the number of containers that need to be scheduled concurrently. The
  7320. default value of 1 would fall back to the current non concurrency
  7321. constraints on the scheduling behavior.
  7322. @return the number of containers to be concurrently scheduled]]>
  7323. </doc>
  7324. </method>
  7325. <method name="setConcurrency"
  7326. abstract="true" native="false" synchronized="false"
  7327. static="false" final="false" visibility="public"
  7328. deprecated="not deprecated">
  7329. <param name="numContainers" type="int"/>
  7330. <doc>
  7331. <![CDATA[Set the number of containers that need to be scheduled concurrently. The
  7332. default value of 1 would fall back to the current non concurrency
  7333. constraints on the scheduling behavior.
  7334. @param numContainers the number of containers to be concurrently scheduled]]>
  7335. </doc>
  7336. </method>
  7337. <method name="getDuration" return="long"
  7338. abstract="true" native="false" synchronized="false"
  7339. static="false" final="false" visibility="public"
  7340. deprecated="not deprecated">
  7341. <doc>
  7342. <![CDATA[Get the duration in milliseconds for which the resource is required. A
  7343. default value of -1, indicates an unspecified lease duration, and fallback
  7344. to current behavior.
  7345. @return the duration in milliseconds for which the resource is required]]>
  7346. </doc>
  7347. </method>
  7348. <method name="setDuration"
  7349. abstract="true" native="false" synchronized="false"
  7350. static="false" final="false" visibility="public"
  7351. deprecated="not deprecated">
  7352. <param name="duration" type="long"/>
  7353. <doc>
  7354. <![CDATA[Set the duration in milliseconds for which the resource is required.
  7355. @param duration the duration in milliseconds for which the resource is
  7356. required]]>
  7357. </doc>
  7358. </method>
  7359. <method name="hashCode" return="int"
  7360. abstract="false" native="false" synchronized="false"
  7361. static="false" final="false" visibility="public"
  7362. deprecated="not deprecated">
  7363. </method>
  7364. <method name="equals" return="boolean"
  7365. abstract="false" native="false" synchronized="false"
  7366. static="false" final="false" visibility="public"
  7367. deprecated="not deprecated">
  7368. <param name="obj" type="java.lang.Object"/>
  7369. </method>
  7370. <method name="compareTo" return="int"
  7371. abstract="false" native="false" synchronized="false"
  7372. static="false" final="false" visibility="public"
  7373. deprecated="not deprecated">
  7374. <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  7375. </method>
  7376. <doc>
  7377. <![CDATA[<p>
  7378. {@link ReservationRequest} represents the request made by an application to
  7379. the {@code ResourceManager} to reserve {@link Resource}s.
  7380. </p>
  7381. <p>
  7382. It includes:
  7383. <ul>
  7384. <li>{@link Resource} required for each request.</li>
  7385. <li>
  7386. Number of containers, of above specifications, which are required by the
  7387. application.</li>
  7388. <li>
  7389. Concurrency that indicates the gang size of the request.</li>
  7390. </ul>
  7391. </p>]]>
  7392. </doc>
  7393. </class>
  7394. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest -->
  7395. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
  7396. <class name="ReservationRequest.ReservationRequestComparator" extends="java.lang.Object"
  7397. abstract="false"
  7398. static="true" final="false" visibility="public"
  7399. deprecated="not deprecated">
  7400. <implements name="java.util.Comparator"/>
  7401. <implements name="java.io.Serializable"/>
  7402. <constructor name="ReservationRequest.ReservationRequestComparator"
  7403. static="false" final="false" visibility="public"
  7404. deprecated="not deprecated">
  7405. </constructor>
  7406. <method name="compare" return="int"
  7407. abstract="false" native="false" synchronized="false"
  7408. static="false" final="false" visibility="public"
  7409. deprecated="not deprecated">
  7410. <param name="r1" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  7411. <param name="r2" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  7412. </method>
  7413. </class>
  7414. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
  7415. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
  7416. <class name="ReservationRequestInterpreter" extends="java.lang.Enum"
  7417. abstract="false"
  7418. static="false" final="true" visibility="public"
  7419. deprecated="not deprecated">
  7420. <method name="values" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter[]"
  7421. abstract="false" native="false" synchronized="false"
  7422. static="true" final="false" visibility="public"
  7423. deprecated="not deprecated">
  7424. </method>
  7425. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
  7426. abstract="false" native="false" synchronized="false"
  7427. static="true" final="false" visibility="public"
  7428. deprecated="not deprecated">
  7429. <param name="name" type="java.lang.String"/>
  7430. </method>
  7431. <doc>
  7432. <![CDATA[Enumeration of various types of dependencies among multiple
  7433. {@link ReservationRequests} within one {@link ReservationDefinition} (from
  7434. least constraining to most constraining).]]>
  7435. </doc>
  7436. </class>
  7437. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
  7438. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequests -->
  7439. <class name="ReservationRequests" extends="java.lang.Object"
  7440. abstract="true"
  7441. static="false" final="false" visibility="public"
  7442. deprecated="not deprecated">
  7443. <constructor name="ReservationRequests"
  7444. static="false" final="false" visibility="public"
  7445. deprecated="not deprecated">
  7446. </constructor>
  7447. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
  7448. abstract="false" native="false" synchronized="false"
  7449. static="true" final="false" visibility="public"
  7450. deprecated="not deprecated">
  7451. <param name="reservationResources" type="java.util.List"/>
  7452. <param name="type" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
  7453. </method>
  7454. <method name="getReservationResources" return="java.util.List"
  7455. abstract="true" native="false" synchronized="false"
  7456. static="false" final="false" visibility="public"
  7457. deprecated="not deprecated">
  7458. <doc>
  7459. <![CDATA[Get the list of {@link ReservationRequest} representing the resources
  7460. required by the application
  7461. @return the list of {@link ReservationRequest}]]>
  7462. </doc>
  7463. </method>
  7464. <method name="setReservationResources"
  7465. abstract="true" native="false" synchronized="false"
  7466. static="false" final="false" visibility="public"
  7467. deprecated="not deprecated">
  7468. <param name="reservationResources" type="java.util.List"/>
  7469. <doc>
  7470. <![CDATA[Set the list of {@link ReservationRequest} representing the resources
  7471. required by the application
  7472. @param reservationResources the list of {@link ReservationRequest}]]>
  7473. </doc>
  7474. </method>
  7475. <method name="getInterpreter" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
  7476. abstract="true" native="false" synchronized="false"
  7477. static="false" final="false" visibility="public"
  7478. deprecated="not deprecated">
  7479. <doc>
  7480. <![CDATA[Get the {@link ReservationRequestInterpreter}, representing how the list of
  7481. resources should be allocated, this captures temporal ordering and other
  7482. constraints.
  7483. @return the list of {@link ReservationRequestInterpreter}]]>
  7484. </doc>
  7485. </method>
  7486. <method name="setInterpreter"
  7487. abstract="true" native="false" synchronized="false"
  7488. static="false" final="false" visibility="public"
  7489. deprecated="not deprecated">
  7490. <param name="interpreter" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
  7491. <doc>
  7492. <![CDATA[Set the {@link ReservationRequestInterpreter}, representing how the list of
  7493. resources should be allocated, this captures temporal ordering and other
  7494. constraints.
  7495. @param interpreter the {@link ReservationRequestInterpreter} for this
  7496. reservation]]>
  7497. </doc>
  7498. </method>
  7499. <doc>
  7500. <![CDATA[{@link ReservationRequests} captures the set of resource and constraints the
  7501. user cares about regarding a reservation.
  7502. @see ReservationRequest]]>
  7503. </doc>
  7504. </class>
  7505. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequests -->
  7506. <!-- start class org.apache.hadoop.yarn.api.records.Resource -->
  7507. <class name="Resource" extends="java.lang.Object"
  7508. abstract="true"
  7509. static="false" final="false" visibility="public"
  7510. deprecated="not deprecated">
  7511. <implements name="java.lang.Comparable"/>
  7512. <constructor name="Resource"
  7513. static="false" final="false" visibility="public"
  7514. deprecated="not deprecated">
  7515. </constructor>
  7516. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
  7517. abstract="false" native="false" synchronized="false"
  7518. static="true" final="false" visibility="public"
  7519. deprecated="not deprecated">
  7520. <param name="memory" type="int"/>
  7521. <param name="vCores" type="int"/>
  7522. </method>
  7523. <method name="getMemory" return="int"
  7524. abstract="true" native="false" synchronized="false"
  7525. static="false" final="false" visibility="public"
  7526. deprecated="not deprecated">
  7527. <doc>
  7528. <![CDATA[Get <em>memory</em> of the resource.
  7529. @return <em>memory</em> of the resource]]>
  7530. </doc>
  7531. </method>
  7532. <method name="setMemory"
  7533. abstract="true" native="false" synchronized="false"
  7534. static="false" final="false" visibility="public"
  7535. deprecated="not deprecated">
  7536. <param name="memory" type="int"/>
  7537. <doc>
  7538. <![CDATA[Set <em>memory</em> of the resource.
  7539. @param memory <em>memory</em> of the resource]]>
  7540. </doc>
  7541. </method>
  7542. <method name="getVirtualCores" return="int"
  7543. abstract="true" native="false" synchronized="false"
  7544. static="false" final="false" visibility="public"
  7545. deprecated="not deprecated">
  7546. <doc>
  7547. <![CDATA[Get <em>number of virtual cpu cores</em> of the resource.
  7548. Virtual cores are a unit for expressing CPU parallelism. A node's capacity
  7549. should be configured with virtual cores equal to its number of physical cores.
  7550. A container should be requested with the number of cores it can saturate, i.e.
  7551. the average number of threads it expects to have runnable at a time.
  7552. @return <em>num of virtual cpu cores</em> of the resource]]>
  7553. </doc>
  7554. </method>
  7555. <method name="setVirtualCores"
  7556. abstract="true" native="false" synchronized="false"
  7557. static="false" final="false" visibility="public"
  7558. deprecated="not deprecated">
  7559. <param name="vCores" type="int"/>
  7560. <doc>
  7561. <![CDATA[Set <em>number of virtual cpu cores</em> of the resource.
  7562. Virtual cores are a unit for expressing CPU parallelism. A node's capacity
  7563. should be configured with virtual cores equal to its number of physical cores.
  7564. A container should be requested with the number of cores it can saturate, i.e.
  7565. the average number of threads it expects to have runnable at a time.
  7566. @param vCores <em>number of virtual cpu cores</em> of the resource]]>
  7567. </doc>
  7568. </method>
  7569. <method name="hashCode" return="int"
  7570. abstract="false" native="false" synchronized="false"
  7571. static="false" final="false" visibility="public"
  7572. deprecated="not deprecated">
  7573. </method>
  7574. <method name="equals" return="boolean"
  7575. abstract="false" native="false" synchronized="false"
  7576. static="false" final="false" visibility="public"
  7577. deprecated="not deprecated">
  7578. <param name="obj" type="java.lang.Object"/>
  7579. </method>
  7580. <method name="toString" return="java.lang.String"
  7581. abstract="false" native="false" synchronized="false"
  7582. static="false" final="false" visibility="public"
  7583. deprecated="not deprecated">
  7584. </method>
  7585. <doc>
  7586. <![CDATA[<p><code>Resource</code> models a set of computer resources in the
  7587. cluster.</p>
  7588. <p>Currently it models both <em>memory</em> and <em>CPU</em>.</p>
  7589. <p>The unit for memory is megabytes. CPU is modeled with virtual cores
  7590. (vcores), a unit for expressing parallelism. A node's capacity should
  7591. be configured with virtual cores equal to its number of physical cores. A
  7592. container should be requested with the number of cores it can saturate, i.e.
  7593. the average number of threads it expects to have runnable at a time.</p>
  7594. <p>Virtual cores take integer values and thus currently CPU-scheduling is
  7595. very coarse. A complementary axis for CPU requests that represents processing
  7596. power will likely be added in the future to enable finer-grained resource
  7597. configuration.</p>
  7598. <p>Typically, applications request <code>Resource</code> of suitable
  7599. capability to run their component tasks.</p>
  7600. @see ResourceRequest
  7601. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  7602. </doc>
  7603. </class>
  7604. <!-- end class org.apache.hadoop.yarn.api.records.Resource -->
  7605. <!-- start class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
  7606. <class name="ResourceBlacklistRequest" extends="java.lang.Object"
  7607. abstract="true"
  7608. static="false" final="false" visibility="public"
  7609. deprecated="not deprecated">
  7610. <constructor name="ResourceBlacklistRequest"
  7611. static="false" final="false" visibility="public"
  7612. deprecated="not deprecated">
  7613. </constructor>
  7614. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
  7615. abstract="false" native="false" synchronized="false"
  7616. static="true" final="false" visibility="public"
  7617. deprecated="not deprecated">
  7618. <param name="additions" type="java.util.List"/>
  7619. <param name="removals" type="java.util.List"/>
  7620. </method>
  7621. <method name="getBlacklistAdditions" return="java.util.List"
  7622. abstract="true" native="false" synchronized="false"
  7623. static="false" final="false" visibility="public"
  7624. deprecated="not deprecated">
  7625. <doc>
  7626. <![CDATA[Get the list of resource-names which should be added to the
  7627. application blacklist.
  7628. @return list of resource-names which should be added to the
  7629. application blacklist]]>
  7630. </doc>
  7631. </method>
  7632. <method name="setBlacklistAdditions"
  7633. abstract="true" native="false" synchronized="false"
  7634. static="false" final="false" visibility="public"
  7635. deprecated="not deprecated">
  7636. <param name="resourceNames" type="java.util.List"/>
  7637. <doc>
  7638. <![CDATA[Set list of resource-names which should be added to the application blacklist.
  7639. @param resourceNames list of resource-names which should be added to the
  7640. application blacklist]]>
  7641. </doc>
  7642. </method>
  7643. <method name="getBlacklistRemovals" return="java.util.List"
  7644. abstract="true" native="false" synchronized="false"
  7645. static="false" final="false" visibility="public"
  7646. deprecated="not deprecated">
  7647. <doc>
  7648. <![CDATA[Get the list of resource-names which should be removed from the
  7649. application blacklist.
  7650. @return list of resource-names which should be removed from the
  7651. application blacklist]]>
  7652. </doc>
  7653. </method>
  7654. <method name="setBlacklistRemovals"
  7655. abstract="true" native="false" synchronized="false"
  7656. static="false" final="false" visibility="public"
  7657. deprecated="not deprecated">
  7658. <param name="resourceNames" type="java.util.List"/>
  7659. <doc>
  7660. <![CDATA[Set list of resource-names which should be removed from the
  7661. application blacklist.
  7662. @param resourceNames list of resource-names which should be removed from the
  7663. application blacklist]]>
  7664. </doc>
  7665. </method>
  7666. <doc>
  7667. <![CDATA[{@link ResourceBlacklistRequest} encapsulates the list of resource-names
  7668. which should be added or removed from the <em>blacklist</em> of resources
  7669. for the application.
  7670. @see ResourceRequest
  7671. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  7672. </doc>
  7673. </class>
  7674. <!-- end class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
  7675. <!-- start class org.apache.hadoop.yarn.api.records.ResourceOption -->
  7676. <class name="ResourceOption" extends="java.lang.Object"
  7677. abstract="true"
  7678. static="false" final="false" visibility="public"
  7679. deprecated="not deprecated">
  7680. <constructor name="ResourceOption"
  7681. static="false" final="false" visibility="public"
  7682. deprecated="not deprecated">
  7683. </constructor>
  7684. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceOption"
  7685. abstract="false" native="false" synchronized="false"
  7686. static="true" final="false" visibility="public"
  7687. deprecated="not deprecated">
  7688. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7689. <param name="overCommitTimeout" type="int"/>
  7690. </method>
  7691. <method name="toString" return="java.lang.String"
  7692. abstract="false" native="false" synchronized="false"
  7693. static="false" final="false" visibility="public"
  7694. deprecated="not deprecated">
  7695. </method>
  7696. </class>
  7697. <!-- end class org.apache.hadoop.yarn.api.records.ResourceOption -->
  7698. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest -->
  7699. <class name="ResourceRequest" extends="java.lang.Object"
  7700. abstract="true"
  7701. static="false" final="false" visibility="public"
  7702. deprecated="not deprecated">
  7703. <implements name="java.lang.Comparable"/>
  7704. <constructor name="ResourceRequest"
  7705. static="false" final="false" visibility="public"
  7706. deprecated="not deprecated">
  7707. </constructor>
  7708. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  7709. abstract="false" native="false" synchronized="false"
  7710. static="true" final="false" visibility="public"
  7711. deprecated="not deprecated">
  7712. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  7713. <param name="hostName" type="java.lang.String"/>
  7714. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7715. <param name="numContainers" type="int"/>
  7716. </method>
  7717. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  7718. abstract="false" native="false" synchronized="false"
  7719. static="true" final="false" visibility="public"
  7720. deprecated="not deprecated">
  7721. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  7722. <param name="hostName" type="java.lang.String"/>
  7723. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7724. <param name="numContainers" type="int"/>
  7725. <param name="relaxLocality" type="boolean"/>
  7726. </method>
  7727. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  7728. abstract="false" native="false" synchronized="false"
  7729. static="true" final="false" visibility="public"
  7730. deprecated="not deprecated">
  7731. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  7732. <param name="hostName" type="java.lang.String"/>
  7733. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7734. <param name="numContainers" type="int"/>
  7735. <param name="relaxLocality" type="boolean"/>
  7736. <param name="labelExpression" type="java.lang.String"/>
  7737. </method>
  7738. <method name="isAnyLocation" return="boolean"
  7739. abstract="false" native="false" synchronized="false"
  7740. static="true" final="false" visibility="public"
  7741. deprecated="not deprecated">
  7742. <param name="hostName" type="java.lang.String"/>
  7743. <doc>
  7744. <![CDATA[Check whether the given <em>host/rack</em> string represents an arbitrary
  7745. host name.
  7746. @param hostName <em>host/rack</em> on which the allocation is desired
  7747. @return whether the given <em>host/rack</em> string represents an arbitrary
  7748. host name]]>
  7749. </doc>
  7750. </method>
  7751. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  7752. abstract="true" native="false" synchronized="false"
  7753. static="false" final="false" visibility="public"
  7754. deprecated="not deprecated">
  7755. <doc>
  7756. <![CDATA[Get the <code>Priority</code> of the request.
  7757. @return <code>Priority</code> of the request]]>
  7758. </doc>
  7759. </method>
  7760. <method name="setPriority"
  7761. abstract="true" native="false" synchronized="false"
  7762. static="false" final="false" visibility="public"
  7763. deprecated="not deprecated">
  7764. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  7765. <doc>
  7766. <![CDATA[Set the <code>Priority</code> of the request
  7767. @param priority <code>Priority</code> of the request]]>
  7768. </doc>
  7769. </method>
  7770. <method name="getResourceName" return="java.lang.String"
  7771. abstract="true" native="false" synchronized="false"
  7772. static="false" final="false" visibility="public"
  7773. deprecated="not deprecated">
  7774. <doc>
  7775. <![CDATA[Get the resource (e.g. <em>host/rack</em>) on which the allocation
  7776. is desired.
  7777. A special value of <em>*</em> signifies that <em>any</em> resource
  7778. (host/rack) is acceptable.
  7779. @return resource (e.g. <em>host/rack</em>) on which the allocation
  7780. is desired]]>
  7781. </doc>
  7782. </method>
  7783. <method name="setResourceName"
  7784. abstract="true" native="false" synchronized="false"
  7785. static="false" final="false" visibility="public"
  7786. deprecated="not deprecated">
  7787. <param name="resourceName" type="java.lang.String"/>
  7788. <doc>
  7789. <![CDATA[Set the resource name (e.g. <em>host/rack</em>) on which the allocation
  7790. is desired.
  7791. A special value of <em>*</em> signifies that <em>any</em> resource name
  7792. (e.g. host/rack) is acceptable.
  7793. @param resourceName (e.g. <em>host/rack</em>) on which the
  7794. allocation is desired]]>
  7795. </doc>
  7796. </method>
  7797. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  7798. abstract="true" native="false" synchronized="false"
  7799. static="false" final="false" visibility="public"
  7800. deprecated="not deprecated">
  7801. <doc>
  7802. <![CDATA[Get the <code>Resource</code> capability of the request.
  7803. @return <code>Resource</code> capability of the request]]>
  7804. </doc>
  7805. </method>
  7806. <method name="setCapability"
  7807. abstract="true" native="false" synchronized="false"
  7808. static="false" final="false" visibility="public"
  7809. deprecated="not deprecated">
  7810. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7811. <doc>
  7812. <![CDATA[Set the <code>Resource</code> capability of the request
  7813. @param capability <code>Resource</code> capability of the request]]>
  7814. </doc>
  7815. </method>
  7816. <method name="getNumContainers" return="int"
  7817. abstract="true" native="false" synchronized="false"
  7818. static="false" final="false" visibility="public"
  7819. deprecated="not deprecated">
  7820. <doc>
  7821. <![CDATA[Get the number of containers required with the given specifications.
  7822. @return number of containers required with the given specifications]]>
  7823. </doc>
  7824. </method>
  7825. <method name="setNumContainers"
  7826. abstract="true" native="false" synchronized="false"
  7827. static="false" final="false" visibility="public"
  7828. deprecated="not deprecated">
  7829. <param name="numContainers" type="int"/>
  7830. <doc>
  7831. <![CDATA[Set the number of containers required with the given specifications
  7832. @param numContainers number of containers required with the given
  7833. specifications]]>
  7834. </doc>
  7835. </method>
  7836. <method name="getRelaxLocality" return="boolean"
  7837. abstract="true" native="false" synchronized="false"
  7838. static="false" final="false" visibility="public"
  7839. deprecated="not deprecated">
  7840. <doc>
  7841. <![CDATA[Get whether locality relaxation is enabled with this
  7842. <code>ResourceRequest</code>. Defaults to true.
  7843. @return whether locality relaxation is enabled with this
  7844. <code>ResourceRequest</code>.]]>
  7845. </doc>
  7846. </method>
  7847. <method name="setRelaxLocality"
  7848. abstract="true" native="false" synchronized="false"
  7849. static="false" final="false" visibility="public"
  7850. deprecated="not deprecated">
  7851. <param name="relaxLocality" type="boolean"/>
  7852. <doc>
  7853. <![CDATA[<p>For a request at a network hierarchy level, set whether locality can be relaxed
  7854. to that level and beyond.<p>
  7855. <p>If the flag is off on a rack-level <code>ResourceRequest</code>,
  7856. containers at that request's priority will not be assigned to nodes on that
  7857. request's rack unless requests specifically for those nodes have also been
  7858. submitted.<p>
  7859. <p>If the flag is off on an {@link ResourceRequest#ANY}-level
  7860. <code>ResourceRequest</code>, containers at that request's priority will
  7861. only be assigned on racks for which specific requests have also been
  7862. submitted.<p>
  7863. <p>For example, to request a container strictly on a specific node, the
  7864. corresponding rack-level and any-level requests should have locality
  7865. relaxation set to false. Similarly, to request a container strictly on a
  7866. specific rack, the corresponding any-level request should have locality
  7867. relaxation set to false.<p>
  7868. @param relaxLocality whether locality relaxation is enabled with this
  7869. <code>ResourceRequest</code>.]]>
  7870. </doc>
  7871. </method>
  7872. <method name="getNodeLabelExpression" return="java.lang.String"
  7873. abstract="true" native="false" synchronized="false"
  7874. static="false" final="false" visibility="public"
  7875. deprecated="not deprecated">
  7876. <doc>
  7877. <![CDATA[Get node-label-expression for this Resource Request. If this is set, all
  7878. containers allocated to satisfy this resource-request will be only on those
  7879. nodes that satisfy this node-label-expression
  7880. @return node-label-expression]]>
  7881. </doc>
  7882. </method>
  7883. <method name="setNodeLabelExpression"
  7884. abstract="true" native="false" synchronized="false"
  7885. static="false" final="false" visibility="public"
  7886. deprecated="not deprecated">
  7887. <param name="nodelabelExpression" type="java.lang.String"/>
  7888. <doc>
  7889. <![CDATA[Set node label expression of this resource request. Now only
  7890. support AND(&&), in the future will provide support for OR(||), NOT(!).
  7891. Examples:
  7892. - GPU && LARGE_MEM, ask for node has label GPU and LARGE_MEM together
  7893. - "" (empty) means ask for node doesn't have label on it, this is default
  7894. behavior
  7895. @param nodelabelExpression node-label-expression of this ResourceRequest]]>
  7896. </doc>
  7897. </method>
  7898. <method name="hashCode" return="int"
  7899. abstract="false" native="false" synchronized="false"
  7900. static="false" final="false" visibility="public"
  7901. deprecated="not deprecated">
  7902. </method>
  7903. <method name="equals" return="boolean"
  7904. abstract="false" native="false" synchronized="false"
  7905. static="false" final="false" visibility="public"
  7906. deprecated="not deprecated">
  7907. <param name="obj" type="java.lang.Object"/>
  7908. </method>
  7909. <method name="compareTo" return="int"
  7910. abstract="false" native="false" synchronized="false"
  7911. static="false" final="false" visibility="public"
  7912. deprecated="not deprecated">
  7913. <param name="other" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  7914. </method>
  7915. <field name="ANY" type="java.lang.String"
  7916. transient="false" volatile="false"
  7917. static="true" final="true" visibility="public"
  7918. deprecated="not deprecated">
  7919. <doc>
  7920. <![CDATA[The constant string representing no locality.
  7921. It should be used by all references that want to pass an arbitrary host
  7922. name in.]]>
  7923. </doc>
  7924. </field>
  7925. <doc>
  7926. <![CDATA[<p><code>ResourceRequest</code> represents the request made by an
  7927. application to the <code>ResourceManager</code> to obtain various
  7928. <code>Container</code> allocations.</p>
  7929. <p>It includes:
  7930. <ul>
  7931. <li>{@link Priority} of the request.</li>
  7932. <li>
  7933. The <em>name</em> of the machine or rack on which the allocation is
  7934. desired. A special value of <em>*</em> signifies that
  7935. <em>any</em> host/rack is acceptable to the application.
  7936. </li>
  7937. <li>{@link Resource} required for each request.</li>
  7938. <li>
  7939. Number of containers, of above specifications, which are required
  7940. by the application.
  7941. </li>
  7942. <li>
  7943. A boolean <em>relaxLocality</em> flag, defaulting to <code>true</code>,
  7944. which tells the <code>ResourceManager</code> if the application wants
  7945. locality to be loose (i.e. allows fall-through to rack or <em>any</em>)
  7946. or strict (i.e. specify hard constraint on resource allocation).
  7947. </li>
  7948. </ul>
  7949. </p>
  7950. @see Resource
  7951. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  7952. </doc>
  7953. </class>
  7954. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest -->
  7955. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
  7956. <class name="ResourceRequest.ResourceRequestComparator" extends="java.lang.Object"
  7957. abstract="false"
  7958. static="true" final="false" visibility="public"
  7959. deprecated="not deprecated">
  7960. <implements name="java.util.Comparator"/>
  7961. <implements name="java.io.Serializable"/>
  7962. <constructor name="ResourceRequest.ResourceRequestComparator"
  7963. static="false" final="false" visibility="public"
  7964. deprecated="not deprecated">
  7965. </constructor>
  7966. <method name="compare" return="int"
  7967. abstract="false" native="false" synchronized="false"
  7968. static="false" final="false" visibility="public"
  7969. deprecated="not deprecated">
  7970. <param name="r1" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  7971. <param name="r2" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  7972. </method>
  7973. </class>
  7974. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
  7975. <!-- start class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
  7976. <class name="StrictPreemptionContract" extends="java.lang.Object"
  7977. abstract="true"
  7978. static="false" final="false" visibility="public"
  7979. deprecated="not deprecated">
  7980. <constructor name="StrictPreemptionContract"
  7981. static="false" final="false" visibility="public"
  7982. deprecated="not deprecated">
  7983. </constructor>
  7984. <method name="getContainers" return="java.util.Set"
  7985. abstract="true" native="false" synchronized="false"
  7986. static="false" final="false" visibility="public"
  7987. deprecated="not deprecated">
  7988. <doc>
  7989. <![CDATA[Get the set of {@link PreemptionContainer} specifying containers owned by
  7990. the <code>ApplicationMaster</code> that may be reclaimed by the
  7991. <code>ResourceManager</code>.
  7992. @return the set of {@link ContainerId} to be preempted.]]>
  7993. </doc>
  7994. </method>
  7995. <doc>
  7996. <![CDATA[Enumeration of particular allocations to be reclaimed. The platform will
  7997. reclaim exactly these resources, so the <code>ApplicationMaster</code> (AM)
  7998. may attempt to checkpoint work or adjust its execution plan to accommodate
  7999. it. In contrast to {@link PreemptionContract}, the AM has no flexibility in
  8000. selecting which resources to return to the cluster.
  8001. @see PreemptionMessage]]>
  8002. </doc>
  8003. </class>
  8004. <!-- end class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
  8005. <!-- start class org.apache.hadoop.yarn.api.records.Token -->
  8006. <class name="Token" extends="java.lang.Object"
  8007. abstract="true"
  8008. static="false" final="false" visibility="public"
  8009. deprecated="not deprecated">
  8010. <constructor name="Token"
  8011. static="false" final="false" visibility="public"
  8012. deprecated="not deprecated">
  8013. </constructor>
  8014. <method name="getIdentifier" return="java.nio.ByteBuffer"
  8015. abstract="true" native="false" synchronized="false"
  8016. static="false" final="false" visibility="public"
  8017. deprecated="not deprecated">
  8018. <doc>
  8019. <![CDATA[Get the token identifier.
  8020. @return token identifier]]>
  8021. </doc>
  8022. </method>
  8023. <method name="getPassword" return="java.nio.ByteBuffer"
  8024. abstract="true" native="false" synchronized="false"
  8025. static="false" final="false" visibility="public"
  8026. deprecated="not deprecated">
  8027. <doc>
  8028. <![CDATA[Get the token password
  8029. @return token password]]>
  8030. </doc>
  8031. </method>
  8032. <method name="getKind" return="java.lang.String"
  8033. abstract="true" native="false" synchronized="false"
  8034. static="false" final="false" visibility="public"
  8035. deprecated="not deprecated">
  8036. <doc>
  8037. <![CDATA[Get the token kind.
  8038. @return token kind]]>
  8039. </doc>
  8040. </method>
  8041. <method name="getService" return="java.lang.String"
  8042. abstract="true" native="false" synchronized="false"
  8043. static="false" final="false" visibility="public"
  8044. deprecated="not deprecated">
  8045. <doc>
  8046. <![CDATA[Get the service to which the token is allocated.
  8047. @return service to which the token is allocated]]>
  8048. </doc>
  8049. </method>
  8050. <doc>
  8051. <![CDATA[<p><code>Token</code> is the security entity used by the framework
  8052. to verify authenticity of any resource.</p>]]>
  8053. </doc>
  8054. </class>
  8055. <!-- end class org.apache.hadoop.yarn.api.records.Token -->
  8056. <!-- start class org.apache.hadoop.yarn.api.records.URL -->
  8057. <class name="URL" extends="java.lang.Object"
  8058. abstract="true"
  8059. static="false" final="false" visibility="public"
  8060. deprecated="not deprecated">
  8061. <constructor name="URL"
  8062. static="false" final="false" visibility="public"
  8063. deprecated="not deprecated">
  8064. </constructor>
  8065. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.URL"
  8066. abstract="false" native="false" synchronized="false"
  8067. static="true" final="false" visibility="public"
  8068. deprecated="not deprecated">
  8069. <param name="scheme" type="java.lang.String"/>
  8070. <param name="host" type="java.lang.String"/>
  8071. <param name="port" type="int"/>
  8072. <param name="file" type="java.lang.String"/>
  8073. </method>
  8074. <method name="getScheme" return="java.lang.String"
  8075. abstract="true" native="false" synchronized="false"
  8076. static="false" final="false" visibility="public"
  8077. deprecated="not deprecated">
  8078. <doc>
  8079. <![CDATA[Get the scheme of the URL.
  8080. @return scheme of the URL]]>
  8081. </doc>
  8082. </method>
  8083. <method name="setScheme"
  8084. abstract="true" native="false" synchronized="false"
  8085. static="false" final="false" visibility="public"
  8086. deprecated="not deprecated">
  8087. <param name="scheme" type="java.lang.String"/>
  8088. <doc>
  8089. <![CDATA[Set the scheme of the URL
  8090. @param scheme scheme of the URL]]>
  8091. </doc>
  8092. </method>
  8093. <method name="getUserInfo" return="java.lang.String"
  8094. abstract="true" native="false" synchronized="false"
  8095. static="false" final="false" visibility="public"
  8096. deprecated="not deprecated">
  8097. <doc>
  8098. <![CDATA[Get the user info of the URL.
  8099. @return user info of the URL]]>
  8100. </doc>
  8101. </method>
  8102. <method name="setUserInfo"
  8103. abstract="true" native="false" synchronized="false"
  8104. static="false" final="false" visibility="public"
  8105. deprecated="not deprecated">
  8106. <param name="userInfo" type="java.lang.String"/>
  8107. <doc>
  8108. <![CDATA[Set the user info of the URL.
  8109. @param userInfo user info of the URL]]>
  8110. </doc>
  8111. </method>
  8112. <method name="getHost" return="java.lang.String"
  8113. abstract="true" native="false" synchronized="false"
  8114. static="false" final="false" visibility="public"
  8115. deprecated="not deprecated">
  8116. <doc>
  8117. <![CDATA[Get the host of the URL.
  8118. @return host of the URL]]>
  8119. </doc>
  8120. </method>
  8121. <method name="setHost"
  8122. abstract="true" native="false" synchronized="false"
  8123. static="false" final="false" visibility="public"
  8124. deprecated="not deprecated">
  8125. <param name="host" type="java.lang.String"/>
  8126. <doc>
  8127. <![CDATA[Set the host of the URL.
  8128. @param host host of the URL]]>
  8129. </doc>
  8130. </method>
  8131. <method name="getPort" return="int"
  8132. abstract="true" native="false" synchronized="false"
  8133. static="false" final="false" visibility="public"
  8134. deprecated="not deprecated">
  8135. <doc>
  8136. <![CDATA[Get the port of the URL.
  8137. @return port of the URL]]>
  8138. </doc>
  8139. </method>
  8140. <method name="setPort"
  8141. abstract="true" native="false" synchronized="false"
  8142. static="false" final="false" visibility="public"
  8143. deprecated="not deprecated">
  8144. <param name="port" type="int"/>
  8145. <doc>
  8146. <![CDATA[Set the port of the URL
  8147. @param port port of the URL]]>
  8148. </doc>
  8149. </method>
  8150. <method name="getFile" return="java.lang.String"
  8151. abstract="true" native="false" synchronized="false"
  8152. static="false" final="false" visibility="public"
  8153. deprecated="not deprecated">
  8154. <doc>
  8155. <![CDATA[Get the file of the URL.
  8156. @return file of the URL]]>
  8157. </doc>
  8158. </method>
  8159. <method name="setFile"
  8160. abstract="true" native="false" synchronized="false"
  8161. static="false" final="false" visibility="public"
  8162. deprecated="not deprecated">
  8163. <param name="file" type="java.lang.String"/>
  8164. <doc>
  8165. <![CDATA[Set the file of the URL.
  8166. @param file file of the URL]]>
  8167. </doc>
  8168. </method>
  8169. <doc>
  8170. <![CDATA[<p><code>URL</code> represents a serializable {@link java.net.URL}.</p>]]>
  8171. </doc>
  8172. </class>
  8173. <!-- end class org.apache.hadoop.yarn.api.records.URL -->
  8174. <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
  8175. <class name="YarnApplicationAttemptState" extends="java.lang.Enum"
  8176. abstract="false"
  8177. static="false" final="true" visibility="public"
  8178. deprecated="not deprecated">
  8179. <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState[]"
  8180. abstract="false" native="false" synchronized="false"
  8181. static="true" final="false" visibility="public"
  8182. deprecated="not deprecated">
  8183. </method>
  8184. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
  8185. abstract="false" native="false" synchronized="false"
  8186. static="true" final="false" visibility="public"
  8187. deprecated="not deprecated">
  8188. <param name="name" type="java.lang.String"/>
  8189. </method>
  8190. <doc>
  8191. <![CDATA[Enumeration of various states of a <code>RMAppAttempt</code>.]]>
  8192. </doc>
  8193. </class>
  8194. <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
  8195. <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
  8196. <class name="YarnApplicationState" extends="java.lang.Enum"
  8197. abstract="false"
  8198. static="false" final="true" visibility="public"
  8199. deprecated="not deprecated">
  8200. <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationState[]"
  8201. abstract="false" native="false" synchronized="false"
  8202. static="true" final="false" visibility="public"
  8203. deprecated="not deprecated">
  8204. </method>
  8205. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
  8206. abstract="false" native="false" synchronized="false"
  8207. static="true" final="false" visibility="public"
  8208. deprecated="not deprecated">
  8209. <param name="name" type="java.lang.String"/>
  8210. </method>
  8211. <doc>
  8212. <![CDATA[Enumeration of various states of an <code>ApplicationMaster</code>.]]>
  8213. </doc>
  8214. </class>
  8215. <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
  8216. <!-- start class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
  8217. <class name="YarnClusterMetrics" extends="java.lang.Object"
  8218. abstract="true"
  8219. static="false" final="false" visibility="public"
  8220. deprecated="not deprecated">
  8221. <constructor name="YarnClusterMetrics"
  8222. static="false" final="false" visibility="public"
  8223. deprecated="not deprecated">
  8224. </constructor>
  8225. <method name="getNumNodeManagers" return="int"
  8226. abstract="true" native="false" synchronized="false"
  8227. static="false" final="false" visibility="public"
  8228. deprecated="not deprecated">
  8229. <doc>
  8230. <![CDATA[Get the number of <code>NodeManager</code>s in the cluster.
  8231. @return number of <code>NodeManager</code>s in the cluster]]>
  8232. </doc>
  8233. </method>
  8234. <doc>
  8235. <![CDATA[<p><code>YarnClusterMetrics</code> represents cluster metrics.</p>
  8236. <p>Currently only number of <code>NodeManager</code>s is provided.</p>]]>
  8237. </doc>
  8238. </class>
  8239. <!-- end class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
  8240. </package>
  8241. <package name="org.apache.hadoop.yarn.api.records.timeline">
  8242. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
  8243. <class name="TimelineDelegationTokenResponse" extends="java.lang.Object"
  8244. abstract="false"
  8245. static="false" final="false" visibility="public"
  8246. deprecated="not deprecated">
  8247. <constructor name="TimelineDelegationTokenResponse"
  8248. static="false" final="false" visibility="public"
  8249. deprecated="not deprecated">
  8250. </constructor>
  8251. <method name="getType" return="java.lang.String"
  8252. abstract="false" native="false" synchronized="false"
  8253. static="false" final="false" visibility="public"
  8254. deprecated="not deprecated">
  8255. </method>
  8256. <method name="setType"
  8257. abstract="false" native="false" synchronized="false"
  8258. static="false" final="false" visibility="public"
  8259. deprecated="not deprecated">
  8260. <param name="type" type="java.lang.String"/>
  8261. </method>
  8262. <method name="getContent" return="java.lang.Object"
  8263. abstract="false" native="false" synchronized="false"
  8264. static="false" final="false" visibility="public"
  8265. deprecated="not deprecated">
  8266. </method>
  8267. <method name="setContent"
  8268. abstract="false" native="false" synchronized="false"
  8269. static="false" final="false" visibility="public"
  8270. deprecated="not deprecated">
  8271. <param name="content" type="java.lang.Object"/>
  8272. </method>
  8273. <doc>
  8274. <![CDATA[The response of delegation token related request]]>
  8275. </doc>
  8276. </class>
  8277. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
  8278. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
  8279. <class name="TimelineDomain" extends="java.lang.Object"
  8280. abstract="false"
  8281. static="false" final="false" visibility="public"
  8282. deprecated="not deprecated">
  8283. <constructor name="TimelineDomain"
  8284. static="false" final="false" visibility="public"
  8285. deprecated="not deprecated">
  8286. </constructor>
  8287. <method name="getId" return="java.lang.String"
  8288. abstract="false" native="false" synchronized="false"
  8289. static="false" final="false" visibility="public"
  8290. deprecated="not deprecated">
  8291. <doc>
  8292. <![CDATA[Get the domain ID
  8293. @return the domain ID]]>
  8294. </doc>
  8295. </method>
  8296. <method name="setId"
  8297. abstract="false" native="false" synchronized="false"
  8298. static="false" final="false" visibility="public"
  8299. deprecated="not deprecated">
  8300. <param name="id" type="java.lang.String"/>
  8301. <doc>
  8302. <![CDATA[Set the domain ID
  8303. @param id the domain ID]]>
  8304. </doc>
  8305. </method>
  8306. <method name="getDescription" return="java.lang.String"
  8307. abstract="false" native="false" synchronized="false"
  8308. static="false" final="false" visibility="public"
  8309. deprecated="not deprecated">
  8310. <doc>
  8311. <![CDATA[Get the domain description
  8312. @return the domain description]]>
  8313. </doc>
  8314. </method>
  8315. <method name="setDescription"
  8316. abstract="false" native="false" synchronized="false"
  8317. static="false" final="false" visibility="public"
  8318. deprecated="not deprecated">
  8319. <param name="description" type="java.lang.String"/>
  8320. <doc>
  8321. <![CDATA[Set the domain description
  8322. @param description the domain description]]>
  8323. </doc>
  8324. </method>
  8325. <method name="getOwner" return="java.lang.String"
  8326. abstract="false" native="false" synchronized="false"
  8327. static="false" final="false" visibility="public"
  8328. deprecated="not deprecated">
  8329. <doc>
  8330. <![CDATA[Get the domain owner
  8331. @return the domain owner]]>
  8332. </doc>
  8333. </method>
  8334. <method name="setOwner"
  8335. abstract="false" native="false" synchronized="false"
  8336. static="false" final="false" visibility="public"
  8337. deprecated="not deprecated">
  8338. <param name="owner" type="java.lang.String"/>
  8339. <doc>
  8340. <![CDATA[Set the domain owner. The user doesn't need to set it, which will
  8341. automatically set to the user who puts the domain.
  8342. @param owner the domain owner]]>
  8343. </doc>
  8344. </method>
  8345. <method name="getReaders" return="java.lang.String"
  8346. abstract="false" native="false" synchronized="false"
  8347. static="false" final="false" visibility="public"
  8348. deprecated="not deprecated">
  8349. <doc>
  8350. <![CDATA[Get the reader (and/or reader group) list string
  8351. @return the reader (and/or reader group) list string]]>
  8352. </doc>
  8353. </method>
  8354. <method name="setReaders"
  8355. abstract="false" native="false" synchronized="false"
  8356. static="false" final="false" visibility="public"
  8357. deprecated="not deprecated">
  8358. <param name="readers" type="java.lang.String"/>
  8359. <doc>
  8360. <![CDATA[Set the reader (and/or reader group) list string
  8361. @param readers the reader (and/or reader group) list string]]>
  8362. </doc>
  8363. </method>
  8364. <method name="getWriters" return="java.lang.String"
  8365. abstract="false" native="false" synchronized="false"
  8366. static="false" final="false" visibility="public"
  8367. deprecated="not deprecated">
  8368. <doc>
  8369. <![CDATA[Get the writer (and/or writer group) list string
  8370. @return the writer (and/or writer group) list string]]>
  8371. </doc>
  8372. </method>
  8373. <method name="setWriters"
  8374. abstract="false" native="false" synchronized="false"
  8375. static="false" final="false" visibility="public"
  8376. deprecated="not deprecated">
  8377. <param name="writers" type="java.lang.String"/>
  8378. <doc>
  8379. <![CDATA[Set the writer (and/or writer group) list string
  8380. @param writers the writer (and/or writer group) list string]]>
  8381. </doc>
  8382. </method>
  8383. <method name="getCreatedTime" return="java.lang.Long"
  8384. abstract="false" native="false" synchronized="false"
  8385. static="false" final="false" visibility="public"
  8386. deprecated="not deprecated">
  8387. <doc>
  8388. <![CDATA[Get the created time of the domain
  8389. @return the created time of the domain]]>
  8390. </doc>
  8391. </method>
  8392. <method name="setCreatedTime"
  8393. abstract="false" native="false" synchronized="false"
  8394. static="false" final="false" visibility="public"
  8395. deprecated="not deprecated">
  8396. <param name="createdTime" type="java.lang.Long"/>
  8397. <doc>
  8398. <![CDATA[Set the created time of the domain
  8399. @param createdTime the created time of the domain]]>
  8400. </doc>
  8401. </method>
  8402. <method name="getModifiedTime" return="java.lang.Long"
  8403. abstract="false" native="false" synchronized="false"
  8404. static="false" final="false" visibility="public"
  8405. deprecated="not deprecated">
  8406. <doc>
  8407. <![CDATA[Get the modified time of the domain
  8408. @return the modified time of the domain]]>
  8409. </doc>
  8410. </method>
  8411. <method name="setModifiedTime"
  8412. abstract="false" native="false" synchronized="false"
  8413. static="false" final="false" visibility="public"
  8414. deprecated="not deprecated">
  8415. <param name="modifiedTime" type="java.lang.Long"/>
  8416. <doc>
  8417. <![CDATA[Set the modified time of the domain
  8418. @param modifiedTime the modified time of the domain]]>
  8419. </doc>
  8420. </method>
  8421. <doc>
  8422. <![CDATA[<p>
  8423. This class contains the information about a timeline domain, which is used
  8424. to a user to host a number of timeline entities, isolating them from others'.
  8425. The user can also define the reader and writer users/groups for the the
  8426. domain, which is used to control the access to its entities.
  8427. </p>
  8428. <p>
  8429. The reader and writer users/groups pattern that the user can supply is the
  8430. same as what <code>AccessControlList</code> takes.
  8431. </p>]]>
  8432. </doc>
  8433. </class>
  8434. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
  8435. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
  8436. <class name="TimelineDomains" extends="java.lang.Object"
  8437. abstract="false"
  8438. static="false" final="false" visibility="public"
  8439. deprecated="not deprecated">
  8440. <constructor name="TimelineDomains"
  8441. static="false" final="false" visibility="public"
  8442. deprecated="not deprecated">
  8443. </constructor>
  8444. <method name="getDomains" return="java.util.List"
  8445. abstract="false" native="false" synchronized="false"
  8446. static="false" final="false" visibility="public"
  8447. deprecated="not deprecated">
  8448. <doc>
  8449. <![CDATA[Get a list of domains
  8450. @return a list of domains]]>
  8451. </doc>
  8452. </method>
  8453. <method name="addDomain"
  8454. abstract="false" native="false" synchronized="false"
  8455. static="false" final="false" visibility="public"
  8456. deprecated="not deprecated">
  8457. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  8458. <doc>
  8459. <![CDATA[Add a single domain into the existing domain list
  8460. @param domain
  8461. a single domain]]>
  8462. </doc>
  8463. </method>
  8464. <method name="addDomains"
  8465. abstract="false" native="false" synchronized="false"
  8466. static="false" final="false" visibility="public"
  8467. deprecated="not deprecated">
  8468. <param name="domains" type="java.util.List"/>
  8469. <doc>
  8470. <![CDATA[All a list of domains into the existing domain list
  8471. @param domains
  8472. a list of domains]]>
  8473. </doc>
  8474. </method>
  8475. <method name="setDomains"
  8476. abstract="false" native="false" synchronized="false"
  8477. static="false" final="false" visibility="public"
  8478. deprecated="not deprecated">
  8479. <param name="domains" type="java.util.List"/>
  8480. <doc>
  8481. <![CDATA[Set the domain list to the given list of domains
  8482. @param domains
  8483. a list of domains]]>
  8484. </doc>
  8485. </method>
  8486. <doc>
  8487. <![CDATA[The class that hosts a list of timeline domains.]]>
  8488. </doc>
  8489. </class>
  8490. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
  8491. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
  8492. <class name="TimelineEntities" extends="java.lang.Object"
  8493. abstract="false"
  8494. static="false" final="false" visibility="public"
  8495. deprecated="not deprecated">
  8496. <constructor name="TimelineEntities"
  8497. static="false" final="false" visibility="public"
  8498. deprecated="not deprecated">
  8499. </constructor>
  8500. <method name="getEntities" return="java.util.List"
  8501. abstract="false" native="false" synchronized="false"
  8502. static="false" final="false" visibility="public"
  8503. deprecated="not deprecated">
  8504. <doc>
  8505. <![CDATA[Get a list of entities
  8506. @return a list of entities]]>
  8507. </doc>
  8508. </method>
  8509. <method name="addEntity"
  8510. abstract="false" native="false" synchronized="false"
  8511. static="false" final="false" visibility="public"
  8512. deprecated="not deprecated">
  8513. <param name="entity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
  8514. <doc>
  8515. <![CDATA[Add a single entity into the existing entity list
  8516. @param entity
  8517. a single entity]]>
  8518. </doc>
  8519. </method>
  8520. <method name="addEntities"
  8521. abstract="false" native="false" synchronized="false"
  8522. static="false" final="false" visibility="public"
  8523. deprecated="not deprecated">
  8524. <param name="entities" type="java.util.List"/>
  8525. <doc>
  8526. <![CDATA[All a list of entities into the existing entity list
  8527. @param entities
  8528. a list of entities]]>
  8529. </doc>
  8530. </method>
  8531. <method name="setEntities"
  8532. abstract="false" native="false" synchronized="false"
  8533. static="false" final="false" visibility="public"
  8534. deprecated="not deprecated">
  8535. <param name="entities" type="java.util.List"/>
  8536. <doc>
  8537. <![CDATA[Set the entity list to the given list of entities
  8538. @param entities
  8539. a list of entities]]>
  8540. </doc>
  8541. </method>
  8542. <doc>
  8543. <![CDATA[The class that hosts a list of timeline entities.]]>
  8544. </doc>
  8545. </class>
  8546. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
  8547. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
  8548. <class name="TimelineEntity" extends="java.lang.Object"
  8549. abstract="false"
  8550. static="false" final="false" visibility="public"
  8551. deprecated="not deprecated">
  8552. <implements name="java.lang.Comparable"/>
  8553. <constructor name="TimelineEntity"
  8554. static="false" final="false" visibility="public"
  8555. deprecated="not deprecated">
  8556. </constructor>
  8557. <method name="getEntityType" return="java.lang.String"
  8558. abstract="false" native="false" synchronized="false"
  8559. static="false" final="false" visibility="public"
  8560. deprecated="not deprecated">
  8561. <doc>
  8562. <![CDATA[Get the entity type
  8563. @return the entity type]]>
  8564. </doc>
  8565. </method>
  8566. <method name="setEntityType"
  8567. abstract="false" native="false" synchronized="false"
  8568. static="false" final="false" visibility="public"
  8569. deprecated="not deprecated">
  8570. <param name="entityType" type="java.lang.String"/>
  8571. <doc>
  8572. <![CDATA[Set the entity type
  8573. @param entityType
  8574. the entity type]]>
  8575. </doc>
  8576. </method>
  8577. <method name="getEntityId" return="java.lang.String"
  8578. abstract="false" native="false" synchronized="false"
  8579. static="false" final="false" visibility="public"
  8580. deprecated="not deprecated">
  8581. <doc>
  8582. <![CDATA[Get the entity Id
  8583. @return the entity Id]]>
  8584. </doc>
  8585. </method>
  8586. <method name="setEntityId"
  8587. abstract="false" native="false" synchronized="false"
  8588. static="false" final="false" visibility="public"
  8589. deprecated="not deprecated">
  8590. <param name="entityId" type="java.lang.String"/>
  8591. <doc>
  8592. <![CDATA[Set the entity Id
  8593. @param entityId
  8594. the entity Id]]>
  8595. </doc>
  8596. </method>
  8597. <method name="getStartTime" return="java.lang.Long"
  8598. abstract="false" native="false" synchronized="false"
  8599. static="false" final="false" visibility="public"
  8600. deprecated="not deprecated">
  8601. <doc>
  8602. <![CDATA[Get the start time of the entity
  8603. @return the start time of the entity]]>
  8604. </doc>
  8605. </method>
  8606. <method name="setStartTime"
  8607. abstract="false" native="false" synchronized="false"
  8608. static="false" final="false" visibility="public"
  8609. deprecated="not deprecated">
  8610. <param name="startTime" type="java.lang.Long"/>
  8611. <doc>
  8612. <![CDATA[Set the start time of the entity
  8613. @param startTime
  8614. the start time of the entity]]>
  8615. </doc>
  8616. </method>
  8617. <method name="getEvents" return="java.util.List"
  8618. abstract="false" native="false" synchronized="false"
  8619. static="false" final="false" visibility="public"
  8620. deprecated="not deprecated">
  8621. <doc>
  8622. <![CDATA[Get a list of events related to the entity
  8623. @return a list of events related to the entity]]>
  8624. </doc>
  8625. </method>
  8626. <method name="addEvent"
  8627. abstract="false" native="false" synchronized="false"
  8628. static="false" final="false" visibility="public"
  8629. deprecated="not deprecated">
  8630. <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  8631. <doc>
  8632. <![CDATA[Add a single event related to the entity to the existing event list
  8633. @param event
  8634. a single event related to the entity]]>
  8635. </doc>
  8636. </method>
  8637. <method name="addEvents"
  8638. abstract="false" native="false" synchronized="false"
  8639. static="false" final="false" visibility="public"
  8640. deprecated="not deprecated">
  8641. <param name="events" type="java.util.List"/>
  8642. <doc>
  8643. <![CDATA[Add a list of events related to the entity to the existing event list
  8644. @param events
  8645. a list of events related to the entity]]>
  8646. </doc>
  8647. </method>
  8648. <method name="setEvents"
  8649. abstract="false" native="false" synchronized="false"
  8650. static="false" final="false" visibility="public"
  8651. deprecated="not deprecated">
  8652. <param name="events" type="java.util.List"/>
  8653. <doc>
  8654. <![CDATA[Set the event list to the given list of events related to the entity
  8655. @param events
  8656. events a list of events related to the entity]]>
  8657. </doc>
  8658. </method>
  8659. <method name="getRelatedEntities" return="java.util.Map"
  8660. abstract="false" native="false" synchronized="false"
  8661. static="false" final="false" visibility="public"
  8662. deprecated="not deprecated">
  8663. <doc>
  8664. <![CDATA[Get the related entities
  8665. @return the related entities]]>
  8666. </doc>
  8667. </method>
  8668. <method name="addRelatedEntity"
  8669. abstract="false" native="false" synchronized="false"
  8670. static="false" final="false" visibility="public"
  8671. deprecated="not deprecated">
  8672. <param name="entityType" type="java.lang.String"/>
  8673. <param name="entityId" type="java.lang.String"/>
  8674. <doc>
  8675. <![CDATA[Add an entity to the existing related entity map
  8676. @param entityType
  8677. the entity type
  8678. @param entityId
  8679. the entity Id]]>
  8680. </doc>
  8681. </method>
  8682. <method name="addRelatedEntities"
  8683. abstract="false" native="false" synchronized="false"
  8684. static="false" final="false" visibility="public"
  8685. deprecated="not deprecated">
  8686. <param name="relatedEntities" type="java.util.Map"/>
  8687. <doc>
  8688. <![CDATA[Add a map of related entities to the existing related entity map
  8689. @param relatedEntities
  8690. a map of related entities]]>
  8691. </doc>
  8692. </method>
  8693. <method name="setRelatedEntities"
  8694. abstract="false" native="false" synchronized="false"
  8695. static="false" final="false" visibility="public"
  8696. deprecated="not deprecated">
  8697. <param name="relatedEntities" type="java.util.Map"/>
  8698. <doc>
  8699. <![CDATA[Set the related entity map to the given map of related entities
  8700. @param relatedEntities
  8701. a map of related entities]]>
  8702. </doc>
  8703. </method>
  8704. <method name="getPrimaryFilters" return="java.util.Map"
  8705. abstract="false" native="false" synchronized="false"
  8706. static="false" final="false" visibility="public"
  8707. deprecated="not deprecated">
  8708. <doc>
  8709. <![CDATA[Get the primary filters
  8710. @return the primary filters]]>
  8711. </doc>
  8712. </method>
  8713. <method name="addPrimaryFilter"
  8714. abstract="false" native="false" synchronized="false"
  8715. static="false" final="false" visibility="public"
  8716. deprecated="not deprecated">
  8717. <param name="key" type="java.lang.String"/>
  8718. <param name="value" type="java.lang.Object"/>
  8719. <doc>
  8720. <![CDATA[Add a single piece of primary filter to the existing primary filter map
  8721. @param key
  8722. the primary filter key
  8723. @param value
  8724. the primary filter value]]>
  8725. </doc>
  8726. </method>
  8727. <method name="addPrimaryFilters"
  8728. abstract="false" native="false" synchronized="false"
  8729. static="false" final="false" visibility="public"
  8730. deprecated="not deprecated">
  8731. <param name="primaryFilters" type="java.util.Map"/>
  8732. <doc>
  8733. <![CDATA[Add a map of primary filters to the existing primary filter map
  8734. @param primaryFilters
  8735. a map of primary filters]]>
  8736. </doc>
  8737. </method>
  8738. <method name="setPrimaryFilters"
  8739. abstract="false" native="false" synchronized="false"
  8740. static="false" final="false" visibility="public"
  8741. deprecated="not deprecated">
  8742. <param name="primaryFilters" type="java.util.Map"/>
  8743. <doc>
  8744. <![CDATA[Set the primary filter map to the given map of primary filters
  8745. @param primaryFilters
  8746. a map of primary filters]]>
  8747. </doc>
  8748. </method>
  8749. <method name="getOtherInfo" return="java.util.Map"
  8750. abstract="false" native="false" synchronized="false"
  8751. static="false" final="false" visibility="public"
  8752. deprecated="not deprecated">
  8753. <doc>
  8754. <![CDATA[Get the other information of the entity
  8755. @return the other information of the entity]]>
  8756. </doc>
  8757. </method>
  8758. <method name="addOtherInfo"
  8759. abstract="false" native="false" synchronized="false"
  8760. static="false" final="false" visibility="public"
  8761. deprecated="not deprecated">
  8762. <param name="key" type="java.lang.String"/>
  8763. <param name="value" type="java.lang.Object"/>
  8764. <doc>
  8765. <![CDATA[Add one piece of other information of the entity to the existing other info
  8766. map
  8767. @param key
  8768. the other information key
  8769. @param value
  8770. the other information value]]>
  8771. </doc>
  8772. </method>
  8773. <method name="addOtherInfo"
  8774. abstract="false" native="false" synchronized="false"
  8775. static="false" final="false" visibility="public"
  8776. deprecated="not deprecated">
  8777. <param name="otherInfo" type="java.util.Map"/>
  8778. <doc>
  8779. <![CDATA[Add a map of other information of the entity to the existing other info map
  8780. @param otherInfo
  8781. a map of other information]]>
  8782. </doc>
  8783. </method>
  8784. <method name="setOtherInfo"
  8785. abstract="false" native="false" synchronized="false"
  8786. static="false" final="false" visibility="public"
  8787. deprecated="not deprecated">
  8788. <param name="otherInfo" type="java.util.Map"/>
  8789. <doc>
  8790. <![CDATA[Set the other info map to the given map of other information
  8791. @param otherInfo
  8792. a map of other information]]>
  8793. </doc>
  8794. </method>
  8795. <method name="getDomainId" return="java.lang.String"
  8796. abstract="false" native="false" synchronized="false"
  8797. static="false" final="false" visibility="public"
  8798. deprecated="not deprecated">
  8799. <doc>
  8800. <![CDATA[Get the ID of the domain that the entity is to be put
  8801. @return the domain ID]]>
  8802. </doc>
  8803. </method>
  8804. <method name="setDomainId"
  8805. abstract="false" native="false" synchronized="false"
  8806. static="false" final="false" visibility="public"
  8807. deprecated="not deprecated">
  8808. <param name="domainId" type="java.lang.String"/>
  8809. <doc>
  8810. <![CDATA[Set the ID of the domain that the entity is to be put
  8811. @param domainId
  8812. the name space ID]]>
  8813. </doc>
  8814. </method>
  8815. <method name="hashCode" return="int"
  8816. abstract="false" native="false" synchronized="false"
  8817. static="false" final="false" visibility="public"
  8818. deprecated="not deprecated">
  8819. </method>
  8820. <method name="equals" return="boolean"
  8821. abstract="false" native="false" synchronized="false"
  8822. static="false" final="false" visibility="public"
  8823. deprecated="not deprecated">
  8824. <param name="obj" type="java.lang.Object"/>
  8825. </method>
  8826. <method name="compareTo" return="int"
  8827. abstract="false" native="false" synchronized="false"
  8828. static="false" final="false" visibility="public"
  8829. deprecated="not deprecated">
  8830. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
  8831. </method>
  8832. <doc>
  8833. <![CDATA[<p>
  8834. The class that contains the the meta information of some conceptual entity
  8835. and its related events. The entity can be an application, an application
  8836. attempt, a container or whatever the user-defined object.
  8837. </p>
  8838. <p>
  8839. Primary filters will be used to index the entities in
  8840. <code>TimelineStore</code>, such that users should carefully choose the
  8841. information they want to store as the primary filters. The remaining can be
  8842. stored as other information.
  8843. </p>]]>
  8844. </doc>
  8845. </class>
  8846. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
  8847. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
  8848. <class name="TimelineEvent" extends="java.lang.Object"
  8849. abstract="false"
  8850. static="false" final="false" visibility="public"
  8851. deprecated="not deprecated">
  8852. <implements name="java.lang.Comparable"/>
  8853. <constructor name="TimelineEvent"
  8854. static="false" final="false" visibility="public"
  8855. deprecated="not deprecated">
  8856. </constructor>
  8857. <method name="getTimestamp" return="long"
  8858. abstract="false" native="false" synchronized="false"
  8859. static="false" final="false" visibility="public"
  8860. deprecated="not deprecated">
  8861. <doc>
  8862. <![CDATA[Get the timestamp of the event
  8863. @return the timestamp of the event]]>
  8864. </doc>
  8865. </method>
  8866. <method name="setTimestamp"
  8867. abstract="false" native="false" synchronized="false"
  8868. static="false" final="false" visibility="public"
  8869. deprecated="not deprecated">
  8870. <param name="timestamp" type="long"/>
  8871. <doc>
  8872. <![CDATA[Set the timestamp of the event
  8873. @param timestamp
  8874. the timestamp of the event]]>
  8875. </doc>
  8876. </method>
  8877. <method name="getEventType" return="java.lang.String"
  8878. abstract="false" native="false" synchronized="false"
  8879. static="false" final="false" visibility="public"
  8880. deprecated="not deprecated">
  8881. <doc>
  8882. <![CDATA[Get the event type
  8883. @return the event type]]>
  8884. </doc>
  8885. </method>
  8886. <method name="setEventType"
  8887. abstract="false" native="false" synchronized="false"
  8888. static="false" final="false" visibility="public"
  8889. deprecated="not deprecated">
  8890. <param name="eventType" type="java.lang.String"/>
  8891. <doc>
  8892. <![CDATA[Set the event type
  8893. @param eventType
  8894. the event type]]>
  8895. </doc>
  8896. </method>
  8897. <method name="getEventInfo" return="java.util.Map"
  8898. abstract="false" native="false" synchronized="false"
  8899. static="false" final="false" visibility="public"
  8900. deprecated="not deprecated">
  8901. <doc>
  8902. <![CDATA[Set the information of the event
  8903. @return the information of the event]]>
  8904. </doc>
  8905. </method>
  8906. <method name="addEventInfo"
  8907. abstract="false" native="false" synchronized="false"
  8908. static="false" final="false" visibility="public"
  8909. deprecated="not deprecated">
  8910. <param name="key" type="java.lang.String"/>
  8911. <param name="value" type="java.lang.Object"/>
  8912. <doc>
  8913. <![CDATA[Add one piece of the information of the event to the existing information
  8914. map
  8915. @param key
  8916. the information key
  8917. @param value
  8918. the information value]]>
  8919. </doc>
  8920. </method>
  8921. <method name="addEventInfo"
  8922. abstract="false" native="false" synchronized="false"
  8923. static="false" final="false" visibility="public"
  8924. deprecated="not deprecated">
  8925. <param name="eventInfo" type="java.util.Map"/>
  8926. <doc>
  8927. <![CDATA[Add a map of the information of the event to the existing information map
  8928. @param eventInfo
  8929. a map of of the information of the event]]>
  8930. </doc>
  8931. </method>
  8932. <method name="setEventInfo"
  8933. abstract="false" native="false" synchronized="false"
  8934. static="false" final="false" visibility="public"
  8935. deprecated="not deprecated">
  8936. <param name="eventInfo" type="java.util.Map"/>
  8937. <doc>
  8938. <![CDATA[Set the information map to the given map of the information of the event
  8939. @param eventInfo
  8940. a map of of the information of the event]]>
  8941. </doc>
  8942. </method>
  8943. <method name="compareTo" return="int"
  8944. abstract="false" native="false" synchronized="false"
  8945. static="false" final="false" visibility="public"
  8946. deprecated="not deprecated">
  8947. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  8948. </method>
  8949. <method name="equals" return="boolean"
  8950. abstract="false" native="false" synchronized="false"
  8951. static="false" final="false" visibility="public"
  8952. deprecated="not deprecated">
  8953. <param name="o" type="java.lang.Object"/>
  8954. </method>
  8955. <method name="hashCode" return="int"
  8956. abstract="false" native="false" synchronized="false"
  8957. static="false" final="false" visibility="public"
  8958. deprecated="not deprecated">
  8959. </method>
  8960. <doc>
  8961. <![CDATA[The class that contains the information of an event that is related to some
  8962. conceptual entity of an application. Users are free to define what the event
  8963. means, such as starting an application, getting allocated a container and
  8964. etc.]]>
  8965. </doc>
  8966. </class>
  8967. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
  8968. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
  8969. <class name="TimelineEvents" extends="java.lang.Object"
  8970. abstract="false"
  8971. static="false" final="false" visibility="public"
  8972. deprecated="not deprecated">
  8973. <constructor name="TimelineEvents"
  8974. static="false" final="false" visibility="public"
  8975. deprecated="not deprecated">
  8976. </constructor>
  8977. <method name="getAllEvents" return="java.util.List"
  8978. abstract="false" native="false" synchronized="false"
  8979. static="false" final="false" visibility="public"
  8980. deprecated="not deprecated">
  8981. <doc>
  8982. <![CDATA[Get a list of {@link EventsOfOneEntity} instances
  8983. @return a list of {@link EventsOfOneEntity} instances]]>
  8984. </doc>
  8985. </method>
  8986. <method name="addEvent"
  8987. abstract="false" native="false" synchronized="false"
  8988. static="false" final="false" visibility="public"
  8989. deprecated="not deprecated">
  8990. <param name="eventsOfOneEntity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity"/>
  8991. <doc>
  8992. <![CDATA[Add a single {@link EventsOfOneEntity} instance into the existing list
  8993. @param eventsOfOneEntity
  8994. a single {@link EventsOfOneEntity} instance]]>
  8995. </doc>
  8996. </method>
  8997. <method name="addEvents"
  8998. abstract="false" native="false" synchronized="false"
  8999. static="false" final="false" visibility="public"
  9000. deprecated="not deprecated">
  9001. <param name="allEvents" type="java.util.List"/>
  9002. <doc>
  9003. <![CDATA[Add a list of {@link EventsOfOneEntity} instances into the existing list
  9004. @param allEvents
  9005. a list of {@link EventsOfOneEntity} instances]]>
  9006. </doc>
  9007. </method>
  9008. <method name="setEvents"
  9009. abstract="false" native="false" synchronized="false"
  9010. static="false" final="false" visibility="public"
  9011. deprecated="not deprecated">
  9012. <param name="allEvents" type="java.util.List"/>
  9013. <doc>
  9014. <![CDATA[Set the list to the given list of {@link EventsOfOneEntity} instances
  9015. @param allEvents
  9016. a list of {@link EventsOfOneEntity} instances]]>
  9017. </doc>
  9018. </method>
  9019. <doc>
  9020. <![CDATA[The class that hosts a list of events, which are categorized according to
  9021. their related entities.]]>
  9022. </doc>
  9023. </class>
  9024. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
  9025. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
  9026. <class name="TimelineEvents.EventsOfOneEntity" extends="java.lang.Object"
  9027. abstract="false"
  9028. static="true" final="false" visibility="public"
  9029. deprecated="not deprecated">
  9030. <constructor name="TimelineEvents.EventsOfOneEntity"
  9031. static="false" final="false" visibility="public"
  9032. deprecated="not deprecated">
  9033. </constructor>
  9034. <method name="getEntityId" return="java.lang.String"
  9035. abstract="false" native="false" synchronized="false"
  9036. static="false" final="false" visibility="public"
  9037. deprecated="not deprecated">
  9038. <doc>
  9039. <![CDATA[Get the entity Id
  9040. @return the entity Id]]>
  9041. </doc>
  9042. </method>
  9043. <method name="setEntityId"
  9044. abstract="false" native="false" synchronized="false"
  9045. static="false" final="false" visibility="public"
  9046. deprecated="not deprecated">
  9047. <param name="entityId" type="java.lang.String"/>
  9048. <doc>
  9049. <![CDATA[Set the entity Id
  9050. @param entityId
  9051. the entity Id]]>
  9052. </doc>
  9053. </method>
  9054. <method name="getEntityType" return="java.lang.String"
  9055. abstract="false" native="false" synchronized="false"
  9056. static="false" final="false" visibility="public"
  9057. deprecated="not deprecated">
  9058. <doc>
  9059. <![CDATA[Get the entity type
  9060. @return the entity type]]>
  9061. </doc>
  9062. </method>
  9063. <method name="setEntityType"
  9064. abstract="false" native="false" synchronized="false"
  9065. static="false" final="false" visibility="public"
  9066. deprecated="not deprecated">
  9067. <param name="entityType" type="java.lang.String"/>
  9068. <doc>
  9069. <![CDATA[Set the entity type
  9070. @param entityType
  9071. the entity type]]>
  9072. </doc>
  9073. </method>
  9074. <method name="getEvents" return="java.util.List"
  9075. abstract="false" native="false" synchronized="false"
  9076. static="false" final="false" visibility="public"
  9077. deprecated="not deprecated">
  9078. <doc>
  9079. <![CDATA[Get a list of events
  9080. @return a list of events]]>
  9081. </doc>
  9082. </method>
  9083. <method name="addEvent"
  9084. abstract="false" native="false" synchronized="false"
  9085. static="false" final="false" visibility="public"
  9086. deprecated="not deprecated">
  9087. <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  9088. <doc>
  9089. <![CDATA[Add a single event to the existing event list
  9090. @param event
  9091. a single event]]>
  9092. </doc>
  9093. </method>
  9094. <method name="addEvents"
  9095. abstract="false" native="false" synchronized="false"
  9096. static="false" final="false" visibility="public"
  9097. deprecated="not deprecated">
  9098. <param name="events" type="java.util.List"/>
  9099. <doc>
  9100. <![CDATA[Add a list of event to the existing event list
  9101. @param events
  9102. a list of events]]>
  9103. </doc>
  9104. </method>
  9105. <method name="setEvents"
  9106. abstract="false" native="false" synchronized="false"
  9107. static="false" final="false" visibility="public"
  9108. deprecated="not deprecated">
  9109. <param name="events" type="java.util.List"/>
  9110. <doc>
  9111. <![CDATA[Set the event list to the given list of events
  9112. @param events
  9113. a list of events]]>
  9114. </doc>
  9115. </method>
  9116. <doc>
  9117. <![CDATA[The class that hosts a list of events that are only related to one entity.]]>
  9118. </doc>
  9119. </class>
  9120. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
  9121. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
  9122. <class name="TimelinePutResponse" extends="java.lang.Object"
  9123. abstract="false"
  9124. static="false" final="false" visibility="public"
  9125. deprecated="not deprecated">
  9126. <constructor name="TimelinePutResponse"
  9127. static="false" final="false" visibility="public"
  9128. deprecated="not deprecated">
  9129. </constructor>
  9130. <method name="getErrors" return="java.util.List"
  9131. abstract="false" native="false" synchronized="false"
  9132. static="false" final="false" visibility="public"
  9133. deprecated="not deprecated">
  9134. <doc>
  9135. <![CDATA[Get a list of {@link TimelinePutError} instances
  9136. @return a list of {@link TimelinePutError} instances]]>
  9137. </doc>
  9138. </method>
  9139. <method name="addError"
  9140. abstract="false" native="false" synchronized="false"
  9141. static="false" final="false" visibility="public"
  9142. deprecated="not deprecated">
  9143. <param name="error" type="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError"/>
  9144. <doc>
  9145. <![CDATA[Add a single {@link TimelinePutError} instance into the existing list
  9146. @param error
  9147. a single {@link TimelinePutError} instance]]>
  9148. </doc>
  9149. </method>
  9150. <method name="addErrors"
  9151. abstract="false" native="false" synchronized="false"
  9152. static="false" final="false" visibility="public"
  9153. deprecated="not deprecated">
  9154. <param name="errors" type="java.util.List"/>
  9155. <doc>
  9156. <![CDATA[Add a list of {@link TimelinePutError} instances into the existing list
  9157. @param errors
  9158. a list of {@link TimelinePutError} instances]]>
  9159. </doc>
  9160. </method>
  9161. <method name="setErrors"
  9162. abstract="false" native="false" synchronized="false"
  9163. static="false" final="false" visibility="public"
  9164. deprecated="not deprecated">
  9165. <param name="errors" type="java.util.List"/>
  9166. <doc>
  9167. <![CDATA[Set the list to the given list of {@link TimelinePutError} instances
  9168. @param errors
  9169. a list of {@link TimelinePutError} instances]]>
  9170. </doc>
  9171. </method>
  9172. <doc>
  9173. <![CDATA[A class that holds a list of put errors. This is the response returned when a
  9174. list of {@link TimelineEntity} objects is added to the timeline. If there are errors
  9175. in storing individual entity objects, they will be indicated in the list of
  9176. errors.]]>
  9177. </doc>
  9178. </class>
  9179. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
  9180. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
  9181. <class name="TimelinePutResponse.TimelinePutError" extends="java.lang.Object"
  9182. abstract="false"
  9183. static="true" final="false" visibility="public"
  9184. deprecated="not deprecated">
  9185. <constructor name="TimelinePutResponse.TimelinePutError"
  9186. static="false" final="false" visibility="public"
  9187. deprecated="not deprecated">
  9188. </constructor>
  9189. <method name="getEntityId" return="java.lang.String"
  9190. abstract="false" native="false" synchronized="false"
  9191. static="false" final="false" visibility="public"
  9192. deprecated="not deprecated">
  9193. <doc>
  9194. <![CDATA[Get the entity Id
  9195. @return the entity Id]]>
  9196. </doc>
  9197. </method>
  9198. <method name="setEntityId"
  9199. abstract="false" native="false" synchronized="false"
  9200. static="false" final="false" visibility="public"
  9201. deprecated="not deprecated">
  9202. <param name="entityId" type="java.lang.String"/>
  9203. <doc>
  9204. <![CDATA[Set the entity Id
  9205. @param entityId
  9206. the entity Id]]>
  9207. </doc>
  9208. </method>
  9209. <method name="getEntityType" return="java.lang.String"
  9210. abstract="false" native="false" synchronized="false"
  9211. static="false" final="false" visibility="public"
  9212. deprecated="not deprecated">
  9213. <doc>
  9214. <![CDATA[Get the entity type
  9215. @return the entity type]]>
  9216. </doc>
  9217. </method>
  9218. <method name="setEntityType"
  9219. abstract="false" native="false" synchronized="false"
  9220. static="false" final="false" visibility="public"
  9221. deprecated="not deprecated">
  9222. <param name="entityType" type="java.lang.String"/>
  9223. <doc>
  9224. <![CDATA[Set the entity type
  9225. @param entityType
  9226. the entity type]]>
  9227. </doc>
  9228. </method>
  9229. <method name="getErrorCode" return="int"
  9230. abstract="false" native="false" synchronized="false"
  9231. static="false" final="false" visibility="public"
  9232. deprecated="not deprecated">
  9233. <doc>
  9234. <![CDATA[Get the error code
  9235. @return an error code]]>
  9236. </doc>
  9237. </method>
  9238. <method name="setErrorCode"
  9239. abstract="false" native="false" synchronized="false"
  9240. static="false" final="false" visibility="public"
  9241. deprecated="not deprecated">
  9242. <param name="errorCode" type="int"/>
  9243. <doc>
  9244. <![CDATA[Set the error code to the given error code
  9245. @param errorCode
  9246. an error code]]>
  9247. </doc>
  9248. </method>
  9249. <field name="NO_START_TIME" type="int"
  9250. transient="false" volatile="false"
  9251. static="true" final="true" visibility="public"
  9252. deprecated="not deprecated">
  9253. <doc>
  9254. <![CDATA[Error code returned when no start time can be found when putting an
  9255. entity. This occurs when the entity does not already exist in the store
  9256. and it is put with no start time or events specified.]]>
  9257. </doc>
  9258. </field>
  9259. <field name="IO_EXCEPTION" type="int"
  9260. transient="false" volatile="false"
  9261. static="true" final="true" visibility="public"
  9262. deprecated="not deprecated">
  9263. <doc>
  9264. <![CDATA[Error code returned if an IOException is encountered when putting an
  9265. entity.]]>
  9266. </doc>
  9267. </field>
  9268. <field name="SYSTEM_FILTER_CONFLICT" type="int"
  9269. transient="false" volatile="false"
  9270. static="true" final="true" visibility="public"
  9271. deprecated="not deprecated">
  9272. <doc>
  9273. <![CDATA[Error code returned if the user specifies the timeline system reserved
  9274. filter key]]>
  9275. </doc>
  9276. </field>
  9277. <field name="ACCESS_DENIED" type="int"
  9278. transient="false" volatile="false"
  9279. static="true" final="true" visibility="public"
  9280. deprecated="not deprecated">
  9281. <doc>
  9282. <![CDATA[Error code returned if the user is denied to access the timeline data]]>
  9283. </doc>
  9284. </field>
  9285. <field name="NO_DOMAIN" type="int"
  9286. transient="false" volatile="false"
  9287. static="true" final="true" visibility="public"
  9288. deprecated="not deprecated">
  9289. <doc>
  9290. <![CDATA[Error code returned if the entity doesn't have an valid domain ID]]>
  9291. </doc>
  9292. </field>
  9293. <field name="FORBIDDEN_RELATION" type="int"
  9294. transient="false" volatile="false"
  9295. static="true" final="true" visibility="public"
  9296. deprecated="not deprecated">
  9297. <doc>
  9298. <![CDATA[Error code returned if the user is denied to relate the entity to another
  9299. one in different domain]]>
  9300. </doc>
  9301. </field>
  9302. <doc>
  9303. <![CDATA[A class that holds the error code for one entity.]]>
  9304. </doc>
  9305. </class>
  9306. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
  9307. </package>
  9308. <package name="org.apache.hadoop.yarn.conf">
  9309. <!-- start class org.apache.hadoop.yarn.conf.YarnConfiguration -->
  9310. <class name="YarnConfiguration" extends="org.apache.hadoop.conf.Configuration"
  9311. abstract="false"
  9312. static="false" final="false" visibility="public"
  9313. deprecated="not deprecated">
  9314. <constructor name="YarnConfiguration"
  9315. static="false" final="false" visibility="public"
  9316. deprecated="not deprecated">
  9317. </constructor>
  9318. <constructor name="YarnConfiguration" type="org.apache.hadoop.conf.Configuration"
  9319. static="false" final="false" visibility="public"
  9320. deprecated="not deprecated">
  9321. </constructor>
  9322. <method name="getSocketAddr" return="java.net.InetSocketAddress"
  9323. abstract="false" native="false" synchronized="false"
  9324. static="false" final="false" visibility="public"
  9325. deprecated="not deprecated">
  9326. <param name="name" type="java.lang.String"/>
  9327. <param name="defaultAddress" type="java.lang.String"/>
  9328. <param name="defaultPort" type="int"/>
  9329. <doc>
  9330. <![CDATA[Get the socket address for <code>name</code> property as a
  9331. <code>InetSocketAddress</code>. On an HA cluster,
  9332. this fetches the address corresponding to the RM identified by
  9333. {@link #RM_HA_ID}.
  9334. @param name property name.
  9335. @param defaultAddress the default value
  9336. @param defaultPort the default port
  9337. @return InetSocketAddress]]>
  9338. </doc>
  9339. </method>
  9340. <method name="updateConnectAddr" return="java.net.InetSocketAddress"
  9341. abstract="false" native="false" synchronized="false"
  9342. static="false" final="false" visibility="public"
  9343. deprecated="not deprecated">
  9344. <param name="name" type="java.lang.String"/>
  9345. <param name="addr" type="java.net.InetSocketAddress"/>
  9346. </method>
  9347. <method name="useHttps" return="boolean"
  9348. abstract="false" native="false" synchronized="false"
  9349. static="true" final="false" visibility="public"
  9350. deprecated="not deprecated">
  9351. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  9352. </method>
  9353. <field name="CS_CONFIGURATION_FILE" type="java.lang.String"
  9354. transient="false" volatile="false"
  9355. static="true" final="true" visibility="public"
  9356. deprecated="not deprecated">
  9357. </field>
  9358. <field name="HADOOP_POLICY_CONFIGURATION_FILE" type="java.lang.String"
  9359. transient="false" volatile="false"
  9360. static="true" final="true" visibility="public"
  9361. deprecated="not deprecated">
  9362. </field>
  9363. <field name="YARN_SITE_CONFIGURATION_FILE" type="java.lang.String"
  9364. transient="false" volatile="false"
  9365. static="true" final="true" visibility="public"
  9366. deprecated="not deprecated">
  9367. </field>
  9368. <field name="CORE_SITE_CONFIGURATION_FILE" type="java.lang.String"
  9369. transient="false" volatile="false"
  9370. static="true" final="true" visibility="public"
  9371. deprecated="not deprecated">
  9372. </field>
  9373. <field name="RM_CONFIGURATION_FILES" type="java.util.List"
  9374. transient="false" volatile="false"
  9375. static="true" final="true" visibility="public"
  9376. deprecated="not deprecated">
  9377. </field>
  9378. <field name="APPLICATION_MAX_TAGS" type="int"
  9379. transient="false" volatile="false"
  9380. static="true" final="true" visibility="public"
  9381. deprecated="not deprecated">
  9382. </field>
  9383. <field name="APPLICATION_MAX_TAG_LENGTH" type="int"
  9384. transient="false" volatile="false"
  9385. static="true" final="true" visibility="public"
  9386. deprecated="not deprecated">
  9387. </field>
  9388. <field name="YARN_PREFIX" type="java.lang.String"
  9389. transient="false" volatile="false"
  9390. static="true" final="true" visibility="public"
  9391. deprecated="not deprecated">
  9392. </field>
  9393. <field name="DEBUG_NM_DELETE_DELAY_SEC" type="java.lang.String"
  9394. transient="false" volatile="false"
  9395. static="true" final="true" visibility="public"
  9396. deprecated="not deprecated">
  9397. <doc>
  9398. <![CDATA[Delay before deleting resource to ease debugging of NM issues]]>
  9399. </doc>
  9400. </field>
  9401. <field name="IPC_PREFIX" type="java.lang.String"
  9402. transient="false" volatile="false"
  9403. static="true" final="true" visibility="public"
  9404. deprecated="not deprecated">
  9405. </field>
  9406. <field name="IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
  9407. transient="false" volatile="false"
  9408. static="true" final="true" visibility="public"
  9409. deprecated="not deprecated">
  9410. <doc>
  9411. <![CDATA[Factory to create client IPC classes.]]>
  9412. </doc>
  9413. </field>
  9414. <field name="DEFAULT_IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
  9415. transient="false" volatile="false"
  9416. static="true" final="true" visibility="public"
  9417. deprecated="not deprecated">
  9418. </field>
  9419. <field name="IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
  9420. transient="false" volatile="false"
  9421. static="true" final="true" visibility="public"
  9422. deprecated="not deprecated">
  9423. <doc>
  9424. <![CDATA[Factory to create server IPC classes.]]>
  9425. </doc>
  9426. </field>
  9427. <field name="DEFAULT_IPC_SERVER_FACTORY_CLASS" 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="IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
  9433. transient="false" volatile="false"
  9434. static="true" final="true" visibility="public"
  9435. deprecated="not deprecated">
  9436. <doc>
  9437. <![CDATA[Factory to create serializeable records.]]>
  9438. </doc>
  9439. </field>
  9440. <field name="DEFAULT_IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
  9441. transient="false" volatile="false"
  9442. static="true" final="true" visibility="public"
  9443. deprecated="not deprecated">
  9444. </field>
  9445. <field name="IPC_RPC_IMPL" type="java.lang.String"
  9446. transient="false" volatile="false"
  9447. static="true" final="true" visibility="public"
  9448. deprecated="not deprecated">
  9449. <doc>
  9450. <![CDATA[RPC class implementation]]>
  9451. </doc>
  9452. </field>
  9453. <field name="DEFAULT_IPC_RPC_IMPL" type="java.lang.String"
  9454. transient="false" volatile="false"
  9455. static="true" final="true" visibility="public"
  9456. deprecated="not deprecated">
  9457. </field>
  9458. <field name="RM_PREFIX" type="java.lang.String"
  9459. transient="false" volatile="false"
  9460. static="true" final="true" visibility="public"
  9461. deprecated="not deprecated">
  9462. </field>
  9463. <field name="RM_CLUSTER_ID" type="java.lang.String"
  9464. transient="false" volatile="false"
  9465. static="true" final="true" visibility="public"
  9466. deprecated="not deprecated">
  9467. </field>
  9468. <field name="RM_HOSTNAME" type="java.lang.String"
  9469. transient="false" volatile="false"
  9470. static="true" final="true" visibility="public"
  9471. deprecated="not deprecated">
  9472. </field>
  9473. <field name="RM_ADDRESS" type="java.lang.String"
  9474. transient="false" volatile="false"
  9475. static="true" final="true" visibility="public"
  9476. deprecated="not deprecated">
  9477. <doc>
  9478. <![CDATA[The address of the applications manager interface in the RM.]]>
  9479. </doc>
  9480. </field>
  9481. <field name="DEFAULT_RM_PORT" type="int"
  9482. transient="false" volatile="false"
  9483. static="true" final="true" visibility="public"
  9484. deprecated="not deprecated">
  9485. </field>
  9486. <field name="DEFAULT_RM_ADDRESS" type="java.lang.String"
  9487. transient="false" volatile="false"
  9488. static="true" final="true" visibility="public"
  9489. deprecated="not deprecated">
  9490. </field>
  9491. <field name="RM_BIND_HOST" type="java.lang.String"
  9492. transient="false" volatile="false"
  9493. static="true" final="true" visibility="public"
  9494. deprecated="not deprecated">
  9495. <doc>
  9496. <![CDATA[The actual bind address for the RM.]]>
  9497. </doc>
  9498. </field>
  9499. <field name="RM_CLIENT_THREAD_COUNT" type="java.lang.String"
  9500. transient="false" volatile="false"
  9501. static="true" final="true" visibility="public"
  9502. deprecated="not deprecated">
  9503. <doc>
  9504. <![CDATA[The number of threads used to handle applications manager requests.]]>
  9505. </doc>
  9506. </field>
  9507. <field name="DEFAULT_RM_CLIENT_THREAD_COUNT" type="int"
  9508. transient="false" volatile="false"
  9509. static="true" final="true" visibility="public"
  9510. deprecated="not deprecated">
  9511. </field>
  9512. <field name="RM_PRINCIPAL" type="java.lang.String"
  9513. transient="false" volatile="false"
  9514. static="true" final="true" visibility="public"
  9515. deprecated="not deprecated">
  9516. <doc>
  9517. <![CDATA[The Kerberos principal for the resource manager.]]>
  9518. </doc>
  9519. </field>
  9520. <field name="RM_SCHEDULER_ADDRESS" type="java.lang.String"
  9521. transient="false" volatile="false"
  9522. static="true" final="true" visibility="public"
  9523. deprecated="not deprecated">
  9524. <doc>
  9525. <![CDATA[The address of the scheduler interface.]]>
  9526. </doc>
  9527. </field>
  9528. <field name="DEFAULT_RM_SCHEDULER_PORT" type="int"
  9529. transient="false" volatile="false"
  9530. static="true" final="true" visibility="public"
  9531. deprecated="not deprecated">
  9532. </field>
  9533. <field name="DEFAULT_RM_SCHEDULER_ADDRESS" type="java.lang.String"
  9534. transient="false" volatile="false"
  9535. static="true" final="true" visibility="public"
  9536. deprecated="not deprecated">
  9537. </field>
  9538. <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="java.lang.String"
  9539. transient="false" volatile="false"
  9540. static="true" final="true" visibility="public"
  9541. deprecated="not deprecated">
  9542. <doc>
  9543. <![CDATA[Miniumum request grant-able by the RM scheduler.]]>
  9544. </doc>
  9545. </field>
  9546. <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="int"
  9547. transient="false" volatile="false"
  9548. static="true" final="true" visibility="public"
  9549. deprecated="not deprecated">
  9550. </field>
  9551. <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="java.lang.String"
  9552. transient="false" volatile="false"
  9553. static="true" final="true" visibility="public"
  9554. deprecated="not deprecated">
  9555. </field>
  9556. <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="int"
  9557. transient="false" volatile="false"
  9558. static="true" final="true" visibility="public"
  9559. deprecated="not deprecated">
  9560. </field>
  9561. <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="java.lang.String"
  9562. transient="false" volatile="false"
  9563. static="true" final="true" visibility="public"
  9564. deprecated="not deprecated">
  9565. <doc>
  9566. <![CDATA[Maximum request grant-able by the RM scheduler.]]>
  9567. </doc>
  9568. </field>
  9569. <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="int"
  9570. transient="false" volatile="false"
  9571. static="true" final="true" visibility="public"
  9572. deprecated="not deprecated">
  9573. </field>
  9574. <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="java.lang.String"
  9575. transient="false" volatile="false"
  9576. static="true" final="true" visibility="public"
  9577. deprecated="not deprecated">
  9578. </field>
  9579. <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="int"
  9580. transient="false" volatile="false"
  9581. static="true" final="true" visibility="public"
  9582. deprecated="not deprecated">
  9583. </field>
  9584. <field name="RM_SCHEDULER_CLIENT_THREAD_COUNT" type="java.lang.String"
  9585. transient="false" volatile="false"
  9586. static="true" final="true" visibility="public"
  9587. deprecated="not deprecated">
  9588. <doc>
  9589. <![CDATA[Number of threads to handle scheduler interface.]]>
  9590. </doc>
  9591. </field>
  9592. <field name="DEFAULT_RM_SCHEDULER_CLIENT_THREAD_COUNT" type="int"
  9593. transient="false" volatile="false"
  9594. static="true" final="true" visibility="public"
  9595. deprecated="not deprecated">
  9596. </field>
  9597. <field name="RM_SCHEDULER_INCLUDE_PORT_IN_NODE_NAME" type="java.lang.String"
  9598. transient="false" volatile="false"
  9599. static="true" final="true" visibility="public"
  9600. deprecated="not deprecated">
  9601. <doc>
  9602. <![CDATA[If the port should be included or not in the node name. The node name
  9603. is used by the scheduler for resource requests allocation location
  9604. matching. Typically this is just the hostname, using the port is needed
  9605. when using minicluster and specific NM are required.]]>
  9606. </doc>
  9607. </field>
  9608. <field name="DEFAULT_RM_SCHEDULER_USE_PORT_FOR_NODE_NAME" type="boolean"
  9609. transient="false" volatile="false"
  9610. static="true" final="true" visibility="public"
  9611. deprecated="not deprecated">
  9612. </field>
  9613. <field name="RM_RESERVATION_SYSTEM_ENABLE" type="java.lang.String"
  9614. transient="false" volatile="false"
  9615. static="true" final="true" visibility="public"
  9616. deprecated="not deprecated">
  9617. <doc>
  9618. <![CDATA[Whether the RM should enable Reservation System]]>
  9619. </doc>
  9620. </field>
  9621. <field name="DEFAULT_RM_RESERVATION_SYSTEM_ENABLE" type="boolean"
  9622. transient="false" volatile="false"
  9623. static="true" final="true" visibility="public"
  9624. deprecated="not deprecated">
  9625. </field>
  9626. <field name="RM_RESERVATION_SYSTEM_CLASS" type="java.lang.String"
  9627. transient="false" volatile="false"
  9628. static="true" final="true" visibility="public"
  9629. deprecated="not deprecated">
  9630. <doc>
  9631. <![CDATA[The class to use as the Reservation System.]]>
  9632. </doc>
  9633. </field>
  9634. <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER" type="java.lang.String"
  9635. transient="false" volatile="false"
  9636. static="true" final="true" visibility="public"
  9637. deprecated="not deprecated">
  9638. <doc>
  9639. <![CDATA[The PlanFollower for the Reservation System.]]>
  9640. </doc>
  9641. </field>
  9642. <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="java.lang.String"
  9643. transient="false" volatile="false"
  9644. static="true" final="true" visibility="public"
  9645. deprecated="not deprecated">
  9646. <doc>
  9647. <![CDATA[The step size of the Reservation System.]]>
  9648. </doc>
  9649. </field>
  9650. <field name="DEFAULT_RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="long"
  9651. transient="false" volatile="false"
  9652. static="true" final="true" visibility="public"
  9653. deprecated="not deprecated">
  9654. </field>
  9655. <field name="RM_SCHEDULER_ENABLE_MONITORS" type="java.lang.String"
  9656. transient="false" volatile="false"
  9657. static="true" final="true" visibility="public"
  9658. deprecated="not deprecated">
  9659. <doc>
  9660. <![CDATA[Enable periodic monitor threads.
  9661. @see #RM_SCHEDULER_MONITOR_POLICIES]]>
  9662. </doc>
  9663. </field>
  9664. <field name="DEFAULT_RM_SCHEDULER_ENABLE_MONITORS" type="boolean"
  9665. transient="false" volatile="false"
  9666. static="true" final="true" visibility="public"
  9667. deprecated="not deprecated">
  9668. </field>
  9669. <field name="RM_SCHEDULER_MONITOR_POLICIES" type="java.lang.String"
  9670. transient="false" volatile="false"
  9671. static="true" final="true" visibility="public"
  9672. deprecated="not deprecated">
  9673. <doc>
  9674. <![CDATA[List of SchedulingEditPolicy classes affecting the scheduler.]]>
  9675. </doc>
  9676. </field>
  9677. <field name="RM_WEBAPP_ADDRESS" type="java.lang.String"
  9678. transient="false" volatile="false"
  9679. static="true" final="true" visibility="public"
  9680. deprecated="not deprecated">
  9681. <doc>
  9682. <![CDATA[The address of the RM web application.]]>
  9683. </doc>
  9684. </field>
  9685. <field name="DEFAULT_RM_WEBAPP_PORT" type="int"
  9686. transient="false" volatile="false"
  9687. static="true" final="true" visibility="public"
  9688. deprecated="not deprecated">
  9689. </field>
  9690. <field name="DEFAULT_RM_WEBAPP_ADDRESS" 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_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  9696. transient="false" volatile="false"
  9697. static="true" final="true" visibility="public"
  9698. deprecated="not deprecated">
  9699. <doc>
  9700. <![CDATA[The https address of the RM web application.]]>
  9701. </doc>
  9702. </field>
  9703. <field name="YARN_SSL_CLIENT_HTTPS_NEED_AUTH_DEFAULT" type="boolean"
  9704. transient="false" volatile="false"
  9705. static="true" final="true" visibility="public"
  9706. deprecated="not deprecated">
  9707. </field>
  9708. <field name="YARN_SSL_SERVER_RESOURCE_DEFAULT" type="java.lang.String"
  9709. transient="false" volatile="false"
  9710. static="true" final="true" visibility="public"
  9711. deprecated="not deprecated">
  9712. </field>
  9713. <field name="DEFAULT_RM_WEBAPP_HTTPS_PORT" type="int"
  9714. transient="false" volatile="false"
  9715. static="true" final="true" visibility="public"
  9716. deprecated="not deprecated">
  9717. </field>
  9718. <field name="DEFAULT_RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  9719. transient="false" volatile="false"
  9720. static="true" final="true" visibility="public"
  9721. deprecated="not deprecated">
  9722. </field>
  9723. <field name="RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
  9724. transient="false" volatile="false"
  9725. static="true" final="true" visibility="public"
  9726. deprecated="not deprecated">
  9727. </field>
  9728. <field name="DEFAULT_RM_RESOURCE_TRACKER_PORT" type="int"
  9729. transient="false" volatile="false"
  9730. static="true" final="true" visibility="public"
  9731. deprecated="not deprecated">
  9732. </field>
  9733. <field name="DEFAULT_RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
  9734. transient="false" volatile="false"
  9735. static="true" final="true" visibility="public"
  9736. deprecated="not deprecated">
  9737. </field>
  9738. <field name="RM_AM_EXPIRY_INTERVAL_MS" type="java.lang.String"
  9739. transient="false" volatile="false"
  9740. static="true" final="true" visibility="public"
  9741. deprecated="not deprecated">
  9742. <doc>
  9743. <![CDATA[The expiry interval for application master reporting.]]>
  9744. </doc>
  9745. </field>
  9746. <field name="DEFAULT_RM_AM_EXPIRY_INTERVAL_MS" type="int"
  9747. transient="false" volatile="false"
  9748. static="true" final="true" visibility="public"
  9749. deprecated="not deprecated">
  9750. </field>
  9751. <field name="RM_NM_EXPIRY_INTERVAL_MS" type="java.lang.String"
  9752. transient="false" volatile="false"
  9753. static="true" final="true" visibility="public"
  9754. deprecated="not deprecated">
  9755. <doc>
  9756. <![CDATA[How long to wait until a node manager is considered dead.]]>
  9757. </doc>
  9758. </field>
  9759. <field name="DEFAULT_RM_NM_EXPIRY_INTERVAL_MS" type="int"
  9760. transient="false" volatile="false"
  9761. static="true" final="true" visibility="public"
  9762. deprecated="not deprecated">
  9763. </field>
  9764. <field name="YARN_ACL_ENABLE" type="java.lang.String"
  9765. transient="false" volatile="false"
  9766. static="true" final="true" visibility="public"
  9767. deprecated="not deprecated">
  9768. <doc>
  9769. <![CDATA[Are acls enabled.]]>
  9770. </doc>
  9771. </field>
  9772. <field name="DEFAULT_YARN_ACL_ENABLE" type="boolean"
  9773. transient="false" volatile="false"
  9774. static="true" final="true" visibility="public"
  9775. deprecated="not deprecated">
  9776. </field>
  9777. <field name="YARN_ADMIN_ACL" type="java.lang.String"
  9778. transient="false" volatile="false"
  9779. static="true" final="true" visibility="public"
  9780. deprecated="not deprecated">
  9781. <doc>
  9782. <![CDATA[ACL of who can be admin of YARN cluster.]]>
  9783. </doc>
  9784. </field>
  9785. <field name="DEFAULT_YARN_ADMIN_ACL" 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_APP_ACL" type="java.lang.String"
  9791. transient="false" volatile="false"
  9792. static="true" final="true" visibility="public"
  9793. deprecated="not deprecated">
  9794. <doc>
  9795. <![CDATA[ACL used in case none is found. Allows nothing.]]>
  9796. </doc>
  9797. </field>
  9798. <field name="RM_ADMIN_ADDRESS" type="java.lang.String"
  9799. transient="false" volatile="false"
  9800. static="true" final="true" visibility="public"
  9801. deprecated="not deprecated">
  9802. <doc>
  9803. <![CDATA[The address of the RM admin interface.]]>
  9804. </doc>
  9805. </field>
  9806. <field name="DEFAULT_RM_ADMIN_PORT" type="int"
  9807. transient="false" volatile="false"
  9808. static="true" final="true" visibility="public"
  9809. deprecated="not deprecated">
  9810. </field>
  9811. <field name="DEFAULT_RM_ADMIN_ADDRESS" type="java.lang.String"
  9812. transient="false" volatile="false"
  9813. static="true" final="true" visibility="public"
  9814. deprecated="not deprecated">
  9815. </field>
  9816. <field name="RM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
  9817. transient="false" volatile="false"
  9818. static="true" final="true" visibility="public"
  9819. deprecated="not deprecated">
  9820. <doc>
  9821. <![CDATA[Number of threads used to handle RM admin interface.]]>
  9822. </doc>
  9823. </field>
  9824. <field name="DEFAULT_RM_ADMIN_CLIENT_THREAD_COUNT" type="int"
  9825. transient="false" volatile="false"
  9826. static="true" final="true" visibility="public"
  9827. deprecated="not deprecated">
  9828. </field>
  9829. <field name="RM_AM_MAX_ATTEMPTS" type="java.lang.String"
  9830. transient="false" volatile="false"
  9831. static="true" final="true" visibility="public"
  9832. deprecated="not deprecated">
  9833. <doc>
  9834. <![CDATA[The maximum number of application attempts.
  9835. It's a global setting for all application masters.]]>
  9836. </doc>
  9837. </field>
  9838. <field name="DEFAULT_RM_AM_MAX_ATTEMPTS" type="int"
  9839. transient="false" volatile="false"
  9840. static="true" final="true" visibility="public"
  9841. deprecated="not deprecated">
  9842. </field>
  9843. <field name="RM_KEYTAB" type="java.lang.String"
  9844. transient="false" volatile="false"
  9845. static="true" final="true" visibility="public"
  9846. deprecated="not deprecated">
  9847. <doc>
  9848. <![CDATA[The keytab for the resource manager.]]>
  9849. </doc>
  9850. </field>
  9851. <field name="RM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
  9852. transient="false" volatile="false"
  9853. static="true" final="true" visibility="public"
  9854. deprecated="not deprecated">
  9855. <doc>
  9856. <![CDATA[The kerberos principal to be used for spnego filter for RM.]]>
  9857. </doc>
  9858. </field>
  9859. <field name="RM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
  9860. transient="false" volatile="false"
  9861. static="true" final="true" visibility="public"
  9862. deprecated="not deprecated">
  9863. <doc>
  9864. <![CDATA[The kerberos keytab to be used for spnego filter for RM.]]>
  9865. </doc>
  9866. </field>
  9867. <field name="RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="java.lang.String"
  9868. transient="false" volatile="false"
  9869. static="true" final="true" visibility="public"
  9870. deprecated="not deprecated">
  9871. <doc>
  9872. <![CDATA[Flag to enable override of the default kerberos authentication filter with
  9873. the RM authentication filter to allow authentication using delegation
  9874. tokens(fallback to kerberos if the tokens are missing). Only applicable
  9875. when the http authentication type is kerberos.]]>
  9876. </doc>
  9877. </field>
  9878. <field name="DEFAULT_RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="boolean"
  9879. transient="false" volatile="false"
  9880. static="true" final="true" visibility="public"
  9881. deprecated="not deprecated">
  9882. </field>
  9883. <field name="RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="java.lang.String"
  9884. transient="false" volatile="false"
  9885. static="true" final="true" visibility="public"
  9886. deprecated="not deprecated">
  9887. <doc>
  9888. <![CDATA[How long to wait until a container is considered dead.]]>
  9889. </doc>
  9890. </field>
  9891. <field name="DEFAULT_RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="int"
  9892. transient="false" volatile="false"
  9893. static="true" final="true" visibility="public"
  9894. deprecated="not deprecated">
  9895. </field>
  9896. <field name="RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
  9897. transient="false" volatile="false"
  9898. static="true" final="true" visibility="public"
  9899. deprecated="not deprecated">
  9900. <doc>
  9901. <![CDATA[Path to file with nodes to include.]]>
  9902. </doc>
  9903. </field>
  9904. <field name="DEFAULT_RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
  9905. transient="false" volatile="false"
  9906. static="true" final="true" visibility="public"
  9907. deprecated="not deprecated">
  9908. </field>
  9909. <field name="RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
  9910. transient="false" volatile="false"
  9911. static="true" final="true" visibility="public"
  9912. deprecated="not deprecated">
  9913. <doc>
  9914. <![CDATA[Path to file with nodes to exclude.]]>
  9915. </doc>
  9916. </field>
  9917. <field name="DEFAULT_RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
  9918. transient="false" volatile="false"
  9919. static="true" final="true" visibility="public"
  9920. deprecated="not deprecated">
  9921. </field>
  9922. <field name="RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="java.lang.String"
  9923. transient="false" volatile="false"
  9924. static="true" final="true" visibility="public"
  9925. deprecated="not deprecated">
  9926. <doc>
  9927. <![CDATA[Number of threads to handle resource tracker calls.]]>
  9928. </doc>
  9929. </field>
  9930. <field name="DEFAULT_RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="int"
  9931. transient="false" volatile="false"
  9932. static="true" final="true" visibility="public"
  9933. deprecated="not deprecated">
  9934. </field>
  9935. <field name="RM_SCHEDULER" type="java.lang.String"
  9936. transient="false" volatile="false"
  9937. static="true" final="true" visibility="public"
  9938. deprecated="not deprecated">
  9939. <doc>
  9940. <![CDATA[The class to use as the resource scheduler.]]>
  9941. </doc>
  9942. </field>
  9943. <field name="DEFAULT_RM_SCHEDULER" type="java.lang.String"
  9944. transient="false" volatile="false"
  9945. static="true" final="true" visibility="public"
  9946. deprecated="not deprecated">
  9947. </field>
  9948. <field name="RM_NM_HEARTBEAT_INTERVAL_MS" type="java.lang.String"
  9949. transient="false" volatile="false"
  9950. static="true" final="true" visibility="public"
  9951. deprecated="not deprecated">
  9952. <doc>
  9953. <![CDATA[RM set next Heartbeat interval for NM]]>
  9954. </doc>
  9955. </field>
  9956. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MS" type="long"
  9957. transient="false" volatile="false"
  9958. static="true" final="true" visibility="public"
  9959. deprecated="not deprecated">
  9960. </field>
  9961. <field name="RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="java.lang.String"
  9962. transient="false" volatile="false"
  9963. static="true" final="true" visibility="public"
  9964. deprecated="not deprecated">
  9965. <doc>
  9966. <![CDATA[Number of worker threads that write the history data.]]>
  9967. </doc>
  9968. </field>
  9969. <field name="DEFAULT_RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="int"
  9970. transient="false" volatile="false"
  9971. static="true" final="true" visibility="public"
  9972. deprecated="not deprecated">
  9973. </field>
  9974. <field name="RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="java.lang.String"
  9975. transient="false" volatile="false"
  9976. static="true" final="true" visibility="public"
  9977. deprecated="not deprecated">
  9978. <doc>
  9979. <![CDATA[The setting that controls whether yarn system metrics is published on the
  9980. timeline server or not by RM.]]>
  9981. </doc>
  9982. </field>
  9983. <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="boolean"
  9984. transient="false" volatile="false"
  9985. static="true" final="true" visibility="public"
  9986. deprecated="not deprecated">
  9987. </field>
  9988. <field name="RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="java.lang.String"
  9989. transient="false" volatile="false"
  9990. static="true" final="true" visibility="public"
  9991. deprecated="not deprecated">
  9992. </field>
  9993. <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="int"
  9994. transient="false" volatile="false"
  9995. static="true" final="true" visibility="public"
  9996. deprecated="not deprecated">
  9997. </field>
  9998. <field name="DELEGATION_KEY_UPDATE_INTERVAL_KEY" type="java.lang.String"
  9999. transient="false" volatile="false"
  10000. static="true" final="true" visibility="public"
  10001. deprecated="not deprecated">
  10002. </field>
  10003. <field name="DELEGATION_KEY_UPDATE_INTERVAL_DEFAULT" type="long"
  10004. transient="false" volatile="false"
  10005. static="true" final="true" visibility="public"
  10006. deprecated="not deprecated">
  10007. </field>
  10008. <field name="DELEGATION_TOKEN_RENEW_INTERVAL_KEY" type="java.lang.String"
  10009. transient="false" volatile="false"
  10010. static="true" final="true" visibility="public"
  10011. deprecated="not deprecated">
  10012. </field>
  10013. <field name="DELEGATION_TOKEN_RENEW_INTERVAL_DEFAULT" type="long"
  10014. transient="false" volatile="false"
  10015. static="true" final="true" visibility="public"
  10016. deprecated="not deprecated">
  10017. </field>
  10018. <field name="DELEGATION_TOKEN_MAX_LIFETIME_KEY" type="java.lang.String"
  10019. transient="false" volatile="false"
  10020. static="true" final="true" visibility="public"
  10021. deprecated="not deprecated">
  10022. </field>
  10023. <field name="DELEGATION_TOKEN_MAX_LIFETIME_DEFAULT" type="long"
  10024. transient="false" volatile="false"
  10025. static="true" final="true" visibility="public"
  10026. deprecated="not deprecated">
  10027. </field>
  10028. <field name="RECOVERY_ENABLED" type="java.lang.String"
  10029. transient="false" volatile="false"
  10030. static="true" final="true" visibility="public"
  10031. deprecated="not deprecated">
  10032. </field>
  10033. <field name="DEFAULT_RM_RECOVERY_ENABLED" type="boolean"
  10034. transient="false" volatile="false"
  10035. static="true" final="true" visibility="public"
  10036. deprecated="not deprecated">
  10037. </field>
  10038. <field name="RM_WORK_PRESERVING_RECOVERY_ENABLED" type="java.lang.String"
  10039. transient="false" volatile="false"
  10040. static="true" final="true" visibility="public"
  10041. deprecated="not deprecated">
  10042. </field>
  10043. <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_ENABLED" type="boolean"
  10044. transient="false" volatile="false"
  10045. static="true" final="true" visibility="public"
  10046. deprecated="not deprecated">
  10047. </field>
  10048. <field name="RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="java.lang.String"
  10049. transient="false" volatile="false"
  10050. static="true" final="true" visibility="public"
  10051. deprecated="not deprecated">
  10052. </field>
  10053. <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="long"
  10054. transient="false" volatile="false"
  10055. static="true" final="true" visibility="public"
  10056. deprecated="not deprecated">
  10057. </field>
  10058. <field name="RM_ZK_PREFIX" type="java.lang.String"
  10059. transient="false" volatile="false"
  10060. static="true" final="true" visibility="public"
  10061. deprecated="not deprecated">
  10062. <doc>
  10063. <![CDATA[Zookeeper interaction configs]]>
  10064. </doc>
  10065. </field>
  10066. <field name="RM_ZK_ADDRESS" 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="RM_ZK_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_ZK_RM_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="RM_ZK_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_RM_ZK_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_ZK_TIMEOUT_MS" 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="DEFAULT_RM_ZK_TIMEOUT_MS" type="int"
  10097. transient="false" volatile="false"
  10098. static="true" final="true" visibility="public"
  10099. deprecated="not deprecated">
  10100. </field>
  10101. <field name="RM_ZK_ACL" type="java.lang.String"
  10102. transient="false" volatile="false"
  10103. static="true" final="true" visibility="public"
  10104. deprecated="not deprecated">
  10105. </field>
  10106. <field name="DEFAULT_RM_ZK_ACL" type="java.lang.String"
  10107. transient="false" volatile="false"
  10108. static="true" final="true" visibility="public"
  10109. deprecated="not deprecated">
  10110. </field>
  10111. <field name="RM_ZK_AUTH" type="java.lang.String"
  10112. transient="false" volatile="false"
  10113. static="true" final="true" visibility="public"
  10114. deprecated="not deprecated">
  10115. </field>
  10116. <field name="ZK_STATE_STORE_PREFIX" type="java.lang.String"
  10117. transient="false" volatile="false"
  10118. static="true" final="true" visibility="public"
  10119. deprecated="not deprecated">
  10120. </field>
  10121. <field name="ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
  10122. transient="false" volatile="false"
  10123. static="true" final="true" visibility="public"
  10124. deprecated="not deprecated">
  10125. <doc>
  10126. <![CDATA[Parent znode path under which ZKRMStateStore will create znodes]]>
  10127. </doc>
  10128. </field>
  10129. <field name="DEFAULT_ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
  10130. transient="false" volatile="false"
  10131. static="true" final="true" visibility="public"
  10132. deprecated="not deprecated">
  10133. </field>
  10134. <field name="ZK_RM_STATE_STORE_ROOT_NODE_ACL" type="java.lang.String"
  10135. transient="false" volatile="false"
  10136. static="true" final="true" visibility="public"
  10137. deprecated="not deprecated">
  10138. <doc>
  10139. <![CDATA[Root node ACLs for fencing]]>
  10140. </doc>
  10141. </field>
  10142. <field name="RM_HA_PREFIX" type="java.lang.String"
  10143. transient="false" volatile="false"
  10144. static="true" final="true" visibility="public"
  10145. deprecated="not deprecated">
  10146. <doc>
  10147. <![CDATA[HA related configs]]>
  10148. </doc>
  10149. </field>
  10150. <field name="RM_HA_ENABLED" type="java.lang.String"
  10151. transient="false" volatile="false"
  10152. static="true" final="true" visibility="public"
  10153. deprecated="not deprecated">
  10154. </field>
  10155. <field name="DEFAULT_RM_HA_ENABLED" type="boolean"
  10156. transient="false" volatile="false"
  10157. static="true" final="true" visibility="public"
  10158. deprecated="not deprecated">
  10159. </field>
  10160. <field name="RM_HA_IDS" type="java.lang.String"
  10161. transient="false" volatile="false"
  10162. static="true" final="true" visibility="public"
  10163. deprecated="not deprecated">
  10164. </field>
  10165. <field name="RM_HA_ID" type="java.lang.String"
  10166. transient="false" volatile="false"
  10167. static="true" final="true" visibility="public"
  10168. deprecated="not deprecated">
  10169. </field>
  10170. <field name="FS_BASED_RM_CONF_STORE" type="java.lang.String"
  10171. transient="false" volatile="false"
  10172. static="true" final="true" visibility="public"
  10173. deprecated="not deprecated">
  10174. <doc>
  10175. <![CDATA[Store the related configuration files in File System]]>
  10176. </doc>
  10177. </field>
  10178. <field name="DEFAULT_FS_BASED_RM_CONF_STORE" type="java.lang.String"
  10179. transient="false" volatile="false"
  10180. static="true" final="true" visibility="public"
  10181. deprecated="not deprecated">
  10182. </field>
  10183. <field name="RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
  10184. transient="false" volatile="false"
  10185. static="true" final="true" visibility="public"
  10186. deprecated="not deprecated">
  10187. </field>
  10188. <field name="DEFAULT_RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
  10189. transient="false" volatile="false"
  10190. static="true" final="true" visibility="public"
  10191. deprecated="not deprecated">
  10192. </field>
  10193. <field name="AUTO_FAILOVER_PREFIX" type="java.lang.String"
  10194. transient="false" volatile="false"
  10195. static="true" final="true" visibility="public"
  10196. deprecated="not deprecated">
  10197. </field>
  10198. <field name="AUTO_FAILOVER_ENABLED" type="java.lang.String"
  10199. transient="false" volatile="false"
  10200. static="true" final="true" visibility="public"
  10201. deprecated="not deprecated">
  10202. </field>
  10203. <field name="DEFAULT_AUTO_FAILOVER_ENABLED" type="boolean"
  10204. transient="false" volatile="false"
  10205. static="true" final="true" visibility="public"
  10206. deprecated="not deprecated">
  10207. </field>
  10208. <field name="AUTO_FAILOVER_EMBEDDED" type="java.lang.String"
  10209. transient="false" volatile="false"
  10210. static="true" final="true" visibility="public"
  10211. deprecated="not deprecated">
  10212. </field>
  10213. <field name="DEFAULT_AUTO_FAILOVER_EMBEDDED" type="boolean"
  10214. transient="false" volatile="false"
  10215. static="true" final="true" visibility="public"
  10216. deprecated="not deprecated">
  10217. </field>
  10218. <field name="AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
  10219. transient="false" volatile="false"
  10220. static="true" final="true" visibility="public"
  10221. deprecated="not deprecated">
  10222. </field>
  10223. <field name="DEFAULT_AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
  10224. transient="false" volatile="false"
  10225. static="true" final="true" visibility="public"
  10226. deprecated="not deprecated">
  10227. </field>
  10228. <field name="CLIENT_FAILOVER_PREFIX" type="java.lang.String"
  10229. transient="false" volatile="false"
  10230. static="true" final="true" visibility="public"
  10231. deprecated="not deprecated">
  10232. </field>
  10233. <field name="CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
  10234. transient="false" volatile="false"
  10235. static="true" final="true" visibility="public"
  10236. deprecated="not deprecated">
  10237. </field>
  10238. <field name="DEFAULT_CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
  10239. transient="false" volatile="false"
  10240. static="true" final="true" visibility="public"
  10241. deprecated="not deprecated">
  10242. </field>
  10243. <field name="CLIENT_FAILOVER_MAX_ATTEMPTS" type="java.lang.String"
  10244. transient="false" volatile="false"
  10245. static="true" final="true" visibility="public"
  10246. deprecated="not deprecated">
  10247. </field>
  10248. <field name="CLIENT_FAILOVER_SLEEPTIME_BASE_MS" 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="CLIENT_FAILOVER_SLEEPTIME_MAX_MS" type="java.lang.String"
  10254. transient="false" volatile="false"
  10255. static="true" final="true" visibility="public"
  10256. deprecated="not deprecated">
  10257. </field>
  10258. <field name="CLIENT_FAILOVER_RETRIES" type="java.lang.String"
  10259. transient="false" volatile="false"
  10260. static="true" final="true" visibility="public"
  10261. deprecated="not deprecated">
  10262. </field>
  10263. <field name="DEFAULT_CLIENT_FAILOVER_RETRIES" type="int"
  10264. transient="false" volatile="false"
  10265. static="true" final="true" visibility="public"
  10266. deprecated="not deprecated">
  10267. </field>
  10268. <field name="CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="java.lang.String"
  10269. transient="false" volatile="false"
  10270. static="true" final="true" visibility="public"
  10271. deprecated="not deprecated">
  10272. </field>
  10273. <field name="DEFAULT_CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="int"
  10274. transient="false" volatile="false"
  10275. static="true" final="true" visibility="public"
  10276. deprecated="not deprecated">
  10277. </field>
  10278. <field name="RM_STORE" type="java.lang.String"
  10279. transient="false" volatile="false"
  10280. static="true" final="true" visibility="public"
  10281. deprecated="not deprecated">
  10282. <doc>
  10283. <![CDATA[The class to use as the persistent store.]]>
  10284. </doc>
  10285. </field>
  10286. <field name="FS_RM_STATE_STORE_URI" type="java.lang.String"
  10287. transient="false" volatile="false"
  10288. static="true" final="true" visibility="public"
  10289. deprecated="not deprecated">
  10290. <doc>
  10291. <![CDATA[URI for FileSystemRMStateStore]]>
  10292. </doc>
  10293. </field>
  10294. <field name="FS_RM_STATE_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  10295. transient="false" volatile="false"
  10296. static="true" final="true" visibility="public"
  10297. deprecated="not deprecated">
  10298. </field>
  10299. <field name="DEFAULT_FS_RM_STATE_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  10300. transient="false" volatile="false"
  10301. static="true" final="true" visibility="public"
  10302. deprecated="not deprecated">
  10303. </field>
  10304. <field name="RM_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
  10305. transient="false" volatile="false"
  10306. static="true" final="true" visibility="public"
  10307. deprecated="not deprecated">
  10308. <doc>
  10309. <![CDATA[The maximum number of completed applications RM keeps.]]>
  10310. </doc>
  10311. </field>
  10312. <field name="DEFAULT_RM_MAX_COMPLETED_APPLICATIONS" type="int"
  10313. transient="false" volatile="false"
  10314. static="true" final="true" visibility="public"
  10315. deprecated="not deprecated">
  10316. </field>
  10317. <field name="RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
  10318. transient="false" volatile="false"
  10319. static="true" final="true" visibility="public"
  10320. deprecated="not deprecated">
  10321. <doc>
  10322. <![CDATA[The maximum number of completed applications RM state store keeps, by
  10323. default equals to DEFAULT_RM_MAX_COMPLETED_APPLICATIONS]]>
  10324. </doc>
  10325. </field>
  10326. <field name="DEFAULT_RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="int"
  10327. transient="false" volatile="false"
  10328. static="true" final="true" visibility="public"
  10329. deprecated="not deprecated">
  10330. </field>
  10331. <field name="DEFAULT_APPLICATION_NAME" type="java.lang.String"
  10332. transient="false" volatile="false"
  10333. static="true" final="true" visibility="public"
  10334. deprecated="not deprecated">
  10335. <doc>
  10336. <![CDATA[Default application name]]>
  10337. </doc>
  10338. </field>
  10339. <field name="DEFAULT_APPLICATION_TYPE" type="java.lang.String"
  10340. transient="false" volatile="false"
  10341. static="true" final="true" visibility="public"
  10342. deprecated="not deprecated">
  10343. <doc>
  10344. <![CDATA[Default application type]]>
  10345. </doc>
  10346. </field>
  10347. <field name="APPLICATION_TYPE_LENGTH" type="int"
  10348. transient="false" volatile="false"
  10349. static="true" final="true" visibility="public"
  10350. deprecated="not deprecated">
  10351. <doc>
  10352. <![CDATA[Default application type length]]>
  10353. </doc>
  10354. </field>
  10355. <field name="DEFAULT_QUEUE_NAME" type="java.lang.String"
  10356. transient="false" volatile="false"
  10357. static="true" final="true" visibility="public"
  10358. deprecated="not deprecated">
  10359. <doc>
  10360. <![CDATA[Default queue name]]>
  10361. </doc>
  10362. </field>
  10363. <field name="RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
  10364. transient="false" volatile="false"
  10365. static="true" final="true" visibility="public"
  10366. deprecated="not deprecated">
  10367. <doc>
  10368. <![CDATA[Buckets (in minutes) for the number of apps running in each queue.]]>
  10369. </doc>
  10370. </field>
  10371. <field name="DEFAULT_RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
  10372. transient="false" volatile="false"
  10373. static="true" final="true" visibility="public"
  10374. deprecated="not deprecated">
  10375. <doc>
  10376. <![CDATA[Default sizes of the runtime metric buckets in minutes.]]>
  10377. </doc>
  10378. </field>
  10379. <field name="RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  10380. transient="false" volatile="false"
  10381. static="true" final="true" visibility="public"
  10382. deprecated="not deprecated">
  10383. </field>
  10384. <field name="DEFAULT_RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  10385. transient="false" volatile="false"
  10386. static="true" final="true" visibility="public"
  10387. deprecated="not deprecated">
  10388. </field>
  10389. <field name="RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  10390. transient="false" volatile="false"
  10391. static="true" final="true" visibility="public"
  10392. deprecated="not deprecated">
  10393. </field>
  10394. <field name="DEFAULT_RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  10395. transient="false" volatile="false"
  10396. static="true" final="true" visibility="public"
  10397. deprecated="not deprecated">
  10398. </field>
  10399. <field name="RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  10400. transient="false" volatile="false"
  10401. static="true" final="true" visibility="public"
  10402. deprecated="not deprecated">
  10403. </field>
  10404. <field name="DEFAULT_RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  10405. transient="false" volatile="false"
  10406. static="true" final="true" visibility="public"
  10407. deprecated="not deprecated">
  10408. </field>
  10409. <field name="RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  10410. transient="false" volatile="false"
  10411. static="true" final="true" visibility="public"
  10412. deprecated="not deprecated">
  10413. </field>
  10414. <field name="DEFAULT_RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  10415. transient="false" volatile="false"
  10416. static="true" final="true" visibility="public"
  10417. deprecated="not deprecated">
  10418. </field>
  10419. <field name="RM_PROXY_USER_PREFIX" type="java.lang.String"
  10420. transient="false" volatile="false"
  10421. static="true" final="true" visibility="public"
  10422. deprecated="not deprecated">
  10423. <doc>
  10424. <![CDATA[RM proxy users' prefix]]>
  10425. </doc>
  10426. </field>
  10427. <field name="NM_PREFIX" type="java.lang.String"
  10428. transient="false" volatile="false"
  10429. static="true" final="true" visibility="public"
  10430. deprecated="not deprecated">
  10431. <doc>
  10432. <![CDATA[Prefix for all node manager configs.]]>
  10433. </doc>
  10434. </field>
  10435. <field name="NM_ADMIN_USER_ENV" type="java.lang.String"
  10436. transient="false" volatile="false"
  10437. static="true" final="true" visibility="public"
  10438. deprecated="not deprecated">
  10439. <doc>
  10440. <![CDATA[Environment variables that will be sent to containers.]]>
  10441. </doc>
  10442. </field>
  10443. <field name="DEFAULT_NM_ADMIN_USER_ENV" type="java.lang.String"
  10444. transient="false" volatile="false"
  10445. static="true" final="true" visibility="public"
  10446. deprecated="not deprecated">
  10447. </field>
  10448. <field name="NM_ENV_WHITELIST" type="java.lang.String"
  10449. transient="false" volatile="false"
  10450. static="true" final="true" visibility="public"
  10451. deprecated="not deprecated">
  10452. <doc>
  10453. <![CDATA[Environment variables that containers may override rather than use NodeManager's default.]]>
  10454. </doc>
  10455. </field>
  10456. <field name="DEFAULT_NM_ENV_WHITELIST" type="java.lang.String"
  10457. transient="false" volatile="false"
  10458. static="true" final="true" visibility="public"
  10459. deprecated="not deprecated">
  10460. </field>
  10461. <field name="NM_ADDRESS" type="java.lang.String"
  10462. transient="false" volatile="false"
  10463. static="true" final="true" visibility="public"
  10464. deprecated="not deprecated">
  10465. <doc>
  10466. <![CDATA[address of node manager IPC.]]>
  10467. </doc>
  10468. </field>
  10469. <field name="DEFAULT_NM_PORT" type="int"
  10470. transient="false" volatile="false"
  10471. static="true" final="true" visibility="public"
  10472. deprecated="not deprecated">
  10473. </field>
  10474. <field name="DEFAULT_NM_ADDRESS" type="java.lang.String"
  10475. transient="false" volatile="false"
  10476. static="true" final="true" visibility="public"
  10477. deprecated="not deprecated">
  10478. </field>
  10479. <field name="NM_BIND_HOST" type="java.lang.String"
  10480. transient="false" volatile="false"
  10481. static="true" final="true" visibility="public"
  10482. deprecated="not deprecated">
  10483. <doc>
  10484. <![CDATA[The actual bind address or the NM.]]>
  10485. </doc>
  10486. </field>
  10487. <field name="NM_CONTAINER_EXECUTOR" type="java.lang.String"
  10488. transient="false" volatile="false"
  10489. static="true" final="true" visibility="public"
  10490. deprecated="not deprecated">
  10491. <doc>
  10492. <![CDATA[who will execute(launch) the containers.]]>
  10493. </doc>
  10494. </field>
  10495. <field name="NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="java.lang.String"
  10496. transient="false" volatile="false"
  10497. static="true" final="true" visibility="public"
  10498. deprecated="not deprecated">
  10499. <doc>
  10500. <![CDATA[Adjustment to make to the container os scheduling priority.
  10501. The valid values for this could vary depending on the platform.
  10502. On Linux, higher values mean run the containers at a less
  10503. favorable priority than the NM.
  10504. The value specified is an int.]]>
  10505. </doc>
  10506. </field>
  10507. <field name="DEFAULT_NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="int"
  10508. transient="false" volatile="false"
  10509. static="true" final="true" visibility="public"
  10510. deprecated="not deprecated">
  10511. </field>
  10512. <field name="NM_CONTAINER_MGR_THREAD_COUNT" type="java.lang.String"
  10513. transient="false" volatile="false"
  10514. static="true" final="true" visibility="public"
  10515. deprecated="not deprecated">
  10516. <doc>
  10517. <![CDATA[Number of threads container manager uses.]]>
  10518. </doc>
  10519. </field>
  10520. <field name="DEFAULT_NM_CONTAINER_MGR_THREAD_COUNT" type="int"
  10521. transient="false" volatile="false"
  10522. static="true" final="true" visibility="public"
  10523. deprecated="not deprecated">
  10524. </field>
  10525. <field name="NM_DELETE_THREAD_COUNT" type="java.lang.String"
  10526. transient="false" volatile="false"
  10527. static="true" final="true" visibility="public"
  10528. deprecated="not deprecated">
  10529. <doc>
  10530. <![CDATA[Number of threads used in cleanup.]]>
  10531. </doc>
  10532. </field>
  10533. <field name="DEFAULT_NM_DELETE_THREAD_COUNT" type="int"
  10534. transient="false" volatile="false"
  10535. static="true" final="true" visibility="public"
  10536. deprecated="not deprecated">
  10537. </field>
  10538. <field name="NM_KEYTAB" type="java.lang.String"
  10539. transient="false" volatile="false"
  10540. static="true" final="true" visibility="public"
  10541. deprecated="not deprecated">
  10542. <doc>
  10543. <![CDATA[Keytab for NM.]]>
  10544. </doc>
  10545. </field>
  10546. <field name="NM_LOCAL_DIRS" type="java.lang.String"
  10547. transient="false" volatile="false"
  10548. static="true" final="true" visibility="public"
  10549. deprecated="not deprecated">
  10550. <doc>
  10551. <![CDATA[List of directories to store localized files in.]]>
  10552. </doc>
  10553. </field>
  10554. <field name="DEFAULT_NM_LOCAL_DIRS" type="java.lang.String"
  10555. transient="false" volatile="false"
  10556. static="true" final="true" visibility="public"
  10557. deprecated="not deprecated">
  10558. </field>
  10559. <field name="NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="java.lang.String"
  10560. transient="false" volatile="false"
  10561. static="true" final="true" visibility="public"
  10562. deprecated="not deprecated">
  10563. <doc>
  10564. <![CDATA[Number of files in each localized directories
  10565. Avoid tuning this too low.]]>
  10566. </doc>
  10567. </field>
  10568. <field name="DEFAULT_NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="int"
  10569. transient="false" volatile="false"
  10570. static="true" final="true" visibility="public"
  10571. deprecated="not deprecated">
  10572. </field>
  10573. <field name="NM_LOCALIZER_ADDRESS" type="java.lang.String"
  10574. transient="false" volatile="false"
  10575. static="true" final="true" visibility="public"
  10576. deprecated="not deprecated">
  10577. <doc>
  10578. <![CDATA[Address where the localizer IPC is.]]>
  10579. </doc>
  10580. </field>
  10581. <field name="DEFAULT_NM_LOCALIZER_PORT" type="int"
  10582. transient="false" volatile="false"
  10583. static="true" final="true" visibility="public"
  10584. deprecated="not deprecated">
  10585. </field>
  10586. <field name="DEFAULT_NM_LOCALIZER_ADDRESS" type="java.lang.String"
  10587. transient="false" volatile="false"
  10588. static="true" final="true" visibility="public"
  10589. deprecated="not deprecated">
  10590. </field>
  10591. <field name="NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="java.lang.String"
  10592. transient="false" volatile="false"
  10593. static="true" final="true" visibility="public"
  10594. deprecated="not deprecated">
  10595. <doc>
  10596. <![CDATA[Interval in between cache cleanups.]]>
  10597. </doc>
  10598. </field>
  10599. <field name="DEFAULT_NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="long"
  10600. transient="false" volatile="false"
  10601. static="true" final="true" visibility="public"
  10602. deprecated="not deprecated">
  10603. </field>
  10604. <field name="NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="java.lang.String"
  10605. transient="false" volatile="false"
  10606. static="true" final="true" visibility="public"
  10607. deprecated="not deprecated">
  10608. <doc>
  10609. <![CDATA[Target size of localizer cache in MB, per nodemanager. It is a target
  10610. retention size that only includes resources with PUBLIC and PRIVATE
  10611. visibility and excludes resources with APPLICATION visibility]]>
  10612. </doc>
  10613. </field>
  10614. <field name="DEFAULT_NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="long"
  10615. transient="false" volatile="false"
  10616. static="true" final="true" visibility="public"
  10617. deprecated="not deprecated">
  10618. </field>
  10619. <field name="NM_LOCALIZER_CLIENT_THREAD_COUNT" type="java.lang.String"
  10620. transient="false" volatile="false"
  10621. static="true" final="true" visibility="public"
  10622. deprecated="not deprecated">
  10623. <doc>
  10624. <![CDATA[Number of threads to handle localization requests.]]>
  10625. </doc>
  10626. </field>
  10627. <field name="DEFAULT_NM_LOCALIZER_CLIENT_THREAD_COUNT" type="int"
  10628. transient="false" volatile="false"
  10629. static="true" final="true" visibility="public"
  10630. deprecated="not deprecated">
  10631. </field>
  10632. <field name="NM_LOCALIZER_FETCH_THREAD_COUNT" type="java.lang.String"
  10633. transient="false" volatile="false"
  10634. static="true" final="true" visibility="public"
  10635. deprecated="not deprecated">
  10636. <doc>
  10637. <![CDATA[Number of threads to use for localization fetching.]]>
  10638. </doc>
  10639. </field>
  10640. <field name="DEFAULT_NM_LOCALIZER_FETCH_THREAD_COUNT" type="int"
  10641. transient="false" volatile="false"
  10642. static="true" final="true" visibility="public"
  10643. deprecated="not deprecated">
  10644. </field>
  10645. <field name="NM_LOG_DIRS" type="java.lang.String"
  10646. transient="false" volatile="false"
  10647. static="true" final="true" visibility="public"
  10648. deprecated="not deprecated">
  10649. <doc>
  10650. <![CDATA[Where to store container logs.]]>
  10651. </doc>
  10652. </field>
  10653. <field name="DEFAULT_NM_LOG_DIRS" type="java.lang.String"
  10654. transient="false" volatile="false"
  10655. static="true" final="true" visibility="public"
  10656. deprecated="not deprecated">
  10657. </field>
  10658. <field name="NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  10659. transient="false" volatile="false"
  10660. static="true" final="true" visibility="public"
  10661. deprecated="not deprecated">
  10662. </field>
  10663. <field name="DEFAULT_NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  10664. transient="false" volatile="false"
  10665. static="true" final="true" visibility="public"
  10666. deprecated="not deprecated">
  10667. </field>
  10668. <field name="RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="java.lang.String"
  10669. transient="false" volatile="false"
  10670. static="true" final="true" visibility="public"
  10671. deprecated="not deprecated">
  10672. <doc>
  10673. <![CDATA[Interval at which the delayed token removal thread runs]]>
  10674. </doc>
  10675. </field>
  10676. <field name="DEFAULT_RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="long"
  10677. transient="false" volatile="false"
  10678. static="true" final="true" visibility="public"
  10679. deprecated="not deprecated">
  10680. </field>
  10681. <field name="RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="java.lang.String"
  10682. transient="false" volatile="false"
  10683. static="true" final="true" visibility="public"
  10684. deprecated="not deprecated">
  10685. <doc>
  10686. <![CDATA[Delegation Token renewer thread count]]>
  10687. </doc>
  10688. </field>
  10689. <field name="DEFAULT_RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="int"
  10690. transient="false" volatile="false"
  10691. static="true" final="true" visibility="public"
  10692. deprecated="not deprecated">
  10693. </field>
  10694. <field name="RM_PROXY_USER_PRIVILEGES_ENABLED" type="java.lang.String"
  10695. transient="false" volatile="false"
  10696. static="true" final="true" visibility="public"
  10697. deprecated="not deprecated">
  10698. </field>
  10699. <field name="DEFAULT_RM_PROXY_USER_PRIVILEGES_ENABLED" type="boolean"
  10700. transient="false" volatile="false"
  10701. static="true" final="false" visibility="public"
  10702. deprecated="not deprecated">
  10703. </field>
  10704. <field name="LOG_AGGREGATION_ENABLED" type="java.lang.String"
  10705. transient="false" volatile="false"
  10706. static="true" final="true" visibility="public"
  10707. deprecated="not deprecated">
  10708. <doc>
  10709. <![CDATA[Whether to enable log aggregation]]>
  10710. </doc>
  10711. </field>
  10712. <field name="DEFAULT_LOG_AGGREGATION_ENABLED" type="boolean"
  10713. transient="false" volatile="false"
  10714. static="true" final="true" visibility="public"
  10715. deprecated="not deprecated">
  10716. </field>
  10717. <field name="LOG_AGGREGATION_RETAIN_SECONDS" type="java.lang.String"
  10718. transient="false" volatile="false"
  10719. static="true" final="true" visibility="public"
  10720. deprecated="not deprecated">
  10721. <doc>
  10722. <![CDATA[How long to wait before deleting aggregated logs, -1 disables.
  10723. Be careful set this too small and you will spam the name node.]]>
  10724. </doc>
  10725. </field>
  10726. <field name="DEFAULT_LOG_AGGREGATION_RETAIN_SECONDS" type="long"
  10727. transient="false" volatile="false"
  10728. static="true" final="true" visibility="public"
  10729. deprecated="not deprecated">
  10730. </field>
  10731. <field name="LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="java.lang.String"
  10732. transient="false" volatile="false"
  10733. static="true" final="true" visibility="public"
  10734. deprecated="not deprecated">
  10735. <doc>
  10736. <![CDATA[How long to wait between aggregated log retention checks. If set to
  10737. a value <= 0 then the value is computed as one-tenth of the log retention
  10738. setting. Be careful set this too small and you will spam the name node.]]>
  10739. </doc>
  10740. </field>
  10741. <field name="DEFAULT_LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="long"
  10742. transient="false" volatile="false"
  10743. static="true" final="true" visibility="public"
  10744. deprecated="not deprecated">
  10745. </field>
  10746. <field name="NM_LOG_RETAIN_SECONDS" type="java.lang.String"
  10747. transient="false" volatile="false"
  10748. static="true" final="true" visibility="public"
  10749. deprecated="not deprecated">
  10750. <doc>
  10751. <![CDATA[Number of seconds to retain logs on the NodeManager. Only applicable if Log
  10752. aggregation is disabled]]>
  10753. </doc>
  10754. </field>
  10755. <field name="DEFAULT_NM_LOG_RETAIN_SECONDS" type="long"
  10756. transient="false" volatile="false"
  10757. static="true" final="true" visibility="public"
  10758. deprecated="not deprecated">
  10759. </field>
  10760. <field name="NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="java.lang.String"
  10761. transient="false" volatile="false"
  10762. static="true" final="true" visibility="public"
  10763. deprecated="not deprecated">
  10764. <doc>
  10765. <![CDATA[Define how often NMs wake up and upload log files]]>
  10766. </doc>
  10767. </field>
  10768. <field name="DEFAULT_NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="long"
  10769. transient="false" volatile="false"
  10770. static="true" final="true" visibility="public"
  10771. deprecated="not deprecated">
  10772. </field>
  10773. <field name="NM_LOG_DELETION_THREADS_COUNT" type="java.lang.String"
  10774. transient="false" volatile="false"
  10775. static="true" final="true" visibility="public"
  10776. deprecated="not deprecated">
  10777. <doc>
  10778. <![CDATA[Number of threads used in log cleanup. Only applicable if Log aggregation
  10779. is disabled]]>
  10780. </doc>
  10781. </field>
  10782. <field name="DEFAULT_NM_LOG_DELETE_THREAD_COUNT" type="int"
  10783. transient="false" volatile="false"
  10784. static="true" final="true" visibility="public"
  10785. deprecated="not deprecated">
  10786. </field>
  10787. <field name="NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
  10788. transient="false" volatile="false"
  10789. static="true" final="true" visibility="public"
  10790. deprecated="not deprecated">
  10791. <doc>
  10792. <![CDATA[Where to aggregate logs to.]]>
  10793. </doc>
  10794. </field>
  10795. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
  10796. transient="false" volatile="false"
  10797. static="true" final="true" visibility="public"
  10798. deprecated="not deprecated">
  10799. </field>
  10800. <field name="NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
  10801. transient="false" volatile="false"
  10802. static="true" final="true" visibility="public"
  10803. deprecated="not deprecated">
  10804. <doc>
  10805. <![CDATA[The remote log dir will be created at
  10806. NM_REMOTE_APP_LOG_DIR/${user}/NM_REMOTE_APP_LOG_DIR_SUFFIX/${appId}]]>
  10807. </doc>
  10808. </field>
  10809. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
  10810. transient="false" volatile="false"
  10811. static="true" final="true" visibility="public"
  10812. deprecated="not deprecated">
  10813. </field>
  10814. <field name="YARN_LOG_SERVER_URL" type="java.lang.String"
  10815. transient="false" volatile="false"
  10816. static="true" final="true" visibility="public"
  10817. deprecated="not deprecated">
  10818. </field>
  10819. <field name="YARN_TRACKING_URL_GENERATOR" type="java.lang.String"
  10820. transient="false" volatile="false"
  10821. static="true" final="true" visibility="public"
  10822. deprecated="not deprecated">
  10823. </field>
  10824. <field name="NM_PMEM_MB" type="java.lang.String"
  10825. transient="false" volatile="false"
  10826. static="true" final="true" visibility="public"
  10827. deprecated="not deprecated">
  10828. <doc>
  10829. <![CDATA[Amount of memory in GB that can be allocated for containers.]]>
  10830. </doc>
  10831. </field>
  10832. <field name="DEFAULT_NM_PMEM_MB" type="int"
  10833. transient="false" volatile="false"
  10834. static="true" final="true" visibility="public"
  10835. deprecated="not deprecated">
  10836. </field>
  10837. <field name="NM_PMEM_CHECK_ENABLED" type="java.lang.String"
  10838. transient="false" volatile="false"
  10839. static="true" final="true" visibility="public"
  10840. deprecated="not deprecated">
  10841. <doc>
  10842. <![CDATA[Specifies whether physical memory check is enabled.]]>
  10843. </doc>
  10844. </field>
  10845. <field name="DEFAULT_NM_PMEM_CHECK_ENABLED" type="boolean"
  10846. transient="false" volatile="false"
  10847. static="true" final="true" visibility="public"
  10848. deprecated="not deprecated">
  10849. </field>
  10850. <field name="NM_VMEM_CHECK_ENABLED" type="java.lang.String"
  10851. transient="false" volatile="false"
  10852. static="true" final="true" visibility="public"
  10853. deprecated="not deprecated">
  10854. <doc>
  10855. <![CDATA[Specifies whether physical memory check is enabled.]]>
  10856. </doc>
  10857. </field>
  10858. <field name="DEFAULT_NM_VMEM_CHECK_ENABLED" type="boolean"
  10859. transient="false" volatile="false"
  10860. static="true" final="true" visibility="public"
  10861. deprecated="not deprecated">
  10862. </field>
  10863. <field name="NM_VMEM_PMEM_RATIO" type="java.lang.String"
  10864. transient="false" volatile="false"
  10865. static="true" final="true" visibility="public"
  10866. deprecated="not deprecated">
  10867. <doc>
  10868. <![CDATA[Conversion ratio for physical memory to virtual memory.]]>
  10869. </doc>
  10870. </field>
  10871. <field name="DEFAULT_NM_VMEM_PMEM_RATIO" type="float"
  10872. transient="false" volatile="false"
  10873. static="true" final="true" visibility="public"
  10874. deprecated="not deprecated">
  10875. </field>
  10876. <field name="NM_VCORES" type="java.lang.String"
  10877. transient="false" volatile="false"
  10878. static="true" final="true" visibility="public"
  10879. deprecated="not deprecated">
  10880. <doc>
  10881. <![CDATA[Number of Virtual CPU Cores which can be allocated for containers.]]>
  10882. </doc>
  10883. </field>
  10884. <field name="DEFAULT_NM_VCORES" type="int"
  10885. transient="false" volatile="false"
  10886. static="true" final="true" visibility="public"
  10887. deprecated="not deprecated">
  10888. </field>
  10889. <field name="NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="java.lang.String"
  10890. transient="false" volatile="false"
  10891. static="true" final="true" visibility="public"
  10892. deprecated="not deprecated">
  10893. <doc>
  10894. <![CDATA[Percentage of overall CPU which can be allocated for containers.]]>
  10895. </doc>
  10896. </field>
  10897. <field name="DEFAULT_NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="int"
  10898. transient="false" volatile="false"
  10899. static="true" final="true" visibility="public"
  10900. deprecated="not deprecated">
  10901. </field>
  10902. <field name="NM_WEBAPP_ADDRESS" type="java.lang.String"
  10903. transient="false" volatile="false"
  10904. static="true" final="true" visibility="public"
  10905. deprecated="not deprecated">
  10906. <doc>
  10907. <![CDATA[NM Webapp address.]]>
  10908. </doc>
  10909. </field>
  10910. <field name="DEFAULT_NM_WEBAPP_PORT" type="int"
  10911. transient="false" volatile="false"
  10912. static="true" final="true" visibility="public"
  10913. deprecated="not deprecated">
  10914. </field>
  10915. <field name="DEFAULT_NM_WEBAPP_ADDRESS" type="java.lang.String"
  10916. transient="false" volatile="false"
  10917. static="true" final="true" visibility="public"
  10918. deprecated="not deprecated">
  10919. </field>
  10920. <field name="NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  10921. transient="false" volatile="false"
  10922. static="true" final="true" visibility="public"
  10923. deprecated="not deprecated">
  10924. <doc>
  10925. <![CDATA[NM Webapp https address.]]>
  10926. </doc>
  10927. </field>
  10928. <field name="DEFAULT_NM_WEBAPP_HTTPS_PORT" type="int"
  10929. transient="false" volatile="false"
  10930. static="true" final="true" visibility="public"
  10931. deprecated="not deprecated">
  10932. </field>
  10933. <field name="DEFAULT_NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  10934. transient="false" volatile="false"
  10935. static="true" final="true" visibility="public"
  10936. deprecated="not deprecated">
  10937. </field>
  10938. <field name="NM_CONTAINER_MON_INTERVAL_MS" type="java.lang.String"
  10939. transient="false" volatile="false"
  10940. static="true" final="true" visibility="public"
  10941. deprecated="not deprecated">
  10942. <doc>
  10943. <![CDATA[How often to monitor containers.]]>
  10944. </doc>
  10945. </field>
  10946. <field name="DEFAULT_NM_CONTAINER_MON_INTERVAL_MS" type="int"
  10947. transient="false" volatile="false"
  10948. static="true" final="true" visibility="public"
  10949. deprecated="not deprecated">
  10950. </field>
  10951. <field name="NM_CONTAINER_MON_RESOURCE_CALCULATOR" type="java.lang.String"
  10952. transient="false" volatile="false"
  10953. static="true" final="true" visibility="public"
  10954. deprecated="not deprecated">
  10955. <doc>
  10956. <![CDATA[Class that calculates containers current resource utilization.]]>
  10957. </doc>
  10958. </field>
  10959. <field name="NM_CONTAINER_MON_PROCESS_TREE" type="java.lang.String"
  10960. transient="false" volatile="false"
  10961. static="true" final="true" visibility="public"
  10962. deprecated="not deprecated">
  10963. <doc>
  10964. <![CDATA[Class that calculates process tree resource utilization.]]>
  10965. </doc>
  10966. </field>
  10967. <field name="PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="java.lang.String"
  10968. transient="false" volatile="false"
  10969. static="true" final="true" visibility="public"
  10970. deprecated="not deprecated">
  10971. </field>
  10972. <field name="DEFAULT_PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="boolean"
  10973. transient="false" volatile="false"
  10974. static="true" final="true" visibility="public"
  10975. deprecated="not deprecated">
  10976. </field>
  10977. <field name="NM_DISK_HEALTH_CHECK_ENABLE" type="java.lang.String"
  10978. transient="false" volatile="false"
  10979. static="true" final="true" visibility="public"
  10980. deprecated="not deprecated">
  10981. <doc>
  10982. <![CDATA[Enable/Disable disks' health checker. Default is true. An expert level
  10983. configuration property.]]>
  10984. </doc>
  10985. </field>
  10986. <field name="NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
  10987. transient="false" volatile="false"
  10988. static="true" final="true" visibility="public"
  10989. deprecated="not deprecated">
  10990. <doc>
  10991. <![CDATA[Frequency of running disks' health checker.]]>
  10992. </doc>
  10993. </field>
  10994. <field name="DEFAULT_NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="long"
  10995. transient="false" volatile="false"
  10996. static="true" final="true" visibility="public"
  10997. deprecated="not deprecated">
  10998. <doc>
  10999. <![CDATA[By default, disks' health is checked every 2 minutes.]]>
  11000. </doc>
  11001. </field>
  11002. <field name="NM_MIN_HEALTHY_DISKS_FRACTION" type="java.lang.String"
  11003. transient="false" volatile="false"
  11004. static="true" final="true" visibility="public"
  11005. deprecated="not deprecated">
  11006. <doc>
  11007. <![CDATA[The minimum fraction of number of disks to be healthy for the nodemanager
  11008. to launch new containers. This applies to nm-local-dirs and nm-log-dirs.]]>
  11009. </doc>
  11010. </field>
  11011. <field name="DEFAULT_NM_MIN_HEALTHY_DISKS_FRACTION" type="float"
  11012. transient="false" volatile="false"
  11013. static="true" final="true" visibility="public"
  11014. deprecated="not deprecated">
  11015. <doc>
  11016. <![CDATA[By default, at least 25% of disks are to be healthy to say that the node is
  11017. healthy in terms of disks.]]>
  11018. </doc>
  11019. </field>
  11020. <field name="NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="java.lang.String"
  11021. transient="false" volatile="false"
  11022. static="true" final="true" visibility="public"
  11023. deprecated="not deprecated">
  11024. <doc>
  11025. <![CDATA[The maximum percentage of disk space that can be used after which a disk is
  11026. marked as offline. Values can range from 0.0 to 100.0. If the value is
  11027. greater than or equal to 100, NM will check for full disk. This applies to
  11028. nm-local-dirs and nm-log-dirs.]]>
  11029. </doc>
  11030. </field>
  11031. <field name="DEFAULT_NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="float"
  11032. transient="false" volatile="false"
  11033. static="true" final="true" visibility="public"
  11034. deprecated="not deprecated">
  11035. <doc>
  11036. <![CDATA[By default, 90% of the disk can be used before it is marked as offline.]]>
  11037. </doc>
  11038. </field>
  11039. <field name="NM_MIN_PER_DISK_FREE_SPACE_MB" type="java.lang.String"
  11040. transient="false" volatile="false"
  11041. static="true" final="true" visibility="public"
  11042. deprecated="not deprecated">
  11043. <doc>
  11044. <![CDATA[The minimum space that must be available on a local dir for it to be used.
  11045. This applies to nm-local-dirs and nm-log-dirs.]]>
  11046. </doc>
  11047. </field>
  11048. <field name="DEFAULT_NM_MIN_PER_DISK_FREE_SPACE_MB" type="long"
  11049. transient="false" volatile="false"
  11050. static="true" final="true" visibility="public"
  11051. deprecated="not deprecated">
  11052. <doc>
  11053. <![CDATA[By default, all of the disk can be used before it is marked as offline.]]>
  11054. </doc>
  11055. </field>
  11056. <field name="NM_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
  11057. transient="false" volatile="false"
  11058. static="true" final="true" visibility="public"
  11059. deprecated="not deprecated">
  11060. <doc>
  11061. <![CDATA[Frequency of running node health script.]]>
  11062. </doc>
  11063. </field>
  11064. <field name="DEFAULT_NM_HEALTH_CHECK_INTERVAL_MS" type="long"
  11065. transient="false" volatile="false"
  11066. static="true" final="true" visibility="public"
  11067. deprecated="not deprecated">
  11068. </field>
  11069. <field name="NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="java.lang.String"
  11070. transient="false" volatile="false"
  11071. static="true" final="true" visibility="public"
  11072. deprecated="not deprecated">
  11073. <doc>
  11074. <![CDATA[Health check script time out period.]]>
  11075. </doc>
  11076. </field>
  11077. <field name="DEFAULT_NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="long"
  11078. transient="false" volatile="false"
  11079. static="true" final="true" visibility="public"
  11080. deprecated="not deprecated">
  11081. </field>
  11082. <field name="NM_HEALTH_CHECK_SCRIPT_PATH" type="java.lang.String"
  11083. transient="false" volatile="false"
  11084. static="true" final="true" visibility="public"
  11085. deprecated="not deprecated">
  11086. <doc>
  11087. <![CDATA[The health check script to run.]]>
  11088. </doc>
  11089. </field>
  11090. <field name="NM_HEALTH_CHECK_SCRIPT_OPTS" type="java.lang.String"
  11091. transient="false" volatile="false"
  11092. static="true" final="true" visibility="public"
  11093. deprecated="not deprecated">
  11094. <doc>
  11095. <![CDATA[The arguments to pass to the health check script.]]>
  11096. </doc>
  11097. </field>
  11098. <field name="NM_DOCKER_CONTAINER_EXECUTOR_IMAGE_NAME" type="java.lang.String"
  11099. transient="false" volatile="false"
  11100. static="true" final="true" visibility="public"
  11101. deprecated="not deprecated">
  11102. <doc>
  11103. <![CDATA[The Docker image name(For DockerContainerExecutor).]]>
  11104. </doc>
  11105. </field>
  11106. <field name="NM_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME" type="java.lang.String"
  11107. transient="false" volatile="false"
  11108. static="true" final="true" visibility="public"
  11109. deprecated="not deprecated">
  11110. <doc>
  11111. <![CDATA[The name of the docker executor (For DockerContainerExecutor).]]>
  11112. </doc>
  11113. </field>
  11114. <field name="NM_DEFAULT_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME" type="java.lang.String"
  11115. transient="false" volatile="false"
  11116. static="true" final="true" visibility="public"
  11117. deprecated="not deprecated">
  11118. <doc>
  11119. <![CDATA[The default docker executor (For DockerContainerExecutor).]]>
  11120. </doc>
  11121. </field>
  11122. <field name="NM_LINUX_CONTAINER_EXECUTOR_PATH" type="java.lang.String"
  11123. transient="false" volatile="false"
  11124. static="true" final="true" visibility="public"
  11125. deprecated="not deprecated">
  11126. <doc>
  11127. <![CDATA[The path to the Linux container executor.]]>
  11128. </doc>
  11129. </field>
  11130. <field name="NM_LINUX_CONTAINER_GROUP" type="java.lang.String"
  11131. transient="false" volatile="false"
  11132. static="true" final="true" visibility="public"
  11133. deprecated="not deprecated">
  11134. <doc>
  11135. <![CDATA[The UNIX group that the linux-container-executor should run as.
  11136. This is intended to be set as part of container-executor.cfg.]]>
  11137. </doc>
  11138. </field>
  11139. <field name="NM_NONSECURE_MODE_LIMIT_USERS" type="java.lang.String"
  11140. transient="false" volatile="false"
  11141. static="true" final="true" visibility="public"
  11142. deprecated="not deprecated">
  11143. <doc>
  11144. <![CDATA[If linux-container-executor should limit itself to one user
  11145. when running in non-secure mode.]]>
  11146. </doc>
  11147. </field>
  11148. <field name="DEFAULT_NM_NONSECURE_MODE_LIMIT_USERS" type="boolean"
  11149. transient="false" volatile="false"
  11150. static="true" final="true" visibility="public"
  11151. deprecated="not deprecated">
  11152. </field>
  11153. <field name="NM_NONSECURE_MODE_LOCAL_USER_KEY" type="java.lang.String"
  11154. transient="false" volatile="false"
  11155. static="true" final="true" visibility="public"
  11156. deprecated="not deprecated">
  11157. <doc>
  11158. <![CDATA[The UNIX user that containers will run as when Linux-container-executor
  11159. is used in nonsecure mode (a use case for this is using cgroups).]]>
  11160. </doc>
  11161. </field>
  11162. <field name="DEFAULT_NM_NONSECURE_MODE_LOCAL_USER" type="java.lang.String"
  11163. transient="false" volatile="false"
  11164. static="true" final="true" visibility="public"
  11165. deprecated="not deprecated">
  11166. </field>
  11167. <field name="NM_NONSECURE_MODE_USER_PATTERN_KEY" type="java.lang.String"
  11168. transient="false" volatile="false"
  11169. static="true" final="true" visibility="public"
  11170. deprecated="not deprecated">
  11171. <doc>
  11172. <![CDATA[The allowed pattern for UNIX user names enforced by
  11173. Linux-container-executor when used in nonsecure mode (use case for this
  11174. is using cgroups). The default value is taken from /usr/sbin/adduser]]>
  11175. </doc>
  11176. </field>
  11177. <field name="DEFAULT_NM_NONSECURE_MODE_USER_PATTERN" type="java.lang.String"
  11178. transient="false" volatile="false"
  11179. static="true" final="true" visibility="public"
  11180. deprecated="not deprecated">
  11181. </field>
  11182. <field name="NM_LINUX_CONTAINER_RESOURCES_HANDLER" type="java.lang.String"
  11183. transient="false" volatile="false"
  11184. static="true" final="true" visibility="public"
  11185. deprecated="not deprecated">
  11186. <doc>
  11187. <![CDATA[The type of resource enforcement to use with the
  11188. linux container executor.]]>
  11189. </doc>
  11190. </field>
  11191. <field name="NM_LINUX_CONTAINER_CGROUPS_HIERARCHY" type="java.lang.String"
  11192. transient="false" volatile="false"
  11193. static="true" final="true" visibility="public"
  11194. deprecated="not deprecated">
  11195. <doc>
  11196. <![CDATA[The path the linux container executor should use for cgroups]]>
  11197. </doc>
  11198. </field>
  11199. <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT" type="java.lang.String"
  11200. transient="false" volatile="false"
  11201. static="true" final="true" visibility="public"
  11202. deprecated="not deprecated">
  11203. <doc>
  11204. <![CDATA[Whether the linux container executor should mount cgroups if not found]]>
  11205. </doc>
  11206. </field>
  11207. <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT_PATH" type="java.lang.String"
  11208. transient="false" volatile="false"
  11209. static="true" final="true" visibility="public"
  11210. deprecated="not deprecated">
  11211. <doc>
  11212. <![CDATA[Where the linux container executor should mount cgroups if not found]]>
  11213. </doc>
  11214. </field>
  11215. <field name="NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="java.lang.String"
  11216. transient="false" volatile="false"
  11217. static="true" final="true" visibility="public"
  11218. deprecated="not deprecated">
  11219. <doc>
  11220. <![CDATA[Whether the apps should run in strict resource usage mode(not allowed to
  11221. use spare CPU)]]>
  11222. </doc>
  11223. </field>
  11224. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="boolean"
  11225. transient="false" volatile="false"
  11226. static="true" final="true" visibility="public"
  11227. deprecated="not deprecated">
  11228. </field>
  11229. <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="java.lang.String"
  11230. transient="false" volatile="false"
  11231. static="true" final="true" visibility="public"
  11232. deprecated="not deprecated">
  11233. <doc>
  11234. <![CDATA[Interval of time the linux container executor should try cleaning up
  11235. cgroups entry when cleaning up a container. This is required due to what
  11236. it seems a race condition because the SIGTERM/SIGKILL is asynch.]]>
  11237. </doc>
  11238. </field>
  11239. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="long"
  11240. transient="false" volatile="false"
  11241. static="true" final="true" visibility="public"
  11242. deprecated="not deprecated">
  11243. </field>
  11244. <field name="NM_WINDOWS_SECURE_CONTAINER_GROUP" type="java.lang.String"
  11245. transient="false" volatile="false"
  11246. static="true" final="true" visibility="public"
  11247. deprecated="not deprecated">
  11248. <doc>
  11249. <![CDATA[/* The Windows group that the windows-secure-container-executor should run as.]]>
  11250. </doc>
  11251. </field>
  11252. <field name="NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
  11253. transient="false" volatile="false"
  11254. static="true" final="true" visibility="public"
  11255. deprecated="not deprecated">
  11256. <doc>
  11257. <![CDATA[T-file compression types used to compress aggregated logs.]]>
  11258. </doc>
  11259. </field>
  11260. <field name="DEFAULT_NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
  11261. transient="false" volatile="false"
  11262. static="true" final="true" visibility="public"
  11263. deprecated="not deprecated">
  11264. </field>
  11265. <field name="NM_PRINCIPAL" type="java.lang.String"
  11266. transient="false" volatile="false"
  11267. static="true" final="true" visibility="public"
  11268. deprecated="not deprecated">
  11269. <doc>
  11270. <![CDATA[The kerberos principal for the node manager.]]>
  11271. </doc>
  11272. </field>
  11273. <field name="NM_AUX_SERVICES" 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="NM_AUX_SERVICE_FMT" 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="NM_USER_HOME_DIR" 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_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
  11289. transient="false" volatile="false"
  11290. static="true" final="true" visibility="public"
  11291. deprecated="not deprecated">
  11292. <doc>
  11293. <![CDATA[The kerberos principal to be used for spnego filter for NM.]]>
  11294. </doc>
  11295. </field>
  11296. <field name="NM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
  11297. transient="false" volatile="false"
  11298. static="true" final="true" visibility="public"
  11299. deprecated="not deprecated">
  11300. <doc>
  11301. <![CDATA[The kerberos keytab to be used for spnego filter for NM.]]>
  11302. </doc>
  11303. </field>
  11304. <field name="DEFAULT_NM_USER_HOME_DIR" type="java.lang.String"
  11305. transient="false" volatile="false"
  11306. static="true" final="true" visibility="public"
  11307. deprecated="not deprecated">
  11308. </field>
  11309. <field name="NM_RECOVERY_PREFIX" type="java.lang.String"
  11310. transient="false" volatile="false"
  11311. static="true" final="true" visibility="public"
  11312. deprecated="not deprecated">
  11313. </field>
  11314. <field name="NM_RECOVERY_ENABLED" type="java.lang.String"
  11315. transient="false" volatile="false"
  11316. static="true" final="true" visibility="public"
  11317. deprecated="not deprecated">
  11318. </field>
  11319. <field name="DEFAULT_NM_RECOVERY_ENABLED" type="boolean"
  11320. transient="false" volatile="false"
  11321. static="true" final="true" visibility="public"
  11322. deprecated="not deprecated">
  11323. </field>
  11324. <field name="NM_RECOVERY_DIR" type="java.lang.String"
  11325. transient="false" volatile="false"
  11326. static="true" final="true" visibility="public"
  11327. deprecated="not deprecated">
  11328. </field>
  11329. <field name="PROXY_PREFIX" type="java.lang.String"
  11330. transient="false" volatile="false"
  11331. static="true" final="true" visibility="public"
  11332. deprecated="not deprecated">
  11333. </field>
  11334. <field name="PROXY_PRINCIPAL" type="java.lang.String"
  11335. transient="false" volatile="false"
  11336. static="true" final="true" visibility="public"
  11337. deprecated="not deprecated">
  11338. <doc>
  11339. <![CDATA[The kerberos principal for the proxy.]]>
  11340. </doc>
  11341. </field>
  11342. <field name="PROXY_KEYTAB" type="java.lang.String"
  11343. transient="false" volatile="false"
  11344. static="true" final="true" visibility="public"
  11345. deprecated="not deprecated">
  11346. <doc>
  11347. <![CDATA[Keytab for Proxy.]]>
  11348. </doc>
  11349. </field>
  11350. <field name="PROXY_ADDRESS" type="java.lang.String"
  11351. transient="false" volatile="false"
  11352. static="true" final="true" visibility="public"
  11353. deprecated="not deprecated">
  11354. <doc>
  11355. <![CDATA[The address for the web proxy.]]>
  11356. </doc>
  11357. </field>
  11358. <field name="DEFAULT_PROXY_PORT" type="int"
  11359. transient="false" volatile="false"
  11360. static="true" final="true" visibility="public"
  11361. deprecated="not deprecated">
  11362. </field>
  11363. <field name="DEFAULT_PROXY_ADDRESS" type="java.lang.String"
  11364. transient="false" volatile="false"
  11365. static="true" final="true" visibility="public"
  11366. deprecated="not deprecated">
  11367. </field>
  11368. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCETRACKER_PROTOCOL" type="java.lang.String"
  11369. transient="false" volatile="false"
  11370. static="true" final="true" visibility="public"
  11371. deprecated="not deprecated">
  11372. <doc>
  11373. <![CDATA[YARN Service Level Authorization]]>
  11374. </doc>
  11375. </field>
  11376. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONCLIENT_PROTOCOL" type="java.lang.String"
  11377. transient="false" volatile="false"
  11378. static="true" final="true" visibility="public"
  11379. deprecated="not deprecated">
  11380. </field>
  11381. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCEMANAGER_ADMINISTRATION_PROTOCOL" type="java.lang.String"
  11382. transient="false" volatile="false"
  11383. static="true" final="true" visibility="public"
  11384. deprecated="not deprecated">
  11385. </field>
  11386. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONMASTER_PROTOCOL" type="java.lang.String"
  11387. transient="false" volatile="false"
  11388. static="true" final="true" visibility="public"
  11389. deprecated="not deprecated">
  11390. </field>
  11391. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_CONTAINER_MANAGEMENT_PROTOCOL" type="java.lang.String"
  11392. transient="false" volatile="false"
  11393. static="true" final="true" visibility="public"
  11394. deprecated="not deprecated">
  11395. </field>
  11396. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCE_LOCALIZER" type="java.lang.String"
  11397. transient="false" volatile="false"
  11398. static="true" final="true" visibility="public"
  11399. deprecated="not deprecated">
  11400. </field>
  11401. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONHISTORY_PROTOCOL" type="java.lang.String"
  11402. transient="false" volatile="false"
  11403. static="true" final="true" visibility="public"
  11404. deprecated="not deprecated">
  11405. </field>
  11406. <field name="NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="java.lang.String"
  11407. transient="false" volatile="false"
  11408. static="true" final="true" visibility="public"
  11409. deprecated="not deprecated">
  11410. <doc>
  11411. <![CDATA[No. of milliseconds to wait between sending a SIGTERM and SIGKILL
  11412. to a running container]]>
  11413. </doc>
  11414. </field>
  11415. <field name="DEFAULT_NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="long"
  11416. transient="false" volatile="false"
  11417. static="true" final="true" visibility="public"
  11418. deprecated="not deprecated">
  11419. </field>
  11420. <field name="NM_PROCESS_KILL_WAIT_MS" type="java.lang.String"
  11421. transient="false" volatile="false"
  11422. static="true" final="true" visibility="public"
  11423. deprecated="not deprecated">
  11424. <doc>
  11425. <![CDATA[Max time to wait for a process to come up when trying to cleanup
  11426. container resources]]>
  11427. </doc>
  11428. </field>
  11429. <field name="DEFAULT_NM_PROCESS_KILL_WAIT_MS" type="long"
  11430. transient="false" volatile="false"
  11431. static="true" final="true" visibility="public"
  11432. deprecated="not deprecated">
  11433. </field>
  11434. <field name="RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  11435. transient="false" volatile="false"
  11436. static="true" final="true" visibility="public"
  11437. deprecated="not deprecated">
  11438. <doc>
  11439. <![CDATA[Max time to wait to establish a connection to RM]]>
  11440. </doc>
  11441. </field>
  11442. <field name="DEFAULT_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="long"
  11443. transient="false" volatile="false"
  11444. static="true" final="true" visibility="public"
  11445. deprecated="not deprecated">
  11446. </field>
  11447. <field name="RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  11448. transient="false" volatile="false"
  11449. static="true" final="true" visibility="public"
  11450. deprecated="not deprecated">
  11451. <doc>
  11452. <![CDATA[Time interval between each attempt to connect to RM]]>
  11453. </doc>
  11454. </field>
  11455. <field name="DEFAULT_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="long"
  11456. transient="false" volatile="false"
  11457. static="true" final="true" visibility="public"
  11458. deprecated="not deprecated">
  11459. </field>
  11460. <field name="YARN_APPLICATION_CLASSPATH" type="java.lang.String"
  11461. transient="false" volatile="false"
  11462. static="true" final="true" visibility="public"
  11463. deprecated="not deprecated">
  11464. <doc>
  11465. <![CDATA[CLASSPATH for YARN applications. A comma-separated list of CLASSPATH
  11466. entries]]>
  11467. </doc>
  11468. </field>
  11469. <field name="DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH" type="java.lang.String[]"
  11470. transient="false" volatile="false"
  11471. static="true" final="true" visibility="public"
  11472. deprecated="not deprecated">
  11473. <doc>
  11474. <![CDATA[Default platform-agnostic CLASSPATH for YARN applications. A
  11475. comma-separated list of CLASSPATH entries. The parameter expansion marker
  11476. will be replaced with real parameter expansion marker ('%' for Windows and
  11477. '$' for Linux) by NodeManager on container launch. For example: {{VAR}}
  11478. will be replaced as $VAR on Linux, and %VAR% on Windows.]]>
  11479. </doc>
  11480. </field>
  11481. <field name="DEFAULT_YARN_APPLICATION_CLASSPATH" type="java.lang.String[]"
  11482. transient="false" volatile="false"
  11483. static="true" final="true" visibility="public"
  11484. deprecated="not deprecated">
  11485. <doc>
  11486. <![CDATA[<p>
  11487. Default platform-specific CLASSPATH for YARN applications. A
  11488. comma-separated list of CLASSPATH entries constructed based on the client
  11489. OS environment expansion syntax.
  11490. </p>
  11491. <p>
  11492. Note: Use {@link DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH} for
  11493. cross-platform practice i.e. submit an application from a Windows client to
  11494. a Linux/Unix server or vice versa.
  11495. </p>]]>
  11496. </doc>
  11497. </field>
  11498. <field name="DEFAULT_CONTAINER_TEMP_DIR" type="java.lang.String"
  11499. transient="false" volatile="false"
  11500. static="true" final="true" visibility="public"
  11501. deprecated="not deprecated">
  11502. <doc>
  11503. <![CDATA[Container temp directory]]>
  11504. </doc>
  11505. </field>
  11506. <field name="IS_MINI_YARN_CLUSTER" type="java.lang.String"
  11507. transient="false" volatile="false"
  11508. static="true" final="true" visibility="public"
  11509. deprecated="not deprecated">
  11510. </field>
  11511. <field name="YARN_MC_PREFIX" type="java.lang.String"
  11512. transient="false" volatile="false"
  11513. static="true" final="true" visibility="public"
  11514. deprecated="not deprecated">
  11515. </field>
  11516. <field name="YARN_MINICLUSTER_FIXED_PORTS" type="java.lang.String"
  11517. transient="false" volatile="false"
  11518. static="true" final="true" visibility="public"
  11519. deprecated="not deprecated">
  11520. <doc>
  11521. <![CDATA[Whether to use fixed ports with the minicluster.]]>
  11522. </doc>
  11523. </field>
  11524. <field name="DEFAULT_YARN_MINICLUSTER_FIXED_PORTS" type="boolean"
  11525. transient="false" volatile="false"
  11526. static="true" final="true" visibility="public"
  11527. deprecated="not deprecated">
  11528. <doc>
  11529. <![CDATA[Default is false to be able to run tests concurrently without port
  11530. conflicts.]]>
  11531. </doc>
  11532. </field>
  11533. <field name="YARN_MINICLUSTER_USE_RPC" type="java.lang.String"
  11534. transient="false" volatile="false"
  11535. static="true" final="true" visibility="public"
  11536. deprecated="not deprecated">
  11537. <doc>
  11538. <![CDATA[Whether the NM should use RPC to connect to the RM. Default is false.
  11539. Can be set to true only when using fixed ports.]]>
  11540. </doc>
  11541. </field>
  11542. <field name="DEFAULT_YARN_MINICLUSTER_USE_RPC" type="boolean"
  11543. transient="false" volatile="false"
  11544. static="true" final="true" visibility="public"
  11545. deprecated="not deprecated">
  11546. </field>
  11547. <field name="YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="java.lang.String"
  11548. transient="false" volatile="false"
  11549. static="true" final="true" visibility="public"
  11550. deprecated="not deprecated">
  11551. <doc>
  11552. <![CDATA[Whether users are explicitly trying to control resource monitoring
  11553. configuration for the MiniYARNCluster. Disabled by default.]]>
  11554. </doc>
  11555. </field>
  11556. <field name="DEFAULT_YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="boolean"
  11557. transient="false" volatile="false"
  11558. static="true" final="true" visibility="public"
  11559. deprecated="not deprecated">
  11560. </field>
  11561. <field name="YARN_APP_CONTAINER_LOG_DIR" type="java.lang.String"
  11562. transient="false" volatile="false"
  11563. static="true" final="true" visibility="public"
  11564. deprecated="not deprecated">
  11565. <doc>
  11566. <![CDATA[The log directory for the containers]]>
  11567. </doc>
  11568. </field>
  11569. <field name="YARN_APP_CONTAINER_LOG_SIZE" type="java.lang.String"
  11570. transient="false" volatile="false"
  11571. static="true" final="true" visibility="public"
  11572. deprecated="not deprecated">
  11573. </field>
  11574. <field name="YARN_APP_CONTAINER_LOG_BACKUPS" type="java.lang.String"
  11575. transient="false" volatile="false"
  11576. static="true" final="true" visibility="public"
  11577. deprecated="not deprecated">
  11578. </field>
  11579. <field name="TIMELINE_SERVICE_PREFIX" type="java.lang.String"
  11580. transient="false" volatile="false"
  11581. static="true" final="true" visibility="public"
  11582. deprecated="not deprecated">
  11583. </field>
  11584. <field name="APPLICATION_HISTORY_PREFIX" type="java.lang.String"
  11585. transient="false" volatile="false"
  11586. static="true" final="true" visibility="public"
  11587. deprecated="not deprecated">
  11588. </field>
  11589. <field name="APPLICATION_HISTORY_ENABLED" type="java.lang.String"
  11590. transient="false" volatile="false"
  11591. static="true" final="true" visibility="public"
  11592. deprecated="not deprecated">
  11593. <doc>
  11594. <![CDATA[The setting that controls whether application history service is
  11595. enabled or not.]]>
  11596. </doc>
  11597. </field>
  11598. <field name="DEFAULT_APPLICATION_HISTORY_ENABLED" type="boolean"
  11599. transient="false" volatile="false"
  11600. static="true" final="true" visibility="public"
  11601. deprecated="not deprecated">
  11602. </field>
  11603. <field name="APPLICATION_HISTORY_STORE" type="java.lang.String"
  11604. transient="false" volatile="false"
  11605. static="true" final="true" visibility="public"
  11606. deprecated="not deprecated">
  11607. <doc>
  11608. <![CDATA[Application history store class]]>
  11609. </doc>
  11610. </field>
  11611. <field name="FS_APPLICATION_HISTORY_STORE_URI" type="java.lang.String"
  11612. transient="false" volatile="false"
  11613. static="true" final="true" visibility="public"
  11614. deprecated="not deprecated">
  11615. <doc>
  11616. <![CDATA[URI for FileSystemApplicationHistoryStore]]>
  11617. </doc>
  11618. </field>
  11619. <field name="FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
  11620. transient="false" volatile="false"
  11621. static="true" final="true" visibility="public"
  11622. deprecated="not deprecated">
  11623. <doc>
  11624. <![CDATA[T-file compression types used to compress history data.]]>
  11625. </doc>
  11626. </field>
  11627. <field name="DEFAULT_FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
  11628. transient="false" volatile="false"
  11629. static="true" final="true" visibility="public"
  11630. deprecated="not deprecated">
  11631. </field>
  11632. <field name="TIMELINE_SERVICE_ENABLED" type="java.lang.String"
  11633. transient="false" volatile="false"
  11634. static="true" final="true" visibility="public"
  11635. deprecated="not deprecated">
  11636. <doc>
  11637. <![CDATA[The setting that controls whether timeline service is enabled or not.]]>
  11638. </doc>
  11639. </field>
  11640. <field name="DEFAULT_TIMELINE_SERVICE_ENABLED" type="boolean"
  11641. transient="false" volatile="false"
  11642. static="true" final="true" visibility="public"
  11643. deprecated="not deprecated">
  11644. </field>
  11645. <field name="TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
  11646. transient="false" volatile="false"
  11647. static="true" final="true" visibility="public"
  11648. deprecated="not deprecated">
  11649. <doc>
  11650. <![CDATA[host:port address for timeline service RPC APIs.]]>
  11651. </doc>
  11652. </field>
  11653. <field name="DEFAULT_TIMELINE_SERVICE_PORT" type="int"
  11654. transient="false" volatile="false"
  11655. static="true" final="true" visibility="public"
  11656. deprecated="not deprecated">
  11657. </field>
  11658. <field name="DEFAULT_TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
  11659. transient="false" volatile="false"
  11660. static="true" final="true" visibility="public"
  11661. deprecated="not deprecated">
  11662. </field>
  11663. <field name="TIMELINE_SERVICE_BIND_HOST" type="java.lang.String"
  11664. transient="false" volatile="false"
  11665. static="true" final="true" visibility="public"
  11666. deprecated="not deprecated">
  11667. <doc>
  11668. <![CDATA[The listening endpoint for the timeline service application.]]>
  11669. </doc>
  11670. </field>
  11671. <field name="TIMELINE_SERVICE_HANDLER_THREAD_COUNT" type="java.lang.String"
  11672. transient="false" volatile="false"
  11673. static="true" final="true" visibility="public"
  11674. deprecated="not deprecated">
  11675. <doc>
  11676. <![CDATA[The number of threads to handle client RPC API requests.]]>
  11677. </doc>
  11678. </field>
  11679. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_THREAD_COUNT" type="int"
  11680. transient="false" volatile="false"
  11681. static="true" final="true" visibility="public"
  11682. deprecated="not deprecated">
  11683. </field>
  11684. <field name="TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
  11685. transient="false" volatile="false"
  11686. static="true" final="true" visibility="public"
  11687. deprecated="not deprecated">
  11688. <doc>
  11689. <![CDATA[The address of the timeline service web application.]]>
  11690. </doc>
  11691. </field>
  11692. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_PORT" type="int"
  11693. transient="false" volatile="false"
  11694. static="true" final="true" visibility="public"
  11695. deprecated="not deprecated">
  11696. </field>
  11697. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
  11698. transient="false" volatile="false"
  11699. static="true" final="true" visibility="public"
  11700. deprecated="not deprecated">
  11701. </field>
  11702. <field name="TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  11703. transient="false" volatile="false"
  11704. static="true" final="true" visibility="public"
  11705. deprecated="not deprecated">
  11706. <doc>
  11707. <![CDATA[The https address of the timeline service web application.]]>
  11708. </doc>
  11709. </field>
  11710. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_PORT" type="int"
  11711. transient="false" volatile="false"
  11712. static="true" final="true" visibility="public"
  11713. deprecated="not deprecated">
  11714. </field>
  11715. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  11716. transient="false" volatile="false"
  11717. static="true" final="true" visibility="public"
  11718. deprecated="not deprecated">
  11719. </field>
  11720. <field name="TIMELINE_SERVICE_STORE" type="java.lang.String"
  11721. transient="false" volatile="false"
  11722. static="true" final="true" visibility="public"
  11723. deprecated="not deprecated">
  11724. <doc>
  11725. <![CDATA[Timeline service store class]]>
  11726. </doc>
  11727. </field>
  11728. <field name="TIMELINE_SERVICE_TTL_ENABLE" type="java.lang.String"
  11729. transient="false" volatile="false"
  11730. static="true" final="true" visibility="public"
  11731. deprecated="not deprecated">
  11732. <doc>
  11733. <![CDATA[Timeline service enable data age off]]>
  11734. </doc>
  11735. </field>
  11736. <field name="TIMELINE_SERVICE_TTL_MS" type="java.lang.String"
  11737. transient="false" volatile="false"
  11738. static="true" final="true" visibility="public"
  11739. deprecated="not deprecated">
  11740. <doc>
  11741. <![CDATA[Timeline service length of time to retain data]]>
  11742. </doc>
  11743. </field>
  11744. <field name="DEFAULT_TIMELINE_SERVICE_TTL_MS" type="long"
  11745. transient="false" volatile="false"
  11746. static="true" final="true" visibility="public"
  11747. deprecated="not deprecated">
  11748. </field>
  11749. <field name="TIMELINE_SERVICE_LEVELDB_PREFIX" type="java.lang.String"
  11750. transient="false" volatile="false"
  11751. static="true" final="true" visibility="public"
  11752. deprecated="not deprecated">
  11753. </field>
  11754. <field name="TIMELINE_SERVICE_LEVELDB_PATH" type="java.lang.String"
  11755. transient="false" volatile="false"
  11756. static="true" final="true" visibility="public"
  11757. deprecated="not deprecated">
  11758. <doc>
  11759. <![CDATA[Timeline service leveldb path]]>
  11760. </doc>
  11761. </field>
  11762. <field name="TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="java.lang.String"
  11763. transient="false" volatile="false"
  11764. static="true" final="true" visibility="public"
  11765. deprecated="not deprecated">
  11766. <doc>
  11767. <![CDATA[Timeline service leveldb read cache (uncompressed blocks)]]>
  11768. </doc>
  11769. </field>
  11770. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="long"
  11771. transient="false" volatile="false"
  11772. static="true" final="true" visibility="public"
  11773. deprecated="not deprecated">
  11774. </field>
  11775. <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="java.lang.String"
  11776. transient="false" volatile="false"
  11777. static="true" final="true" visibility="public"
  11778. deprecated="not deprecated">
  11779. <doc>
  11780. <![CDATA[Timeline service leveldb start time read cache (number of entities)]]>
  11781. </doc>
  11782. </field>
  11783. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="int"
  11784. transient="false" volatile="false"
  11785. static="true" final="true" visibility="public"
  11786. deprecated="not deprecated">
  11787. </field>
  11788. <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="java.lang.String"
  11789. transient="false" volatile="false"
  11790. static="true" final="true" visibility="public"
  11791. deprecated="not deprecated">
  11792. <doc>
  11793. <![CDATA[Timeline service leveldb start time write cache (number of entities)]]>
  11794. </doc>
  11795. </field>
  11796. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="int"
  11797. transient="false" volatile="false"
  11798. static="true" final="true" visibility="public"
  11799. deprecated="not deprecated">
  11800. </field>
  11801. <field name="TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="java.lang.String"
  11802. transient="false" volatile="false"
  11803. static="true" final="true" visibility="public"
  11804. deprecated="not deprecated">
  11805. <doc>
  11806. <![CDATA[Timeline service leveldb interval to wait between deletion rounds]]>
  11807. </doc>
  11808. </field>
  11809. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="long"
  11810. transient="false" volatile="false"
  11811. static="true" final="true" visibility="public"
  11812. deprecated="not deprecated">
  11813. </field>
  11814. <field name="TIMELINE_SERVICE_PRINCIPAL" type="java.lang.String"
  11815. transient="false" volatile="false"
  11816. static="true" final="true" visibility="public"
  11817. deprecated="not deprecated">
  11818. <doc>
  11819. <![CDATA[The Kerberos principal for the timeline server.]]>
  11820. </doc>
  11821. </field>
  11822. <field name="TIMELINE_SERVICE_KEYTAB" type="java.lang.String"
  11823. transient="false" volatile="false"
  11824. static="true" final="true" visibility="public"
  11825. deprecated="not deprecated">
  11826. <doc>
  11827. <![CDATA[The Kerberos keytab for the timeline server.]]>
  11828. </doc>
  11829. </field>
  11830. <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED" type="java.lang.String"
  11831. transient="false" volatile="false"
  11832. static="true" final="true" visibility="public"
  11833. deprecated="not deprecated">
  11834. <doc>
  11835. <![CDATA[Enables cross origin support for timeline server.]]>
  11836. </doc>
  11837. </field>
  11838. <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED_DEFAULT" type="boolean"
  11839. transient="false" volatile="false"
  11840. static="true" final="true" visibility="public"
  11841. deprecated="not deprecated">
  11842. <doc>
  11843. <![CDATA[Default value for cross origin support for timeline server.]]>
  11844. </doc>
  11845. </field>
  11846. <field name="TIMELINE_SERVICE_CLIENT_PREFIX" type="java.lang.String"
  11847. transient="false" volatile="false"
  11848. static="true" final="true" visibility="public"
  11849. deprecated="not deprecated">
  11850. <doc>
  11851. <![CDATA[Timeline client settings]]>
  11852. </doc>
  11853. </field>
  11854. <field name="TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="java.lang.String"
  11855. transient="false" volatile="false"
  11856. static="true" final="true" visibility="public"
  11857. deprecated="not deprecated">
  11858. <doc>
  11859. <![CDATA[Timeline client call, max retries (-1 means no limit)]]>
  11860. </doc>
  11861. </field>
  11862. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="int"
  11863. transient="false" volatile="false"
  11864. static="true" final="true" visibility="public"
  11865. deprecated="not deprecated">
  11866. </field>
  11867. <field name="TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="java.lang.String"
  11868. transient="false" volatile="false"
  11869. static="true" final="true" visibility="public"
  11870. deprecated="not deprecated">
  11871. <doc>
  11872. <![CDATA[Timeline client call, retry interval]]>
  11873. </doc>
  11874. </field>
  11875. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="long"
  11876. transient="false" volatile="false"
  11877. static="true" final="true" visibility="public"
  11878. deprecated="not deprecated">
  11879. </field>
  11880. <field name="YARN_CLIENT_APP_SUBMISSION_POLL_INTERVAL_MS" type="java.lang.String"
  11881. transient="false" volatile="false"
  11882. static="true" final="true" visibility="public"
  11883. deprecated="not deprecated">
  11884. <doc>
  11885. <![CDATA[Use YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS instead.
  11886. The interval of the yarn client's querying application state after
  11887. application submission. The unit is millisecond.]]>
  11888. </doc>
  11889. </field>
  11890. <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="java.lang.String"
  11891. transient="false" volatile="false"
  11892. static="true" final="true" visibility="public"
  11893. deprecated="not deprecated">
  11894. <doc>
  11895. <![CDATA[The interval that the yarn client library uses to poll the completion
  11896. status of the asynchronous API of application client protocol.]]>
  11897. </doc>
  11898. </field>
  11899. <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="long"
  11900. transient="false" volatile="false"
  11901. static="true" final="true" visibility="public"
  11902. deprecated="not deprecated">
  11903. </field>
  11904. <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="java.lang.String"
  11905. transient="false" volatile="false"
  11906. static="true" final="true" visibility="public"
  11907. deprecated="not deprecated">
  11908. <doc>
  11909. <![CDATA[The duration that the yarn client library waits, cumulatively across polls,
  11910. for an expected state change to occur. Defaults to -1, which indicates no
  11911. limit.]]>
  11912. </doc>
  11913. </field>
  11914. <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="long"
  11915. transient="false" volatile="false"
  11916. static="true" final="true" visibility="public"
  11917. deprecated="not deprecated">
  11918. </field>
  11919. <field name="NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="java.lang.String"
  11920. transient="false" volatile="false"
  11921. static="true" final="true" visibility="public"
  11922. deprecated="not deprecated">
  11923. <doc>
  11924. <![CDATA[Max number of threads in NMClientAsync to process container management
  11925. events]]>
  11926. </doc>
  11927. </field>
  11928. <field name="DEFAULT_NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="int"
  11929. transient="false" volatile="false"
  11930. static="true" final="true" visibility="public"
  11931. deprecated="not deprecated">
  11932. </field>
  11933. <field name="NM_CLIENT_MAX_NM_PROXIES" type="java.lang.String"
  11934. transient="false" volatile="false"
  11935. static="true" final="true" visibility="public"
  11936. deprecated="not deprecated">
  11937. <doc>
  11938. <![CDATA[Maximum number of proxy connections to cache for node managers. If set
  11939. to a value greater than zero then the cache is enabled and the NMClient
  11940. and MRAppMaster will cache the specified number of node manager proxies.
  11941. There will be at max one proxy per node manager. Ex. configuring it to a
  11942. value of 5 will make sure that client will at max have 5 proxies cached
  11943. with 5 different node managers. These connections for these proxies will
  11944. be timed out if idle for more than the system wide idle timeout period.
  11945. Note that this could cause issues on large clusters as many connections
  11946. could linger simultaneously and lead to a large number of connection
  11947. threads. The token used for authentication will be used only at
  11948. connection creation time. If a new token is received then the earlier
  11949. connection should be closed in order to use the new token. This and
  11950. {@link YarnConfiguration#NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE} are related
  11951. and should be in sync (no need for them to be equal).
  11952. If the value of this property is zero then the connection cache is
  11953. disabled and connections will use a zero idle timeout to prevent too
  11954. many connection threads on large clusters.]]>
  11955. </doc>
  11956. </field>
  11957. <field name="DEFAULT_NM_CLIENT_MAX_NM_PROXIES" type="int"
  11958. transient="false" volatile="false"
  11959. static="true" final="true" visibility="public"
  11960. deprecated="not deprecated">
  11961. </field>
  11962. <field name="CLIENT_NM_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  11963. transient="false" volatile="false"
  11964. static="true" final="true" visibility="public"
  11965. deprecated="not deprecated">
  11966. <doc>
  11967. <![CDATA[Max time to wait to establish a connection to NM]]>
  11968. </doc>
  11969. </field>
  11970. <field name="DEFAULT_CLIENT_NM_CONNECT_MAX_WAIT_MS" type="long"
  11971. transient="false" volatile="false"
  11972. static="true" final="true" visibility="public"
  11973. deprecated="not deprecated">
  11974. </field>
  11975. <field name="CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  11976. transient="false" volatile="false"
  11977. static="true" final="true" visibility="public"
  11978. deprecated="not deprecated">
  11979. <doc>
  11980. <![CDATA[Time interval between each attempt to connect to NM]]>
  11981. </doc>
  11982. </field>
  11983. <field name="DEFAULT_CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="long"
  11984. transient="false" volatile="false"
  11985. static="true" final="true" visibility="public"
  11986. deprecated="not deprecated">
  11987. </field>
  11988. <field name="YARN_HTTP_POLICY_KEY" type="java.lang.String"
  11989. transient="false" volatile="false"
  11990. static="true" final="true" visibility="public"
  11991. deprecated="not deprecated">
  11992. </field>
  11993. <field name="YARN_HTTP_POLICY_DEFAULT" type="java.lang.String"
  11994. transient="false" volatile="false"
  11995. static="true" final="true" visibility="public"
  11996. deprecated="not deprecated">
  11997. </field>
  11998. <field name="NODE_LABELS_PREFIX" type="java.lang.String"
  11999. transient="false" volatile="false"
  12000. static="true" final="true" visibility="public"
  12001. deprecated="not deprecated">
  12002. </field>
  12003. <field name="RM_NODE_LABELS_MANAGER_CLASS" type="java.lang.String"
  12004. transient="false" volatile="false"
  12005. static="true" final="true" visibility="public"
  12006. deprecated="not deprecated">
  12007. <doc>
  12008. <![CDATA[Class for RMNodeLabelsManager Please note this value should be consistent
  12009. in client nodes and RM node(s)]]>
  12010. </doc>
  12011. </field>
  12012. <field name="FS_NODE_LABELS_STORE_ROOT_DIR" type="java.lang.String"
  12013. transient="false" volatile="false"
  12014. static="true" final="true" visibility="public"
  12015. deprecated="not deprecated">
  12016. <doc>
  12017. <![CDATA[URI for NodeLabelManager]]>
  12018. </doc>
  12019. </field>
  12020. <field name="FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  12021. transient="false" volatile="false"
  12022. static="true" final="true" visibility="public"
  12023. deprecated="not deprecated">
  12024. </field>
  12025. <field name="DEFAULT_FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  12026. transient="false" volatile="false"
  12027. static="true" final="true" visibility="public"
  12028. deprecated="not deprecated">
  12029. </field>
  12030. </class>
  12031. <!-- end class org.apache.hadoop.yarn.conf.YarnConfiguration -->
  12032. </package>
  12033. <package name="org.apache.hadoop.yarn.exceptions">
  12034. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
  12035. <class name="ApplicationAttemptNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12036. abstract="false"
  12037. static="false" final="false" visibility="public"
  12038. deprecated="not deprecated">
  12039. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.Throwable"
  12040. static="false" final="false" visibility="public"
  12041. deprecated="not deprecated">
  12042. </constructor>
  12043. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String"
  12044. static="false" final="false" visibility="public"
  12045. deprecated="not deprecated">
  12046. </constructor>
  12047. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String, java.lang.Throwable"
  12048. static="false" final="false" visibility="public"
  12049. deprecated="not deprecated">
  12050. </constructor>
  12051. <doc>
  12052. <![CDATA[This exception is thrown on
  12053. {@link ApplicationHistoryProtocol#getApplicationAttemptReport (GetApplicationAttemptReportRequest)}
  12054. API when the Application Attempt doesn't exist in Application History Server or
  12055. {@link ApplicationMasterProtocol#allocate(AllocateRequest)} if application
  12056. doesn't exist in RM.]]>
  12057. </doc>
  12058. </class>
  12059. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
  12060. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
  12061. <class name="ApplicationIdNotProvidedException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12062. abstract="false"
  12063. static="false" final="false" visibility="public"
  12064. deprecated="not deprecated">
  12065. <constructor name="ApplicationIdNotProvidedException" type="java.lang.Throwable"
  12066. static="false" final="false" visibility="public"
  12067. deprecated="not deprecated">
  12068. </constructor>
  12069. <constructor name="ApplicationIdNotProvidedException" type="java.lang.String"
  12070. static="false" final="false" visibility="public"
  12071. deprecated="not deprecated">
  12072. </constructor>
  12073. <constructor name="ApplicationIdNotProvidedException" type="java.lang.String, java.lang.Throwable"
  12074. static="false" final="false" visibility="public"
  12075. deprecated="not deprecated">
  12076. </constructor>
  12077. <doc>
  12078. <![CDATA[Exception to be thrown when Client submit an application without
  12079. providing {@link ApplicationId} in {@link ApplicationSubmissionContext}.]]>
  12080. </doc>
  12081. </class>
  12082. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
  12083. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationMasterNotRegisteredException -->
  12084. <class name="ApplicationMasterNotRegisteredException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12085. abstract="false"
  12086. static="false" final="false" visibility="public"
  12087. deprecated="not deprecated">
  12088. <constructor name="ApplicationMasterNotRegisteredException" type="java.lang.Throwable"
  12089. static="false" final="false" visibility="public"
  12090. deprecated="not deprecated">
  12091. </constructor>
  12092. <constructor name="ApplicationMasterNotRegisteredException" type="java.lang.String"
  12093. static="false" final="false" visibility="public"
  12094. deprecated="not deprecated">
  12095. </constructor>
  12096. <constructor name="ApplicationMasterNotRegisteredException" type="java.lang.String, java.lang.Throwable"
  12097. static="false" final="false" visibility="public"
  12098. deprecated="not deprecated">
  12099. </constructor>
  12100. <doc>
  12101. <![CDATA[This exception is thrown when an Application Master tries to unregister by calling
  12102. {@link ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)}
  12103. API without first registering by calling
  12104. {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}
  12105. or after an RM restart. The ApplicationMaster is expected to call
  12106. {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}
  12107. and retry.]]>
  12108. </doc>
  12109. </class>
  12110. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationMasterNotRegisteredException -->
  12111. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
  12112. <class name="ApplicationNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12113. abstract="false"
  12114. static="false" final="false" visibility="public"
  12115. deprecated="not deprecated">
  12116. <constructor name="ApplicationNotFoundException" type="java.lang.Throwable"
  12117. static="false" final="false" visibility="public"
  12118. deprecated="not deprecated">
  12119. </constructor>
  12120. <constructor name="ApplicationNotFoundException" type="java.lang.String"
  12121. static="false" final="false" visibility="public"
  12122. deprecated="not deprecated">
  12123. </constructor>
  12124. <constructor name="ApplicationNotFoundException" type="java.lang.String, java.lang.Throwable"
  12125. static="false" final="false" visibility="public"
  12126. deprecated="not deprecated">
  12127. </constructor>
  12128. <doc>
  12129. <![CDATA[This exception is thrown on
  12130. {@link ApplicationClientProtocol#getApplicationReport
  12131. (GetApplicationReportRequest)} API
  12132. when the Application doesn't exist in RM and AHS]]>
  12133. </doc>
  12134. </class>
  12135. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
  12136. <!-- start class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
  12137. <class name="ContainerNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12138. abstract="false"
  12139. static="false" final="false" visibility="public"
  12140. deprecated="not deprecated">
  12141. <constructor name="ContainerNotFoundException" type="java.lang.Throwable"
  12142. static="false" final="false" visibility="public"
  12143. deprecated="not deprecated">
  12144. </constructor>
  12145. <constructor name="ContainerNotFoundException" type="java.lang.String"
  12146. static="false" final="false" visibility="public"
  12147. deprecated="not deprecated">
  12148. </constructor>
  12149. <constructor name="ContainerNotFoundException" type="java.lang.String, java.lang.Throwable"
  12150. static="false" final="false" visibility="public"
  12151. deprecated="not deprecated">
  12152. </constructor>
  12153. <doc>
  12154. <![CDATA[This exception is thrown on
  12155. {@link ApplicationHistoryProtocol#getContainerReport (GetContainerReportRequest)}
  12156. API when the container doesn't exist in AHS]]>
  12157. </doc>
  12158. </class>
  12159. <!-- end class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
  12160. <!-- start class org.apache.hadoop.yarn.exceptions.InvalidApplicationMasterRequestException -->
  12161. <class name="InvalidApplicationMasterRequestException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12162. abstract="false"
  12163. static="false" final="false" visibility="public"
  12164. deprecated="not deprecated">
  12165. <constructor name="InvalidApplicationMasterRequestException" type="java.lang.Throwable"
  12166. static="false" final="false" visibility="public"
  12167. deprecated="not deprecated">
  12168. </constructor>
  12169. <constructor name="InvalidApplicationMasterRequestException" type="java.lang.String"
  12170. static="false" final="false" visibility="public"
  12171. deprecated="not deprecated">
  12172. </constructor>
  12173. <constructor name="InvalidApplicationMasterRequestException" type="java.lang.String, java.lang.Throwable"
  12174. static="false" final="false" visibility="public"
  12175. deprecated="not deprecated">
  12176. </constructor>
  12177. <doc>
  12178. <![CDATA[This exception is thrown when an ApplicationMaster asks for resources by
  12179. calling {@link ApplicationMasterProtocol#allocate(AllocateRequest)}
  12180. without first registering by calling
  12181. {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}
  12182. or if it tries to register more than once.]]>
  12183. </doc>
  12184. </class>
  12185. <!-- end class org.apache.hadoop.yarn.exceptions.InvalidApplicationMasterRequestException -->
  12186. <!-- start class org.apache.hadoop.yarn.exceptions.InvalidAuxServiceException -->
  12187. <class name="InvalidAuxServiceException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12188. abstract="false"
  12189. static="false" final="false" visibility="public"
  12190. deprecated="not deprecated">
  12191. <constructor name="InvalidAuxServiceException" type="java.lang.String"
  12192. static="false" final="false" visibility="public"
  12193. deprecated="not deprecated">
  12194. </constructor>
  12195. <doc>
  12196. <![CDATA[This exception is thrown by a NodeManager that is rejecting start-container
  12197. requests via
  12198. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  12199. for auxservices does not exist.]]>
  12200. </doc>
  12201. </class>
  12202. <!-- end class org.apache.hadoop.yarn.exceptions.InvalidAuxServiceException -->
  12203. <!-- start class org.apache.hadoop.yarn.exceptions.InvalidContainerException -->
  12204. <class name="InvalidContainerException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12205. abstract="false"
  12206. static="false" final="false" visibility="public"
  12207. deprecated="not deprecated">
  12208. <constructor name="InvalidContainerException" type="java.lang.String"
  12209. static="false" final="false" visibility="public"
  12210. deprecated="not deprecated">
  12211. </constructor>
  12212. <doc>
  12213. <![CDATA[This exception is thrown by a NodeManager that is rejecting start-container
  12214. requests via
  12215. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  12216. for containers allocated by a previous instance of the RM.]]>
  12217. </doc>
  12218. </class>
  12219. <!-- end class org.apache.hadoop.yarn.exceptions.InvalidContainerException -->
  12220. <!-- start class org.apache.hadoop.yarn.exceptions.InvalidContainerReleaseException -->
  12221. <class name="InvalidContainerReleaseException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12222. abstract="false"
  12223. static="false" final="false" visibility="public"
  12224. deprecated="not deprecated">
  12225. <constructor name="InvalidContainerReleaseException" type="java.lang.Throwable"
  12226. static="false" final="false" visibility="public"
  12227. deprecated="not deprecated">
  12228. </constructor>
  12229. <constructor name="InvalidContainerReleaseException" type="java.lang.String"
  12230. static="false" final="false" visibility="public"
  12231. deprecated="not deprecated">
  12232. </constructor>
  12233. <constructor name="InvalidContainerReleaseException" type="java.lang.String, java.lang.Throwable"
  12234. static="false" final="false" visibility="public"
  12235. deprecated="not deprecated">
  12236. </constructor>
  12237. <doc>
  12238. <![CDATA[This exception is thrown when an Application Master tries to release
  12239. containers not belonging to it using
  12240. {@link ApplicationMasterProtocol#allocate(AllocateRequest)} API.]]>
  12241. </doc>
  12242. </class>
  12243. <!-- end class org.apache.hadoop.yarn.exceptions.InvalidContainerReleaseException -->
  12244. <!-- start class org.apache.hadoop.yarn.exceptions.InvalidResourceBlacklistRequestException -->
  12245. <class name="InvalidResourceBlacklistRequestException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12246. abstract="false"
  12247. static="false" final="false" visibility="public"
  12248. deprecated="not deprecated">
  12249. <constructor name="InvalidResourceBlacklistRequestException" type="java.lang.Throwable"
  12250. static="false" final="false" visibility="public"
  12251. deprecated="not deprecated">
  12252. </constructor>
  12253. <constructor name="InvalidResourceBlacklistRequestException" type="java.lang.String"
  12254. static="false" final="false" visibility="public"
  12255. deprecated="not deprecated">
  12256. </constructor>
  12257. <constructor name="InvalidResourceBlacklistRequestException" type="java.lang.String, java.lang.Throwable"
  12258. static="false" final="false" visibility="public"
  12259. deprecated="not deprecated">
  12260. </constructor>
  12261. <doc>
  12262. <![CDATA[This exception is thrown when an application provides an invalid
  12263. {@link ResourceBlacklistRequest} specification for blacklisting of resources
  12264. in {@link ApplicationMasterProtocol#allocate(AllocateRequest)} API.
  12265. Currently this exceptions is thrown when an application tries to
  12266. blacklist {@link ResourceRequest#ANY}.]]>
  12267. </doc>
  12268. </class>
  12269. <!-- end class org.apache.hadoop.yarn.exceptions.InvalidResourceBlacklistRequestException -->
  12270. <!-- start class org.apache.hadoop.yarn.exceptions.InvalidResourceRequestException -->
  12271. <class name="InvalidResourceRequestException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12272. abstract="false"
  12273. static="false" final="false" visibility="public"
  12274. deprecated="not deprecated">
  12275. <constructor name="InvalidResourceRequestException" type="java.lang.Throwable"
  12276. static="false" final="false" visibility="public"
  12277. deprecated="not deprecated">
  12278. </constructor>
  12279. <constructor name="InvalidResourceRequestException" type="java.lang.String"
  12280. static="false" final="false" visibility="public"
  12281. deprecated="not deprecated">
  12282. </constructor>
  12283. <constructor name="InvalidResourceRequestException" type="java.lang.String, java.lang.Throwable"
  12284. static="false" final="false" visibility="public"
  12285. deprecated="not deprecated">
  12286. </constructor>
  12287. <doc>
  12288. <![CDATA[This exception is thrown when a resource requested via
  12289. {@link ResourceRequest} in the
  12290. {@link ApplicationMasterProtocol#allocate(AllocateRequest)} API is out of the
  12291. range of the configured lower and upper limits on resources.]]>
  12292. </doc>
  12293. </class>
  12294. <!-- end class org.apache.hadoop.yarn.exceptions.InvalidResourceRequestException -->
  12295. <!-- start class org.apache.hadoop.yarn.exceptions.NMNotYetReadyException -->
  12296. <class name="NMNotYetReadyException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12297. abstract="false"
  12298. static="false" final="false" visibility="public"
  12299. deprecated="not deprecated">
  12300. <constructor name="NMNotYetReadyException" type="java.lang.String"
  12301. static="false" final="false" visibility="public"
  12302. deprecated="not deprecated">
  12303. </constructor>
  12304. <doc>
  12305. <![CDATA[This exception is thrown on
  12306. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)} API
  12307. when an NM starts from scratch but has not yet connected with RM.]]>
  12308. </doc>
  12309. </class>
  12310. <!-- end class org.apache.hadoop.yarn.exceptions.NMNotYetReadyException -->
  12311. <!-- start class org.apache.hadoop.yarn.exceptions.YarnException -->
  12312. <class name="YarnException" extends="java.lang.Exception"
  12313. abstract="false"
  12314. static="false" final="false" visibility="public"
  12315. deprecated="not deprecated">
  12316. <constructor name="YarnException"
  12317. static="false" final="false" visibility="public"
  12318. deprecated="not deprecated">
  12319. </constructor>
  12320. <constructor name="YarnException" type="java.lang.String"
  12321. static="false" final="false" visibility="public"
  12322. deprecated="not deprecated">
  12323. </constructor>
  12324. <constructor name="YarnException" type="java.lang.Throwable"
  12325. static="false" final="false" visibility="public"
  12326. deprecated="not deprecated">
  12327. </constructor>
  12328. <constructor name="YarnException" type="java.lang.String, java.lang.Throwable"
  12329. static="false" final="false" visibility="public"
  12330. deprecated="not deprecated">
  12331. </constructor>
  12332. <doc>
  12333. <![CDATA[YarnException indicates exceptions from yarn servers. On the other hand,
  12334. IOExceptions indicates exceptions from RPC layer.]]>
  12335. </doc>
  12336. </class>
  12337. <!-- end class org.apache.hadoop.yarn.exceptions.YarnException -->
  12338. </package>
  12339. <package name="org.apache.hadoop.yarn.server.api">
  12340. <!-- start class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
  12341. <class name="ApplicationInitializationContext" extends="java.lang.Object"
  12342. abstract="false"
  12343. static="false" final="false" visibility="public"
  12344. deprecated="not deprecated">
  12345. <constructor name="ApplicationInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ApplicationId, java.nio.ByteBuffer"
  12346. static="false" final="false" visibility="public"
  12347. deprecated="not deprecated">
  12348. </constructor>
  12349. <method name="getUser" return="java.lang.String"
  12350. abstract="false" native="false" synchronized="false"
  12351. static="false" final="false" visibility="public"
  12352. deprecated="not deprecated">
  12353. <doc>
  12354. <![CDATA[Get the user-name of the application-submitter
  12355. @return user-name]]>
  12356. </doc>
  12357. </method>
  12358. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  12359. abstract="false" native="false" synchronized="false"
  12360. static="false" final="false" visibility="public"
  12361. deprecated="not deprecated">
  12362. <doc>
  12363. <![CDATA[Get {@link ApplicationId} of the application
  12364. @return applications ID]]>
  12365. </doc>
  12366. </method>
  12367. <method name="getApplicationDataForService" return="java.nio.ByteBuffer"
  12368. abstract="false" native="false" synchronized="false"
  12369. static="false" final="false" visibility="public"
  12370. deprecated="not deprecated">
  12371. <doc>
  12372. <![CDATA[Get the data sent to the NodeManager via
  12373. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  12374. as part of {@link ContainerLaunchContext#getServiceData()}
  12375. @return the servicesData for this application.]]>
  12376. </doc>
  12377. </method>
  12378. <doc>
  12379. <![CDATA[Initialization context for {@link AuxiliaryService} when starting an
  12380. application.]]>
  12381. </doc>
  12382. </class>
  12383. <!-- end class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
  12384. <!-- start class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
  12385. <class name="ApplicationTerminationContext" extends="java.lang.Object"
  12386. abstract="false"
  12387. static="false" final="false" visibility="public"
  12388. deprecated="not deprecated">
  12389. <constructor name="ApplicationTerminationContext" type="org.apache.hadoop.yarn.api.records.ApplicationId"
  12390. static="false" final="false" visibility="public"
  12391. deprecated="not deprecated">
  12392. </constructor>
  12393. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  12394. abstract="false" native="false" synchronized="false"
  12395. static="false" final="false" visibility="public"
  12396. deprecated="not deprecated">
  12397. <doc>
  12398. <![CDATA[Get {@link ApplicationId} of the application being stopped.
  12399. @return applications ID]]>
  12400. </doc>
  12401. </method>
  12402. <doc>
  12403. <![CDATA[Initialization context for {@link AuxiliaryService} when stopping an
  12404. application.]]>
  12405. </doc>
  12406. </class>
  12407. <!-- end class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
  12408. <!-- start class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
  12409. <class name="AuxiliaryService" extends="org.apache.hadoop.service.AbstractService"
  12410. abstract="true"
  12411. static="false" final="false" visibility="public"
  12412. deprecated="not deprecated">
  12413. <constructor name="AuxiliaryService" type="java.lang.String"
  12414. static="false" final="false" visibility="protected"
  12415. deprecated="not deprecated">
  12416. </constructor>
  12417. <method name="getRecoveryPath" return="org.apache.hadoop.fs.Path"
  12418. abstract="false" native="false" synchronized="false"
  12419. static="false" final="false" visibility="protected"
  12420. deprecated="not deprecated">
  12421. <doc>
  12422. <![CDATA[Get the path specific to this auxiliary service to use for recovery.
  12423. @return state storage path or null if recovery is not enabled]]>
  12424. </doc>
  12425. </method>
  12426. <method name="initializeApplication"
  12427. abstract="true" native="false" synchronized="false"
  12428. static="false" final="false" visibility="public"
  12429. deprecated="not deprecated">
  12430. <param name="initAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationInitializationContext"/>
  12431. <doc>
  12432. <![CDATA[A new application is started on this NodeManager. This is a signal to
  12433. this {@link AuxiliaryService} about the application initialization.
  12434. @param initAppContext context for the application's initialization]]>
  12435. </doc>
  12436. </method>
  12437. <method name="stopApplication"
  12438. abstract="true" native="false" synchronized="false"
  12439. static="false" final="false" visibility="public"
  12440. deprecated="not deprecated">
  12441. <param name="stopAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationTerminationContext"/>
  12442. <doc>
  12443. <![CDATA[An application is finishing on this NodeManager. This is a signal to this
  12444. {@link AuxiliaryService} about the same.
  12445. @param stopAppContext context for the application termination]]>
  12446. </doc>
  12447. </method>
  12448. <method name="getMetaData" return="java.nio.ByteBuffer"
  12449. abstract="true" native="false" synchronized="false"
  12450. static="false" final="false" visibility="public"
  12451. deprecated="not deprecated">
  12452. <doc>
  12453. <![CDATA[Retrieve meta-data for this {@link AuxiliaryService}. Applications using
  12454. this {@link AuxiliaryService} SHOULD know the format of the meta-data -
  12455. ideally each service should provide a method to parse out the information
  12456. to the applications. One example of meta-data is contact information so
  12457. that applications can access the service remotely. This will only be called
  12458. after the service's {@link #start()} method has finished. the result may be
  12459. cached.
  12460. <p>
  12461. The information is passed along to applications via
  12462. {@link StartContainersResponse#getAllServicesMetaData()} that is returned by
  12463. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  12464. </p>
  12465. @return meta-data for this service that should be made available to
  12466. applications.]]>
  12467. </doc>
  12468. </method>
  12469. <method name="initializeContainer"
  12470. abstract="false" native="false" synchronized="false"
  12471. static="false" final="false" visibility="public"
  12472. deprecated="not deprecated">
  12473. <param name="initContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerInitializationContext"/>
  12474. <doc>
  12475. <![CDATA[A new container is started on this NodeManager. This is a signal to
  12476. this {@link AuxiliaryService} about the container initialization.
  12477. This method is called when the NodeManager receives the container launch
  12478. command from the ApplicationMaster and before the container process is
  12479. launched.
  12480. @param initContainerContext context for the container's initialization]]>
  12481. </doc>
  12482. </method>
  12483. <method name="stopContainer"
  12484. abstract="false" native="false" synchronized="false"
  12485. static="false" final="false" visibility="public"
  12486. deprecated="not deprecated">
  12487. <param name="stopContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerTerminationContext"/>
  12488. <doc>
  12489. <![CDATA[A container is finishing on this NodeManager. This is a signal to this
  12490. {@link AuxiliaryService} about the same.
  12491. @param stopContainerContext context for the container termination]]>
  12492. </doc>
  12493. </method>
  12494. <method name="setRecoveryPath"
  12495. abstract="false" native="false" synchronized="false"
  12496. static="false" final="false" visibility="public"
  12497. deprecated="not deprecated">
  12498. <param name="recoveryPath" type="org.apache.hadoop.fs.Path"/>
  12499. <doc>
  12500. <![CDATA[Set the path for this auxiliary service to use for storing state
  12501. that will be used during recovery.
  12502. @param recoveryPath where recoverable state should be stored]]>
  12503. </doc>
  12504. </method>
  12505. <doc>
  12506. <![CDATA[A generic service that will be started by the NodeManager. This is a service
  12507. that administrators have to configure on each node by setting
  12508. {@link YarnConfiguration#NM_AUX_SERVICES}.]]>
  12509. </doc>
  12510. </class>
  12511. <!-- end class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
  12512. <!-- start class org.apache.hadoop.yarn.server.api.ContainerContext -->
  12513. <class name="ContainerContext" extends="java.lang.Object"
  12514. abstract="false"
  12515. static="false" final="false" visibility="public"
  12516. deprecated="not deprecated">
  12517. <constructor name="ContainerContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  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 user of the container being initialized or stopped.
  12527. @return the user]]>
  12528. </doc>
  12529. </method>
  12530. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  12531. abstract="false" native="false" synchronized="false"
  12532. static="false" final="false" visibility="public"
  12533. deprecated="not deprecated">
  12534. <doc>
  12535. <![CDATA[Get {@link ContainerId} of the container being initialized or stopped.
  12536. @return the container ID]]>
  12537. </doc>
  12538. </method>
  12539. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  12540. abstract="false" native="false" synchronized="false"
  12541. static="false" final="false" visibility="public"
  12542. deprecated="not deprecated">
  12543. <doc>
  12544. <![CDATA[Get {@link Resource} the resource capability allocated to the container
  12545. being initialized or stopped.
  12546. @return the resource capability.]]>
  12547. </doc>
  12548. </method>
  12549. <doc>
  12550. <![CDATA[Base context class for {@link AuxiliaryService} initializing and stopping a
  12551. container.]]>
  12552. </doc>
  12553. </class>
  12554. <!-- end class org.apache.hadoop.yarn.server.api.ContainerContext -->
  12555. <!-- start class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
  12556. <class name="ContainerInitializationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
  12557. abstract="false"
  12558. static="false" final="false" visibility="public"
  12559. deprecated="not deprecated">
  12560. <constructor name="ContainerInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  12561. static="false" final="false" visibility="public"
  12562. deprecated="not deprecated">
  12563. </constructor>
  12564. <doc>
  12565. <![CDATA[Initialization context for {@link AuxiliaryService} when starting a
  12566. container.]]>
  12567. </doc>
  12568. </class>
  12569. <!-- end class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
  12570. <!-- start class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
  12571. <class name="ContainerTerminationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
  12572. abstract="false"
  12573. static="false" final="false" visibility="public"
  12574. deprecated="not deprecated">
  12575. <constructor name="ContainerTerminationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  12576. static="false" final="false" visibility="public"
  12577. deprecated="not deprecated">
  12578. </constructor>
  12579. <doc>
  12580. <![CDATA[Termination context for {@link AuxiliaryService} when stopping a
  12581. container.]]>
  12582. </doc>
  12583. </class>
  12584. <!-- end class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
  12585. </package>
  12586. </api>