Apache_Hadoop_YARN_API_2.10.0.xml 934 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317
  1. <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
  2. <!-- Generated by the JDiff Javadoc doclet -->
  3. <!-- (http://www.jdiff.org) -->
  4. <!-- on Tue Oct 29 19:52:36 PDT 2019 -->
  5. <api
  6. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  7. xsi:noNamespaceSchemaLocation='api.xsd'
  8. name="Apache Hadoop YARN API 2.10.0"
  9. jdversion="1.0.9">
  10. <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /home/jhung/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-annotations.jar:/home/jhung/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/jdiff.jar -verbose -classpath /home/jhung/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/classes:/home/jhung/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/home/jhung/.m2/repository/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/home/jhung/.m2/repository/com/google/code/findbugs/jsr305/3.0.0/jsr305-3.0.0.jar:/home/jhung/.m2/repository/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/home/jhung/.m2/repository/javax/xml/bind/jaxb-api/2.2.2/jaxb-api-2.2.2.jar:/home/jhung/.m2/repository/javax/xml/stream/stax-api/1.0-2/stax-api-1.0-2.jar:/home/jhung/.m2/repository/javax/activation/activation/1.1/activation-1.1.jar:/home/jhung/hadoop/hadoop-common-project/hadoop-common/target/hadoop-common-2.10.0.jar:/home/jhung/.m2/repository/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/home/jhung/.m2/repository/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/home/jhung/.m2/repository/xmlenc/xmlenc/0.52/xmlenc-0.52.jar:/home/jhung/.m2/repository/org/apache/httpcomponents/httpclient/4.5.2/httpclient-4.5.2.jar:/home/jhung/.m2/repository/org/apache/httpcomponents/httpcore/4.4.4/httpcore-4.4.4.jar:/home/jhung/.m2/repository/commons-codec/commons-codec/1.4/commons-codec-1.4.jar:/home/jhung/.m2/repository/commons-io/commons-io/2.4/commons-io-2.4.jar:/home/jhung/.m2/repository/commons-net/commons-net/3.1/commons-net-3.1.jar:/home/jhung/.m2/repository/commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar:/home/jhung/.m2/repository/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar:/home/jhung/.m2/repository/org/mortbay/jetty/jetty/6.1.26/jetty-6.1.26.jar:/home/jhung/.m2/repository/org/mortbay/jetty/jetty-util/6.1.26/jetty-util-6.1.26.jar:/home/jhung/.m2/repository/org/mortbay/jetty/jetty-sslengine/6.1.26/jetty-sslengine-6.1.26.jar:/home/jhung/.m2/repository/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/home/jhung/.m2/repository/com/sun/jersey/jersey-core/1.9/jersey-core-1.9.jar:/home/jhung/.m2/repository/com/sun/jersey/jersey-json/1.9/jersey-json-1.9.jar:/home/jhung/.m2/repository/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/home/jhung/.m2/repository/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/home/jhung/.m2/repository/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/home/jhung/.m2/repository/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/home/jhung/.m2/repository/com/sun/jersey/jersey-server/1.9/jersey-server-1.9.jar:/home/jhung/.m2/repository/asm/asm/3.2/asm-3.2.jar:/home/jhung/.m2/repository/log4j/log4j/1.2.17/log4j-1.2.17.jar:/home/jhung/.m2/repository/net/java/dev/jets3t/jets3t/0.9.0/jets3t-0.9.0.jar:/home/jhung/.m2/repository/com/jamesmurty/utils/java-xmlbuilder/0.4/java-xmlbuilder-0.4.jar:/home/jhung/.m2/repository/commons-configuration/commons-configuration/1.6/commons-configuration-1.6.jar:/home/jhung/.m2/repository/commons-digester/commons-digester/1.8/commons-digester-1.8.jar:/home/jhung/.m2/repository/commons-beanutils/commons-beanutils/1.9.4/commons-beanutils-1.9.4.jar:/home/jhung/.m2/repository/org/apache/commons/commons-lang3/3.4/commons-lang3-3.4.jar:/home/jhung/.m2/repository/org/slf4j/slf4j-api/1.7.25/slf4j-api-1.7.25.jar:/home/jhung/.m2/repository/org/slf4j/slf4j-log4j12/1.7.25/slf4j-log4j12-1.7.25.jar:/home/jhung/.m2/repository/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/home/jhung/.m2/repository/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/home/jhung/.m2/repository/org/apache/avro/avro/1.7.7/avro-1.7.7.jar:/home/jhung/.m2/repository/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/home/jhung/.m2/repository/org/xerial/snappy/snappy-java/1.0.5/snappy-java-1.0.5.jar:/home/jhung/.m2/repository/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/home/jhung/hadoop/hadoop-common-project/hadoop-auth/target/hadoop-auth-2.10.0.jar:/home/jhung/.m2/repository/com/nimbusds/nimbus-jose-jwt/4.41.1/nimbus-jose-jwt-4.41.1.jar:/home/jhung/.m2/repository/com/github/stephenc/jcip/jcip-annotations/1.0-1/jcip-annotations-1.0-1.jar:/home/jhung/.m2/repository/net/minidev/json-smart/1.3.1/json-smart-1.3.1.jar:/home/jhung/.m2/repository/org/apache/directory/server/apacheds-kerberos-codec/2.0.0-M15/apacheds-kerberos-codec-2.0.0-M15.jar:/home/jhung/.m2/repository/org/apache/directory/server/apacheds-i18n/2.0.0-M15/apacheds-i18n-2.0.0-M15.jar:/home/jhung/.m2/repository/org/apache/directory/api/api-asn1-api/1.0.0-M20/api-asn1-api-1.0.0-M20.jar:/home/jhung/.m2/repository/org/apache/directory/api/api-util/1.0.0-M20/api-util-1.0.0-M20.jar:/home/jhung/.m2/repository/org/apache/curator/curator-framework/2.7.1/curator-framework-2.7.1.jar:/home/jhung/.m2/repository/com/jcraft/jsch/0.1.54/jsch-0.1.54.jar:/home/jhung/.m2/repository/org/apache/curator/curator-client/2.7.1/curator-client-2.7.1.jar:/home/jhung/.m2/repository/org/apache/curator/curator-recipes/2.7.1/curator-recipes-2.7.1.jar:/home/jhung/.m2/repository/org/apache/htrace/htrace-core4/4.1.0-incubating/htrace-core4-4.1.0-incubating.jar:/home/jhung/.m2/repository/org/apache/zookeeper/zookeeper/3.4.9/zookeeper-3.4.9.jar:/home/jhung/.m2/repository/io/netty/netty/3.10.6.Final/netty-3.10.6.Final.jar:/home/jhung/.m2/repository/org/apache/commons/commons-compress/1.19/commons-compress-1.19.jar:/home/jhung/.m2/repository/org/codehaus/woodstox/stax2-api/3.1.4/stax2-api-3.1.4.jar:/home/jhung/.m2/repository/com/fasterxml/woodstox/woodstox-core/5.0.3/woodstox-core-5.0.3.jar:/home/jhung/hadoop/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-2.10.0.jar:/export/apps/jdk/JDK-1_7_0_51/lib/tools.jar:/home/jhung/.m2/repository/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar -sourcepath /home/jhung/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java -apidir /home/jhung/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/jdiff/xml -apiname Apache Hadoop YARN API 2.10.0 -->
  11. <package name="org.apache.hadoop.yarn.ams">
  12. </package>
  13. <package name="org.apache.hadoop.yarn.api">
  14. <!-- start interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
  15. <interface name="ApplicationClientProtocol" abstract="true"
  16. static="false" final="false" visibility="public"
  17. deprecated="not deprecated">
  18. <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
  19. <method name="getNewApplication" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse"
  20. abstract="false" native="false" synchronized="false"
  21. static="false" final="false" visibility="public"
  22. deprecated="not deprecated">
  23. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"/>
  24. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  25. <exception name="IOException" type="java.io.IOException"/>
  26. <doc>
  27. <![CDATA[<p>The interface used by clients to obtain a new {@link ApplicationId} for
  28. submitting new applications.</p>
  29. <p>The <code>ResourceManager</code> responds with a new, monotonically
  30. increasing, {@link ApplicationId} which is used by the client to submit
  31. a new application.</p>
  32. <p>The <code>ResourceManager</code> also responds with details such
  33. as maximum resource capabilities in the cluster as specified in
  34. {@link GetNewApplicationResponse}.</p>
  35. @param request request to get a new <code>ApplicationId</code>
  36. @return response containing the new <code>ApplicationId</code> to be used
  37. to submit an application
  38. @throws YarnException
  39. @throws IOException
  40. @see #submitApplication(SubmitApplicationRequest)]]>
  41. </doc>
  42. </method>
  43. <method name="submitApplication" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse"
  44. abstract="false" native="false" synchronized="false"
  45. static="false" final="false" visibility="public"
  46. deprecated="not deprecated">
  47. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"/>
  48. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  49. <exception name="IOException" type="java.io.IOException"/>
  50. <doc>
  51. <![CDATA[<p>The interface used by clients to submit a new application to the
  52. <code>ResourceManager.</code></p>
  53. <p>The client is required to provide details such as queue,
  54. {@link Resource} required to run the <code>ApplicationMaster</code>,
  55. the equivalent of {@link ContainerLaunchContext} for launching
  56. the <code>ApplicationMaster</code> etc. via the
  57. {@link SubmitApplicationRequest}.</p>
  58. <p>Currently the <code>ResourceManager</code> sends an immediate (empty)
  59. {@link SubmitApplicationResponse} on accepting the submission and throws
  60. an exception if it rejects the submission. However, this call needs to be
  61. followed by {@link #getApplicationReport(GetApplicationReportRequest)}
  62. to make sure that the application gets properly submitted - obtaining a
  63. {@link SubmitApplicationResponse} from ResourceManager doesn't guarantee
  64. that RM 'remembers' this application beyond failover or restart. If RM
  65. failover or RM restart happens before ResourceManager saves the
  66. application's state successfully, the subsequent
  67. {@link #getApplicationReport(GetApplicationReportRequest)} will throw
  68. a {@link ApplicationNotFoundException}. The Clients need to re-submit
  69. the application with the same {@link ApplicationSubmissionContext} when
  70. it encounters the {@link ApplicationNotFoundException} on the
  71. {@link #getApplicationReport(GetApplicationReportRequest)} call.</p>
  72. <p>During the submission process, it checks whether the application
  73. already exists. If the application exists, it will simply return
  74. SubmitApplicationResponse</p>
  75. <p> In secure mode,the <code>ResourceManager</code> verifies access to
  76. queues etc. before accepting the application submission.</p>
  77. @param request request to submit a new application
  78. @return (empty) response on accepting the submission
  79. @throws YarnException
  80. @throws IOException
  81. @see #getNewApplication(GetNewApplicationRequest)]]>
  82. </doc>
  83. </method>
  84. <method name="failApplicationAttempt" return="org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptResponse"
  85. abstract="false" native="false" synchronized="false"
  86. static="false" final="false" visibility="public"
  87. deprecated="not deprecated">
  88. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest"/>
  89. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  90. <exception name="IOException" type="java.io.IOException"/>
  91. <doc>
  92. <![CDATA[<p>The interface used by clients to request the
  93. <code>ResourceManager</code> to fail an application attempt.</p>
  94. <p>The client, via {@link FailApplicationAttemptRequest} provides the
  95. {@link ApplicationAttemptId} of the attempt to be failed.</p>
  96. <p> In secure mode,the <code>ResourceManager</code> verifies access to the
  97. application, queue etc. before failing the attempt.</p>
  98. <p>Currently, the <code>ResourceManager</code> returns an empty response
  99. on success and throws an exception on rejecting the request.</p>
  100. @param request request to fail an attempt
  101. @return <code>ResourceManager</code> returns an empty response
  102. on success and throws an exception on rejecting the request
  103. @throws YarnException
  104. @throws IOException
  105. @see #getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  106. </doc>
  107. </method>
  108. <method name="forceKillApplication" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse"
  109. abstract="false" native="false" synchronized="false"
  110. static="false" final="false" visibility="public"
  111. deprecated="not deprecated">
  112. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"/>
  113. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  114. <exception name="IOException" type="java.io.IOException"/>
  115. <doc>
  116. <![CDATA[<p>The interface used by clients to request the
  117. <code>ResourceManager</code> to abort submitted application.</p>
  118. <p>The client, via {@link KillApplicationRequest} provides the
  119. {@link ApplicationId} of the application to be aborted.</p>
  120. <p> In secure mode,the <code>ResourceManager</code> verifies access to the
  121. application, queue etc. before terminating the application.</p>
  122. <p>Currently, the <code>ResourceManager</code> returns an empty response
  123. on success and throws an exception on rejecting the request.</p>
  124. @param request request to abort a submitted application
  125. @return <code>ResourceManager</code> returns an empty response
  126. on success and throws an exception on rejecting the request
  127. @throws YarnException
  128. @throws IOException
  129. @see #getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  130. </doc>
  131. </method>
  132. <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse"
  133. abstract="false" native="false" synchronized="false"
  134. static="false" final="false" visibility="public"
  135. deprecated="not deprecated">
  136. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"/>
  137. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  138. <exception name="IOException" type="java.io.IOException"/>
  139. <doc>
  140. <![CDATA[<p>The interface used by clients to get metrics about the cluster from
  141. the <code>ResourceManager</code>.</p>
  142. <p>The <code>ResourceManager</code> responds with a
  143. {@link GetClusterMetricsResponse} which includes the
  144. {@link YarnClusterMetrics} with details such as number of current
  145. nodes in the cluster.</p>
  146. @param request request for cluster metrics
  147. @return cluster metrics
  148. @throws YarnException
  149. @throws IOException]]>
  150. </doc>
  151. </method>
  152. <method name="getClusterNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse"
  153. abstract="false" native="false" synchronized="false"
  154. static="false" final="false" visibility="public"
  155. deprecated="not deprecated">
  156. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"/>
  157. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  158. <exception name="IOException" type="java.io.IOException"/>
  159. <doc>
  160. <![CDATA[<p>The interface used by clients to get a report of all nodes
  161. in the cluster from the <code>ResourceManager</code>.</p>
  162. <p>The <code>ResourceManager</code> responds with a
  163. {@link GetClusterNodesResponse} which includes the
  164. {@link NodeReport} for all the nodes in the cluster.</p>
  165. @param request request for report on all nodes
  166. @return report on all nodes
  167. @throws YarnException
  168. @throws IOException]]>
  169. </doc>
  170. </method>
  171. <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse"
  172. abstract="false" native="false" synchronized="false"
  173. static="false" final="false" visibility="public"
  174. deprecated="not deprecated">
  175. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"/>
  176. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  177. <exception name="IOException" type="java.io.IOException"/>
  178. <doc>
  179. <![CDATA[<p>The interface used by clients to get information about <em>queues</em>
  180. from the <code>ResourceManager</code>.</p>
  181. <p>The client, via {@link GetQueueInfoRequest}, can ask for details such
  182. as used/total resources, child queues, running applications etc.</p>
  183. <p> In secure mode,the <code>ResourceManager</code> verifies access before
  184. providing the information.</p>
  185. @param request request to get queue information
  186. @return queue information
  187. @throws YarnException
  188. @throws IOException]]>
  189. </doc>
  190. </method>
  191. <method name="getQueueUserAcls" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse"
  192. abstract="false" native="false" synchronized="false"
  193. static="false" final="false" visibility="public"
  194. deprecated="not deprecated">
  195. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"/>
  196. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  197. <exception name="IOException" type="java.io.IOException"/>
  198. <doc>
  199. <![CDATA[<p>The interface used by clients to get information about <em>queue
  200. acls</em> for <em>current user</em> from the <code>ResourceManager</code>.
  201. </p>
  202. <p>The <code>ResourceManager</code> responds with queue acls for all
  203. existing queues.</p>
  204. @param request request to get queue acls for <em>current user</em>
  205. @return queue acls for <em>current user</em>
  206. @throws YarnException
  207. @throws IOException]]>
  208. </doc>
  209. </method>
  210. <method name="moveApplicationAcrossQueues" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse"
  211. abstract="false" native="false" synchronized="false"
  212. static="false" final="false" visibility="public"
  213. deprecated="not deprecated">
  214. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"/>
  215. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  216. <exception name="IOException" type="java.io.IOException"/>
  217. <doc>
  218. <![CDATA[Move an application to a new queue.
  219. @param request the application ID and the target queue
  220. @return an empty response
  221. @throws YarnException
  222. @throws IOException]]>
  223. </doc>
  224. </method>
  225. <method name="getNewReservation" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse"
  226. abstract="false" native="false" synchronized="false"
  227. static="false" final="false" visibility="public"
  228. deprecated="not deprecated">
  229. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest"/>
  230. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  231. <exception name="IOException" type="java.io.IOException"/>
  232. <doc>
  233. <![CDATA[<p>The interface used by clients to obtain a new {@link ReservationId} for
  234. submitting new reservations.</p>
  235. <p>The <code>ResourceManager</code> responds with a new, unique,
  236. {@link ReservationId} which is used by the client to submit
  237. a new reservation.</p>
  238. @param request to get a new <code>ReservationId</code>
  239. @return response containing the new <code>ReservationId</code> to be used
  240. to submit a new reservation
  241. @throws YarnException if the reservation system is not enabled.
  242. @throws IOException on IO failures.
  243. @see #submitReservation(ReservationSubmissionRequest)]]>
  244. </doc>
  245. </method>
  246. <method name="submitReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse"
  247. abstract="false" native="false" synchronized="false"
  248. static="false" final="false" visibility="public"
  249. deprecated="not deprecated">
  250. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"/>
  251. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  252. <exception name="IOException" type="java.io.IOException"/>
  253. <doc>
  254. <![CDATA[<p>
  255. The interface used by clients to submit a new reservation to the
  256. {@code ResourceManager}.
  257. </p>
  258. <p>
  259. The client packages all details of its request in a
  260. {@link ReservationSubmissionRequest} object. This contains information
  261. about the amount of capacity, temporal constraints, and concurrency needs.
  262. Furthermore, the reservation might be composed of multiple stages, with
  263. ordering dependencies among them.
  264. </p>
  265. <p>
  266. In order to respond, a new admission control component in the
  267. {@code ResourceManager} performs an analysis of the resources that have
  268. been committed over the period of time the user is requesting, verify that
  269. the user requests can be fulfilled, and that it respect a sharing policy
  270. (e.g., {@code CapacityOverTimePolicy}). Once it has positively determined
  271. that the ReservationSubmissionRequest is satisfiable the
  272. {@code ResourceManager} answers with a
  273. {@link ReservationSubmissionResponse} that include a non-null
  274. {@link ReservationId}. Upon failure to find a valid allocation the response
  275. is an exception with the reason.
  276. On application submission the client can use this {@link ReservationId} to
  277. obtain access to the reserved resources.
  278. </p>
  279. <p>
  280. The system guarantees that during the time-range specified by the user, the
  281. reservationID will be corresponding to a valid reservation. The amount of
  282. capacity dedicated to such queue can vary overtime, depending of the
  283. allocation that has been determined. But it is guaranteed to satisfy all
  284. the constraint expressed by the user in the
  285. {@link ReservationSubmissionRequest}.
  286. </p>
  287. @param request the request to submit a new Reservation
  288. @return response the {@link ReservationId} on accepting the submission
  289. @throws YarnException if the request is invalid or reservation cannot be
  290. created successfully
  291. @throws IOException]]>
  292. </doc>
  293. </method>
  294. <method name="updateReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse"
  295. abstract="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.ReservationUpdateRequest"/>
  299. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  300. <exception name="IOException" type="java.io.IOException"/>
  301. <doc>
  302. <![CDATA[<p>
  303. The interface used by clients to update an existing Reservation. This is
  304. referred to as a re-negotiation process, in which a user that has
  305. previously submitted a Reservation.
  306. </p>
  307. <p>
  308. The allocation is attempted by virtually substituting all previous
  309. allocations related to this Reservation with new ones, that satisfy the new
  310. {@link ReservationUpdateRequest}. Upon success the previous allocation is
  311. substituted by the new one, and on failure (i.e., if the system cannot find
  312. a valid allocation for the updated request), the previous allocation
  313. remains valid.
  314. The {@link ReservationId} is not changed, and applications currently
  315. running within this reservation will automatically receive the resources
  316. based on the new allocation.
  317. </p>
  318. @param request to update an existing Reservation (the ReservationRequest
  319. should refer to an existing valid {@link ReservationId})
  320. @return response empty on successfully updating the existing reservation
  321. @throws YarnException if the request is invalid or reservation cannot be
  322. updated successfully
  323. @throws IOException]]>
  324. </doc>
  325. </method>
  326. <method name="deleteReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse"
  327. abstract="false" native="false" synchronized="false"
  328. static="false" final="false" visibility="public"
  329. deprecated="not deprecated">
  330. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"/>
  331. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  332. <exception name="IOException" type="java.io.IOException"/>
  333. <doc>
  334. <![CDATA[<p>
  335. The interface used by clients to remove an existing Reservation.
  336. Upon deletion of a reservation applications running with this reservation,
  337. are automatically downgraded to normal jobs running without any dedicated
  338. reservation.
  339. </p>
  340. @param request to remove an existing Reservation (the ReservationRequest
  341. should refer to an existing valid {@link ReservationId})
  342. @return response empty on successfully deleting the existing reservation
  343. @throws YarnException if the request is invalid or reservation cannot be
  344. deleted successfully
  345. @throws IOException]]>
  346. </doc>
  347. </method>
  348. <method name="listReservations" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse"
  349. abstract="false" native="false" synchronized="false"
  350. static="false" final="false" visibility="public"
  351. deprecated="not deprecated">
  352. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"/>
  353. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  354. <exception name="IOException" type="java.io.IOException"/>
  355. <doc>
  356. <![CDATA[<p>
  357. The interface used by clients to get the list of reservations in a plan.
  358. The reservationId will be used to search for reservations to list if it is
  359. provided. Otherwise, it will select active reservations within the
  360. startTime and endTime (inclusive).
  361. </p>
  362. @param request to list reservations in a plan. Contains fields to select
  363. String queue, ReservationId reservationId, long startTime,
  364. long endTime, and a bool includeReservationAllocations.
  365. queue: Required. Cannot be null or empty. Refers to the
  366. reservable queue in the scheduler that was selected when
  367. creating a reservation submission
  368. {@link ReservationSubmissionRequest}.
  369. reservationId: Optional. If provided, other fields will
  370. be ignored.
  371. startTime: Optional. If provided, only reservations that
  372. end after the startTime will be selected. This defaults
  373. to 0 if an invalid number is used.
  374. endTime: Optional. If provided, only reservations that
  375. start on or before endTime will be selected. This defaults
  376. to Long.MAX_VALUE if an invalid number is used.
  377. includeReservationAllocations: Optional. Flag that
  378. determines whether the entire reservation allocations are
  379. to be returned. Reservation allocations are subject to
  380. change in the event of re-planning as described by
  381. {@code ReservationDefinition}.
  382. @return response that contains information about reservations that are
  383. being searched for.
  384. @throws YarnException if the request is invalid
  385. @throws IOException on IO failures]]>
  386. </doc>
  387. </method>
  388. <method name="getNodeToLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse"
  389. abstract="false" native="false" synchronized="false"
  390. static="false" final="false" visibility="public"
  391. deprecated="not deprecated">
  392. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest"/>
  393. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  394. <exception name="IOException" type="java.io.IOException"/>
  395. <doc>
  396. <![CDATA[<p>
  397. The interface used by client to get node to labels mappings in existing cluster
  398. </p>
  399. @param request
  400. @return node to labels mappings
  401. @throws YarnException
  402. @throws IOException]]>
  403. </doc>
  404. </method>
  405. <method name="getLabelsToNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesResponse"
  406. abstract="false" native="false" synchronized="false"
  407. static="false" final="false" visibility="public"
  408. deprecated="not deprecated">
  409. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest"/>
  410. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  411. <exception name="IOException" type="java.io.IOException"/>
  412. <doc>
  413. <![CDATA[<p>
  414. The interface used by client to get labels to nodes mappings
  415. in existing cluster
  416. </p>
  417. @param request
  418. @return labels to nodes mappings
  419. @throws YarnException
  420. @throws IOException]]>
  421. </doc>
  422. </method>
  423. <method name="getClusterNodeLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  424. abstract="false" native="false" synchronized="false"
  425. static="false" final="false" visibility="public"
  426. deprecated="not deprecated">
  427. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"/>
  428. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  429. <exception name="IOException" type="java.io.IOException"/>
  430. <doc>
  431. <![CDATA[<p>
  432. The interface used by client to get node labels in the cluster
  433. </p>
  434. @param request to get node labels collection of this cluster
  435. @return node labels collection of this cluster
  436. @throws YarnException
  437. @throws IOException]]>
  438. </doc>
  439. </method>
  440. <method name="updateApplicationPriority" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse"
  441. abstract="false" native="false" synchronized="false"
  442. static="false" final="false" visibility="public"
  443. deprecated="not deprecated">
  444. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest"/>
  445. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  446. <exception name="IOException" type="java.io.IOException"/>
  447. <doc>
  448. <![CDATA[<p>
  449. The interface used by client to set priority of an application.
  450. </p>
  451. @param request to set priority of an application
  452. @return an empty response
  453. @throws YarnException
  454. @throws IOException]]>
  455. </doc>
  456. </method>
  457. <method name="signalToContainer" return="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse"
  458. abstract="false" native="false" synchronized="false"
  459. static="false" final="false" visibility="public"
  460. deprecated="not deprecated">
  461. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest"/>
  462. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  463. <exception name="IOException" type="java.io.IOException"/>
  464. <doc>
  465. <![CDATA[<p>The interface used by clients to request the
  466. <code>ResourceManager</code> to signal a container. For example,
  467. the client can send command OUTPUT_THREAD_DUMP to dump threads of the
  468. container.</p>
  469. <p>The client, via {@link SignalContainerRequest} provides the
  470. id of the container and the signal command. </p>
  471. <p> In secure mode,the <code>ResourceManager</code> verifies access to the
  472. application before signaling the container.
  473. The user needs to have <code>MODIFY_APP</code> permission.</p>
  474. <p>Currently, the <code>ResourceManager</code> returns an empty response
  475. on success and throws an exception on rejecting the request.</p>
  476. @param request request to signal a container
  477. @return <code>ResourceManager</code> returns an empty response
  478. on success and throws an exception on rejecting the request
  479. @throws YarnException
  480. @throws IOException]]>
  481. </doc>
  482. </method>
  483. <method name="updateApplicationTimeouts" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse"
  484. abstract="false" native="false" synchronized="false"
  485. static="false" final="false" visibility="public"
  486. deprecated="not deprecated">
  487. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest"/>
  488. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  489. <exception name="IOException" type="java.io.IOException"/>
  490. <doc>
  491. <![CDATA[<p>
  492. The interface used by client to set ApplicationTimeouts of an application.
  493. The UpdateApplicationTimeoutsRequest should have timeout value with
  494. absolute time with ISO8601 format <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.
  495. </p>
  496. <b>Note:</b> If application timeout value is less than or equal to current
  497. time then update application throws YarnException.
  498. @param request to set ApplicationTimeouts of an application
  499. @return a response with updated timeouts.
  500. @throws YarnException if update request has empty values or application is
  501. in completing states.
  502. @throws IOException on IO failures]]>
  503. </doc>
  504. </method>
  505. <method name="getResourceTypeInfo" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse"
  506. abstract="false" native="false" synchronized="false"
  507. static="false" final="false" visibility="public"
  508. deprecated="not deprecated">
  509. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest"/>
  510. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  511. <exception name="IOException" type="java.io.IOException"/>
  512. <doc>
  513. <![CDATA[<p>
  514. The interface to get the details for a specific resource profile.
  515. </p>
  516. @param request request to get the details of a resource profile
  517. @return Response containing the details for a particular resource profile
  518. @throws YarnException if any error happens inside YARN
  519. @throws IOException in case of other errors]]>
  520. </doc>
  521. </method>
  522. <doc>
  523. <![CDATA[<p>The protocol between clients and the <code>ResourceManager</code>
  524. to submit/abort jobs and to get information on applications, cluster metrics,
  525. nodes, queues and ACLs.</p>]]>
  526. </doc>
  527. </interface>
  528. <!-- end interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
  529. <!-- start interface org.apache.hadoop.yarn.api.ApplicationConstants -->
  530. <interface name="ApplicationConstants" abstract="true"
  531. static="false" final="false" visibility="public"
  532. deprecated="not deprecated">
  533. <field name="APP_SUBMIT_TIME_ENV" type="java.lang.String"
  534. transient="false" volatile="false"
  535. static="true" final="true" visibility="public"
  536. deprecated="not deprecated">
  537. <doc>
  538. <![CDATA[The environment variable for APP_SUBMIT_TIME. Set in AppMaster environment
  539. only]]>
  540. </doc>
  541. </field>
  542. <field name="CONTAINER_TOKEN_FILE_ENV_NAME" type="java.lang.String"
  543. transient="false" volatile="false"
  544. static="true" final="true" visibility="public"
  545. deprecated="not deprecated">
  546. <doc>
  547. <![CDATA[The cache file into which container token is written]]>
  548. </doc>
  549. </field>
  550. <field name="APPLICATION_WEB_PROXY_BASE_ENV" type="java.lang.String"
  551. transient="false" volatile="false"
  552. static="true" final="true" visibility="public"
  553. deprecated="not deprecated">
  554. <doc>
  555. <![CDATA[The environmental variable for APPLICATION_WEB_PROXY_BASE. Set in
  556. ApplicationMaster's environment only. This states that for all non-relative
  557. web URLs in the app masters web UI what base should they have.]]>
  558. </doc>
  559. </field>
  560. <field name="LOG_DIR_EXPANSION_VAR" type="java.lang.String"
  561. transient="false" volatile="false"
  562. static="true" final="true" visibility="public"
  563. deprecated="not deprecated">
  564. <doc>
  565. <![CDATA[The temporary environmental variable for container log directory. This
  566. should be replaced by real container log directory on container launch.]]>
  567. </doc>
  568. </field>
  569. <field name="CLASS_PATH_SEPARATOR" type="java.lang.String"
  570. transient="false" volatile="false"
  571. static="true" final="true" visibility="public"
  572. deprecated="not deprecated">
  573. <doc>
  574. <![CDATA[This constant is used to construct class path and it will be replaced with
  575. real class path separator(':' for Linux and ';' for Windows) by
  576. NodeManager on container launch. User has to use this constant to construct
  577. class path if user wants cross-platform practice i.e. submit an application
  578. from a Windows client to a Linux/Unix server or vice versa.]]>
  579. </doc>
  580. </field>
  581. <field name="PARAMETER_EXPANSION_LEFT" type="java.lang.String"
  582. transient="false" volatile="false"
  583. static="true" final="true" visibility="public"
  584. deprecated="not deprecated">
  585. <doc>
  586. <![CDATA[The following two constants are used to expand parameter and it will be
  587. replaced with real parameter expansion marker ('%' for Windows and '$' for
  588. Linux) by NodeManager on container launch. For example: {{VAR}} will be
  589. replaced as $VAR on Linux, and %VAR% on Windows. User has to use this
  590. constant to construct class path if user wants cross-platform practice i.e.
  591. submit an application from a Windows client to a Linux/Unix server or vice
  592. versa.]]>
  593. </doc>
  594. </field>
  595. <field name="PARAMETER_EXPANSION_RIGHT" type="java.lang.String"
  596. transient="false" volatile="false"
  597. static="true" final="true" visibility="public"
  598. deprecated="not deprecated">
  599. <doc>
  600. <![CDATA[User has to use this constant to construct class path if user wants
  601. cross-platform practice i.e. submit an application from a Windows client to
  602. a Linux/Unix server or vice versa.]]>
  603. </doc>
  604. </field>
  605. <field name="STDERR" type="java.lang.String"
  606. transient="false" volatile="false"
  607. static="true" final="true" visibility="public"
  608. deprecated="not deprecated">
  609. </field>
  610. <field name="STDOUT" type="java.lang.String"
  611. transient="false" volatile="false"
  612. static="true" final="true" visibility="public"
  613. deprecated="not deprecated">
  614. </field>
  615. <field name="MAX_APP_ATTEMPTS_ENV" type="java.lang.String"
  616. transient="false" volatile="false"
  617. static="true" final="true" visibility="public"
  618. deprecated="not deprecated">
  619. <doc>
  620. <![CDATA[The environment variable for MAX_APP_ATTEMPTS. Set in AppMaster environment
  621. only]]>
  622. </doc>
  623. </field>
  624. <doc>
  625. <![CDATA[This is the API for the applications comprising of constants that YARN sets
  626. up for the applications and the containers.
  627. TODO: Investigate the semantics and security of each cross-boundary refs.]]>
  628. </doc>
  629. </interface>
  630. <!-- end interface org.apache.hadoop.yarn.api.ApplicationConstants -->
  631. <!-- start interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
  632. <interface name="ApplicationHistoryProtocol" abstract="true"
  633. static="false" final="false" visibility="public"
  634. deprecated="not deprecated">
  635. <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
  636. <doc>
  637. <![CDATA[<p>
  638. The protocol between clients and the <code>ApplicationHistoryServer</code> to
  639. get the information of completed applications etc.
  640. </p>]]>
  641. </doc>
  642. </interface>
  643. <!-- end interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
  644. <!-- start interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
  645. <interface name="ApplicationMasterProtocol" abstract="true"
  646. static="false" final="false" visibility="public"
  647. deprecated="not deprecated">
  648. <method name="registerApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse"
  649. abstract="false" native="false" synchronized="false"
  650. static="false" final="false" visibility="public"
  651. deprecated="not deprecated">
  652. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"/>
  653. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  654. <exception name="IOException" type="java.io.IOException"/>
  655. <doc>
  656. <![CDATA[<p>
  657. The interface used by a new <code>ApplicationMaster</code> to register with
  658. the <code>ResourceManager</code>.
  659. </p>
  660. <p>
  661. The <code>ApplicationMaster</code> needs to provide details such as RPC
  662. Port, HTTP tracking url etc. as specified in
  663. {@link RegisterApplicationMasterRequest}.
  664. </p>
  665. <p>
  666. The <code>ResourceManager</code> responds with critical details such as
  667. maximum resource capabilities in the cluster as specified in
  668. {@link RegisterApplicationMasterResponse}.
  669. </p>
  670. <p>
  671. Re-register is only allowed for <code>Unmanaged Application Master</code>
  672. (UAM) HA, with
  673. {@link org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext#getKeepContainersAcrossApplicationAttempts()}
  674. set to true.
  675. </p>
  676. @param request registration request
  677. @return registration respose
  678. @throws YarnException
  679. @throws IOException
  680. @throws InvalidApplicationMasterRequestException The exception is thrown
  681. when an ApplicationMaster tries to register more then once.
  682. @see RegisterApplicationMasterRequest
  683. @see RegisterApplicationMasterResponse]]>
  684. </doc>
  685. </method>
  686. <method name="finishApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse"
  687. abstract="false" native="false" synchronized="false"
  688. static="false" final="false" visibility="public"
  689. deprecated="not deprecated">
  690. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"/>
  691. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  692. <exception name="IOException" type="java.io.IOException"/>
  693. <doc>
  694. <![CDATA[<p>The interface used by an <code>ApplicationMaster</code> to notify the
  695. <code>ResourceManager</code> about its completion (success or failed).</p>
  696. <p>The <code>ApplicationMaster</code> has to provide details such as
  697. final state, diagnostics (in case of failures) etc. as specified in
  698. {@link FinishApplicationMasterRequest}.</p>
  699. <p>The <code>ResourceManager</code> responds with
  700. {@link FinishApplicationMasterResponse}.</p>
  701. @param request completion request
  702. @return completion response
  703. @throws YarnException
  704. @throws IOException
  705. @see FinishApplicationMasterRequest
  706. @see FinishApplicationMasterResponse]]>
  707. </doc>
  708. </method>
  709. <method name="allocate" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  710. abstract="false" native="false" synchronized="false"
  711. static="false" final="false" visibility="public"
  712. deprecated="not deprecated">
  713. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"/>
  714. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  715. <exception name="IOException" type="java.io.IOException"/>
  716. <doc>
  717. <![CDATA[<p>
  718. The main interface between an <code>ApplicationMaster</code> and the
  719. <code>ResourceManager</code>.
  720. </p>
  721. <p>
  722. The <code>ApplicationMaster</code> uses this interface to provide a list of
  723. {@link ResourceRequest} and returns unused {@link Container} allocated to
  724. it via {@link AllocateRequest}. Optionally, the
  725. <code>ApplicationMaster</code> can also <em>blacklist</em> resources which
  726. it doesn't want to use.
  727. </p>
  728. <p>
  729. This also doubles up as a <em>heartbeat</em> to let the
  730. <code>ResourceManager</code> know that the <code>ApplicationMaster</code>
  731. is alive. Thus, applications should periodically make this call to be kept
  732. alive. The frequency depends on
  733. {@link YarnConfiguration#RM_AM_EXPIRY_INTERVAL_MS} which defaults to
  734. {@link YarnConfiguration#DEFAULT_RM_AM_EXPIRY_INTERVAL_MS}.
  735. </p>
  736. <p>
  737. The <code>ResourceManager</code> responds with list of allocated
  738. {@link Container}, status of completed containers and headroom information
  739. for the application.
  740. </p>
  741. <p>
  742. The <code>ApplicationMaster</code> can use the available headroom
  743. (resources) to decide how to utilized allocated resources and make informed
  744. decisions about future resource requests.
  745. </p>
  746. @param request
  747. allocation request
  748. @return allocation response
  749. @throws YarnException
  750. @throws IOException
  751. @throws InvalidApplicationMasterRequestException
  752. This exception is thrown when an ApplicationMaster calls allocate
  753. without registering first.
  754. @throws InvalidResourceBlacklistRequestException
  755. This exception is thrown when an application provides an invalid
  756. specification for blacklist of resources.
  757. @throws InvalidResourceRequestException
  758. This exception is thrown when a {@link ResourceRequest} is out of
  759. the range of the configured lower and upper limits on the
  760. resources.
  761. @see AllocateRequest
  762. @see AllocateResponse]]>
  763. </doc>
  764. </method>
  765. <doc>
  766. <![CDATA[<p>The protocol between a live instance of <code>ApplicationMaster</code>
  767. and the <code>ResourceManager</code>.</p>
  768. <p>This is used by the <code>ApplicationMaster</code> to register/unregister
  769. and to request and obtain resources in the cluster from the
  770. <code>ResourceManager</code>.</p>]]>
  771. </doc>
  772. </interface>
  773. <!-- end interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
  774. <!-- start interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
  775. <interface name="ClientSCMProtocol" abstract="true"
  776. static="false" final="false" visibility="public"
  777. deprecated="not deprecated">
  778. <method name="use" return="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse"
  779. abstract="false" native="false" synchronized="false"
  780. static="false" final="false" visibility="public"
  781. deprecated="not deprecated">
  782. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest"/>
  783. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  784. <exception name="IOException" type="java.io.IOException"/>
  785. <doc>
  786. <![CDATA[<p>
  787. The interface used by clients to claim a resource with the
  788. <code>SharedCacheManager.</code> The client uses a checksum to identify the
  789. resource and an {@link ApplicationId} to identify which application will be
  790. using the resource.
  791. </p>
  792. <p>
  793. The <code>SharedCacheManager</code> responds with whether or not the
  794. resource exists in the cache. If the resource exists, a <code>Path</code>
  795. to the resource in the shared cache is returned. If the resource does not
  796. exist, the response is empty.
  797. </p>
  798. @param request request to claim a resource in the shared cache
  799. @return response indicating if the resource is already in the cache
  800. @throws YarnException
  801. @throws IOException]]>
  802. </doc>
  803. </method>
  804. <method name="release" return="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse"
  805. abstract="false" native="false" synchronized="false"
  806. static="false" final="false" visibility="public"
  807. deprecated="not deprecated">
  808. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest"/>
  809. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  810. <exception name="IOException" type="java.io.IOException"/>
  811. <doc>
  812. <![CDATA[<p>
  813. The interface used by clients to release a resource with the
  814. <code>SharedCacheManager.</code> This method is called once an application
  815. is no longer using a claimed resource in the shared cache. The client uses
  816. a checksum to identify the resource and an {@link ApplicationId} to
  817. identify which application is releasing the resource.
  818. </p>
  819. <p>
  820. Note: This method is an optimization and the client is not required to call
  821. it for correctness.
  822. </p>
  823. <p>
  824. Currently the <code>SharedCacheManager</code> sends an empty response.
  825. </p>
  826. @param request request to release a resource in the shared cache
  827. @return (empty) response on releasing the resource
  828. @throws YarnException
  829. @throws IOException]]>
  830. </doc>
  831. </method>
  832. <doc>
  833. <![CDATA[<p>
  834. The protocol between clients and the <code>SharedCacheManager</code> to claim
  835. and release resources in the shared cache.
  836. </p>]]>
  837. </doc>
  838. </interface>
  839. <!-- end interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
  840. <!-- start interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
  841. <interface name="ContainerManagementProtocol" abstract="true"
  842. static="false" final="false" visibility="public"
  843. deprecated="not deprecated">
  844. <method name="startContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse"
  845. abstract="false" native="false" synchronized="false"
  846. static="false" final="false" visibility="public"
  847. deprecated="not deprecated">
  848. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"/>
  849. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  850. <exception name="IOException" type="java.io.IOException"/>
  851. <doc>
  852. <![CDATA[<p>
  853. The <code>ApplicationMaster</code> provides a list of
  854. {@link StartContainerRequest}s to a <code>NodeManager</code> to
  855. <em>start</em> {@link Container}s allocated to it using this interface.
  856. </p>
  857. <p>
  858. The <code>ApplicationMaster</code> has to provide details such as allocated
  859. resource capability, security tokens (if enabled), command to be executed
  860. to start the container, environment for the process, necessary
  861. binaries/jar/shared-objects etc. via the {@link ContainerLaunchContext} in
  862. the {@link StartContainerRequest}.
  863. </p>
  864. <p>
  865. The <code>NodeManager</code> sends a response via
  866. {@link StartContainersResponse} which includes a list of
  867. {@link Container}s of successfully launched {@link Container}s, a
  868. containerId-to-exception map for each failed {@link StartContainerRequest} in
  869. which the exception indicates errors from per container and a
  870. allServicesMetaData map between the names of auxiliary services and their
  871. corresponding meta-data. Note: None-container-specific exceptions will
  872. still be thrown by the API method itself.
  873. </p>
  874. <p>
  875. The <code>ApplicationMaster</code> can use
  876. {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
  877. statuses of the to-be-launched or launched containers.
  878. </p>
  879. @param request
  880. request to start a list of containers
  881. @return response including conatinerIds of all successfully launched
  882. containers, a containerId-to-exception map for failed requests and
  883. a allServicesMetaData map.
  884. @throws YarnException
  885. @throws IOException]]>
  886. </doc>
  887. </method>
  888. <method name="stopContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse"
  889. abstract="false" native="false" synchronized="false"
  890. static="false" final="false" visibility="public"
  891. deprecated="not deprecated">
  892. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"/>
  893. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  894. <exception name="IOException" type="java.io.IOException"/>
  895. <doc>
  896. <![CDATA[<p>
  897. The <code>ApplicationMaster</code> requests a <code>NodeManager</code> to
  898. <em>stop</em> a list of {@link Container}s allocated to it using this
  899. interface.
  900. </p>
  901. <p>
  902. The <code>ApplicationMaster</code> sends a {@link StopContainersRequest}
  903. which includes the {@link ContainerId}s of the containers to be stopped.
  904. </p>
  905. <p>
  906. The <code>NodeManager</code> sends a response via
  907. {@link StopContainersResponse} which includes a list of {@link ContainerId}
  908. s of successfully stopped containers, a containerId-to-exception map for
  909. each failed request in which the exception indicates errors from per
  910. container. Note: None-container-specific exceptions will still be thrown by
  911. the API method itself. <code>ApplicationMaster</code> can use
  912. {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
  913. statuses of the containers.
  914. </p>
  915. @param request
  916. request to stop a list of containers
  917. @return response which includes a list of containerIds of successfully
  918. stopped containers, a containerId-to-exception map for failed
  919. requests.
  920. @throws YarnException
  921. @throws IOException]]>
  922. </doc>
  923. </method>
  924. <method name="getContainerStatuses" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse"
  925. abstract="false" native="false" synchronized="false"
  926. static="false" final="false" visibility="public"
  927. deprecated="not deprecated">
  928. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"/>
  929. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  930. <exception name="IOException" type="java.io.IOException"/>
  931. <doc>
  932. <![CDATA[<p>
  933. The API used by the <code>ApplicationMaster</code> to request for current
  934. statuses of <code>Container</code>s from the <code>NodeManager</code>.
  935. </p>
  936. <p>
  937. The <code>ApplicationMaster</code> sends a
  938. {@link GetContainerStatusesRequest} which includes the {@link ContainerId}s
  939. of all containers whose statuses are needed.
  940. </p>
  941. <p>
  942. The <code>NodeManager</code> responds with
  943. {@link GetContainerStatusesResponse} which includes a list of
  944. {@link ContainerStatus} of the successfully queried containers and a
  945. containerId-to-exception map for each failed request in which the exception
  946. indicates errors from per container. Note: None-container-specific
  947. exceptions will still be thrown by the API method itself.
  948. </p>
  949. @param request
  950. request to get <code>ContainerStatus</code>es of containers with
  951. the specified <code>ContainerId</code>s
  952. @return response containing the list of <code>ContainerStatus</code> of the
  953. successfully queried containers and a containerId-to-exception map
  954. for failed requests.
  955. @throws YarnException
  956. @throws IOException]]>
  957. </doc>
  958. </method>
  959. <method name="increaseContainersResource" return="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse"
  960. abstract="false" native="false" synchronized="false"
  961. static="false" final="false" visibility="public"
  962. deprecated="not deprecated">
  963. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest"/>
  964. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  965. <exception name="IOException" type="java.io.IOException"/>
  966. <doc>
  967. <![CDATA[<p>
  968. The API used by the <code>ApplicationMaster</code> to request for
  969. resource increase of running containers on the <code>NodeManager</code>.
  970. </p>
  971. @param request
  972. request to increase resource of a list of containers
  973. @return response which includes a list of containerIds of containers
  974. whose resource has been successfully increased and a
  975. containerId-to-exception map for failed requests.
  976. @throws YarnException
  977. @throws IOException]]>
  978. </doc>
  979. </method>
  980. <method name="updateContainer" return="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse"
  981. abstract="false" native="false" synchronized="false"
  982. static="false" final="false" visibility="public"
  983. deprecated="not deprecated">
  984. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest"/>
  985. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  986. <exception name="IOException" type="java.io.IOException"/>
  987. <doc>
  988. <![CDATA[<p>
  989. The API used by the <code>ApplicationMaster</code> to request for
  990. resource update of running containers on the <code>NodeManager</code>.
  991. </p>
  992. @param request
  993. request to update resource of a list of containers
  994. @return response which includes a list of containerIds of containers
  995. whose resource has been successfully updated and a
  996. containerId-to-exception map for failed requests.
  997. @throws YarnException Exception specific to YARN
  998. @throws IOException IOException thrown from NodeManager]]>
  999. </doc>
  1000. </method>
  1001. <method name="signalToContainer" return="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse"
  1002. abstract="false" native="false" synchronized="false"
  1003. static="false" final="false" visibility="public"
  1004. deprecated="not deprecated">
  1005. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest"/>
  1006. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1007. <exception name="IOException" type="java.io.IOException"/>
  1008. </method>
  1009. <method name="localize" return="org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationResponse"
  1010. abstract="false" native="false" synchronized="false"
  1011. static="false" final="false" visibility="public"
  1012. deprecated="not deprecated">
  1013. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest"/>
  1014. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1015. <exception name="IOException" type="java.io.IOException"/>
  1016. <doc>
  1017. <![CDATA[Localize resources required by the container.
  1018. Currently, this API only works for running containers.
  1019. @param request Specify the resources to be localized.
  1020. @return Response that the localize request is accepted.
  1021. @throws YarnException Exception specific to YARN
  1022. @throws IOException IOException thrown from the RPC layer.]]>
  1023. </doc>
  1024. </method>
  1025. <method name="reInitializeContainer" return="org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerResponse"
  1026. abstract="false" native="false" synchronized="false"
  1027. static="false" final="false" visibility="public"
  1028. deprecated="not deprecated">
  1029. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest"/>
  1030. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1031. <exception name="IOException" type="java.io.IOException"/>
  1032. <doc>
  1033. <![CDATA[ReInitialize the Container with a new Launch Context.
  1034. @param request Specify the new ContainerLaunchContext.
  1035. @return Response that the ReInitialize request is accepted.
  1036. @throws YarnException Exception specific to YARN.
  1037. @throws IOException IOException thrown from the RPC layer.]]>
  1038. </doc>
  1039. </method>
  1040. <method name="restartContainer" return="org.apache.hadoop.yarn.api.protocolrecords.RestartContainerResponse"
  1041. abstract="false" native="false" synchronized="false"
  1042. static="false" final="false" visibility="public"
  1043. deprecated="not deprecated">
  1044. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  1045. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1046. <exception name="IOException" type="java.io.IOException"/>
  1047. <doc>
  1048. <![CDATA[Restart the container.
  1049. @param containerId Container Id.
  1050. @return Response that the restart request is accepted.
  1051. @throws YarnException Exception specific to YARN.
  1052. @throws IOException IOException thrown from the RPC layer.]]>
  1053. </doc>
  1054. </method>
  1055. <method name="rollbackLastReInitialization" return="org.apache.hadoop.yarn.api.protocolrecords.RollbackResponse"
  1056. abstract="false" native="false" synchronized="false"
  1057. static="false" final="false" visibility="public"
  1058. deprecated="not deprecated">
  1059. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  1060. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1061. <exception name="IOException" type="java.io.IOException"/>
  1062. <doc>
  1063. <![CDATA[Rollback the Last ReInitialization if possible.
  1064. @param containerId Container Id.
  1065. @return Response that the rollback request is accepted.
  1066. @throws YarnException Exception specific to YARN.
  1067. @throws IOException IOException thrown from the RPC layer.]]>
  1068. </doc>
  1069. </method>
  1070. <method name="commitLastReInitialization" return="org.apache.hadoop.yarn.api.protocolrecords.CommitResponse"
  1071. abstract="false" native="false" synchronized="false"
  1072. static="false" final="false" visibility="public"
  1073. deprecated="not deprecated">
  1074. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  1075. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  1076. <exception name="IOException" type="java.io.IOException"/>
  1077. <doc>
  1078. <![CDATA[Commit the Last ReInitialization if possible. Once the reinitialization
  1079. has been committed, It cannot be rolled back.
  1080. @param containerId Container Id.
  1081. @return Response that the commit request is accepted.
  1082. @throws YarnException Exception specific to YARN.
  1083. @throws IOException IOException thrown from the RPC layer.]]>
  1084. </doc>
  1085. </method>
  1086. <doc>
  1087. <![CDATA[<p>The protocol between an <code>ApplicationMaster</code> and a
  1088. <code>NodeManager</code> to start/stop and increase resource of containers
  1089. and to get status of running containers.</p>
  1090. <p>If security is enabled the <code>NodeManager</code> verifies that the
  1091. <code>ApplicationMaster</code> has truly been allocated the container
  1092. by the <code>ResourceManager</code> and also verifies all interactions such
  1093. as stopping the container or obtaining status information for the container.
  1094. </p>]]>
  1095. </doc>
  1096. </interface>
  1097. <!-- end interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
  1098. </package>
  1099. <package name="org.apache.hadoop.yarn.api.protocolrecords">
  1100. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
  1101. <class name="AllocateRequest" extends="java.lang.Object"
  1102. abstract="true"
  1103. static="false" final="false" visibility="public"
  1104. deprecated="not deprecated">
  1105. <constructor name="AllocateRequest"
  1106. static="false" final="false" visibility="public"
  1107. deprecated="not deprecated">
  1108. </constructor>
  1109. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1110. abstract="false" native="false" synchronized="false"
  1111. static="true" final="false" visibility="public"
  1112. deprecated="not deprecated">
  1113. <param name="responseID" type="int"/>
  1114. <param name="appProgress" type="float"/>
  1115. <param name="resourceAsk" type="java.util.List"/>
  1116. <param name="containersToBeReleased" type="java.util.List"/>
  1117. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1118. </method>
  1119. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1120. abstract="false" native="false" synchronized="false"
  1121. static="true" final="false" visibility="public"
  1122. deprecated="not deprecated">
  1123. <param name="responseID" type="int"/>
  1124. <param name="appProgress" type="float"/>
  1125. <param name="resourceAsk" type="java.util.List"/>
  1126. <param name="containersToBeReleased" type="java.util.List"/>
  1127. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1128. <param name="increaseRequests" type="java.util.List"/>
  1129. <doc>
  1130. <![CDATA[Use {@link AllocateRequest#newInstance(int, float, List, List,
  1131. ResourceBlacklistRequest, List)} instead
  1132. @param responseID responseId
  1133. @param appProgress appProgress
  1134. @param resourceAsk resourceAsk
  1135. @param containersToBeReleased containersToBeReleased
  1136. @param resourceBlacklistRequest resourceBlacklistRequest
  1137. @param increaseRequests increaseRequests
  1138. @return AllocateRequest]]>
  1139. </doc>
  1140. </method>
  1141. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1142. abstract="false" native="false" synchronized="false"
  1143. static="true" final="false" visibility="public"
  1144. deprecated="not deprecated">
  1145. <param name="responseID" type="int"/>
  1146. <param name="appProgress" type="float"/>
  1147. <param name="resourceAsk" type="java.util.List"/>
  1148. <param name="containersToBeReleased" type="java.util.List"/>
  1149. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1150. <param name="trackingUrl" type="java.lang.String"/>
  1151. </method>
  1152. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1153. abstract="false" native="false" synchronized="false"
  1154. static="true" final="false" visibility="public"
  1155. deprecated="not deprecated">
  1156. <param name="responseID" type="int"/>
  1157. <param name="appProgress" type="float"/>
  1158. <param name="resourceAsk" type="java.util.List"/>
  1159. <param name="containersToBeReleased" type="java.util.List"/>
  1160. <param name="updateRequests" type="java.util.List"/>
  1161. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1162. </method>
  1163. <method name="getResponseId" return="int"
  1164. abstract="true" native="false" synchronized="false"
  1165. static="false" final="false" visibility="public"
  1166. deprecated="not deprecated">
  1167. <doc>
  1168. <![CDATA[Get the <em>response id</em> used to track duplicate responses.
  1169. @return <em>response id</em>]]>
  1170. </doc>
  1171. </method>
  1172. <method name="setResponseId"
  1173. abstract="true" native="false" synchronized="false"
  1174. static="false" final="false" visibility="public"
  1175. deprecated="not deprecated">
  1176. <param name="id" type="int"/>
  1177. <doc>
  1178. <![CDATA[Set the <em>response id</em> used to track duplicate responses.
  1179. @param id <em>response id</em>]]>
  1180. </doc>
  1181. </method>
  1182. <method name="getProgress" return="float"
  1183. abstract="true" native="false" synchronized="false"
  1184. static="false" final="false" visibility="public"
  1185. deprecated="not deprecated">
  1186. <doc>
  1187. <![CDATA[Get the <em>current progress</em> of application.
  1188. @return <em>current progress</em> of application]]>
  1189. </doc>
  1190. </method>
  1191. <method name="setProgress"
  1192. abstract="true" native="false" synchronized="false"
  1193. static="false" final="false" visibility="public"
  1194. deprecated="not deprecated">
  1195. <param name="progress" type="float"/>
  1196. <doc>
  1197. <![CDATA[Set the <em>current progress</em> of application
  1198. @param progress <em>current progress</em> of application]]>
  1199. </doc>
  1200. </method>
  1201. <method name="getAskList" return="java.util.List"
  1202. abstract="true" native="false" synchronized="false"
  1203. static="false" final="false" visibility="public"
  1204. deprecated="not deprecated">
  1205. <doc>
  1206. <![CDATA[Get the list of <code>ResourceRequest</code> to update the
  1207. <code>ResourceManager</code> about the application's resource requirements.
  1208. @return the list of <code>ResourceRequest</code>
  1209. @see ResourceRequest]]>
  1210. </doc>
  1211. </method>
  1212. <method name="setAskList"
  1213. abstract="true" native="false" synchronized="false"
  1214. static="false" final="false" visibility="public"
  1215. deprecated="not deprecated">
  1216. <param name="resourceRequests" type="java.util.List"/>
  1217. <doc>
  1218. <![CDATA[Set list of <code>ResourceRequest</code> to update the
  1219. <code>ResourceManager</code> about the application's resource requirements.
  1220. @param resourceRequests list of <code>ResourceRequest</code> to update the
  1221. <code>ResourceManager</code> about the application's
  1222. resource requirements
  1223. @see ResourceRequest]]>
  1224. </doc>
  1225. </method>
  1226. <method name="getReleaseList" return="java.util.List"
  1227. abstract="true" native="false" synchronized="false"
  1228. static="false" final="false" visibility="public"
  1229. deprecated="not deprecated">
  1230. <doc>
  1231. <![CDATA[Get the list of <code>ContainerId</code> of containers being
  1232. released by the <code>ApplicationMaster</code>.
  1233. @return list of <code>ContainerId</code> of containers being
  1234. released by the <code>ApplicationMaster</code>]]>
  1235. </doc>
  1236. </method>
  1237. <method name="setReleaseList"
  1238. abstract="true" native="false" synchronized="false"
  1239. static="false" final="false" visibility="public"
  1240. deprecated="not deprecated">
  1241. <param name="releaseContainers" type="java.util.List"/>
  1242. <doc>
  1243. <![CDATA[Set the list of <code>ContainerId</code> of containers being
  1244. released by the <code>ApplicationMaster</code>
  1245. @param releaseContainers list of <code>ContainerId</code> of
  1246. containers being released by the
  1247. <code>ApplicationMaster</code>]]>
  1248. </doc>
  1249. </method>
  1250. <method name="getResourceBlacklistRequest" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
  1251. abstract="true" native="false" synchronized="false"
  1252. static="false" final="false" visibility="public"
  1253. deprecated="not deprecated">
  1254. <doc>
  1255. <![CDATA[Get the <code>ResourceBlacklistRequest</code> being sent by the
  1256. <code>ApplicationMaster</code>.
  1257. @return the <code>ResourceBlacklistRequest</code> being sent by the
  1258. <code>ApplicationMaster</code>
  1259. @see ResourceBlacklistRequest]]>
  1260. </doc>
  1261. </method>
  1262. <method name="setResourceBlacklistRequest"
  1263. abstract="true" native="false" synchronized="false"
  1264. static="false" final="false" visibility="public"
  1265. deprecated="not deprecated">
  1266. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1267. <doc>
  1268. <![CDATA[Set the <code>ResourceBlacklistRequest</code> to inform the
  1269. <code>ResourceManager</code> about the blacklist additions and removals
  1270. per the <code>ApplicationMaster</code>.
  1271. @param resourceBlacklistRequest the <code>ResourceBlacklistRequest</code>
  1272. to inform the <code>ResourceManager</code> about
  1273. the blacklist additions and removals
  1274. per the <code>ApplicationMaster</code>
  1275. @see ResourceBlacklistRequest]]>
  1276. </doc>
  1277. </method>
  1278. <method name="getIncreaseRequests" return="java.util.List"
  1279. abstract="true" native="false" synchronized="false"
  1280. static="false" final="false" visibility="public"
  1281. deprecated="not deprecated">
  1282. <doc>
  1283. <![CDATA[Use {@link AllocateRequest#getUpdateRequests()} instead
  1284. @return ContainerResourceIncreaseRequests]]>
  1285. </doc>
  1286. </method>
  1287. <method name="setIncreaseRequests"
  1288. abstract="true" native="false" synchronized="false"
  1289. static="false" final="false" visibility="public"
  1290. deprecated="not deprecated">
  1291. <param name="increaseRequests" type="java.util.List"/>
  1292. <doc>
  1293. <![CDATA[Use {@link AllocateRequest#setUpdateRequests(List)} instead
  1294. @param increaseRequests increaseRequests]]>
  1295. </doc>
  1296. </method>
  1297. <method name="getUpdateRequests" return="java.util.List"
  1298. abstract="true" native="false" synchronized="false"
  1299. static="false" final="false" visibility="public"
  1300. deprecated="not deprecated">
  1301. <doc>
  1302. <![CDATA[Get the list of container update requests being sent by the
  1303. <code>ApplicationMaster</code>.
  1304. @return list of {@link UpdateContainerRequest}
  1305. being sent by the
  1306. <code>ApplicationMaster</code>.]]>
  1307. </doc>
  1308. </method>
  1309. <method name="setUpdateRequests"
  1310. abstract="true" native="false" synchronized="false"
  1311. static="false" final="false" visibility="public"
  1312. deprecated="not deprecated">
  1313. <param name="updateRequests" type="java.util.List"/>
  1314. <doc>
  1315. <![CDATA[Set the list of container update requests to inform the
  1316. <code>ResourceManager</code> about the containers that need to be
  1317. updated.
  1318. @param updateRequests list of <code>UpdateContainerRequest</code> for
  1319. containers to be updated]]>
  1320. </doc>
  1321. </method>
  1322. <method name="getTrackingUrl" return="java.lang.String"
  1323. abstract="true" native="false" synchronized="false"
  1324. static="false" final="false" visibility="public"
  1325. deprecated="not deprecated">
  1326. <doc>
  1327. <![CDATA[Get the tracking url update for this heartbeat.
  1328. @return tracking url to update this application with]]>
  1329. </doc>
  1330. </method>
  1331. <method name="setTrackingUrl"
  1332. abstract="true" native="false" synchronized="false"
  1333. static="false" final="false" visibility="public"
  1334. deprecated="not deprecated">
  1335. <param name="trackingUrl" type="java.lang.String"/>
  1336. <doc>
  1337. <![CDATA[Set the new tracking url for this application.
  1338. @param trackingUrl the new tracking url]]>
  1339. </doc>
  1340. </method>
  1341. <method name="newBuilder" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1342. abstract="false" native="false" synchronized="false"
  1343. static="true" final="false" visibility="public"
  1344. deprecated="not deprecated">
  1345. </method>
  1346. <doc>
  1347. <![CDATA[<p>The core request sent by the <code>ApplicationMaster</code> to the
  1348. <code>ResourceManager</code> to obtain resources in the cluster.</p>
  1349. <p>The request includes:
  1350. <ul>
  1351. <li>A response id to track duplicate responses.</li>
  1352. <li>Progress information.</li>
  1353. <li>
  1354. A list of {@link ResourceRequest} to inform the
  1355. <code>ResourceManager</code> about the application's
  1356. resource requirements.
  1357. </li>
  1358. <li>
  1359. A list of unused {@link Container} which are being returned.
  1360. </li>
  1361. <li>
  1362. A list of {@link UpdateContainerRequest} to inform
  1363. the <code>ResourceManager</code> about the change in
  1364. requirements of running containers.
  1365. </li>
  1366. </ul>
  1367. @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
  1368. </doc>
  1369. </class>
  1370. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
  1371. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder -->
  1372. <class name="AllocateRequest.AllocateRequestBuilder" extends="java.lang.Object"
  1373. abstract="false"
  1374. static="true" final="true" visibility="public"
  1375. deprecated="not deprecated">
  1376. <method name="responseId" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1377. abstract="false" native="false" synchronized="false"
  1378. static="false" final="false" visibility="public"
  1379. deprecated="not deprecated">
  1380. <param name="responseId" type="int"/>
  1381. <doc>
  1382. <![CDATA[Set the <code>responseId</code> of the request.
  1383. @see AllocateRequest#setResponseId(int)
  1384. @param responseId <code>responseId</code> of the request
  1385. @return {@link AllocateRequestBuilder}]]>
  1386. </doc>
  1387. </method>
  1388. <method name="progress" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1389. abstract="false" native="false" synchronized="false"
  1390. static="false" final="false" visibility="public"
  1391. deprecated="not deprecated">
  1392. <param name="progress" type="float"/>
  1393. <doc>
  1394. <![CDATA[Set the <code>progress</code> of the request.
  1395. @see AllocateRequest#setProgress(float)
  1396. @param progress <code>progress</code> of the request
  1397. @return {@link AllocateRequestBuilder}]]>
  1398. </doc>
  1399. </method>
  1400. <method name="askList" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1401. abstract="false" native="false" synchronized="false"
  1402. static="false" final="false" visibility="public"
  1403. deprecated="not deprecated">
  1404. <param name="askList" type="java.util.List"/>
  1405. <doc>
  1406. <![CDATA[Set the <code>askList</code> of the request.
  1407. @see AllocateRequest#setAskList(List)
  1408. @param askList <code>askList</code> of the request
  1409. @return {@link AllocateRequestBuilder}]]>
  1410. </doc>
  1411. </method>
  1412. <method name="releaseList" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1413. abstract="false" native="false" synchronized="false"
  1414. static="false" final="false" visibility="public"
  1415. deprecated="not deprecated">
  1416. <param name="releaseList" type="java.util.List"/>
  1417. <doc>
  1418. <![CDATA[Set the <code>releaseList</code> of the request.
  1419. @see AllocateRequest#setReleaseList(List)
  1420. @param releaseList <code>releaseList</code> of the request
  1421. @return {@link AllocateRequestBuilder}]]>
  1422. </doc>
  1423. </method>
  1424. <method name="resourceBlacklistRequest" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1425. abstract="false" native="false" synchronized="false"
  1426. static="false" final="false" visibility="public"
  1427. deprecated="not deprecated">
  1428. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1429. <doc>
  1430. <![CDATA[Set the <code>resourceBlacklistRequest</code> of the request.
  1431. @see AllocateRequest#setResourceBlacklistRequest(
  1432. ResourceBlacklistRequest)
  1433. @param resourceBlacklistRequest
  1434. <code>resourceBlacklistRequest</code> of the request
  1435. @return {@link AllocateRequestBuilder}]]>
  1436. </doc>
  1437. </method>
  1438. <method name="updateRequests" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1439. abstract="false" native="false" synchronized="false"
  1440. static="false" final="false" visibility="public"
  1441. deprecated="not deprecated">
  1442. <param name="updateRequests" type="java.util.List"/>
  1443. <doc>
  1444. <![CDATA[Set the <code>updateRequests</code> of the request.
  1445. @see AllocateRequest#setUpdateRequests(List)
  1446. @param updateRequests <code>updateRequests</code> of the request
  1447. @return {@link AllocateRequestBuilder}]]>
  1448. </doc>
  1449. </method>
  1450. <method name="trackingUrl" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
  1451. abstract="false" native="false" synchronized="false"
  1452. static="false" final="false" visibility="public"
  1453. deprecated="not deprecated">
  1454. <param name="trackingUrl" type="java.lang.String"/>
  1455. <doc>
  1456. <![CDATA[Set the <code>trackingUrl</code> of the request.
  1457. @see AllocateRequest#setTrackingUrl(String)
  1458. @param trackingUrl new tracking url
  1459. @return {@link AllocateRequestBuilder}]]>
  1460. </doc>
  1461. </method>
  1462. <method name="build" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  1463. abstract="false" native="false" synchronized="false"
  1464. static="false" final="false" visibility="public"
  1465. deprecated="not deprecated">
  1466. <doc>
  1467. <![CDATA[Return generated {@link AllocateRequest} object.
  1468. @return {@link AllocateRequest}]]>
  1469. </doc>
  1470. </method>
  1471. <doc>
  1472. <![CDATA[Class to construct instances of {@link AllocateRequest} with specific
  1473. options.]]>
  1474. </doc>
  1475. </class>
  1476. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder -->
  1477. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
  1478. <class name="AllocateResponse" extends="java.lang.Object"
  1479. abstract="true"
  1480. static="false" final="false" visibility="public"
  1481. deprecated="not deprecated">
  1482. <constructor name="AllocateResponse"
  1483. static="false" final="false" visibility="public"
  1484. deprecated="not deprecated">
  1485. </constructor>
  1486. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1487. abstract="false" native="false" synchronized="false"
  1488. static="true" final="false" visibility="public"
  1489. deprecated="not deprecated">
  1490. <param name="responseId" type="int"/>
  1491. <param name="completedContainers" type="java.util.List"/>
  1492. <param name="allocatedContainers" type="java.util.List"/>
  1493. <param name="updatedNodes" type="java.util.List"/>
  1494. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1495. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1496. <param name="numClusterNodes" type="int"/>
  1497. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1498. <param name="nmTokens" type="java.util.List"/>
  1499. </method>
  1500. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1501. abstract="false" native="false" synchronized="false"
  1502. static="true" final="false" visibility="public"
  1503. deprecated="not deprecated">
  1504. <param name="responseId" type="int"/>
  1505. <param name="completedContainers" type="java.util.List"/>
  1506. <param name="allocatedContainers" type="java.util.List"/>
  1507. <param name="updatedNodes" type="java.util.List"/>
  1508. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1509. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1510. <param name="numClusterNodes" type="int"/>
  1511. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1512. <param name="nmTokens" type="java.util.List"/>
  1513. <param name="increasedContainers" type="java.util.List"/>
  1514. <param name="decreasedContainers" type="java.util.List"/>
  1515. <param name="collectorInfo" type="org.apache.hadoop.yarn.api.records.CollectorInfo"/>
  1516. <doc>
  1517. <![CDATA[Use {@link AllocateResponse#newInstance(int, List, List, List, Resource,
  1518. AMCommand, int, PreemptionMessage, List, Token, List, CollectorInfo)}
  1519. instead.
  1520. @param responseId responseId
  1521. @param completedContainers completedContainers
  1522. @param allocatedContainers allocatedContainers
  1523. @param updatedNodes updatedNodes
  1524. @param availResources availResources
  1525. @param command command
  1526. @param numClusterNodes numClusterNodes
  1527. @param preempt preempt
  1528. @param nmTokens nmTokens
  1529. @param increasedContainers increasedContainers
  1530. @param decreasedContainers decreasedContainers
  1531. @return AllocateResponse]]>
  1532. </doc>
  1533. </method>
  1534. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1535. abstract="false" native="false" synchronized="false"
  1536. static="true" final="false" visibility="public"
  1537. deprecated="not deprecated">
  1538. <param name="responseId" type="int"/>
  1539. <param name="completedContainers" type="java.util.List"/>
  1540. <param name="allocatedContainers" type="java.util.List"/>
  1541. <param name="updatedNodes" type="java.util.List"/>
  1542. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1543. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1544. <param name="numClusterNodes" type="int"/>
  1545. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1546. <param name="nmTokens" type="java.util.List"/>
  1547. <param name="updatedContainers" type="java.util.List"/>
  1548. </method>
  1549. <method name="getAMCommand" return="org.apache.hadoop.yarn.api.records.AMCommand"
  1550. abstract="true" native="false" synchronized="false"
  1551. static="false" final="false" visibility="public"
  1552. deprecated="not deprecated">
  1553. <doc>
  1554. <![CDATA[If the <code>ResourceManager</code> needs the
  1555. <code>ApplicationMaster</code> to take some action then it will send an
  1556. AMCommand to the <code>ApplicationMaster</code>. See <code>AMCommand</code>
  1557. for details on commands and actions for them.
  1558. @return <code>AMCommand</code> if the <code>ApplicationMaster</code> should
  1559. take action, <code>null</code> otherwise
  1560. @see AMCommand]]>
  1561. </doc>
  1562. </method>
  1563. <method name="getResponseId" return="int"
  1564. abstract="true" native="false" synchronized="false"
  1565. static="false" final="false" visibility="public"
  1566. deprecated="not deprecated">
  1567. <doc>
  1568. <![CDATA[Get the <em>last response id</em>.
  1569. @return <em>last response id</em>]]>
  1570. </doc>
  1571. </method>
  1572. <method name="getAllocatedContainers" return="java.util.List"
  1573. abstract="true" native="false" synchronized="false"
  1574. static="false" final="false" visibility="public"
  1575. deprecated="not deprecated">
  1576. <doc>
  1577. <![CDATA[Get the list of <em>newly allocated</em> <code>Container</code> by the
  1578. <code>ResourceManager</code>.
  1579. @return list of <em>newly allocated</em> <code>Container</code>]]>
  1580. </doc>
  1581. </method>
  1582. <method name="getAvailableResources" return="org.apache.hadoop.yarn.api.records.Resource"
  1583. abstract="true" native="false" synchronized="false"
  1584. static="false" final="false" visibility="public"
  1585. deprecated="not deprecated">
  1586. <doc>
  1587. <![CDATA[Get the <em>available headroom</em> for resources in the cluster for the
  1588. application.
  1589. @return limit of available headroom for resources in the cluster for the
  1590. application]]>
  1591. </doc>
  1592. </method>
  1593. <method name="getCompletedContainersStatuses" return="java.util.List"
  1594. abstract="true" native="false" synchronized="false"
  1595. static="false" final="false" visibility="public"
  1596. deprecated="not deprecated">
  1597. <doc>
  1598. <![CDATA[Get the list of <em>completed containers' statuses</em>.
  1599. @return the list of <em>completed containers' statuses</em>]]>
  1600. </doc>
  1601. </method>
  1602. <method name="getUpdatedNodes" return="java.util.List"
  1603. abstract="true" native="false" synchronized="false"
  1604. static="false" final="false" visibility="public"
  1605. deprecated="not deprecated">
  1606. <doc>
  1607. <![CDATA[Get the list of <em>updated <code>NodeReport</code>s</em>. Updates could
  1608. be changes in health, availability etc of the nodes.
  1609. @return The delta of updated nodes since the last response]]>
  1610. </doc>
  1611. </method>
  1612. <method name="getNumClusterNodes" return="int"
  1613. abstract="true" native="false" synchronized="false"
  1614. static="false" final="false" visibility="public"
  1615. deprecated="not deprecated">
  1616. <doc>
  1617. <![CDATA[Get the number of hosts available on the cluster.
  1618. @return the available host count.]]>
  1619. </doc>
  1620. </method>
  1621. <method name="getPreemptionMessage" return="org.apache.hadoop.yarn.api.records.PreemptionMessage"
  1622. abstract="true" native="false" synchronized="false"
  1623. static="false" final="false" visibility="public"
  1624. deprecated="not deprecated">
  1625. <doc>
  1626. <![CDATA[Get the description of containers owned by the AM, but requested back by
  1627. the cluster. Note that the RM may have an inconsistent view of the
  1628. resources owned by the AM. These messages are advisory, and the AM may
  1629. elect to ignore them.
  1630. <p>
  1631. The message is a snapshot of the resources the RM wants back from the AM.
  1632. While demand persists, the RM will repeat its request; applications should
  1633. not interpret each message as a request for <em>additional</em>
  1634. resources on top of previous messages. Resources requested consistently
  1635. over some duration may be forcibly killed by the RM.
  1636. @return A specification of the resources to reclaim from this AM.]]>
  1637. </doc>
  1638. </method>
  1639. <method name="getNMTokens" return="java.util.List"
  1640. abstract="true" native="false" synchronized="false"
  1641. static="false" final="false" visibility="public"
  1642. deprecated="not deprecated">
  1643. <doc>
  1644. <![CDATA[Get the list of NMTokens required for communicating with NM. New NMTokens
  1645. issued only if
  1646. <p>
  1647. 1) AM is receiving first container on underlying NodeManager.<br>
  1648. OR<br>
  1649. 2) NMToken master key rolled over in ResourceManager and AM is getting new
  1650. container on the same underlying NodeManager.
  1651. <p>
  1652. AM will receive one NMToken per NM irrespective of the number of containers
  1653. issued on same NM. AM is expected to store these tokens until issued a
  1654. new token for the same NM.
  1655. @return list of NMTokens required for communicating with NM]]>
  1656. </doc>
  1657. </method>
  1658. <method name="getUpdatedContainers" return="java.util.List"
  1659. abstract="true" native="false" synchronized="false"
  1660. static="false" final="false" visibility="public"
  1661. deprecated="not deprecated">
  1662. <doc>
  1663. <![CDATA[Get the list of newly updated containers by
  1664. <code>ResourceManager</code>.
  1665. @return list of newly increased containers]]>
  1666. </doc>
  1667. </method>
  1668. <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
  1669. abstract="true" native="false" synchronized="false"
  1670. static="false" final="false" visibility="public"
  1671. deprecated="not deprecated">
  1672. <doc>
  1673. <![CDATA[The AMRMToken that belong to this attempt
  1674. @return The AMRMToken that belong to this attempt]]>
  1675. </doc>
  1676. </method>
  1677. <method name="getApplicationPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  1678. abstract="true" native="false" synchronized="false"
  1679. static="false" final="false" visibility="public"
  1680. deprecated="not deprecated">
  1681. <doc>
  1682. <![CDATA[Priority of the application
  1683. @return get application priority]]>
  1684. </doc>
  1685. </method>
  1686. <method name="getCollectorInfo" return="org.apache.hadoop.yarn.api.records.CollectorInfo"
  1687. abstract="true" native="false" synchronized="false"
  1688. static="false" final="false" visibility="public"
  1689. deprecated="not deprecated">
  1690. <doc>
  1691. <![CDATA[The data associated with the collector that belongs to this app. Contains
  1692. address and token alongwith identification information.
  1693. @return The data of collector that belong to this attempt]]>
  1694. </doc>
  1695. </method>
  1696. <method name="getUpdateErrors" return="java.util.List"
  1697. abstract="false" native="false" synchronized="false"
  1698. static="false" final="false" visibility="public"
  1699. deprecated="not deprecated">
  1700. <doc>
  1701. <![CDATA[Get the list of container update errors to inform the
  1702. Application Master about the container updates that could not be
  1703. satisfied due to error.
  1704. @return List of Update Container Errors.]]>
  1705. </doc>
  1706. </method>
  1707. <method name="setUpdateErrors"
  1708. abstract="false" native="false" synchronized="false"
  1709. static="false" final="false" visibility="public"
  1710. deprecated="not deprecated">
  1711. <param name="updateErrors" type="java.util.List"/>
  1712. <doc>
  1713. <![CDATA[Set the list of container update errors to inform the
  1714. Application Master about the container updates that could not be
  1715. satisfied due to error.
  1716. @param updateErrors list of <code>UpdateContainerError</code> for
  1717. containers updates requests that were in error]]>
  1718. </doc>
  1719. </method>
  1720. <method name="getIncreasedContainers" return="java.util.List"
  1721. abstract="true" native="false" synchronized="false"
  1722. static="false" final="false" visibility="public"
  1723. deprecated="not deprecated">
  1724. <doc>
  1725. <![CDATA[Use {@link AllocateResponse#getUpdatedContainers()} instead
  1726. @return null]]>
  1727. </doc>
  1728. </method>
  1729. <method name="getDecreasedContainers" return="java.util.List"
  1730. abstract="true" native="false" synchronized="false"
  1731. static="false" final="false" visibility="public"
  1732. deprecated="not deprecated">
  1733. <doc>
  1734. <![CDATA[Use {@link AllocateResponse#getUpdatedContainers()} instead
  1735. @return null]]>
  1736. </doc>
  1737. </method>
  1738. <doc>
  1739. <![CDATA[The response sent by the <code>ResourceManager</code> the
  1740. <code>ApplicationMaster</code> during resource negotiation.
  1741. <p>
  1742. The response, includes:
  1743. <ul>
  1744. <li>Response ID to track duplicate responses.</li>
  1745. <li>
  1746. An AMCommand sent by ResourceManager to let the
  1747. {@code ApplicationMaster} take some actions (resync, shutdown etc.).
  1748. </li>
  1749. <li>A list of newly allocated {@link Container}.</li>
  1750. <li>A list of completed {@link Container}s' statuses.</li>
  1751. <li>
  1752. The available headroom for resources in the cluster for the
  1753. application.
  1754. </li>
  1755. <li>A list of nodes whose status has been updated.</li>
  1756. <li>The number of available nodes in a cluster.</li>
  1757. <li>A description of resources requested back by the cluster</li>
  1758. <li>AMRMToken, if AMRMToken has been rolled over</li>
  1759. <li>
  1760. A list of {@link Container} representing the containers
  1761. whose resource has been increased.
  1762. </li>
  1763. <li>
  1764. A list of {@link Container} representing the containers
  1765. whose resource has been decreased.
  1766. </li>
  1767. </ul>
  1768. @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
  1769. </doc>
  1770. </class>
  1771. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
  1772. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
  1773. <class name="ApplicationsRequestScope" extends="java.lang.Enum"
  1774. abstract="false"
  1775. static="false" final="true" visibility="public"
  1776. deprecated="not deprecated">
  1777. <method name="values" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope[]"
  1778. abstract="false" native="false" synchronized="false"
  1779. static="true" final="false" visibility="public"
  1780. deprecated="not deprecated">
  1781. </method>
  1782. <method name="valueOf" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"
  1783. abstract="false" native="false" synchronized="false"
  1784. static="true" final="false" visibility="public"
  1785. deprecated="not deprecated">
  1786. <param name="name" type="java.lang.String"/>
  1787. </method>
  1788. <doc>
  1789. <![CDATA[Enumeration that controls the scope of applications fetched]]>
  1790. </doc>
  1791. </class>
  1792. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
  1793. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.CommitResponse -->
  1794. <class name="CommitResponse" extends="java.lang.Object"
  1795. abstract="true"
  1796. static="false" final="false" visibility="public"
  1797. deprecated="not deprecated">
  1798. <constructor name="CommitResponse"
  1799. static="false" final="false" visibility="public"
  1800. deprecated="not deprecated">
  1801. </constructor>
  1802. <doc>
  1803. <![CDATA[Response to Commit Container Request.]]>
  1804. </doc>
  1805. </class>
  1806. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.CommitResponse -->
  1807. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest -->
  1808. <class name="ContainerUpdateRequest" extends="java.lang.Object"
  1809. abstract="true"
  1810. static="false" final="false" visibility="public"
  1811. deprecated="not deprecated">
  1812. <constructor name="ContainerUpdateRequest"
  1813. static="false" final="false" visibility="public"
  1814. deprecated="not deprecated">
  1815. </constructor>
  1816. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest"
  1817. abstract="false" native="false" synchronized="false"
  1818. static="true" final="false" visibility="public"
  1819. deprecated="not deprecated">
  1820. <param name="containersToIncrease" type="java.util.List"/>
  1821. </method>
  1822. <method name="getContainersToUpdate" return="java.util.List"
  1823. abstract="true" native="false" synchronized="false"
  1824. static="false" final="false" visibility="public"
  1825. deprecated="not deprecated">
  1826. <doc>
  1827. <![CDATA[Get a list of container tokens to be used for authorization during
  1828. container resource update.
  1829. <p>
  1830. Note: {@link NMToken} will be used for authenticating communication with
  1831. {@code NodeManager}.
  1832. @return the list of container tokens to be used for authorization during
  1833. container resource update.
  1834. @see NMToken]]>
  1835. </doc>
  1836. </method>
  1837. <method name="setContainersToUpdate"
  1838. abstract="true" native="false" synchronized="false"
  1839. static="false" final="false" visibility="public"
  1840. deprecated="not deprecated">
  1841. <param name="containersToUpdate" type="java.util.List"/>
  1842. <doc>
  1843. <![CDATA[Set container tokens to be used during container resource increase.
  1844. The token is acquired from
  1845. <code>AllocateResponse.getUpdatedContainers</code>.
  1846. The token contains the container id and resource capability required for
  1847. container resource update.
  1848. @param containersToUpdate the list of container tokens to be used
  1849. for container resource increase.]]>
  1850. </doc>
  1851. </method>
  1852. <doc>
  1853. <![CDATA[<p>The request sent by <code>Application Master</code> to the
  1854. <code>Node Manager</code> to change the resource quota of a container.</p>
  1855. @see ContainerManagementProtocol#updateContainer(ContainerUpdateRequest)]]>
  1856. </doc>
  1857. </class>
  1858. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest -->
  1859. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse -->
  1860. <class name="ContainerUpdateResponse" extends="java.lang.Object"
  1861. abstract="true"
  1862. static="false" final="false" visibility="public"
  1863. deprecated="not deprecated">
  1864. <constructor name="ContainerUpdateResponse"
  1865. static="false" final="false" visibility="public"
  1866. deprecated="not deprecated">
  1867. </constructor>
  1868. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse"
  1869. abstract="false" native="false" synchronized="false"
  1870. static="true" final="false" visibility="public"
  1871. deprecated="not deprecated">
  1872. <param name="successfullyUpdatedContainers" type="java.util.List"/>
  1873. <param name="failedRequests" type="java.util.Map"/>
  1874. </method>
  1875. <method name="getSuccessfullyUpdatedContainers" return="java.util.List"
  1876. abstract="true" native="false" synchronized="false"
  1877. static="false" final="false" visibility="public"
  1878. deprecated="not deprecated">
  1879. <doc>
  1880. <![CDATA[Get the list of containerIds of containers whose resource
  1881. have been successfully update.
  1882. @return the list of containerIds of containers whose resource have
  1883. been successfully updated.]]>
  1884. </doc>
  1885. </method>
  1886. <method name="getFailedRequests" return="java.util.Map"
  1887. abstract="true" native="false" synchronized="false"
  1888. static="false" final="false" visibility="public"
  1889. deprecated="not deprecated">
  1890. <doc>
  1891. <![CDATA[Get the containerId-to-exception map in which the exception indicates
  1892. error from each container for failed requests.
  1893. @return map of containerId-to-exception]]>
  1894. </doc>
  1895. </method>
  1896. <doc>
  1897. <![CDATA[<p>
  1898. The response sent by the <code>NodeManager</code> to the
  1899. <code>ApplicationMaster</code> when asked to update container resource.
  1900. </p>
  1901. @see ContainerManagementProtocol#updateContainer(ContainerUpdateRequest)]]>
  1902. </doc>
  1903. </class>
  1904. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse -->
  1905. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest -->
  1906. <class name="FailApplicationAttemptRequest" extends="java.lang.Object"
  1907. abstract="true"
  1908. static="false" final="false" visibility="public"
  1909. deprecated="not deprecated">
  1910. <constructor name="FailApplicationAttemptRequest"
  1911. static="false" final="false" visibility="public"
  1912. deprecated="not deprecated">
  1913. </constructor>
  1914. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest"
  1915. abstract="false" native="false" synchronized="false"
  1916. static="true" final="false" visibility="public"
  1917. deprecated="not deprecated">
  1918. <param name="attemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1919. </method>
  1920. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  1921. abstract="true" native="false" synchronized="false"
  1922. static="false" final="false" visibility="public"
  1923. deprecated="not deprecated">
  1924. <doc>
  1925. <![CDATA[Get the <code>ApplicationAttemptId</code> of the attempt to be failed.
  1926. @return <code>ApplicationAttemptId</code> of the attempt.]]>
  1927. </doc>
  1928. </method>
  1929. <method name="setApplicationAttemptId"
  1930. abstract="true" native="false" synchronized="false"
  1931. static="false" final="false" visibility="public"
  1932. deprecated="not deprecated">
  1933. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1934. </method>
  1935. <doc>
  1936. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  1937. to fail an application attempt.</p>
  1938. <p>The request includes the {@link ApplicationAttemptId} of the attempt to
  1939. be failed.</p>
  1940. @see ApplicationClientProtocol#failApplicationAttempt(FailApplicationAttemptRequest)]]>
  1941. </doc>
  1942. </class>
  1943. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest -->
  1944. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptResponse -->
  1945. <class name="FailApplicationAttemptResponse" extends="java.lang.Object"
  1946. abstract="true"
  1947. static="false" final="false" visibility="public"
  1948. deprecated="not deprecated">
  1949. <constructor name="FailApplicationAttemptResponse"
  1950. static="false" final="false" visibility="public"
  1951. deprecated="not deprecated">
  1952. </constructor>
  1953. <doc>
  1954. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client
  1955. failing an application attempt.</p>
  1956. <p>Currently it's empty.</p>
  1957. @see ApplicationClientProtocol#failApplicationAttempt(FailApplicationAttemptRequest)]]>
  1958. </doc>
  1959. </class>
  1960. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptResponse -->
  1961. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
  1962. <class name="FinishApplicationMasterRequest" extends="java.lang.Object"
  1963. abstract="true"
  1964. static="false" final="false" visibility="public"
  1965. deprecated="not deprecated">
  1966. <constructor name="FinishApplicationMasterRequest"
  1967. static="false" final="false" visibility="public"
  1968. deprecated="not deprecated">
  1969. </constructor>
  1970. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"
  1971. abstract="false" native="false" synchronized="false"
  1972. static="true" final="false" visibility="public"
  1973. deprecated="not deprecated">
  1974. <param name="finalAppStatus" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
  1975. <param name="diagnostics" type="java.lang.String"/>
  1976. <param name="url" type="java.lang.String"/>
  1977. </method>
  1978. <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  1979. abstract="true" native="false" synchronized="false"
  1980. static="false" final="false" visibility="public"
  1981. deprecated="not deprecated">
  1982. <doc>
  1983. <![CDATA[Get <em>final state</em> of the <code>ApplicationMaster</code>.
  1984. @return <em>final state</em> of the <code>ApplicationMaster</code>]]>
  1985. </doc>
  1986. </method>
  1987. <method name="setFinalApplicationStatus"
  1988. abstract="true" native="false" synchronized="false"
  1989. static="false" final="false" visibility="public"
  1990. deprecated="not deprecated">
  1991. <param name="finalState" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
  1992. <doc>
  1993. <![CDATA[Set the <em>final state</em> of the <code>ApplicationMaster</code>
  1994. @param finalState <em>final state</em> of the <code>ApplicationMaster</code>]]>
  1995. </doc>
  1996. </method>
  1997. <method name="getDiagnostics" return="java.lang.String"
  1998. abstract="true" native="false" synchronized="false"
  1999. static="false" final="false" visibility="public"
  2000. deprecated="not deprecated">
  2001. <doc>
  2002. <![CDATA[Get <em>diagnostic information</em> on application failure.
  2003. @return <em>diagnostic information</em> on application failure]]>
  2004. </doc>
  2005. </method>
  2006. <method name="setDiagnostics"
  2007. abstract="true" native="false" synchronized="false"
  2008. static="false" final="false" visibility="public"
  2009. deprecated="not deprecated">
  2010. <param name="diagnostics" type="java.lang.String"/>
  2011. <doc>
  2012. <![CDATA[Set <em>diagnostic information</em> on application failure.
  2013. @param diagnostics <em>diagnostic information</em> on application failure]]>
  2014. </doc>
  2015. </method>
  2016. <method name="getTrackingUrl" return="java.lang.String"
  2017. abstract="true" native="false" synchronized="false"
  2018. static="false" final="false" visibility="public"
  2019. deprecated="not deprecated">
  2020. <doc>
  2021. <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
  2022. This url if contains scheme then that will be used by resource manager
  2023. web application proxy otherwise it will default to http.
  2024. @return <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  2025. </doc>
  2026. </method>
  2027. <method name="setTrackingUrl"
  2028. abstract="true" native="false" synchronized="false"
  2029. static="false" final="false" visibility="public"
  2030. deprecated="not deprecated">
  2031. <param name="url" type="java.lang.String"/>
  2032. <doc>
  2033. <![CDATA[Set the <em>final tracking URL</em>for the <code>ApplicationMaster</code>.
  2034. This is the web-URL to which ResourceManager or web-application proxy will
  2035. redirect client/users once the application is finished and the
  2036. <code>ApplicationMaster</code> is gone.
  2037. <p>
  2038. If the passed url has a scheme then that will be used by the
  2039. ResourceManager and web-application proxy, otherwise the scheme will
  2040. default to http.
  2041. </p>
  2042. <p>
  2043. Empty, null, "N/A" strings are all valid besides a real URL. In case an url
  2044. isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
  2045. <p>
  2046. @param url
  2047. <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  2048. </doc>
  2049. </method>
  2050. <doc>
  2051. <![CDATA[The finalization request sent by the {@code ApplicationMaster} to
  2052. inform the {@code ResourceManager} about its completion.
  2053. <p>
  2054. The final request includes details such:
  2055. <ul>
  2056. <li>Final state of the {@code ApplicationMaster}</li>
  2057. <li>
  2058. Diagnostic information in case of failure of the
  2059. {@code ApplicationMaster}
  2060. </li>
  2061. <li>Tracking URL</li>
  2062. </ul>
  2063. @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
  2064. </doc>
  2065. </class>
  2066. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
  2067. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
  2068. <class name="FinishApplicationMasterResponse" extends="java.lang.Object"
  2069. abstract="true"
  2070. static="false" final="false" visibility="public"
  2071. deprecated="not deprecated">
  2072. <constructor name="FinishApplicationMasterResponse"
  2073. static="false" final="false" visibility="public"
  2074. deprecated="not deprecated">
  2075. </constructor>
  2076. <method name="getIsUnregistered" return="boolean"
  2077. abstract="true" native="false" synchronized="false"
  2078. static="false" final="false" visibility="public"
  2079. deprecated="not deprecated">
  2080. <doc>
  2081. <![CDATA[Get the flag which indicates that the application has successfully
  2082. unregistered with the RM and the application can safely stop.
  2083. @return true if the application has unregistered with the RM,
  2084. false otherwise]]>
  2085. </doc>
  2086. </method>
  2087. <doc>
  2088. <![CDATA[The response sent by the <code>ResourceManager</code> to a
  2089. <code>ApplicationMaster</code> on it's completion.
  2090. <p>
  2091. The response, includes:
  2092. <ul>
  2093. <li>A flag which indicates that the application has successfully unregistered
  2094. with the RM and the application can safely stop.</li>
  2095. </ul>
  2096. <p>
  2097. Note: The flag indicates whether the application has successfully
  2098. unregistered and is safe to stop. The application may stop after the flag is
  2099. true. If the application stops before the flag is true then the RM may retry
  2100. the application.
  2101. @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
  2102. </doc>
  2103. </class>
  2104. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
  2105. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest -->
  2106. <class name="GetAllResourceTypeInfoRequest" extends="java.lang.Object"
  2107. abstract="true"
  2108. static="false" final="false" visibility="public"
  2109. deprecated="not deprecated">
  2110. <constructor name="GetAllResourceTypeInfoRequest"
  2111. static="false" final="false" visibility="public"
  2112. deprecated="not deprecated">
  2113. </constructor>
  2114. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest"
  2115. abstract="false" native="false" synchronized="false"
  2116. static="true" final="false" visibility="public"
  2117. deprecated="not deprecated">
  2118. </method>
  2119. <doc>
  2120. <![CDATA[Request class for getting all the resource profiles from the RM.]]>
  2121. </doc>
  2122. </class>
  2123. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest -->
  2124. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse -->
  2125. <class name="GetAllResourceTypeInfoResponse" extends="java.lang.Object"
  2126. abstract="true"
  2127. static="false" final="false" visibility="public"
  2128. deprecated="not deprecated">
  2129. <constructor name="GetAllResourceTypeInfoResponse"
  2130. static="false" final="false" visibility="public"
  2131. deprecated="not deprecated">
  2132. </constructor>
  2133. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse"
  2134. abstract="false" native="false" synchronized="false"
  2135. static="true" final="false" visibility="public"
  2136. deprecated="not deprecated">
  2137. </method>
  2138. <method name="setResourceTypeInfo"
  2139. abstract="true" native="false" synchronized="false"
  2140. static="false" final="false" visibility="public"
  2141. deprecated="not deprecated">
  2142. <param name="resourceTypes" type="java.util.List"/>
  2143. </method>
  2144. <method name="getResourceTypeInfo" return="java.util.List"
  2145. abstract="true" native="false" synchronized="false"
  2146. static="false" final="false" visibility="public"
  2147. deprecated="not deprecated">
  2148. </method>
  2149. <method name="equals" return="boolean"
  2150. abstract="false" native="false" synchronized="false"
  2151. static="false" final="false" visibility="public"
  2152. deprecated="not deprecated">
  2153. <param name="other" type="java.lang.Object"/>
  2154. </method>
  2155. <method name="hashCode" return="int"
  2156. abstract="false" native="false" synchronized="false"
  2157. static="false" final="false" visibility="public"
  2158. deprecated="not deprecated">
  2159. </method>
  2160. <doc>
  2161. <![CDATA[Response class for getting all the resource profiles from the RM.]]>
  2162. </doc>
  2163. </class>
  2164. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse -->
  2165. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
  2166. <class name="GetApplicationAttemptReportRequest" extends="java.lang.Object"
  2167. abstract="true"
  2168. static="false" final="false" visibility="public"
  2169. deprecated="not deprecated">
  2170. <constructor name="GetApplicationAttemptReportRequest"
  2171. static="false" final="false" visibility="public"
  2172. deprecated="not deprecated">
  2173. </constructor>
  2174. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"
  2175. abstract="false" native="false" synchronized="false"
  2176. static="true" final="false" visibility="public"
  2177. deprecated="not deprecated">
  2178. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2179. </method>
  2180. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2181. abstract="true" native="false" synchronized="false"
  2182. static="false" final="false" visibility="public"
  2183. deprecated="not deprecated">
  2184. <doc>
  2185. <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
  2186. @return <code>ApplicationAttemptId</code> of an application attempt]]>
  2187. </doc>
  2188. </method>
  2189. <method name="setApplicationAttemptId"
  2190. abstract="true" native="false" synchronized="false"
  2191. static="false" final="false" visibility="public"
  2192. deprecated="not deprecated">
  2193. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2194. <doc>
  2195. <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
  2196. @param applicationAttemptId
  2197. <code>ApplicationAttemptId</code> of an application attempt]]>
  2198. </doc>
  2199. </method>
  2200. <doc>
  2201. <![CDATA[<p>
  2202. The request sent by a client to the <code>ResourceManager</code> to get an
  2203. {@link ApplicationAttemptReport} for an application attempt.
  2204. </p>
  2205. <p>
  2206. The request should include the {@link ApplicationAttemptId} of the
  2207. application attempt.
  2208. </p>
  2209. @see ApplicationAttemptReport
  2210. @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
  2211. </doc>
  2212. </class>
  2213. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
  2214. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
  2215. <class name="GetApplicationAttemptReportResponse" extends="java.lang.Object"
  2216. abstract="true"
  2217. static="false" final="false" visibility="public"
  2218. deprecated="not deprecated">
  2219. <constructor name="GetApplicationAttemptReportResponse"
  2220. static="false" final="false" visibility="public"
  2221. deprecated="not deprecated">
  2222. </constructor>
  2223. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
  2224. abstract="false" native="false" synchronized="false"
  2225. static="true" final="false" visibility="public"
  2226. deprecated="not deprecated">
  2227. <param name="ApplicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
  2228. </method>
  2229. <method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
  2230. abstract="true" native="false" synchronized="false"
  2231. static="false" final="false" visibility="public"
  2232. deprecated="not deprecated">
  2233. <doc>
  2234. <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
  2235. @return <code>ApplicationAttemptReport</code> for the application attempt]]>
  2236. </doc>
  2237. </method>
  2238. <method name="setApplicationAttemptReport"
  2239. abstract="true" native="false" synchronized="false"
  2240. static="false" final="false" visibility="public"
  2241. deprecated="not deprecated">
  2242. <param name="applicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
  2243. <doc>
  2244. <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
  2245. @param applicationAttemptReport
  2246. <code>ApplicationAttemptReport</code> for the application attempt]]>
  2247. </doc>
  2248. </method>
  2249. <doc>
  2250. <![CDATA[<p>
  2251. The response sent by the <code>ResourceManager</code> to a client requesting
  2252. an application attempt report.
  2253. </p>
  2254. <p>
  2255. The response includes an {@link ApplicationAttemptReport} which has the
  2256. details about the particular application attempt
  2257. </p>
  2258. @see ApplicationAttemptReport
  2259. @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
  2260. </doc>
  2261. </class>
  2262. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
  2263. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
  2264. <class name="GetApplicationAttemptsRequest" extends="java.lang.Object"
  2265. abstract="true"
  2266. static="false" final="false" visibility="public"
  2267. deprecated="not deprecated">
  2268. <constructor name="GetApplicationAttemptsRequest"
  2269. static="false" final="false" visibility="public"
  2270. deprecated="not deprecated">
  2271. </constructor>
  2272. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"
  2273. abstract="false" native="false" synchronized="false"
  2274. static="true" final="false" visibility="public"
  2275. deprecated="not deprecated">
  2276. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2277. </method>
  2278. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2279. abstract="true" native="false" synchronized="false"
  2280. static="false" final="false" visibility="public"
  2281. deprecated="not deprecated">
  2282. <doc>
  2283. <![CDATA[Get the <code>ApplicationId</code> of an application
  2284. @return <code>ApplicationId</code> of an application]]>
  2285. </doc>
  2286. </method>
  2287. <method name="setApplicationId"
  2288. abstract="true" native="false" synchronized="false"
  2289. static="false" final="false" visibility="public"
  2290. deprecated="not deprecated">
  2291. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2292. <doc>
  2293. <![CDATA[Set the <code>ApplicationId</code> of an application
  2294. @param applicationId
  2295. <code>ApplicationId</code> of an application]]>
  2296. </doc>
  2297. </method>
  2298. <doc>
  2299. <![CDATA[<p>
  2300. The request from clients to get a list of application attempt reports of an
  2301. application from the <code>ResourceManager</code>.
  2302. </p>
  2303. @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
  2304. </doc>
  2305. </class>
  2306. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
  2307. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
  2308. <class name="GetApplicationAttemptsResponse" extends="java.lang.Object"
  2309. abstract="true"
  2310. static="false" final="false" visibility="public"
  2311. deprecated="not deprecated">
  2312. <constructor name="GetApplicationAttemptsResponse"
  2313. static="false" final="false" visibility="public"
  2314. deprecated="not deprecated">
  2315. </constructor>
  2316. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
  2317. abstract="false" native="false" synchronized="false"
  2318. static="true" final="false" visibility="public"
  2319. deprecated="not deprecated">
  2320. <param name="applicationAttempts" type="java.util.List"/>
  2321. </method>
  2322. <method name="getApplicationAttemptList" return="java.util.List"
  2323. abstract="true" native="false" synchronized="false"
  2324. static="false" final="false" visibility="public"
  2325. deprecated="not deprecated">
  2326. <doc>
  2327. <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
  2328. @return a list of <code>ApplicationReport</code> of an application]]>
  2329. </doc>
  2330. </method>
  2331. <method name="setApplicationAttemptList"
  2332. abstract="true" native="false" synchronized="false"
  2333. static="false" final="false" visibility="public"
  2334. deprecated="not deprecated">
  2335. <param name="applicationAttempts" type="java.util.List"/>
  2336. <doc>
  2337. <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
  2338. @param applicationAttempts
  2339. a list of <code>ApplicationReport</code> of an application]]>
  2340. </doc>
  2341. </method>
  2342. <doc>
  2343. <![CDATA[<p>
  2344. The response sent by the <code>ResourceManager</code> to a client requesting
  2345. a list of {@link ApplicationAttemptReport} for application attempts.
  2346. </p>
  2347. <p>
  2348. The <code>ApplicationAttemptReport</code> for each application includes the
  2349. details of an application attempt.
  2350. </p>
  2351. @see ApplicationAttemptReport
  2352. @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
  2353. </doc>
  2354. </class>
  2355. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
  2356. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
  2357. <class name="GetApplicationReportRequest" extends="java.lang.Object"
  2358. abstract="true"
  2359. static="false" final="false" visibility="public"
  2360. deprecated="not deprecated">
  2361. <constructor name="GetApplicationReportRequest"
  2362. static="false" final="false" visibility="public"
  2363. deprecated="not deprecated">
  2364. </constructor>
  2365. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"
  2366. abstract="false" native="false" synchronized="false"
  2367. static="true" final="false" visibility="public"
  2368. deprecated="not deprecated">
  2369. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2370. </method>
  2371. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2372. abstract="true" native="false" synchronized="false"
  2373. static="false" final="false" visibility="public"
  2374. deprecated="not deprecated">
  2375. <doc>
  2376. <![CDATA[Get the <code>ApplicationId</code> of the application.
  2377. @return <code>ApplicationId</code> of the application]]>
  2378. </doc>
  2379. </method>
  2380. <method name="setApplicationId"
  2381. abstract="true" native="false" synchronized="false"
  2382. static="false" final="false" visibility="public"
  2383. deprecated="not deprecated">
  2384. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2385. <doc>
  2386. <![CDATA[Set the <code>ApplicationId</code> of the application
  2387. @param applicationId <code>ApplicationId</code> of the application]]>
  2388. </doc>
  2389. </method>
  2390. <doc>
  2391. <![CDATA[<p>The request sent by a client to the <code>ResourceManager</code> to
  2392. get an {@link ApplicationReport} for an application.</p>
  2393. <p>The request should include the {@link ApplicationId} of the
  2394. application.</p>
  2395. @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)
  2396. @see ApplicationReport]]>
  2397. </doc>
  2398. </class>
  2399. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
  2400. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
  2401. <class name="GetApplicationReportResponse" extends="java.lang.Object"
  2402. abstract="true"
  2403. static="false" final="false" visibility="public"
  2404. deprecated="not deprecated">
  2405. <constructor name="GetApplicationReportResponse"
  2406. static="false" final="false" visibility="public"
  2407. deprecated="not deprecated">
  2408. </constructor>
  2409. <method name="getApplicationReport" return="org.apache.hadoop.yarn.api.records.ApplicationReport"
  2410. abstract="true" native="false" synchronized="false"
  2411. static="false" final="false" visibility="public"
  2412. deprecated="not deprecated">
  2413. <doc>
  2414. <![CDATA[Get the <code>ApplicationReport</code> for the application.
  2415. @return <code>ApplicationReport</code> for the application]]>
  2416. </doc>
  2417. </method>
  2418. <doc>
  2419. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  2420. requesting an application report.</p>
  2421. <p>The response includes an {@link ApplicationReport} which has details such
  2422. as user, queue, name, host on which the <code>ApplicationMaster</code> is
  2423. running, RPC port, tracking URL, diagnostics, start time etc.</p>
  2424. @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)]]>
  2425. </doc>
  2426. </class>
  2427. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
  2428. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
  2429. <class name="GetApplicationsRequest" extends="java.lang.Object"
  2430. abstract="true"
  2431. static="false" final="false" visibility="public"
  2432. deprecated="not deprecated">
  2433. <constructor name="GetApplicationsRequest"
  2434. static="false" final="false" visibility="public"
  2435. deprecated="not deprecated">
  2436. </constructor>
  2437. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2438. abstract="false" native="false" synchronized="false"
  2439. static="true" final="false" visibility="public"
  2440. deprecated="not deprecated">
  2441. </method>
  2442. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2443. abstract="false" native="false" synchronized="false"
  2444. static="true" final="false" visibility="public"
  2445. deprecated="not deprecated">
  2446. <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
  2447. <param name="users" type="java.util.Set"/>
  2448. <param name="queues" type="java.util.Set"/>
  2449. <param name="applicationTypes" type="java.util.Set"/>
  2450. <param name="applicationTags" type="java.util.Set"/>
  2451. <param name="applicationStates" type="java.util.EnumSet"/>
  2452. <param name="startRange" type="org.apache.commons.lang.math.LongRange"/>
  2453. <param name="finishRange" type="org.apache.commons.lang.math.LongRange"/>
  2454. <param name="limit" type="java.lang.Long"/>
  2455. <doc>
  2456. <![CDATA[<p>
  2457. The request from clients to get a report of Applications matching the
  2458. giving application types in the cluster from the
  2459. <code>ResourceManager</code>.
  2460. </p>
  2461. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2462. <p>Setting any of the parameters to null, would just disable that
  2463. filter</p>
  2464. @param scope {@link ApplicationsRequestScope} to filter by
  2465. @param users list of users to filter by
  2466. @param queues list of scheduler queues to filter by
  2467. @param applicationTypes types of applications
  2468. @param applicationTags application tags to filter by
  2469. @param applicationStates application states to filter by
  2470. @param startRange range of application start times to filter by
  2471. @param finishRange range of application finish times to filter by
  2472. @param limit number of applications to limit to
  2473. @return {@link GetApplicationsRequest} to be used with
  2474. {@link ApplicationClientProtocol#getApplications(GetApplicationsRequest)}]]>
  2475. </doc>
  2476. </method>
  2477. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2478. abstract="false" native="false" synchronized="false"
  2479. static="true" final="false" visibility="public"
  2480. deprecated="not deprecated">
  2481. <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
  2482. <doc>
  2483. <![CDATA[<p>
  2484. The request from clients to get a report of Applications matching the
  2485. giving application types in the cluster from the
  2486. <code>ResourceManager</code>.
  2487. </p>
  2488. @param scope {@link ApplicationsRequestScope} to filter by
  2489. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2490. @return a report of Applications in {@link GetApplicationsRequest}]]>
  2491. </doc>
  2492. </method>
  2493. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2494. abstract="false" native="false" synchronized="false"
  2495. static="true" final="false" visibility="public"
  2496. deprecated="not deprecated">
  2497. <param name="applicationTypes" type="java.util.Set"/>
  2498. <doc>
  2499. <![CDATA[<p>
  2500. The request from clients to get a report of Applications matching the
  2501. giving application types in the cluster from the
  2502. <code>ResourceManager</code>.
  2503. </p>
  2504. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2505. @return a report of Applications in {@link GetApplicationsRequest}]]>
  2506. </doc>
  2507. </method>
  2508. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2509. abstract="false" native="false" synchronized="false"
  2510. static="true" final="false" visibility="public"
  2511. deprecated="not deprecated">
  2512. <param name="applicationStates" type="java.util.EnumSet"/>
  2513. <doc>
  2514. <![CDATA[<p>
  2515. The request from clients to get a report of Applications matching the
  2516. giving application states in the cluster from the
  2517. <code>ResourceManager</code>.
  2518. </p>
  2519. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2520. @return a report of Applications in {@link GetApplicationsRequest}]]>
  2521. </doc>
  2522. </method>
  2523. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  2524. abstract="false" native="false" synchronized="false"
  2525. static="true" final="false" visibility="public"
  2526. deprecated="not deprecated">
  2527. <param name="applicationTypes" type="java.util.Set"/>
  2528. <param name="applicationStates" type="java.util.EnumSet"/>
  2529. <doc>
  2530. <![CDATA[<p>
  2531. The request from clients to get a report of Applications matching the
  2532. giving and application types and application types in the cluster from the
  2533. <code>ResourceManager</code>.
  2534. </p>
  2535. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  2536. @return a report of Applications in <code>GetApplicationsRequest</code>]]>
  2537. </doc>
  2538. </method>
  2539. <method name="getApplicationTypes" return="java.util.Set"
  2540. abstract="true" native="false" synchronized="false"
  2541. static="false" final="false" visibility="public"
  2542. deprecated="not deprecated">
  2543. <doc>
  2544. <![CDATA[Get the application types to filter applications on
  2545. @return Set of Application Types to filter on]]>
  2546. </doc>
  2547. </method>
  2548. <method name="getApplicationStates" return="java.util.EnumSet"
  2549. abstract="true" native="false" synchronized="false"
  2550. static="false" final="false" visibility="public"
  2551. deprecated="not deprecated">
  2552. <doc>
  2553. <![CDATA[Get the application states to filter applications on
  2554. @return Set of Application states to filter on]]>
  2555. </doc>
  2556. </method>
  2557. <doc>
  2558. <![CDATA[<p>The request from clients to get a report of Applications
  2559. in the cluster from the <code>ResourceManager</code>.</p>
  2560. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2561. </doc>
  2562. </class>
  2563. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
  2564. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
  2565. <class name="GetApplicationsResponse" extends="java.lang.Object"
  2566. abstract="true"
  2567. static="false" final="false" visibility="public"
  2568. deprecated="not deprecated">
  2569. <constructor name="GetApplicationsResponse"
  2570. static="false" final="false" visibility="public"
  2571. deprecated="not deprecated">
  2572. </constructor>
  2573. <method name="getApplicationList" return="java.util.List"
  2574. abstract="true" native="false" synchronized="false"
  2575. static="false" final="false" visibility="public"
  2576. deprecated="not deprecated">
  2577. <doc>
  2578. <![CDATA[Get <code>ApplicationReport</code> for applications.
  2579. @return <code>ApplicationReport</code> for applications]]>
  2580. </doc>
  2581. </method>
  2582. <doc>
  2583. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  2584. requesting an {@link ApplicationReport} for applications.</p>
  2585. <p>The <code>ApplicationReport</code> for each application includes details
  2586. such as user, queue, name, host on which the <code>ApplicationMaster</code>
  2587. is running, RPC port, tracking URL, diagnostics, start time etc.</p>
  2588. @see ApplicationReport
  2589. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  2590. </doc>
  2591. </class>
  2592. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
  2593. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
  2594. <class name="GetClusterMetricsRequest" extends="java.lang.Object"
  2595. abstract="true"
  2596. static="false" final="false" visibility="public"
  2597. deprecated="not deprecated">
  2598. <constructor name="GetClusterMetricsRequest"
  2599. static="false" final="false" visibility="public"
  2600. deprecated="not deprecated">
  2601. </constructor>
  2602. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"
  2603. abstract="false" native="false" synchronized="false"
  2604. static="true" final="false" visibility="public"
  2605. deprecated="not deprecated">
  2606. </method>
  2607. <doc>
  2608. <![CDATA[<p>The request sent by clients to get cluster metrics from the
  2609. <code>ResourceManager</code>.</p>
  2610. <p>Currently, this is empty.</p>
  2611. @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
  2612. </doc>
  2613. </class>
  2614. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
  2615. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
  2616. <class name="GetClusterMetricsResponse" extends="java.lang.Object"
  2617. abstract="true"
  2618. static="false" final="false" visibility="public"
  2619. deprecated="not deprecated">
  2620. <constructor name="GetClusterMetricsResponse"
  2621. static="false" final="false" visibility="public"
  2622. deprecated="not deprecated">
  2623. </constructor>
  2624. <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.records.YarnClusterMetrics"
  2625. abstract="true" native="false" synchronized="false"
  2626. static="false" final="false" visibility="public"
  2627. deprecated="not deprecated">
  2628. <doc>
  2629. <![CDATA[Get the <code>YarnClusterMetrics</code> for the cluster.
  2630. @return <code>YarnClusterMetrics</code> for the cluster]]>
  2631. </doc>
  2632. </method>
  2633. <doc>
  2634. <![CDATA[The response sent by the <code>ResourceManager</code> to a client
  2635. requesting cluster metrics.
  2636. @see YarnClusterMetrics
  2637. @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
  2638. </doc>
  2639. </class>
  2640. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
  2641. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
  2642. <class name="GetClusterNodeLabelsRequest" extends="java.lang.Object"
  2643. abstract="true"
  2644. static="false" final="false" visibility="public"
  2645. deprecated="not deprecated">
  2646. <constructor name="GetClusterNodeLabelsRequest"
  2647. static="false" final="false" visibility="public"
  2648. deprecated="not deprecated">
  2649. </constructor>
  2650. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"
  2651. abstract="false" native="false" synchronized="false"
  2652. static="true" final="false" visibility="public"
  2653. deprecated="not deprecated">
  2654. </method>
  2655. </class>
  2656. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
  2657. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
  2658. <class name="GetClusterNodeLabelsResponse" extends="java.lang.Object"
  2659. abstract="true"
  2660. static="false" final="false" visibility="public"
  2661. deprecated="not deprecated">
  2662. <constructor name="GetClusterNodeLabelsResponse"
  2663. static="false" final="false" visibility="public"
  2664. deprecated="not deprecated">
  2665. </constructor>
  2666. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  2667. abstract="false" native="false" synchronized="false"
  2668. static="true" final="false" visibility="public"
  2669. deprecated="Use {@link #newInstance(List)} instead.">
  2670. <param name="labels" type="java.util.Set"/>
  2671. <doc>
  2672. <![CDATA[Creates a new instance.
  2673. @param labels Node labels
  2674. @return response
  2675. @deprecated Use {@link #newInstance(List)} instead.]]>
  2676. </doc>
  2677. </method>
  2678. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  2679. abstract="false" native="false" synchronized="false"
  2680. static="true" final="false" visibility="public"
  2681. deprecated="not deprecated">
  2682. <param name="labels" type="java.util.List"/>
  2683. </method>
  2684. <method name="setNodeLabelList"
  2685. abstract="true" native="false" synchronized="false"
  2686. static="false" final="false" visibility="public"
  2687. deprecated="not deprecated">
  2688. <param name="labels" type="java.util.List"/>
  2689. </method>
  2690. <method name="getNodeLabelList" return="java.util.List"
  2691. abstract="true" native="false" synchronized="false"
  2692. static="false" final="false" visibility="public"
  2693. deprecated="not deprecated">
  2694. </method>
  2695. <method name="setNodeLabels"
  2696. abstract="true" native="false" synchronized="false"
  2697. static="false" final="false" visibility="public"
  2698. deprecated="Use {@link #setNodeLabelList(List)} instead.">
  2699. <param name="labels" type="java.util.Set"/>
  2700. <doc>
  2701. <![CDATA[Set node labels to the response.
  2702. @param labels Node labels
  2703. @deprecated Use {@link #setNodeLabelList(List)} instead.]]>
  2704. </doc>
  2705. </method>
  2706. <method name="getNodeLabels" return="java.util.Set"
  2707. abstract="true" native="false" synchronized="false"
  2708. static="false" final="false" visibility="public"
  2709. deprecated="Use {@link #getNodeLabelList()} instead.">
  2710. <doc>
  2711. <![CDATA[Get node labels of the response.
  2712. @return Node labels
  2713. @deprecated Use {@link #getNodeLabelList()} instead.]]>
  2714. </doc>
  2715. </method>
  2716. </class>
  2717. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
  2718. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
  2719. <class name="GetClusterNodesRequest" extends="java.lang.Object"
  2720. abstract="true"
  2721. static="false" final="false" visibility="public"
  2722. deprecated="not deprecated">
  2723. <constructor name="GetClusterNodesRequest"
  2724. static="false" final="false" visibility="public"
  2725. deprecated="not deprecated">
  2726. </constructor>
  2727. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
  2728. abstract="false" native="false" synchronized="false"
  2729. static="true" final="false" visibility="public"
  2730. deprecated="not deprecated">
  2731. <param name="states" type="java.util.EnumSet"/>
  2732. </method>
  2733. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
  2734. abstract="false" native="false" synchronized="false"
  2735. static="true" final="false" visibility="public"
  2736. deprecated="not deprecated">
  2737. </method>
  2738. <method name="getNodeStates" return="java.util.EnumSet"
  2739. abstract="true" native="false" synchronized="false"
  2740. static="false" final="false" visibility="public"
  2741. deprecated="not deprecated">
  2742. <doc>
  2743. <![CDATA[The state to filter the cluster nodes with.
  2744. @return the set of {@link NodeState}]]>
  2745. </doc>
  2746. </method>
  2747. <method name="setNodeStates"
  2748. abstract="true" native="false" synchronized="false"
  2749. static="false" final="false" visibility="public"
  2750. deprecated="not deprecated">
  2751. <param name="states" type="java.util.EnumSet"/>
  2752. <doc>
  2753. <![CDATA[The state to filter the cluster nodes with.
  2754. @param states the set of {@link NodeState}]]>
  2755. </doc>
  2756. </method>
  2757. <doc>
  2758. <![CDATA[<p>The request from clients to get a report of all nodes
  2759. in the cluster from the <code>ResourceManager</code>.</p>
  2760. The request will ask for all nodes in the given {@link NodeState}s.
  2761. @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
  2762. </doc>
  2763. </class>
  2764. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
  2765. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
  2766. <class name="GetClusterNodesResponse" extends="java.lang.Object"
  2767. abstract="true"
  2768. static="false" final="false" visibility="public"
  2769. deprecated="not deprecated">
  2770. <constructor name="GetClusterNodesResponse"
  2771. static="false" final="false" visibility="public"
  2772. deprecated="not deprecated">
  2773. </constructor>
  2774. <method name="getNodeReports" return="java.util.List"
  2775. abstract="true" native="false" synchronized="false"
  2776. static="false" final="false" visibility="public"
  2777. deprecated="not deprecated">
  2778. <doc>
  2779. <![CDATA[Get <code>NodeReport</code> for all nodes in the cluster.
  2780. @return <code>NodeReport</code> for all nodes in the cluster]]>
  2781. </doc>
  2782. </method>
  2783. <doc>
  2784. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  2785. requesting a {@link NodeReport} for all nodes.</p>
  2786. <p>The <code>NodeReport</code> contains per-node information such as
  2787. available resources, number of containers, tracking url, rack name, health
  2788. status etc.
  2789. @see NodeReport
  2790. @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
  2791. </doc>
  2792. </class>
  2793. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
  2794. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
  2795. <class name="GetContainerReportRequest" extends="java.lang.Object"
  2796. abstract="true"
  2797. static="false" final="false" visibility="public"
  2798. deprecated="not deprecated">
  2799. <constructor name="GetContainerReportRequest"
  2800. static="false" final="false" visibility="public"
  2801. deprecated="not deprecated">
  2802. </constructor>
  2803. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"
  2804. abstract="false" native="false" synchronized="false"
  2805. static="true" final="false" visibility="public"
  2806. deprecated="not deprecated">
  2807. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  2808. </method>
  2809. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  2810. abstract="true" native="false" synchronized="false"
  2811. static="false" final="false" visibility="public"
  2812. deprecated="not deprecated">
  2813. <doc>
  2814. <![CDATA[Get the <code>ContainerId</code> of the Container.
  2815. @return <code>ContainerId</code> of the Container]]>
  2816. </doc>
  2817. </method>
  2818. <method name="setContainerId"
  2819. abstract="true" native="false" synchronized="false"
  2820. static="false" final="false" visibility="public"
  2821. deprecated="not deprecated">
  2822. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  2823. <doc>
  2824. <![CDATA[Set the <code>ContainerId</code> of the container
  2825. @param containerId
  2826. <code>ContainerId</code> of the container]]>
  2827. </doc>
  2828. </method>
  2829. <doc>
  2830. <![CDATA[<p>
  2831. The request sent by a client to the <code>ResourceManager</code> to get an
  2832. {@link ContainerReport} for a container.
  2833. </p>]]>
  2834. </doc>
  2835. </class>
  2836. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
  2837. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
  2838. <class name="GetContainerReportResponse" extends="java.lang.Object"
  2839. abstract="true"
  2840. static="false" final="false" visibility="public"
  2841. deprecated="not deprecated">
  2842. <constructor name="GetContainerReportResponse"
  2843. static="false" final="false" visibility="public"
  2844. deprecated="not deprecated">
  2845. </constructor>
  2846. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
  2847. abstract="false" native="false" synchronized="false"
  2848. static="true" final="false" visibility="public"
  2849. deprecated="not deprecated">
  2850. <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
  2851. </method>
  2852. <method name="getContainerReport" return="org.apache.hadoop.yarn.api.records.ContainerReport"
  2853. abstract="true" native="false" synchronized="false"
  2854. static="false" final="false" visibility="public"
  2855. deprecated="not deprecated">
  2856. <doc>
  2857. <![CDATA[Get the <code>ContainerReport</code> for the container.
  2858. @return <code>ContainerReport</code> for the container]]>
  2859. </doc>
  2860. </method>
  2861. <method name="setContainerReport"
  2862. abstract="true" native="false" synchronized="false"
  2863. static="false" final="false" visibility="public"
  2864. deprecated="not deprecated">
  2865. <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
  2866. </method>
  2867. <doc>
  2868. <![CDATA[<p>
  2869. The response sent by the <code>ResourceManager</code> to a client requesting
  2870. a container report.
  2871. </p>
  2872. <p>
  2873. The response includes a {@link ContainerReport} which has details of a
  2874. container.
  2875. </p>]]>
  2876. </doc>
  2877. </class>
  2878. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
  2879. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
  2880. <class name="GetContainersRequest" extends="java.lang.Object"
  2881. abstract="true"
  2882. static="false" final="false" visibility="public"
  2883. deprecated="not deprecated">
  2884. <constructor name="GetContainersRequest"
  2885. static="false" final="false" visibility="public"
  2886. deprecated="not deprecated">
  2887. </constructor>
  2888. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"
  2889. abstract="false" native="false" synchronized="false"
  2890. static="true" final="false" visibility="public"
  2891. deprecated="not deprecated">
  2892. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2893. </method>
  2894. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2895. abstract="true" native="false" synchronized="false"
  2896. static="false" final="false" visibility="public"
  2897. deprecated="not deprecated">
  2898. <doc>
  2899. <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
  2900. @return <code>ApplicationAttemptId</code> of an application attempt]]>
  2901. </doc>
  2902. </method>
  2903. <method name="setApplicationAttemptId"
  2904. abstract="true" native="false" synchronized="false"
  2905. static="false" final="false" visibility="public"
  2906. deprecated="not deprecated">
  2907. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2908. <doc>
  2909. <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
  2910. @param applicationAttemptId
  2911. <code>ApplicationAttemptId</code> of an application attempt]]>
  2912. </doc>
  2913. </method>
  2914. <doc>
  2915. <![CDATA[<p>
  2916. The request from clients to get a list of container reports, which belong to
  2917. an application attempt from the <code>ResourceManager</code>.
  2918. </p>
  2919. @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
  2920. </doc>
  2921. </class>
  2922. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
  2923. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
  2924. <class name="GetContainersResponse" extends="java.lang.Object"
  2925. abstract="true"
  2926. static="false" final="false" visibility="public"
  2927. deprecated="not deprecated">
  2928. <constructor name="GetContainersResponse"
  2929. static="false" final="false" visibility="public"
  2930. deprecated="not deprecated">
  2931. </constructor>
  2932. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
  2933. abstract="false" native="false" synchronized="false"
  2934. static="true" final="false" visibility="public"
  2935. deprecated="not deprecated">
  2936. <param name="containers" type="java.util.List"/>
  2937. </method>
  2938. <method name="getContainerList" return="java.util.List"
  2939. abstract="true" native="false" synchronized="false"
  2940. static="false" final="false" visibility="public"
  2941. deprecated="not deprecated">
  2942. <doc>
  2943. <![CDATA[Get a list of <code>ContainerReport</code> for all the containers of an
  2944. application attempt.
  2945. @return a list of <code>ContainerReport</code> for all the containers of an
  2946. application attempt]]>
  2947. </doc>
  2948. </method>
  2949. <method name="setContainerList"
  2950. abstract="true" native="false" synchronized="false"
  2951. static="false" final="false" visibility="public"
  2952. deprecated="not deprecated">
  2953. <param name="containers" type="java.util.List"/>
  2954. <doc>
  2955. <![CDATA[Set a list of <code>ContainerReport</code> for all the containers of an
  2956. application attempt.
  2957. @param containers
  2958. a list of <code>ContainerReport</code> for all the containers of
  2959. an application attempt]]>
  2960. </doc>
  2961. </method>
  2962. <doc>
  2963. <![CDATA[<p>
  2964. The response sent by the <code>ResourceManager</code> to a client requesting
  2965. a list of {@link ContainerReport} for containers.
  2966. </p>
  2967. <p>
  2968. The <code>ContainerReport</code> for each container includes the container
  2969. details.
  2970. </p>
  2971. @see ContainerReport
  2972. @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
  2973. </doc>
  2974. </class>
  2975. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
  2976. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
  2977. <class name="GetContainerStatusesRequest" extends="java.lang.Object"
  2978. abstract="true"
  2979. static="false" final="false" visibility="public"
  2980. deprecated="not deprecated">
  2981. <constructor name="GetContainerStatusesRequest"
  2982. static="false" final="false" visibility="public"
  2983. deprecated="not deprecated">
  2984. </constructor>
  2985. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"
  2986. abstract="false" native="false" synchronized="false"
  2987. static="true" final="false" visibility="public"
  2988. deprecated="not deprecated">
  2989. <param name="containerIds" type="java.util.List"/>
  2990. </method>
  2991. <method name="getContainerIds" return="java.util.List"
  2992. abstract="true" native="false" synchronized="false"
  2993. static="false" final="false" visibility="public"
  2994. deprecated="not deprecated">
  2995. <doc>
  2996. <![CDATA[Get the list of <code>ContainerId</code>s of containers for which to obtain
  2997. the <code>ContainerStatus</code>.
  2998. @return the list of <code>ContainerId</code>s of containers for which to
  2999. obtain the <code>ContainerStatus</code>.]]>
  3000. </doc>
  3001. </method>
  3002. <method name="setContainerIds"
  3003. abstract="true" native="false" synchronized="false"
  3004. static="false" final="false" visibility="public"
  3005. deprecated="not deprecated">
  3006. <param name="containerIds" type="java.util.List"/>
  3007. <doc>
  3008. <![CDATA[Set a list of <code>ContainerId</code>s of containers for which to obtain
  3009. the <code>ContainerStatus</code>
  3010. @param containerIds
  3011. a list of <code>ContainerId</code>s of containers for which to
  3012. obtain the <code>ContainerStatus</code>]]>
  3013. </doc>
  3014. </method>
  3015. <doc>
  3016. <![CDATA[The request sent by the <code>ApplicationMaster</code> to the
  3017. <code>NodeManager</code> to get {@link ContainerStatus} of requested
  3018. containers.
  3019. @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
  3020. </doc>
  3021. </class>
  3022. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
  3023. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
  3024. <class name="GetContainerStatusesResponse" extends="java.lang.Object"
  3025. abstract="true"
  3026. static="false" final="false" visibility="public"
  3027. deprecated="not deprecated">
  3028. <constructor name="GetContainerStatusesResponse"
  3029. static="false" final="false" visibility="public"
  3030. deprecated="not deprecated">
  3031. </constructor>
  3032. <method name="getContainerStatuses" return="java.util.List"
  3033. abstract="true" native="false" synchronized="false"
  3034. static="false" final="false" visibility="public"
  3035. deprecated="not deprecated">
  3036. <doc>
  3037. <![CDATA[Get the <code>ContainerStatus</code>es of the requested containers.
  3038. @return <code>ContainerStatus</code>es of the requested containers.]]>
  3039. </doc>
  3040. </method>
  3041. <method name="getFailedRequests" return="java.util.Map"
  3042. abstract="true" native="false" synchronized="false"
  3043. static="false" final="false" visibility="public"
  3044. deprecated="not deprecated">
  3045. <doc>
  3046. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  3047. from per container for failed requests
  3048. @return map of containerId-to-exception]]>
  3049. </doc>
  3050. </method>
  3051. <doc>
  3052. <![CDATA[The response sent by the <code>NodeManager</code> to the
  3053. <code>ApplicationMaster</code> when asked to obtain the
  3054. <code>ContainerStatus</code> of requested containers.
  3055. @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
  3056. </doc>
  3057. </class>
  3058. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
  3059. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
  3060. <class name="GetDelegationTokenRequest" extends="java.lang.Object"
  3061. abstract="true"
  3062. static="false" final="false" visibility="public"
  3063. deprecated="not deprecated">
  3064. <constructor name="GetDelegationTokenRequest"
  3065. static="false" final="false" visibility="public"
  3066. deprecated="not deprecated">
  3067. </constructor>
  3068. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"
  3069. abstract="false" native="false" synchronized="false"
  3070. static="true" final="false" visibility="public"
  3071. deprecated="not deprecated">
  3072. <param name="renewer" type="java.lang.String"/>
  3073. </method>
  3074. <method name="getRenewer" return="java.lang.String"
  3075. abstract="true" native="false" synchronized="false"
  3076. static="false" final="false" visibility="public"
  3077. deprecated="not deprecated">
  3078. </method>
  3079. <method name="setRenewer"
  3080. abstract="true" native="false" synchronized="false"
  3081. static="false" final="false" visibility="public"
  3082. deprecated="not deprecated">
  3083. <param name="renewer" type="java.lang.String"/>
  3084. </method>
  3085. <doc>
  3086. <![CDATA[The request issued by the client to get a delegation token from
  3087. the {@code ResourceManager}.
  3088. for more information.]]>
  3089. </doc>
  3090. </class>
  3091. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
  3092. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
  3093. <class name="GetDelegationTokenResponse" extends="java.lang.Object"
  3094. abstract="true"
  3095. static="false" final="false" visibility="public"
  3096. deprecated="not deprecated">
  3097. <constructor name="GetDelegationTokenResponse"
  3098. static="false" final="false" visibility="public"
  3099. deprecated="not deprecated">
  3100. </constructor>
  3101. <method name="getRMDelegationToken" return="org.apache.hadoop.yarn.api.records.Token"
  3102. abstract="true" native="false" synchronized="false"
  3103. static="false" final="false" visibility="public"
  3104. deprecated="not deprecated">
  3105. <doc>
  3106. <![CDATA[The Delegation tokens have a identifier which maps to
  3107. {@link AbstractDelegationTokenIdentifier}.
  3108. @return the delegation tokens]]>
  3109. </doc>
  3110. </method>
  3111. <doc>
  3112. <![CDATA[Response to a {@link GetDelegationTokenRequest} request
  3113. from the client. The response contains the token that
  3114. can be used by the containers to talk to ClientRMService.]]>
  3115. </doc>
  3116. </class>
  3117. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
  3118. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
  3119. <class name="GetNewApplicationRequest" extends="java.lang.Object"
  3120. abstract="true"
  3121. static="false" final="false" visibility="public"
  3122. deprecated="not deprecated">
  3123. <constructor name="GetNewApplicationRequest"
  3124. static="false" final="false" visibility="public"
  3125. deprecated="not deprecated">
  3126. </constructor>
  3127. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"
  3128. abstract="false" native="false" synchronized="false"
  3129. static="true" final="false" visibility="public"
  3130. deprecated="not deprecated">
  3131. </method>
  3132. <doc>
  3133. <![CDATA[<p>The request sent by clients to get a new {@link ApplicationId} for
  3134. submitting an application.</p>
  3135. <p>Currently, this is empty.</p>
  3136. @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
  3137. </doc>
  3138. </class>
  3139. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
  3140. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
  3141. <class name="GetNewApplicationResponse" extends="java.lang.Object"
  3142. abstract="true"
  3143. static="false" final="false" visibility="public"
  3144. deprecated="not deprecated">
  3145. <constructor name="GetNewApplicationResponse"
  3146. static="false" final="false" visibility="public"
  3147. deprecated="not deprecated">
  3148. </constructor>
  3149. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3150. abstract="true" native="false" synchronized="false"
  3151. static="false" final="false" visibility="public"
  3152. deprecated="not deprecated">
  3153. <doc>
  3154. <![CDATA[Get the <em>new</em> <code>ApplicationId</code> allocated by the
  3155. <code>ResourceManager</code>.
  3156. @return <em>new</em> <code>ApplicationId</code> allocated by the
  3157. <code>ResourceManager</code>]]>
  3158. </doc>
  3159. </method>
  3160. <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  3161. abstract="true" native="false" synchronized="false"
  3162. static="false" final="false" visibility="public"
  3163. deprecated="not deprecated">
  3164. <doc>
  3165. <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
  3166. <code>ResourceManager</code> in the cluster.
  3167. @return maximum capability of allocated resources in the cluster]]>
  3168. </doc>
  3169. </method>
  3170. <doc>
  3171. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client for
  3172. a request to get a new {@link ApplicationId} for submitting applications.</p>
  3173. <p>Clients can submit an application with the returned
  3174. {@link ApplicationId}.</p>
  3175. @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
  3176. </doc>
  3177. </class>
  3178. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
  3179. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest -->
  3180. <class name="GetNewReservationRequest" extends="java.lang.Object"
  3181. abstract="true"
  3182. static="false" final="false" visibility="public"
  3183. deprecated="not deprecated">
  3184. <constructor name="GetNewReservationRequest"
  3185. static="false" final="false" visibility="public"
  3186. deprecated="not deprecated">
  3187. </constructor>
  3188. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest"
  3189. abstract="false" native="false" synchronized="false"
  3190. static="true" final="false" visibility="public"
  3191. deprecated="not deprecated">
  3192. </method>
  3193. <doc>
  3194. <![CDATA[<p>The request sent by clients to get a new {@code ReservationId} for
  3195. submitting an reservation.</p>
  3196. {@code ApplicationClientProtocol#getNewReservation(GetNewReservationRequest)}]]>
  3197. </doc>
  3198. </class>
  3199. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest -->
  3200. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse -->
  3201. <class name="GetNewReservationResponse" extends="java.lang.Object"
  3202. abstract="true"
  3203. static="false" final="false" visibility="public"
  3204. deprecated="not deprecated">
  3205. <constructor name="GetNewReservationResponse"
  3206. static="false" final="false" visibility="public"
  3207. deprecated="not deprecated">
  3208. </constructor>
  3209. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  3210. abstract="true" native="false" synchronized="false"
  3211. static="false" final="false" visibility="public"
  3212. deprecated="not deprecated">
  3213. <doc>
  3214. <![CDATA[Get a new {@link ReservationId} to be used to submit a reservation.
  3215. @return a {@link ReservationId} representing the unique id to identify
  3216. a reservation with which it was submitted.]]>
  3217. </doc>
  3218. </method>
  3219. <doc>
  3220. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client for
  3221. a request to get a new {@link ReservationId} for submitting reservations.</p>
  3222. <p>Clients can submit an reservation with the returned
  3223. {@link ReservationId}.</p>
  3224. {@code ApplicationClientProtocol#getNewReservation(GetNewReservationRequest)}]]>
  3225. </doc>
  3226. </class>
  3227. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse -->
  3228. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
  3229. <class name="GetQueueInfoRequest" extends="java.lang.Object"
  3230. abstract="true"
  3231. static="false" final="false" visibility="public"
  3232. deprecated="not deprecated">
  3233. <constructor name="GetQueueInfoRequest"
  3234. static="false" final="false" visibility="public"
  3235. deprecated="not deprecated">
  3236. </constructor>
  3237. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"
  3238. abstract="false" native="false" synchronized="false"
  3239. static="true" final="false" visibility="public"
  3240. deprecated="not deprecated">
  3241. <param name="queueName" type="java.lang.String"/>
  3242. <param name="includeApplications" type="boolean"/>
  3243. <param name="includeChildQueues" type="boolean"/>
  3244. <param name="recursive" type="boolean"/>
  3245. </method>
  3246. <method name="getQueueName" return="java.lang.String"
  3247. abstract="true" native="false" synchronized="false"
  3248. static="false" final="false" visibility="public"
  3249. deprecated="not deprecated">
  3250. <doc>
  3251. <![CDATA[Get the <em>queue name</em> for which to get queue information.
  3252. @return <em>queue name</em> for which to get queue information]]>
  3253. </doc>
  3254. </method>
  3255. <method name="setQueueName"
  3256. abstract="true" native="false" synchronized="false"
  3257. static="false" final="false" visibility="public"
  3258. deprecated="not deprecated">
  3259. <param name="queueName" type="java.lang.String"/>
  3260. <doc>
  3261. <![CDATA[Set the <em>queue name</em> for which to get queue information
  3262. @param queueName <em>queue name</em> for which to get queue information]]>
  3263. </doc>
  3264. </method>
  3265. <method name="getIncludeApplications" return="boolean"
  3266. abstract="true" native="false" synchronized="false"
  3267. static="false" final="false" visibility="public"
  3268. deprecated="not deprecated">
  3269. <doc>
  3270. <![CDATA[Is information about <em>active applications</em> required?
  3271. @return <code>true</code> if applications' information is to be included,
  3272. else <code>false</code>]]>
  3273. </doc>
  3274. </method>
  3275. <method name="setIncludeApplications"
  3276. abstract="true" native="false" synchronized="false"
  3277. static="false" final="false" visibility="public"
  3278. deprecated="not deprecated">
  3279. <param name="includeApplications" type="boolean"/>
  3280. <doc>
  3281. <![CDATA[Should we get fetch information about <em>active applications</em>?
  3282. @param includeApplications fetch information about <em>active
  3283. applications</em>?]]>
  3284. </doc>
  3285. </method>
  3286. <method name="getIncludeChildQueues" return="boolean"
  3287. abstract="true" native="false" synchronized="false"
  3288. static="false" final="false" visibility="public"
  3289. deprecated="not deprecated">
  3290. <doc>
  3291. <![CDATA[Is information about <em>child queues</em> required?
  3292. @return <code>true</code> if information about child queues is required,
  3293. else <code>false</code>]]>
  3294. </doc>
  3295. </method>
  3296. <method name="setIncludeChildQueues"
  3297. abstract="true" native="false" synchronized="false"
  3298. static="false" final="false" visibility="public"
  3299. deprecated="not deprecated">
  3300. <param name="includeChildQueues" type="boolean"/>
  3301. <doc>
  3302. <![CDATA[Should we fetch information about <em>child queues</em>?
  3303. @param includeChildQueues fetch information about <em>child queues</em>?]]>
  3304. </doc>
  3305. </method>
  3306. <method name="getRecursive" return="boolean"
  3307. abstract="true" native="false" synchronized="false"
  3308. static="false" final="false" visibility="public"
  3309. deprecated="not deprecated">
  3310. <doc>
  3311. <![CDATA[Is information on the entire <em>child queue hierarchy</em> required?
  3312. @return <code>true</code> if information about entire hierarchy is
  3313. required, <code>false</code> otherwise]]>
  3314. </doc>
  3315. </method>
  3316. <method name="setRecursive"
  3317. abstract="true" native="false" synchronized="false"
  3318. static="false" final="false" visibility="public"
  3319. deprecated="not deprecated">
  3320. <param name="recursive" type="boolean"/>
  3321. <doc>
  3322. <![CDATA[Should we fetch information on the entire <em>child queue hierarchy</em>?
  3323. @param recursive fetch information on the entire <em>child queue
  3324. hierarchy</em>?]]>
  3325. </doc>
  3326. </method>
  3327. <doc>
  3328. <![CDATA[<p>The request sent by clients to get <em>queue information</em>
  3329. from the <code>ResourceManager</code>.</p>
  3330. @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
  3331. </doc>
  3332. </class>
  3333. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
  3334. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
  3335. <class name="GetQueueInfoResponse" extends="java.lang.Object"
  3336. abstract="true"
  3337. static="false" final="false" visibility="public"
  3338. deprecated="not deprecated">
  3339. <constructor name="GetQueueInfoResponse"
  3340. static="false" final="false" visibility="public"
  3341. deprecated="not deprecated">
  3342. </constructor>
  3343. <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.records.QueueInfo"
  3344. abstract="true" native="false" synchronized="false"
  3345. static="false" final="false" visibility="public"
  3346. deprecated="not deprecated">
  3347. <doc>
  3348. <![CDATA[Get the <code>QueueInfo</code> for the specified queue.
  3349. @return <code>QueueInfo</code> for the specified queue]]>
  3350. </doc>
  3351. </method>
  3352. <doc>
  3353. <![CDATA[The response sent by the {@code ResourceManager} to a client
  3354. requesting information about queues in the system.
  3355. <p>
  3356. The response includes a {@link QueueInfo} which has details such as
  3357. queue name, used/total capacities, running applications, child queues etc.
  3358. @see QueueInfo
  3359. @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
  3360. </doc>
  3361. </class>
  3362. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
  3363. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
  3364. <class name="GetQueueUserAclsInfoRequest" extends="java.lang.Object"
  3365. abstract="true"
  3366. static="false" final="false" visibility="public"
  3367. deprecated="not deprecated">
  3368. <constructor name="GetQueueUserAclsInfoRequest"
  3369. static="false" final="false" visibility="public"
  3370. deprecated="not deprecated">
  3371. </constructor>
  3372. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"
  3373. abstract="false" native="false" synchronized="false"
  3374. static="true" final="false" visibility="public"
  3375. deprecated="not deprecated">
  3376. </method>
  3377. <doc>
  3378. <![CDATA[<p>The request sent by clients to the <code>ResourceManager</code> to
  3379. get queue acls for the <em>current user</em>.</p>
  3380. <p>Currently, this is empty.</p>
  3381. @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  3382. </doc>
  3383. </class>
  3384. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
  3385. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
  3386. <class name="GetQueueUserAclsInfoResponse" extends="java.lang.Object"
  3387. abstract="true"
  3388. static="false" final="false" visibility="public"
  3389. deprecated="not deprecated">
  3390. <constructor name="GetQueueUserAclsInfoResponse"
  3391. static="false" final="false" visibility="public"
  3392. deprecated="not deprecated">
  3393. </constructor>
  3394. <method name="getUserAclsInfoList" return="java.util.List"
  3395. abstract="true" native="false" synchronized="false"
  3396. static="false" final="false" visibility="public"
  3397. deprecated="not deprecated">
  3398. <doc>
  3399. <![CDATA[Get the <code>QueueUserACLInfo</code> per queue for the user.
  3400. @return <code>QueueUserACLInfo</code> per queue for the user]]>
  3401. </doc>
  3402. </method>
  3403. <doc>
  3404. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to clients
  3405. seeking queue acls for the user.</p>
  3406. <p>The response contains a list of {@link QueueUserACLInfo} which
  3407. provides information about {@link QueueACL} per queue.</p>
  3408. @see QueueACL
  3409. @see QueueUserACLInfo
  3410. @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  3411. </doc>
  3412. </class>
  3413. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
  3414. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest -->
  3415. <class name="IncreaseContainersResourceRequest" extends="java.lang.Object"
  3416. abstract="true"
  3417. static="false" final="false" visibility="public"
  3418. deprecated="not deprecated">
  3419. <constructor name="IncreaseContainersResourceRequest"
  3420. static="false" final="false" visibility="public"
  3421. deprecated="not deprecated">
  3422. </constructor>
  3423. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest"
  3424. abstract="false" native="false" synchronized="false"
  3425. static="true" final="false" visibility="public"
  3426. deprecated="not deprecated">
  3427. <param name="containersToIncrease" type="java.util.List"/>
  3428. </method>
  3429. <method name="getContainersToIncrease" return="java.util.List"
  3430. abstract="true" native="false" synchronized="false"
  3431. static="false" final="false" visibility="public"
  3432. deprecated="not deprecated">
  3433. <doc>
  3434. <![CDATA[Get a list of container tokens to be used for authorization during
  3435. container resource increase.
  3436. <p>
  3437. Note: {@link NMToken} will be used for authenticating communication with
  3438. {@code NodeManager}.
  3439. @return the list of container tokens to be used for authorization during
  3440. container resource increase.
  3441. @see NMToken]]>
  3442. </doc>
  3443. </method>
  3444. <method name="setContainersToIncrease"
  3445. abstract="true" native="false" synchronized="false"
  3446. static="false" final="false" visibility="public"
  3447. deprecated="not deprecated">
  3448. <param name="containersToIncrease" type="java.util.List"/>
  3449. <doc>
  3450. <![CDATA[Set container tokens to be used during container resource increase.
  3451. The token is acquired from
  3452. <code>AllocateResponse.getIncreasedContainers</code>.
  3453. The token contains the container id and resource capability required for
  3454. container resource increase.
  3455. @param containersToIncrease the list of container tokens to be used
  3456. for container resource increase.]]>
  3457. </doc>
  3458. </method>
  3459. <doc>
  3460. <![CDATA[<p>The request sent by <code>Application Master</code> to the
  3461. <code>Node Manager</code> to change the resource quota of a container.</p>
  3462. @see ContainerManagementProtocol#increaseContainersResource(IncreaseContainersResourceRequest)]]>
  3463. </doc>
  3464. </class>
  3465. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest -->
  3466. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse -->
  3467. <class name="IncreaseContainersResourceResponse" extends="java.lang.Object"
  3468. abstract="true"
  3469. static="false" final="false" visibility="public"
  3470. deprecated="not deprecated">
  3471. <constructor name="IncreaseContainersResourceResponse"
  3472. static="false" final="false" visibility="public"
  3473. deprecated="not deprecated">
  3474. </constructor>
  3475. <method name="getSuccessfullyIncreasedContainers" return="java.util.List"
  3476. abstract="true" native="false" synchronized="false"
  3477. static="false" final="false" visibility="public"
  3478. deprecated="not deprecated">
  3479. <doc>
  3480. <![CDATA[Get the list of containerIds of containers whose resource
  3481. have been successfully increased.
  3482. @return the list of containerIds of containers whose resource have
  3483. been successfully increased.]]>
  3484. </doc>
  3485. </method>
  3486. <method name="getFailedRequests" return="java.util.Map"
  3487. abstract="true" native="false" synchronized="false"
  3488. static="false" final="false" visibility="public"
  3489. deprecated="not deprecated">
  3490. <doc>
  3491. <![CDATA[Get the containerId-to-exception map in which the exception indicates
  3492. error from each container for failed requests.
  3493. @return map of containerId-to-exception]]>
  3494. </doc>
  3495. </method>
  3496. <doc>
  3497. <![CDATA[<p>
  3498. The response sent by the <code>NodeManager</code> to the
  3499. <code>ApplicationMaster</code> when asked to increase container resource.
  3500. </p>
  3501. @see ContainerManagementProtocol#increaseContainersResource(IncreaseContainersResourceRequest)]]>
  3502. </doc>
  3503. </class>
  3504. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse -->
  3505. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
  3506. <class name="KillApplicationRequest" extends="java.lang.Object"
  3507. abstract="true"
  3508. static="false" final="false" visibility="public"
  3509. deprecated="not deprecated">
  3510. <constructor name="KillApplicationRequest"
  3511. static="false" final="false" visibility="public"
  3512. deprecated="not deprecated">
  3513. </constructor>
  3514. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"
  3515. abstract="false" native="false" synchronized="false"
  3516. static="true" final="false" visibility="public"
  3517. deprecated="not deprecated">
  3518. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3519. </method>
  3520. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3521. abstract="true" native="false" synchronized="false"
  3522. static="false" final="false" visibility="public"
  3523. deprecated="not deprecated">
  3524. <doc>
  3525. <![CDATA[Get the <code>ApplicationId</code> of the application to be aborted.
  3526. @return <code>ApplicationId</code> of the application to be aborted]]>
  3527. </doc>
  3528. </method>
  3529. <method name="setApplicationId"
  3530. abstract="true" native="false" synchronized="false"
  3531. static="false" final="false" visibility="public"
  3532. deprecated="not deprecated">
  3533. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3534. </method>
  3535. <method name="getDiagnostics" return="java.lang.String"
  3536. abstract="true" native="false" synchronized="false"
  3537. static="false" final="false" visibility="public"
  3538. deprecated="not deprecated">
  3539. <doc>
  3540. <![CDATA[Get the <em>diagnostics</em> to which the application is being killed.
  3541. @return <em>diagnostics</em> to which the application is being killed]]>
  3542. </doc>
  3543. </method>
  3544. <method name="setDiagnostics"
  3545. abstract="true" native="false" synchronized="false"
  3546. static="false" final="false" visibility="public"
  3547. deprecated="not deprecated">
  3548. <param name="diagnostics" type="java.lang.String"/>
  3549. <doc>
  3550. <![CDATA[Set the <em>diagnostics</em> to which the application is being killed.
  3551. @param diagnostics <em>diagnostics</em> to which the application is being
  3552. killed]]>
  3553. </doc>
  3554. </method>
  3555. <doc>
  3556. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  3557. to abort a submitted application.</p>
  3558. <p>The request includes the {@link ApplicationId} of the application to be
  3559. aborted.</p>
  3560. @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
  3561. </doc>
  3562. </class>
  3563. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
  3564. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
  3565. <class name="KillApplicationResponse" extends="java.lang.Object"
  3566. abstract="true"
  3567. static="false" final="false" visibility="public"
  3568. deprecated="not deprecated">
  3569. <constructor name="KillApplicationResponse"
  3570. static="false" final="false" visibility="public"
  3571. deprecated="not deprecated">
  3572. </constructor>
  3573. <method name="getIsKillCompleted" return="boolean"
  3574. abstract="true" native="false" synchronized="false"
  3575. static="false" final="false" visibility="public"
  3576. deprecated="not deprecated">
  3577. <doc>
  3578. <![CDATA[Get the flag which indicates that the process of killing application is completed or not.
  3579. @return true if the process of killing application has completed,
  3580. false otherwise]]>
  3581. </doc>
  3582. </method>
  3583. <doc>
  3584. <![CDATA[The response sent by the <code>ResourceManager</code> to the client aborting
  3585. a submitted application.
  3586. <p>
  3587. The response, includes:
  3588. <ul>
  3589. <li>
  3590. A flag which indicates that the process of killing the application is
  3591. completed or not.
  3592. </li>
  3593. </ul>
  3594. Note: user is recommended to wait until this flag becomes true, otherwise if
  3595. the <code>ResourceManager</code> crashes before the process of killing the
  3596. application is completed, the <code>ResourceManager</code> may retry this
  3597. application on recovery.
  3598. @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
  3599. </doc>
  3600. </class>
  3601. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
  3602. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
  3603. <class name="MoveApplicationAcrossQueuesRequest" extends="java.lang.Object"
  3604. abstract="true"
  3605. static="false" final="false" visibility="public"
  3606. deprecated="not deprecated">
  3607. <constructor name="MoveApplicationAcrossQueuesRequest"
  3608. static="false" final="false" visibility="public"
  3609. deprecated="not deprecated">
  3610. </constructor>
  3611. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"
  3612. abstract="false" native="false" synchronized="false"
  3613. static="true" final="false" visibility="public"
  3614. deprecated="not deprecated">
  3615. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3616. <param name="queue" type="java.lang.String"/>
  3617. </method>
  3618. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3619. abstract="true" native="false" synchronized="false"
  3620. static="false" final="false" visibility="public"
  3621. deprecated="not deprecated">
  3622. <doc>
  3623. <![CDATA[Get the <code>ApplicationId</code> of the application to be moved.
  3624. @return <code>ApplicationId</code> of the application to be moved]]>
  3625. </doc>
  3626. </method>
  3627. <method name="setApplicationId"
  3628. abstract="true" native="false" synchronized="false"
  3629. static="false" final="false" visibility="public"
  3630. deprecated="not deprecated">
  3631. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3632. <doc>
  3633. <![CDATA[Set the <code>ApplicationId</code> of the application to be moved.
  3634. @param appId <code>ApplicationId</code> of the application to be moved]]>
  3635. </doc>
  3636. </method>
  3637. <method name="getTargetQueue" return="java.lang.String"
  3638. abstract="true" native="false" synchronized="false"
  3639. static="false" final="false" visibility="public"
  3640. deprecated="not deprecated">
  3641. <doc>
  3642. <![CDATA[Get the queue to place the application in.
  3643. @return the name of the queue to place the application in]]>
  3644. </doc>
  3645. </method>
  3646. <method name="setTargetQueue"
  3647. abstract="true" native="false" synchronized="false"
  3648. static="false" final="false" visibility="public"
  3649. deprecated="not deprecated">
  3650. <param name="queue" type="java.lang.String"/>
  3651. <doc>
  3652. <![CDATA[Get the queue to place the application in.
  3653. @param queue the name of the queue to place the application in]]>
  3654. </doc>
  3655. </method>
  3656. <doc>
  3657. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  3658. to move a submitted application to a different queue.</p>
  3659. <p>The request includes the {@link ApplicationId} of the application to be
  3660. moved and the queue to place it in.</p>
  3661. @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
  3662. </doc>
  3663. </class>
  3664. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
  3665. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
  3666. <class name="MoveApplicationAcrossQueuesResponse" extends="java.lang.Object"
  3667. abstract="true"
  3668. static="false" final="false" visibility="public"
  3669. deprecated="not deprecated">
  3670. <constructor name="MoveApplicationAcrossQueuesResponse"
  3671. static="false" final="false" visibility="public"
  3672. deprecated="not deprecated">
  3673. </constructor>
  3674. <doc>
  3675. <![CDATA[<p>
  3676. The response sent by the <code>ResourceManager</code> to the client moving
  3677. a submitted application to a different queue.
  3678. </p>
  3679. <p>
  3680. A response without exception means that the move has completed successfully.
  3681. </p>
  3682. @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
  3683. </doc>
  3684. </class>
  3685. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
  3686. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
  3687. <class name="RegisterApplicationMasterRequest" extends="java.lang.Object"
  3688. abstract="true"
  3689. static="false" final="false" visibility="public"
  3690. deprecated="not deprecated">
  3691. <constructor name="RegisterApplicationMasterRequest"
  3692. static="false" final="false" visibility="public"
  3693. deprecated="not deprecated">
  3694. </constructor>
  3695. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"
  3696. abstract="false" native="false" synchronized="false"
  3697. static="true" final="false" visibility="public"
  3698. deprecated="not deprecated">
  3699. <param name="host" type="java.lang.String"/>
  3700. <param name="port" type="int"/>
  3701. <param name="trackingUrl" type="java.lang.String"/>
  3702. <doc>
  3703. <![CDATA[Create a new instance of <code>RegisterApplicationMasterRequest</code>.
  3704. If <em>port, trackingUrl</em> is not used, use the following default value:
  3705. <ul>
  3706. <li>port: -1</li>
  3707. <li>trackingUrl: null</li>
  3708. </ul>
  3709. The port is allowed to be any integer larger than or equal to -1.
  3710. @return the new instance of <code>RegisterApplicationMasterRequest</code>]]>
  3711. </doc>
  3712. </method>
  3713. <method name="getHost" return="java.lang.String"
  3714. abstract="true" native="false" synchronized="false"
  3715. static="false" final="false" visibility="public"
  3716. deprecated="not deprecated">
  3717. <doc>
  3718. <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code> is
  3719. running.
  3720. @return <em>host</em> on which the <code>ApplicationMaster</code> is running]]>
  3721. </doc>
  3722. </method>
  3723. <method name="setHost"
  3724. abstract="true" native="false" synchronized="false"
  3725. static="false" final="false" visibility="public"
  3726. deprecated="not deprecated">
  3727. <param name="host" type="java.lang.String"/>
  3728. <doc>
  3729. <![CDATA[Set the <em>host</em> on which the <code>ApplicationMaster</code> is
  3730. running.
  3731. @param host <em>host</em> on which the <code>ApplicationMaster</code>
  3732. is running]]>
  3733. </doc>
  3734. </method>
  3735. <method name="getRpcPort" return="int"
  3736. abstract="true" native="false" synchronized="false"
  3737. static="false" final="false" visibility="public"
  3738. deprecated="not deprecated">
  3739. <doc>
  3740. <![CDATA[Get the <em>RPC port</em> on which the {@code ApplicationMaster} is
  3741. responding.
  3742. @return the <em>RPC port</em> on which the {@code ApplicationMaster}
  3743. is responding]]>
  3744. </doc>
  3745. </method>
  3746. <method name="setRpcPort"
  3747. abstract="true" native="false" synchronized="false"
  3748. static="false" final="false" visibility="public"
  3749. deprecated="not deprecated">
  3750. <param name="port" type="int"/>
  3751. <doc>
  3752. <![CDATA[Set the <em>RPC port</em> on which the {@code ApplicationMaster} is
  3753. responding.
  3754. @param port <em>RPC port</em> on which the {@code ApplicationMaster}
  3755. is responding]]>
  3756. </doc>
  3757. </method>
  3758. <method name="getTrackingUrl" return="java.lang.String"
  3759. abstract="true" native="false" synchronized="false"
  3760. static="false" final="false" visibility="public"
  3761. deprecated="not deprecated">
  3762. <doc>
  3763. <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
  3764. This url if contains scheme then that will be used by resource manager
  3765. web application proxy otherwise it will default to http.
  3766. @return <em>tracking URL</em> for the <code>ApplicationMaster</code>]]>
  3767. </doc>
  3768. </method>
  3769. <method name="setTrackingUrl"
  3770. abstract="true" native="false" synchronized="false"
  3771. static="false" final="false" visibility="public"
  3772. deprecated="not deprecated">
  3773. <param name="trackingUrl" type="java.lang.String"/>
  3774. <doc>
  3775. <![CDATA[Set the <em>tracking URL</em>for the <code>ApplicationMaster</code> while
  3776. it is running. This is the web-URL to which ResourceManager or
  3777. web-application proxy will redirect client/users while the application and
  3778. the <code>ApplicationMaster</code> are still running.
  3779. <p>
  3780. If the passed url has a scheme then that will be used by the
  3781. ResourceManager and web-application proxy, otherwise the scheme will
  3782. default to http.
  3783. </p>
  3784. <p>
  3785. Empty, null, "N/A" strings are all valid besides a real URL. In case an url
  3786. isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
  3787. <p>
  3788. @param trackingUrl
  3789. <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  3790. </doc>
  3791. </method>
  3792. <doc>
  3793. <![CDATA[The request sent by the {@code ApplicationMaster} to {@code ResourceManager}
  3794. on registration.
  3795. <p>
  3796. The registration includes details such as:
  3797. <ul>
  3798. <li>Hostname on which the AM is running.</li>
  3799. <li>RPC Port</li>
  3800. <li>Tracking URL</li>
  3801. </ul>
  3802. @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
  3803. </doc>
  3804. </class>
  3805. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
  3806. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
  3807. <class name="RegisterApplicationMasterResponse" extends="java.lang.Object"
  3808. abstract="true"
  3809. static="false" final="false" visibility="public"
  3810. deprecated="not deprecated">
  3811. <constructor name="RegisterApplicationMasterResponse"
  3812. static="false" final="false" visibility="public"
  3813. deprecated="not deprecated">
  3814. </constructor>
  3815. <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  3816. abstract="true" native="false" synchronized="false"
  3817. static="false" final="false" visibility="public"
  3818. deprecated="not deprecated">
  3819. <doc>
  3820. <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
  3821. <code>ResourceManager</code> in the cluster.
  3822. @return maximum capability of allocated resources in the cluster]]>
  3823. </doc>
  3824. </method>
  3825. <method name="getApplicationACLs" return="java.util.Map"
  3826. abstract="true" native="false" synchronized="false"
  3827. static="false" final="false" visibility="public"
  3828. deprecated="not deprecated">
  3829. <doc>
  3830. <![CDATA[Get the <code>ApplicationACL</code>s for the application.
  3831. @return all the <code>ApplicationACL</code>s]]>
  3832. </doc>
  3833. </method>
  3834. <method name="getClientToAMTokenMasterKey" return="java.nio.ByteBuffer"
  3835. abstract="true" native="false" synchronized="false"
  3836. static="false" final="false" visibility="public"
  3837. deprecated="not deprecated">
  3838. <doc>
  3839. <![CDATA[<p>Get ClientToAMToken master key.</p>
  3840. <p>The ClientToAMToken master key is sent to <code>ApplicationMaster</code>
  3841. by <code>ResourceManager</code> via {@link RegisterApplicationMasterResponse}
  3842. , used to verify corresponding ClientToAMToken.</p>
  3843. @return ClientToAMToken master key]]>
  3844. </doc>
  3845. </method>
  3846. <method name="setClientToAMTokenMasterKey"
  3847. abstract="true" native="false" synchronized="false"
  3848. static="false" final="false" visibility="public"
  3849. deprecated="not deprecated">
  3850. <param name="key" type="java.nio.ByteBuffer"/>
  3851. <doc>
  3852. <![CDATA[Set ClientToAMToken master key.]]>
  3853. </doc>
  3854. </method>
  3855. <method name="getQueue" return="java.lang.String"
  3856. abstract="true" native="false" synchronized="false"
  3857. static="false" final="false" visibility="public"
  3858. deprecated="not deprecated">
  3859. <doc>
  3860. <![CDATA[<p>Get the queue that the application was placed in.<p>
  3861. @return the queue that the application was placed in.]]>
  3862. </doc>
  3863. </method>
  3864. <method name="setQueue"
  3865. abstract="true" native="false" synchronized="false"
  3866. static="false" final="false" visibility="public"
  3867. deprecated="not deprecated">
  3868. <param name="queue" type="java.lang.String"/>
  3869. <doc>
  3870. <![CDATA[<p>Set the queue that the application was placed in.<p>]]>
  3871. </doc>
  3872. </method>
  3873. <method name="getContainersFromPreviousAttempts" return="java.util.List"
  3874. abstract="true" native="false" synchronized="false"
  3875. static="false" final="false" visibility="public"
  3876. deprecated="not deprecated">
  3877. <doc>
  3878. <![CDATA[<p>
  3879. Get the list of running containers as viewed by
  3880. <code>ResourceManager</code> from previous application attempts.
  3881. </p>
  3882. @return the list of running containers as viewed by
  3883. <code>ResourceManager</code> from previous application attempts
  3884. @see RegisterApplicationMasterResponse#getNMTokensFromPreviousAttempts()]]>
  3885. </doc>
  3886. </method>
  3887. <method name="getNMTokensFromPreviousAttempts" return="java.util.List"
  3888. abstract="true" native="false" synchronized="false"
  3889. static="false" final="false" visibility="public"
  3890. deprecated="not deprecated">
  3891. <doc>
  3892. <![CDATA[Get the list of NMTokens for communicating with the NMs where the
  3893. containers of previous application attempts are running.
  3894. @return the list of NMTokens for communicating with the NMs where the
  3895. containers of previous application attempts are running.
  3896. @see RegisterApplicationMasterResponse#getContainersFromPreviousAttempts()]]>
  3897. </doc>
  3898. </method>
  3899. <method name="getSchedulerResourceTypes" return="java.util.EnumSet"
  3900. abstract="true" native="false" synchronized="false"
  3901. static="false" final="false" visibility="public"
  3902. deprecated="not deprecated">
  3903. <doc>
  3904. <![CDATA[Get a set of the resource types considered by the scheduler.
  3905. @return a Map of RM settings]]>
  3906. </doc>
  3907. </method>
  3908. <doc>
  3909. <![CDATA[The response sent by the {@code ResourceManager} to a new
  3910. {@code ApplicationMaster} on registration.
  3911. <p>
  3912. The response contains critical details such as:
  3913. <ul>
  3914. <li>Maximum capability for allocated resources in the cluster.</li>
  3915. <li>{@code ApplicationACL}s for the application.</li>
  3916. <li>ClientToAMToken master key.</li>
  3917. </ul>
  3918. @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
  3919. </doc>
  3920. </class>
  3921. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
  3922. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest -->
  3923. <class name="ReInitializeContainerRequest" extends="java.lang.Object"
  3924. abstract="true"
  3925. static="false" final="false" visibility="public"
  3926. deprecated="not deprecated">
  3927. <constructor name="ReInitializeContainerRequest"
  3928. static="false" final="false" visibility="public"
  3929. deprecated="not deprecated">
  3930. </constructor>
  3931. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest"
  3932. abstract="false" native="false" synchronized="false"
  3933. static="true" final="false" visibility="public"
  3934. deprecated="not deprecated">
  3935. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  3936. <param name="containerLaunchContext" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  3937. <param name="autoCommit" type="boolean"/>
  3938. <doc>
  3939. <![CDATA[Creates a new instance of the ReInitializationContainerRequest.
  3940. @param containerId Container Id.
  3941. @param containerLaunchContext Container Launch Context.
  3942. @param autoCommit AutoCommit.
  3943. @return ReInitializationContainerRequest.]]>
  3944. </doc>
  3945. </method>
  3946. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  3947. abstract="true" native="false" synchronized="false"
  3948. static="false" final="false" visibility="public"
  3949. deprecated="not deprecated">
  3950. <doc>
  3951. <![CDATA[Get the <code>ContainerId</code> of the container to re-initialize.
  3952. @return <code>ContainerId</code> of the container to re-initialize.]]>
  3953. </doc>
  3954. </method>
  3955. <method name="getContainerLaunchContext" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  3956. abstract="true" native="false" synchronized="false"
  3957. static="false" final="false" visibility="public"
  3958. deprecated="not deprecated">
  3959. <doc>
  3960. <![CDATA[Get the <code>ContainerLaunchContext</code> to re-initialize the container
  3961. with.
  3962. @return <code>ContainerLaunchContext</code> of to re-initialize the
  3963. container with.]]>
  3964. </doc>
  3965. </method>
  3966. <method name="getAutoCommit" return="boolean"
  3967. abstract="true" native="false" synchronized="false"
  3968. static="false" final="false" visibility="public"
  3969. deprecated="not deprecated">
  3970. <doc>
  3971. <![CDATA[Check if AutoCommit is set for this ReInitialization.
  3972. @return If AutoCommit is set for this ReInitialization.]]>
  3973. </doc>
  3974. </method>
  3975. <doc>
  3976. <![CDATA[This encapsulates all the required fields needed for a Container
  3977. ReInitialization.]]>
  3978. </doc>
  3979. </class>
  3980. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest -->
  3981. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerResponse -->
  3982. <class name="ReInitializeContainerResponse" extends="java.lang.Object"
  3983. abstract="true"
  3984. static="false" final="false" visibility="public"
  3985. deprecated="not deprecated">
  3986. <constructor name="ReInitializeContainerResponse"
  3987. static="false" final="false" visibility="public"
  3988. deprecated="not deprecated">
  3989. </constructor>
  3990. <doc>
  3991. <![CDATA[The response to the {@link ReInitializeContainerRequest}.]]>
  3992. </doc>
  3993. </class>
  3994. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerResponse -->
  3995. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
  3996. <class name="ReleaseSharedCacheResourceRequest" extends="java.lang.Object"
  3997. abstract="true"
  3998. static="false" final="false" visibility="public"
  3999. deprecated="not deprecated">
  4000. <constructor name="ReleaseSharedCacheResourceRequest"
  4001. static="false" final="false" visibility="public"
  4002. deprecated="not deprecated">
  4003. </constructor>
  4004. <method name="getAppId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4005. abstract="true" native="false" synchronized="false"
  4006. static="false" final="false" visibility="public"
  4007. deprecated="not deprecated">
  4008. <doc>
  4009. <![CDATA[Get the <code>ApplicationId</code> of the resource to be released.
  4010. @return <code>ApplicationId</code>]]>
  4011. </doc>
  4012. </method>
  4013. <method name="setAppId"
  4014. abstract="true" native="false" synchronized="false"
  4015. static="false" final="false" visibility="public"
  4016. deprecated="not deprecated">
  4017. <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4018. <doc>
  4019. <![CDATA[Set the <code>ApplicationId</code> of the resource to be released.
  4020. @param id <code>ApplicationId</code>]]>
  4021. </doc>
  4022. </method>
  4023. <method name="getResourceKey" return="java.lang.String"
  4024. abstract="true" native="false" synchronized="false"
  4025. static="false" final="false" visibility="public"
  4026. deprecated="not deprecated">
  4027. <doc>
  4028. <![CDATA[Get the <code>key</code> of the resource to be released.
  4029. @return <code>key</code>]]>
  4030. </doc>
  4031. </method>
  4032. <method name="setResourceKey"
  4033. abstract="true" native="false" synchronized="false"
  4034. static="false" final="false" visibility="public"
  4035. deprecated="not deprecated">
  4036. <param name="key" type="java.lang.String"/>
  4037. <doc>
  4038. <![CDATA[Set the <code>key</code> of the resource to be released.
  4039. @param key unique identifier for the resource]]>
  4040. </doc>
  4041. </method>
  4042. <doc>
  4043. <![CDATA[<p>The request from clients to release a resource in the shared cache.</p>]]>
  4044. </doc>
  4045. </class>
  4046. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
  4047. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
  4048. <class name="ReleaseSharedCacheResourceResponse" extends="java.lang.Object"
  4049. abstract="true"
  4050. static="false" final="false" visibility="public"
  4051. deprecated="not deprecated">
  4052. <constructor name="ReleaseSharedCacheResourceResponse"
  4053. static="false" final="false" visibility="public"
  4054. deprecated="not deprecated">
  4055. </constructor>
  4056. <doc>
  4057. <![CDATA[<p>
  4058. The response to clients from the <code>SharedCacheManager</code> when
  4059. releasing a resource in the shared cache.
  4060. </p>
  4061. <p>
  4062. Currently, this is empty.
  4063. </p>]]>
  4064. </doc>
  4065. </class>
  4066. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
  4067. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
  4068. <class name="ReservationDeleteRequest" extends="java.lang.Object"
  4069. abstract="true"
  4070. static="false" final="false" visibility="public"
  4071. deprecated="not deprecated">
  4072. <constructor name="ReservationDeleteRequest"
  4073. static="false" final="false" visibility="public"
  4074. deprecated="not deprecated">
  4075. </constructor>
  4076. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"
  4077. abstract="false" native="false" synchronized="false"
  4078. static="true" final="false" visibility="public"
  4079. deprecated="not deprecated">
  4080. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  4081. </method>
  4082. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  4083. abstract="true" native="false" synchronized="false"
  4084. static="false" final="false" visibility="public"
  4085. deprecated="not deprecated">
  4086. <doc>
  4087. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  4088. allocation in the scheduler (between start and end time of this
  4089. reservation)
  4090. @return the {@link ReservationId} representing the unique id of the
  4091. corresponding reserved resource allocation in the scheduler]]>
  4092. </doc>
  4093. </method>
  4094. <method name="setReservationId"
  4095. abstract="true" native="false" synchronized="false"
  4096. static="false" final="false" visibility="public"
  4097. deprecated="not deprecated">
  4098. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  4099. <doc>
  4100. <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
  4101. allocation in the scheduler (between start and end time of this
  4102. reservation)
  4103. @param reservationId the {@link ReservationId} representing the the unique
  4104. id of the corresponding reserved resource allocation in the
  4105. scheduler]]>
  4106. </doc>
  4107. </method>
  4108. <doc>
  4109. <![CDATA[{@link ReservationDeleteRequest} captures the set of requirements the user
  4110. has to delete an existing reservation.
  4111. @see ReservationDefinition]]>
  4112. </doc>
  4113. </class>
  4114. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
  4115. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
  4116. <class name="ReservationDeleteResponse" extends="java.lang.Object"
  4117. abstract="true"
  4118. static="false" final="false" visibility="public"
  4119. deprecated="not deprecated">
  4120. <constructor name="ReservationDeleteResponse"
  4121. static="false" final="false" visibility="public"
  4122. deprecated="not deprecated">
  4123. </constructor>
  4124. <doc>
  4125. <![CDATA[{@link ReservationDeleteResponse} contains the answer of the admission
  4126. control system in the {@code ResourceManager} to a reservation delete
  4127. operation. Currently response is empty if the operation was successful, if
  4128. not an exception reporting reason for a failure.
  4129. @see ReservationDefinition]]>
  4130. </doc>
  4131. </class>
  4132. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
  4133. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest -->
  4134. <class name="ReservationListRequest" extends="java.lang.Object"
  4135. abstract="true"
  4136. static="false" final="false" visibility="public"
  4137. deprecated="not deprecated">
  4138. <constructor name="ReservationListRequest"
  4139. static="false" final="false" visibility="public"
  4140. deprecated="not deprecated">
  4141. </constructor>
  4142. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
  4143. abstract="false" native="false" synchronized="false"
  4144. static="true" final="false" visibility="public"
  4145. deprecated="not deprecated">
  4146. <param name="queue" type="java.lang.String"/>
  4147. <param name="reservationId" type="java.lang.String"/>
  4148. <param name="startTime" type="long"/>
  4149. <param name="endTime" type="long"/>
  4150. <param name="includeReservationAllocations" type="boolean"/>
  4151. <doc>
  4152. <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
  4153. reservations to list if it is provided. Otherwise, it will select active
  4154. reservations within the startTime and endTime (inclusive).
  4155. @param queue Required. Cannot be null or empty. Refers to the reservable
  4156. queue in the scheduler that was selected when creating a
  4157. reservation submission {@link ReservationSubmissionRequest}.
  4158. @param reservationId Optional. String representation of
  4159. {@code ReservationId} If provided, other fields will
  4160. be ignored.
  4161. @param startTime Optional. If provided, only reservations that
  4162. end after the startTime will be selected. This defaults
  4163. to 0 if an invalid number is used.
  4164. @param endTime Optional. If provided, only reservations that
  4165. start on or before endTime will be selected. This defaults
  4166. to Long.MAX_VALUE if an invalid number is used.
  4167. @param includeReservationAllocations Optional. Flag that
  4168. determines whether the entire reservation allocations are
  4169. to be returned. Reservation allocations are subject to
  4170. change in the event of re-planning as described by
  4171. {@code ReservationDefinition}.
  4172. @return the list of reservations via {@link ReservationListRequest}]]>
  4173. </doc>
  4174. </method>
  4175. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
  4176. abstract="false" native="false" synchronized="false"
  4177. static="true" final="false" visibility="public"
  4178. deprecated="not deprecated">
  4179. <param name="queue" type="java.lang.String"/>
  4180. <param name="reservationId" type="java.lang.String"/>
  4181. <param name="includeReservationAllocations" type="boolean"/>
  4182. <doc>
  4183. <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
  4184. reservations to list if it is provided. Otherwise, it will select active
  4185. reservations within the startTime and endTime (inclusive).
  4186. @param queue Required. Cannot be null or empty. Refers to the reservable
  4187. queue in the scheduler that was selected when creating a
  4188. reservation submission {@link ReservationSubmissionRequest}.
  4189. @param reservationId Optional. String representation of
  4190. {@code ReservationId} If provided, other fields will
  4191. be ignored.
  4192. @param includeReservationAllocations Optional. Flag that
  4193. determines whether the entire reservation allocations are
  4194. to be returned. Reservation allocations are subject to
  4195. change in the event of re-planning as described by
  4196. {@code ReservationDefinition}.
  4197. @return the list of reservations via {@link ReservationListRequest}]]>
  4198. </doc>
  4199. </method>
  4200. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
  4201. abstract="false" native="false" synchronized="false"
  4202. static="true" final="false" visibility="public"
  4203. deprecated="not deprecated">
  4204. <param name="queue" type="java.lang.String"/>
  4205. <param name="reservationId" type="java.lang.String"/>
  4206. <doc>
  4207. <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
  4208. reservations to list if it is provided. Otherwise, it will select active
  4209. reservations within the startTime and endTime (inclusive).
  4210. @param queue Required. Cannot be null or empty. Refers to the reservable
  4211. queue in the scheduler that was selected when creating a
  4212. reservation submission {@link ReservationSubmissionRequest}.
  4213. @param reservationId Optional. String representation of
  4214. {@code ReservationId} If provided, other fields will
  4215. be ignored.
  4216. @return the list of reservations via {@link ReservationListRequest}]]>
  4217. </doc>
  4218. </method>
  4219. <method name="getQueue" return="java.lang.String"
  4220. abstract="true" native="false" synchronized="false"
  4221. static="false" final="false" visibility="public"
  4222. deprecated="not deprecated">
  4223. <doc>
  4224. <![CDATA[Get queue name to use to find reservations.
  4225. @return the queue name to use to find reservations.]]>
  4226. </doc>
  4227. </method>
  4228. <method name="setQueue"
  4229. abstract="true" native="false" synchronized="false"
  4230. static="false" final="false" visibility="public"
  4231. deprecated="not deprecated">
  4232. <param name="queue" type="java.lang.String"/>
  4233. <doc>
  4234. <![CDATA[Set queue name to use to find resource allocations.
  4235. @param queue Required. Cannot be null or empty.]]>
  4236. </doc>
  4237. </method>
  4238. <method name="getReservationId" return="java.lang.String"
  4239. abstract="true" native="false" synchronized="false"
  4240. static="false" final="false" visibility="public"
  4241. deprecated="not deprecated">
  4242. <doc>
  4243. <![CDATA[Get the reservation id to use to find a reservation.
  4244. @return the reservation id of the reservation.]]>
  4245. </doc>
  4246. </method>
  4247. <method name="setReservationId"
  4248. abstract="true" native="false" synchronized="false"
  4249. static="false" final="false" visibility="public"
  4250. deprecated="not deprecated">
  4251. <param name="reservationId" type="java.lang.String"/>
  4252. <doc>
  4253. <![CDATA[Set the reservation id to use to find a reservation.
  4254. @param reservationId Optional. String representation of
  4255. {@code ReservationId} If provided, other fields will
  4256. be ignored.]]>
  4257. </doc>
  4258. </method>
  4259. <method name="getStartTime" return="long"
  4260. abstract="true" native="false" synchronized="false"
  4261. static="false" final="false" visibility="public"
  4262. deprecated="not deprecated">
  4263. <doc>
  4264. <![CDATA[Get the start time to use to search for reservations.
  4265. When this is set, reservations that start before this start
  4266. time are ignored.
  4267. @return the start time to use to search for reservations.]]>
  4268. </doc>
  4269. </method>
  4270. <method name="setStartTime"
  4271. abstract="true" native="false" synchronized="false"
  4272. static="false" final="false" visibility="public"
  4273. deprecated="not deprecated">
  4274. <param name="startTime" type="long"/>
  4275. <doc>
  4276. <![CDATA[Set the start time to use to search for reservations.
  4277. When this is set, reservations that start before this start
  4278. time are ignored.
  4279. @param startTime Optional. If provided, only reservations that
  4280. end after the startTime will be selected. This defaults
  4281. to 0 if an invalid number is used.]]>
  4282. </doc>
  4283. </method>
  4284. <method name="getEndTime" return="long"
  4285. abstract="true" native="false" synchronized="false"
  4286. static="false" final="false" visibility="public"
  4287. deprecated="not deprecated">
  4288. <doc>
  4289. <![CDATA[Get the end time to use to search for reservations.
  4290. When this is set, reservations that start after this end
  4291. time are ignored.
  4292. @return the end time to use to search for reservations.]]>
  4293. </doc>
  4294. </method>
  4295. <method name="setEndTime"
  4296. abstract="true" native="false" synchronized="false"
  4297. static="false" final="false" visibility="public"
  4298. deprecated="not deprecated">
  4299. <param name="endTime" type="long"/>
  4300. <doc>
  4301. <![CDATA[Set the end time to use to search for reservations.
  4302. When this is set, reservations that start after this end
  4303. time are ignored.
  4304. @param endTime Optional. If provided, only reservations that
  4305. start before endTime will be selected. This defaults
  4306. to Long.MAX_VALUE if an invalid number is used.]]>
  4307. </doc>
  4308. </method>
  4309. <method name="getIncludeResourceAllocations" return="boolean"
  4310. abstract="true" native="false" synchronized="false"
  4311. static="false" final="false" visibility="public"
  4312. deprecated="not deprecated">
  4313. <doc>
  4314. <![CDATA[Get the boolean representing whether or not the user
  4315. is requesting the full resource allocation.
  4316. If this is true, the full resource allocation will
  4317. be included in the response.
  4318. @return the end time to use to search for reservations.]]>
  4319. </doc>
  4320. </method>
  4321. <method name="setIncludeResourceAllocations"
  4322. abstract="true" native="false" synchronized="false"
  4323. static="false" final="false" visibility="public"
  4324. deprecated="not deprecated">
  4325. <param name="includeReservationAllocations" type="boolean"/>
  4326. <doc>
  4327. <![CDATA[Set the boolean representing whether or not the user
  4328. is requesting the full resource allocation.
  4329. If this is true, the full resource allocation will
  4330. be included in the response.
  4331. @param includeReservationAllocations Optional. Flag that
  4332. determines whether the entire list of
  4333. {@code ResourceAllocationRequest} will be returned.]]>
  4334. </doc>
  4335. </method>
  4336. <doc>
  4337. <![CDATA[{@link ReservationListRequest} captures the set of requirements the
  4338. user has to list reservations.]]>
  4339. </doc>
  4340. </class>
  4341. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest -->
  4342. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse -->
  4343. <class name="ReservationListResponse" extends="java.lang.Object"
  4344. abstract="true"
  4345. static="false" final="false" visibility="public"
  4346. deprecated="not deprecated">
  4347. <constructor name="ReservationListResponse"
  4348. static="false" final="false" visibility="public"
  4349. deprecated="not deprecated">
  4350. </constructor>
  4351. <method name="getReservationAllocationState" return="java.util.List"
  4352. abstract="true" native="false" synchronized="false"
  4353. static="false" final="false" visibility="public"
  4354. deprecated="not deprecated">
  4355. <doc>
  4356. <![CDATA[Get the list of {@link ReservationAllocationState}, that corresponds
  4357. to a reservation in the scheduler.
  4358. @return the list of {@link ReservationAllocationState} which holds
  4359. information of a particular reservation]]>
  4360. </doc>
  4361. </method>
  4362. <doc>
  4363. <![CDATA[{@link ReservationListResponse} captures the list of reservations that the
  4364. user has queried.
  4365. The resulting list of {@link ReservationAllocationState} contains a list of
  4366. {@code ResourceAllocationRequest} representing the current state of the
  4367. reservation resource allocations will be returned. This is subject to change
  4368. in the event of re-planning a described by {@code ReservationDefinition}
  4369. @see ReservationAllocationState]]>
  4370. </doc>
  4371. </class>
  4372. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse -->
  4373. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
  4374. <class name="ReservationSubmissionRequest" extends="java.lang.Object"
  4375. abstract="true"
  4376. static="false" final="false" visibility="public"
  4377. deprecated="not deprecated">
  4378. <constructor name="ReservationSubmissionRequest"
  4379. static="false" final="false" visibility="public"
  4380. deprecated="not deprecated">
  4381. </constructor>
  4382. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"
  4383. abstract="false" native="false" synchronized="false"
  4384. static="true" final="false" visibility="public"
  4385. deprecated="not deprecated">
  4386. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  4387. <param name="queueName" type="java.lang.String"/>
  4388. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  4389. </method>
  4390. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  4391. abstract="true" native="false" synchronized="false"
  4392. static="false" final="false" visibility="public"
  4393. deprecated="not deprecated">
  4394. <doc>
  4395. <![CDATA[Get the {@link ReservationDefinition} representing the user constraints for
  4396. this reservation
  4397. @return the reservation definition representing user constraints]]>
  4398. </doc>
  4399. </method>
  4400. <method name="setReservationDefinition"
  4401. abstract="true" native="false" synchronized="false"
  4402. static="false" final="false" visibility="public"
  4403. deprecated="not deprecated">
  4404. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  4405. <doc>
  4406. <![CDATA[Set the {@link ReservationDefinition} representing the user constraints for
  4407. this reservation
  4408. @param reservationDefinition the reservation request representing the
  4409. reservation]]>
  4410. </doc>
  4411. </method>
  4412. <method name="getQueue" return="java.lang.String"
  4413. abstract="true" native="false" synchronized="false"
  4414. static="false" final="false" visibility="public"
  4415. deprecated="not deprecated">
  4416. <doc>
  4417. <![CDATA[Get the name of the {@code Plan} that corresponds to the name of the
  4418. {@link QueueInfo} in the scheduler to which the reservation will be
  4419. submitted to.
  4420. @return the name of the {@code Plan} that corresponds to the name of the
  4421. {@link QueueInfo} in the scheduler to which the reservation will be
  4422. submitted to]]>
  4423. </doc>
  4424. </method>
  4425. <method name="setQueue"
  4426. abstract="true" native="false" synchronized="false"
  4427. static="false" final="false" visibility="public"
  4428. deprecated="not deprecated">
  4429. <param name="queueName" type="java.lang.String"/>
  4430. <doc>
  4431. <![CDATA[Set the name of the {@code Plan} that corresponds to the name of the
  4432. {@link QueueInfo} in the scheduler to which the reservation will be
  4433. submitted to
  4434. @param queueName the name of the parent {@code Plan} that corresponds to
  4435. the name of the {@link QueueInfo} in the scheduler to which the
  4436. reservation will be submitted to]]>
  4437. </doc>
  4438. </method>
  4439. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  4440. abstract="true" native="false" synchronized="false"
  4441. static="false" final="false" visibility="public"
  4442. deprecated="not deprecated">
  4443. <doc>
  4444. <![CDATA[Get the reservation id that corresponds to the reservation submission.
  4445. @return reservation id that will be used to identify the reservation
  4446. submission.]]>
  4447. </doc>
  4448. </method>
  4449. <method name="setReservationId"
  4450. abstract="true" native="false" synchronized="false"
  4451. static="false" final="false" visibility="public"
  4452. deprecated="not deprecated">
  4453. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  4454. <doc>
  4455. <![CDATA[Set the reservation id that corresponds to the reservation submission.
  4456. @param reservationId reservation id that will be used to identify the
  4457. reservation submission.]]>
  4458. </doc>
  4459. </method>
  4460. <doc>
  4461. <![CDATA[{@link ReservationSubmissionRequest} captures the set of requirements the
  4462. user has to create a reservation.
  4463. @see ReservationDefinition]]>
  4464. </doc>
  4465. </class>
  4466. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
  4467. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
  4468. <class name="ReservationSubmissionResponse" extends="java.lang.Object"
  4469. abstract="true"
  4470. static="false" final="false" visibility="public"
  4471. deprecated="not deprecated">
  4472. <constructor name="ReservationSubmissionResponse"
  4473. static="false" final="false" visibility="public"
  4474. deprecated="not deprecated">
  4475. </constructor>
  4476. <doc>
  4477. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client on
  4478. reservation submission.</p>
  4479. <p>Currently, this is empty.</p>
  4480. {@code ApplicationClientProtocol#submitReservation(
  4481. ReservationSubmissionRequest)}]]>
  4482. </doc>
  4483. </class>
  4484. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
  4485. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
  4486. <class name="ReservationUpdateRequest" extends="java.lang.Object"
  4487. abstract="true"
  4488. static="false" final="false" visibility="public"
  4489. deprecated="not deprecated">
  4490. <constructor name="ReservationUpdateRequest"
  4491. static="false" final="false" visibility="public"
  4492. deprecated="not deprecated">
  4493. </constructor>
  4494. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"
  4495. abstract="false" native="false" synchronized="false"
  4496. static="true" final="false" visibility="public"
  4497. deprecated="not deprecated">
  4498. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  4499. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  4500. </method>
  4501. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  4502. abstract="true" native="false" synchronized="false"
  4503. static="false" final="false" visibility="public"
  4504. deprecated="not deprecated">
  4505. <doc>
  4506. <![CDATA[Get the {@link ReservationDefinition} representing the updated user
  4507. constraints for this reservation
  4508. @return the reservation definition representing user constraints]]>
  4509. </doc>
  4510. </method>
  4511. <method name="setReservationDefinition"
  4512. abstract="true" native="false" synchronized="false"
  4513. static="false" final="false" visibility="public"
  4514. deprecated="not deprecated">
  4515. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  4516. <doc>
  4517. <![CDATA[Set the {@link ReservationDefinition} representing the updated user
  4518. constraints for this reservation
  4519. @param reservationDefinition the reservation request representing the
  4520. reservation]]>
  4521. </doc>
  4522. </method>
  4523. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  4524. abstract="true" native="false" synchronized="false"
  4525. static="false" final="false" visibility="public"
  4526. deprecated="not deprecated">
  4527. <doc>
  4528. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  4529. allocation in the scheduler (between start and end time of this
  4530. reservation)
  4531. @return the {@link ReservationId} representing the unique id of the
  4532. corresponding reserved resource allocation in the scheduler]]>
  4533. </doc>
  4534. </method>
  4535. <method name="setReservationId"
  4536. abstract="true" native="false" synchronized="false"
  4537. static="false" final="false" visibility="public"
  4538. deprecated="not deprecated">
  4539. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  4540. <doc>
  4541. <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
  4542. allocation in the scheduler (between start and end time of this
  4543. reservation)
  4544. @param reservationId the {@link ReservationId} representing the the unique
  4545. id of the corresponding reserved resource allocation in the
  4546. scheduler]]>
  4547. </doc>
  4548. </method>
  4549. <doc>
  4550. <![CDATA[{@link ReservationUpdateRequest} captures the set of requirements the user
  4551. has to update an existing reservation.
  4552. @see ReservationDefinition]]>
  4553. </doc>
  4554. </class>
  4555. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
  4556. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
  4557. <class name="ReservationUpdateResponse" extends="java.lang.Object"
  4558. abstract="true"
  4559. static="false" final="false" visibility="public"
  4560. deprecated="not deprecated">
  4561. <constructor name="ReservationUpdateResponse"
  4562. static="false" final="false" visibility="public"
  4563. deprecated="not deprecated">
  4564. </constructor>
  4565. <doc>
  4566. <![CDATA[{@link ReservationUpdateResponse} contains the answer of the admission
  4567. control system in the {@code ResourceManager} to a reservation update
  4568. operation. Currently response is empty if the operation was successful, if
  4569. not an exception reporting reason for a failure.
  4570. @see ReservationDefinition]]>
  4571. </doc>
  4572. </class>
  4573. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
  4574. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest -->
  4575. <class name="ResourceLocalizationRequest" extends="java.lang.Object"
  4576. abstract="true"
  4577. static="false" final="false" visibility="public"
  4578. deprecated="not deprecated">
  4579. <constructor name="ResourceLocalizationRequest"
  4580. static="false" final="false" visibility="public"
  4581. deprecated="not deprecated">
  4582. </constructor>
  4583. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest"
  4584. abstract="false" native="false" synchronized="false"
  4585. static="true" final="false" visibility="public"
  4586. deprecated="not deprecated">
  4587. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  4588. <param name="localResources" type="java.util.Map"/>
  4589. </method>
  4590. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  4591. abstract="true" native="false" synchronized="false"
  4592. static="false" final="false" visibility="public"
  4593. deprecated="not deprecated">
  4594. <doc>
  4595. <![CDATA[Get the <code>ContainerId</code> of the container to localize resources.
  4596. @return <code>ContainerId</code> of the container to localize resources.]]>
  4597. </doc>
  4598. </method>
  4599. <method name="getLocalResources" return="java.util.Map"
  4600. abstract="true" native="false" synchronized="false"
  4601. static="false" final="false" visibility="public"
  4602. deprecated="not deprecated">
  4603. <doc>
  4604. <![CDATA[Get <code>LocalResource</code> required by the container.
  4605. @return all <code>LocalResource</code> required by the container]]>
  4606. </doc>
  4607. </method>
  4608. <doc>
  4609. <![CDATA[The request sent by the ApplicationMaster to ask for localizing resources.]]>
  4610. </doc>
  4611. </class>
  4612. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest -->
  4613. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationResponse -->
  4614. <class name="ResourceLocalizationResponse" extends="java.lang.Object"
  4615. abstract="true"
  4616. static="false" final="false" visibility="public"
  4617. deprecated="not deprecated">
  4618. <constructor name="ResourceLocalizationResponse"
  4619. static="false" final="false" visibility="public"
  4620. deprecated="not deprecated">
  4621. </constructor>
  4622. <doc>
  4623. <![CDATA[The response to the {@link ResourceLocalizationRequest}]]>
  4624. </doc>
  4625. </class>
  4626. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationResponse -->
  4627. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RestartContainerResponse -->
  4628. <class name="RestartContainerResponse" extends="java.lang.Object"
  4629. abstract="true"
  4630. static="false" final="false" visibility="public"
  4631. deprecated="not deprecated">
  4632. <constructor name="RestartContainerResponse"
  4633. static="false" final="false" visibility="public"
  4634. deprecated="not deprecated">
  4635. </constructor>
  4636. <doc>
  4637. <![CDATA[The response to a restart Container request.]]>
  4638. </doc>
  4639. </class>
  4640. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RestartContainerResponse -->
  4641. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RollbackResponse -->
  4642. <class name="RollbackResponse" extends="java.lang.Object"
  4643. abstract="true"
  4644. static="false" final="false" visibility="public"
  4645. deprecated="not deprecated">
  4646. <constructor name="RollbackResponse"
  4647. static="false" final="false" visibility="public"
  4648. deprecated="not deprecated">
  4649. </constructor>
  4650. <doc>
  4651. <![CDATA[Response to a Rollback request.]]>
  4652. </doc>
  4653. </class>
  4654. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RollbackResponse -->
  4655. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest -->
  4656. <class name="SignalContainerRequest" extends="java.lang.Object"
  4657. abstract="true"
  4658. static="false" final="false" visibility="public"
  4659. deprecated="not deprecated">
  4660. <constructor name="SignalContainerRequest"
  4661. static="false" final="false" visibility="public"
  4662. deprecated="not deprecated">
  4663. </constructor>
  4664. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest"
  4665. abstract="false" native="false" synchronized="false"
  4666. static="true" final="false" visibility="public"
  4667. deprecated="not deprecated">
  4668. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  4669. <param name="signalContainerCommand" type="org.apache.hadoop.yarn.api.records.SignalContainerCommand"/>
  4670. </method>
  4671. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  4672. abstract="true" native="false" synchronized="false"
  4673. static="false" final="false" visibility="public"
  4674. deprecated="not deprecated">
  4675. <doc>
  4676. <![CDATA[Get the <code>ContainerId</code> of the container to signal.
  4677. @return <code>ContainerId</code> of the container to signal.]]>
  4678. </doc>
  4679. </method>
  4680. <method name="setContainerId"
  4681. abstract="true" native="false" synchronized="false"
  4682. static="false" final="false" visibility="public"
  4683. deprecated="not deprecated">
  4684. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  4685. <doc>
  4686. <![CDATA[Set the <code>ContainerId</code> of the container to signal.]]>
  4687. </doc>
  4688. </method>
  4689. <method name="getCommand" return="org.apache.hadoop.yarn.api.records.SignalContainerCommand"
  4690. abstract="true" native="false" synchronized="false"
  4691. static="false" final="false" visibility="public"
  4692. deprecated="not deprecated">
  4693. <doc>
  4694. <![CDATA[Get the <code>SignalContainerCommand</code> of the signal request.
  4695. @return <code>SignalContainerCommand</code> of the signal request.]]>
  4696. </doc>
  4697. </method>
  4698. <method name="setCommand"
  4699. abstract="true" native="false" synchronized="false"
  4700. static="false" final="false" visibility="public"
  4701. deprecated="not deprecated">
  4702. <param name="command" type="org.apache.hadoop.yarn.api.records.SignalContainerCommand"/>
  4703. <doc>
  4704. <![CDATA[Set the <code>SignalContainerCommand</code> of the signal request.]]>
  4705. </doc>
  4706. </method>
  4707. <doc>
  4708. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  4709. or by the <code>ApplicationMaster</code> to the <code>NodeManager</code>
  4710. to signal a container.
  4711. @see SignalContainerCommand </p>]]>
  4712. </doc>
  4713. </class>
  4714. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest -->
  4715. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse -->
  4716. <class name="SignalContainerResponse" extends="java.lang.Object"
  4717. abstract="true"
  4718. static="false" final="false" visibility="public"
  4719. deprecated="not deprecated">
  4720. <constructor name="SignalContainerResponse"
  4721. static="false" final="false" visibility="public"
  4722. deprecated="not deprecated">
  4723. </constructor>
  4724. <doc>
  4725. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client
  4726. signalling a container.</p>
  4727. <p>Currently it's empty.</p>
  4728. @see ApplicationClientProtocol#signalToContainer(SignalContainerRequest)]]>
  4729. </doc>
  4730. </class>
  4731. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse -->
  4732. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
  4733. <class name="StartContainerRequest" extends="java.lang.Object"
  4734. abstract="true"
  4735. static="false" final="false" visibility="public"
  4736. deprecated="not deprecated">
  4737. <constructor name="StartContainerRequest"
  4738. static="false" final="false" visibility="public"
  4739. deprecated="not deprecated">
  4740. </constructor>
  4741. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest"
  4742. abstract="false" native="false" synchronized="false"
  4743. static="true" final="false" visibility="public"
  4744. deprecated="not deprecated">
  4745. <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4746. <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
  4747. </method>
  4748. <method name="getContainerLaunchContext" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  4749. abstract="true" native="false" synchronized="false"
  4750. static="false" final="false" visibility="public"
  4751. deprecated="not deprecated">
  4752. <doc>
  4753. <![CDATA[Get the <code>ContainerLaunchContext</code> for the container to be started
  4754. by the <code>NodeManager</code>.
  4755. @return <code>ContainerLaunchContext</code> for the container to be started
  4756. by the <code>NodeManager</code>]]>
  4757. </doc>
  4758. </method>
  4759. <method name="setContainerLaunchContext"
  4760. abstract="true" native="false" synchronized="false"
  4761. static="false" final="false" visibility="public"
  4762. deprecated="not deprecated">
  4763. <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4764. <doc>
  4765. <![CDATA[Set the <code>ContainerLaunchContext</code> for the container to be started
  4766. by the <code>NodeManager</code>
  4767. @param context <code>ContainerLaunchContext</code> for the container to be
  4768. started by the <code>NodeManager</code>]]>
  4769. </doc>
  4770. </method>
  4771. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  4772. abstract="true" native="false" synchronized="false"
  4773. static="false" final="false" visibility="public"
  4774. deprecated="not deprecated">
  4775. <doc>
  4776. <![CDATA[Get the container token to be used for authorization during starting
  4777. container.
  4778. <p>
  4779. Note: {@link NMToken} will be used for authenticating communication with
  4780. {@code NodeManager}.
  4781. @return the container token to be used for authorization during starting
  4782. container.
  4783. @see NMToken
  4784. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  4785. </doc>
  4786. </method>
  4787. <method name="setContainerToken"
  4788. abstract="true" native="false" synchronized="false"
  4789. static="false" final="false" visibility="public"
  4790. deprecated="not deprecated">
  4791. <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
  4792. </method>
  4793. <doc>
  4794. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
  4795. <code>NodeManager</code> to <em>start</em> a container.</p>
  4796. <p>The <code>ApplicationMaster</code> has to provide details such as
  4797. allocated resource capability, security tokens (if enabled), command
  4798. to be executed to start the container, environment for the process,
  4799. necessary binaries/jar/shared-objects etc. via the
  4800. {@link ContainerLaunchContext}.</p>
  4801. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  4802. </doc>
  4803. </class>
  4804. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
  4805. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
  4806. <class name="StartContainersRequest" extends="java.lang.Object"
  4807. abstract="true"
  4808. static="false" final="false" visibility="public"
  4809. deprecated="not deprecated">
  4810. <constructor name="StartContainersRequest"
  4811. static="false" final="false" visibility="public"
  4812. deprecated="not deprecated">
  4813. </constructor>
  4814. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"
  4815. abstract="false" native="false" synchronized="false"
  4816. static="true" final="false" visibility="public"
  4817. deprecated="not deprecated">
  4818. <param name="requests" type="java.util.List"/>
  4819. </method>
  4820. <method name="getStartContainerRequests" return="java.util.List"
  4821. abstract="true" native="false" synchronized="false"
  4822. static="false" final="false" visibility="public"
  4823. deprecated="not deprecated">
  4824. <doc>
  4825. <![CDATA[Get a list of {@link StartContainerRequest} to start containers.
  4826. @return a list of {@link StartContainerRequest} to start containers.]]>
  4827. </doc>
  4828. </method>
  4829. <method name="setStartContainerRequests"
  4830. abstract="true" native="false" synchronized="false"
  4831. static="false" final="false" visibility="public"
  4832. deprecated="not deprecated">
  4833. <param name="request" type="java.util.List"/>
  4834. <doc>
  4835. <![CDATA[Set a list of {@link StartContainerRequest} to start containers.
  4836. @param request a list of {@link StartContainerRequest} to start containers]]>
  4837. </doc>
  4838. </method>
  4839. <doc>
  4840. <![CDATA[<p>
  4841. The request which contains a list of {@link StartContainerRequest} sent by
  4842. the <code>ApplicationMaster</code> to the <code>NodeManager</code> to
  4843. <em>start</em> containers.
  4844. </p>
  4845. <p>
  4846. In each {@link StartContainerRequest}, the <code>ApplicationMaster</code> has
  4847. to provide details such as allocated resource capability, security tokens (if
  4848. enabled), command to be executed to start the container, environment for the
  4849. process, necessary binaries/jar/shared-objects etc. via the
  4850. {@link ContainerLaunchContext}.
  4851. </p>
  4852. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  4853. </doc>
  4854. </class>
  4855. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
  4856. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
  4857. <class name="StartContainersResponse" extends="java.lang.Object"
  4858. abstract="true"
  4859. static="false" final="false" visibility="public"
  4860. deprecated="not deprecated">
  4861. <constructor name="StartContainersResponse"
  4862. static="false" final="false" visibility="public"
  4863. deprecated="not deprecated">
  4864. </constructor>
  4865. <method name="getSuccessfullyStartedContainers" return="java.util.List"
  4866. abstract="true" native="false" synchronized="false"
  4867. static="false" final="false" visibility="public"
  4868. deprecated="not deprecated">
  4869. <doc>
  4870. <![CDATA[Get the list of <code>ContainerId</code> s of the containers that are
  4871. started successfully.
  4872. @return the list of <code>ContainerId</code> s of the containers that are
  4873. started successfully.
  4874. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  4875. </doc>
  4876. </method>
  4877. <method name="getFailedRequests" return="java.util.Map"
  4878. abstract="true" native="false" synchronized="false"
  4879. static="false" final="false" visibility="public"
  4880. deprecated="not deprecated">
  4881. <doc>
  4882. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  4883. from per container for failed requests
  4884. @return map of containerId-to-exception]]>
  4885. </doc>
  4886. </method>
  4887. <method name="getAllServicesMetaData" return="java.util.Map"
  4888. abstract="true" native="false" synchronized="false"
  4889. static="false" final="false" visibility="public"
  4890. deprecated="not deprecated">
  4891. <doc>
  4892. <![CDATA[<p>
  4893. Get the meta-data from all auxiliary services running on the
  4894. <code>NodeManager</code>.
  4895. </p>
  4896. <p>
  4897. The meta-data is returned as a Map between the auxiliary service names and
  4898. their corresponding per service meta-data as an opaque blob
  4899. <code>ByteBuffer</code>
  4900. </p>
  4901. <p>
  4902. To be able to interpret the per-service meta-data, you should consult the
  4903. documentation for the Auxiliary-service configured on the NodeManager
  4904. </p>
  4905. @return a Map between the names of auxiliary services and their
  4906. corresponding meta-data]]>
  4907. </doc>
  4908. </method>
  4909. <doc>
  4910. <![CDATA[<p>
  4911. The response sent by the <code>NodeManager</code> to the
  4912. <code>ApplicationMaster</code> when asked to <em>start</em> an allocated
  4913. container.
  4914. </p>
  4915. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  4916. </doc>
  4917. </class>
  4918. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
  4919. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
  4920. <class name="StopContainersRequest" extends="java.lang.Object"
  4921. abstract="true"
  4922. static="false" final="false" visibility="public"
  4923. deprecated="not deprecated">
  4924. <constructor name="StopContainersRequest"
  4925. static="false" final="false" visibility="public"
  4926. deprecated="not deprecated">
  4927. </constructor>
  4928. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"
  4929. abstract="false" native="false" synchronized="false"
  4930. static="true" final="false" visibility="public"
  4931. deprecated="not deprecated">
  4932. <param name="containerIds" type="java.util.List"/>
  4933. </method>
  4934. <method name="getContainerIds" return="java.util.List"
  4935. abstract="true" native="false" synchronized="false"
  4936. static="false" final="false" visibility="public"
  4937. deprecated="not deprecated">
  4938. <doc>
  4939. <![CDATA[Get the <code>ContainerId</code>s of the containers to be stopped.
  4940. @return <code>ContainerId</code>s of containers to be stopped]]>
  4941. </doc>
  4942. </method>
  4943. <method name="setContainerIds"
  4944. abstract="true" native="false" synchronized="false"
  4945. static="false" final="false" visibility="public"
  4946. deprecated="not deprecated">
  4947. <param name="containerIds" type="java.util.List"/>
  4948. <doc>
  4949. <![CDATA[Set the <code>ContainerId</code>s of the containers to be stopped.
  4950. @param containerIds <code>ContainerId</code>s of the containers to be stopped]]>
  4951. </doc>
  4952. </method>
  4953. <doc>
  4954. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
  4955. <code>NodeManager</code> to <em>stop</em> containers.</p>
  4956. @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
  4957. </doc>
  4958. </class>
  4959. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
  4960. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
  4961. <class name="StopContainersResponse" extends="java.lang.Object"
  4962. abstract="true"
  4963. static="false" final="false" visibility="public"
  4964. deprecated="not deprecated">
  4965. <constructor name="StopContainersResponse"
  4966. static="false" final="false" visibility="public"
  4967. deprecated="not deprecated">
  4968. </constructor>
  4969. <method name="getSuccessfullyStoppedContainers" return="java.util.List"
  4970. abstract="true" native="false" synchronized="false"
  4971. static="false" final="false" visibility="public"
  4972. deprecated="not deprecated">
  4973. <doc>
  4974. <![CDATA[Get the list of containerIds of successfully stopped containers.
  4975. @return the list of containerIds of successfully stopped containers.]]>
  4976. </doc>
  4977. </method>
  4978. <method name="getFailedRequests" return="java.util.Map"
  4979. abstract="true" native="false" synchronized="false"
  4980. static="false" final="false" visibility="public"
  4981. deprecated="not deprecated">
  4982. <doc>
  4983. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  4984. from per container for failed requests
  4985. @return map of containerId-to-exception]]>
  4986. </doc>
  4987. </method>
  4988. <doc>
  4989. <![CDATA[<p>
  4990. The response sent by the <code>NodeManager</code> to the
  4991. <code>ApplicationMaster</code> when asked to <em>stop</em> allocated
  4992. containers.
  4993. </p>
  4994. @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
  4995. </doc>
  4996. </class>
  4997. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
  4998. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
  4999. <class name="SubmitApplicationRequest" extends="java.lang.Object"
  5000. abstract="true"
  5001. static="false" final="false" visibility="public"
  5002. deprecated="not deprecated">
  5003. <constructor name="SubmitApplicationRequest"
  5004. static="false" final="false" visibility="public"
  5005. deprecated="not deprecated">
  5006. </constructor>
  5007. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"
  5008. abstract="false" native="false" synchronized="false"
  5009. static="true" final="false" visibility="public"
  5010. deprecated="not deprecated">
  5011. <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
  5012. </method>
  5013. <method name="getApplicationSubmissionContext" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  5014. abstract="true" native="false" synchronized="false"
  5015. static="false" final="false" visibility="public"
  5016. deprecated="not deprecated">
  5017. <doc>
  5018. <![CDATA[Get the <code>ApplicationSubmissionContext</code> for the application.
  5019. @return <code>ApplicationSubmissionContext</code> for the application]]>
  5020. </doc>
  5021. </method>
  5022. <method name="setApplicationSubmissionContext"
  5023. abstract="true" native="false" synchronized="false"
  5024. static="false" final="false" visibility="public"
  5025. deprecated="not deprecated">
  5026. <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
  5027. <doc>
  5028. <![CDATA[Set the <code>ApplicationSubmissionContext</code> for the application.
  5029. @param context <code>ApplicationSubmissionContext</code> for the
  5030. application]]>
  5031. </doc>
  5032. </method>
  5033. <doc>
  5034. <![CDATA[<p>The request sent by a client to <em>submit an application</em> to the
  5035. <code>ResourceManager</code>.</p>
  5036. <p>The request, via {@link ApplicationSubmissionContext}, contains
  5037. details such as queue, {@link Resource} required to run the
  5038. <code>ApplicationMaster</code>, the equivalent of
  5039. {@link ContainerLaunchContext} for launching the
  5040. <code>ApplicationMaster</code> etc.
  5041. @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
  5042. </doc>
  5043. </class>
  5044. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
  5045. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
  5046. <class name="SubmitApplicationResponse" extends="java.lang.Object"
  5047. abstract="true"
  5048. static="false" final="false" visibility="public"
  5049. deprecated="not deprecated">
  5050. <constructor name="SubmitApplicationResponse"
  5051. static="false" final="false" visibility="public"
  5052. deprecated="not deprecated">
  5053. </constructor>
  5054. <doc>
  5055. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client on
  5056. application submission.</p>
  5057. <p>Currently, this is empty.</p>
  5058. @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
  5059. </doc>
  5060. </class>
  5061. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
  5062. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest -->
  5063. <class name="UpdateApplicationPriorityRequest" extends="java.lang.Object"
  5064. abstract="true"
  5065. static="false" final="false" visibility="public"
  5066. deprecated="not deprecated">
  5067. <constructor name="UpdateApplicationPriorityRequest"
  5068. static="false" final="false" visibility="public"
  5069. deprecated="not deprecated">
  5070. </constructor>
  5071. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest"
  5072. abstract="false" native="false" synchronized="false"
  5073. static="true" final="false" visibility="public"
  5074. deprecated="not deprecated">
  5075. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5076. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5077. </method>
  5078. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5079. abstract="true" native="false" synchronized="false"
  5080. static="false" final="false" visibility="public"
  5081. deprecated="not deprecated">
  5082. <doc>
  5083. <![CDATA[Get the <code>ApplicationId</code> of the application.
  5084. @return <code>ApplicationId</code> of the application]]>
  5085. </doc>
  5086. </method>
  5087. <method name="setApplicationId"
  5088. abstract="true" native="false" synchronized="false"
  5089. static="false" final="false" visibility="public"
  5090. deprecated="not deprecated">
  5091. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5092. <doc>
  5093. <![CDATA[Set the <code>ApplicationId</code> of the application.
  5094. @param applicationId <code>ApplicationId</code> of the application]]>
  5095. </doc>
  5096. </method>
  5097. <method name="getApplicationPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  5098. abstract="true" native="false" synchronized="false"
  5099. static="false" final="false" visibility="public"
  5100. deprecated="not deprecated">
  5101. <doc>
  5102. <![CDATA[Get the <code>Priority</code> of the application to be set.
  5103. @return <code>Priority</code> of the application to be set.]]>
  5104. </doc>
  5105. </method>
  5106. <method name="setApplicationPriority"
  5107. abstract="true" native="false" synchronized="false"
  5108. static="false" final="false" visibility="public"
  5109. deprecated="not deprecated">
  5110. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5111. <doc>
  5112. <![CDATA[Set the <code>Priority</code> of the application.
  5113. @param priority <code>Priority</code> of the application]]>
  5114. </doc>
  5115. </method>
  5116. <doc>
  5117. <![CDATA[<p>
  5118. The request sent by the client to the <code>ResourceManager</code> to set or
  5119. update the application priority.
  5120. </p>
  5121. <p>
  5122. The request includes the {@link ApplicationId} of the application and
  5123. {@link Priority} to be set for an application
  5124. </p>
  5125. @see ApplicationClientProtocol#updateApplicationPriority(UpdateApplicationPriorityRequest)]]>
  5126. </doc>
  5127. </class>
  5128. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest -->
  5129. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse -->
  5130. <class name="UpdateApplicationPriorityResponse" extends="java.lang.Object"
  5131. abstract="true"
  5132. static="false" final="false" visibility="public"
  5133. deprecated="not deprecated">
  5134. <constructor name="UpdateApplicationPriorityResponse"
  5135. static="false" final="false" visibility="public"
  5136. deprecated="not deprecated">
  5137. </constructor>
  5138. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse"
  5139. abstract="false" native="false" synchronized="false"
  5140. static="true" final="false" visibility="public"
  5141. deprecated="not deprecated">
  5142. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5143. </method>
  5144. <method name="getApplicationPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  5145. abstract="true" native="false" synchronized="false"
  5146. static="false" final="false" visibility="public"
  5147. deprecated="not deprecated">
  5148. <doc>
  5149. <![CDATA[Get the <code>Priority</code> of the application to be set.
  5150. @return Updated <code>Priority</code> of the application.]]>
  5151. </doc>
  5152. </method>
  5153. <method name="setApplicationPriority"
  5154. abstract="true" native="false" synchronized="false"
  5155. static="false" final="false" visibility="public"
  5156. deprecated="not deprecated">
  5157. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5158. <doc>
  5159. <![CDATA[Set the <code>Priority</code> of the application.
  5160. @param priority <code>Priority</code> of the application]]>
  5161. </doc>
  5162. </method>
  5163. <doc>
  5164. <![CDATA[<p>
  5165. The response sent by the <code>ResourceManager</code> to the client on update
  5166. the application priority.
  5167. </p>
  5168. <p>
  5169. A response without exception means that the move has completed successfully.
  5170. </p>
  5171. @see ApplicationClientProtocol#updateApplicationPriority(UpdateApplicationPriorityRequest)]]>
  5172. </doc>
  5173. </class>
  5174. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse -->
  5175. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest -->
  5176. <class name="UpdateApplicationTimeoutsRequest" extends="java.lang.Object"
  5177. abstract="true"
  5178. static="false" final="false" visibility="public"
  5179. deprecated="not deprecated">
  5180. <constructor name="UpdateApplicationTimeoutsRequest"
  5181. static="false" final="false" visibility="public"
  5182. deprecated="not deprecated">
  5183. </constructor>
  5184. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest"
  5185. abstract="false" native="false" synchronized="false"
  5186. static="true" final="false" visibility="public"
  5187. deprecated="not deprecated">
  5188. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5189. <param name="applicationTimeouts" type="java.util.Map"/>
  5190. </method>
  5191. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5192. abstract="true" native="false" synchronized="false"
  5193. static="false" final="false" visibility="public"
  5194. deprecated="not deprecated">
  5195. <doc>
  5196. <![CDATA[Get the <code>ApplicationId</code> of the application.
  5197. @return <code>ApplicationId</code> of the application]]>
  5198. </doc>
  5199. </method>
  5200. <method name="setApplicationId"
  5201. abstract="true" native="false" synchronized="false"
  5202. static="false" final="false" visibility="public"
  5203. deprecated="not deprecated">
  5204. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5205. <doc>
  5206. <![CDATA[Set the <code>ApplicationId</code> of the application.
  5207. @param applicationId <code>ApplicationId</code> of the application]]>
  5208. </doc>
  5209. </method>
  5210. <method name="getApplicationTimeouts" return="java.util.Map"
  5211. abstract="true" native="false" synchronized="false"
  5212. static="false" final="false" visibility="public"
  5213. deprecated="not deprecated">
  5214. <doc>
  5215. <![CDATA[Get <code>ApplicationTimeouts</code> of the application. Timeout value is
  5216. in ISO8601 standard with format <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.
  5217. @return all <code>ApplicationTimeouts</code> of the application.]]>
  5218. </doc>
  5219. </method>
  5220. <method name="setApplicationTimeouts"
  5221. abstract="true" native="false" synchronized="false"
  5222. static="false" final="false" visibility="public"
  5223. deprecated="not deprecated">
  5224. <param name="applicationTimeouts" type="java.util.Map"/>
  5225. <doc>
  5226. <![CDATA[Set the <code>ApplicationTimeouts</code> for the application. Timeout value
  5227. is absolute. Timeout value should meet ISO8601 format. Support ISO8601
  5228. format is <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>. All pre-existing Map entries
  5229. are cleared before adding the new Map.
  5230. @param applicationTimeouts <code>ApplicationTimeouts</code>s for the
  5231. application]]>
  5232. </doc>
  5233. </method>
  5234. <doc>
  5235. <![CDATA[<p>
  5236. The request sent by the client to the <code>ResourceManager</code> to set or
  5237. update the application timeout.
  5238. </p>
  5239. <p>
  5240. The request includes the {@link ApplicationId} of the application and timeout
  5241. to be set for an application
  5242. </p>]]>
  5243. </doc>
  5244. </class>
  5245. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest -->
  5246. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse -->
  5247. <class name="UpdateApplicationTimeoutsResponse" extends="java.lang.Object"
  5248. abstract="true"
  5249. static="false" final="false" visibility="public"
  5250. deprecated="not deprecated">
  5251. <constructor name="UpdateApplicationTimeoutsResponse"
  5252. static="false" final="false" visibility="public"
  5253. deprecated="not deprecated">
  5254. </constructor>
  5255. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse"
  5256. abstract="false" native="false" synchronized="false"
  5257. static="true" final="false" visibility="public"
  5258. deprecated="not deprecated">
  5259. </method>
  5260. <method name="getApplicationTimeouts" return="java.util.Map"
  5261. abstract="true" native="false" synchronized="false"
  5262. static="false" final="false" visibility="public"
  5263. deprecated="not deprecated">
  5264. <doc>
  5265. <![CDATA[Get <code>ApplicationTimeouts</code> of the application. Timeout value is
  5266. in ISO8601 standard with format <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.
  5267. @return all <code>ApplicationTimeouts</code> of the application.]]>
  5268. </doc>
  5269. </method>
  5270. <method name="setApplicationTimeouts"
  5271. abstract="true" native="false" synchronized="false"
  5272. static="false" final="false" visibility="public"
  5273. deprecated="not deprecated">
  5274. <param name="applicationTimeouts" type="java.util.Map"/>
  5275. <doc>
  5276. <![CDATA[Set the <code>ApplicationTimeouts</code> for the application. Timeout value
  5277. is absolute. Timeout value should meet ISO8601 format. Support ISO8601
  5278. format is <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>. All pre-existing Map entries
  5279. are cleared before adding the new Map.
  5280. @param applicationTimeouts <code>ApplicationTimeouts</code>s for the
  5281. application]]>
  5282. </doc>
  5283. </method>
  5284. <doc>
  5285. <![CDATA[<p>
  5286. The response sent by the <code>ResourceManager</code> to the client on update
  5287. application timeout.
  5288. </p>
  5289. <p>
  5290. A response without exception means that the update has completed
  5291. successfully.
  5292. </p>]]>
  5293. </doc>
  5294. </class>
  5295. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse -->
  5296. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
  5297. <class name="UseSharedCacheResourceRequest" extends="java.lang.Object"
  5298. abstract="true"
  5299. static="false" final="false" visibility="public"
  5300. deprecated="not deprecated">
  5301. <constructor name="UseSharedCacheResourceRequest"
  5302. static="false" final="false" visibility="public"
  5303. deprecated="not deprecated">
  5304. </constructor>
  5305. <method name="getAppId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5306. abstract="true" native="false" synchronized="false"
  5307. static="false" final="false" visibility="public"
  5308. deprecated="not deprecated">
  5309. <doc>
  5310. <![CDATA[Get the <code>ApplicationId</code> of the resource to be used.
  5311. @return <code>ApplicationId</code>]]>
  5312. </doc>
  5313. </method>
  5314. <method name="setAppId"
  5315. abstract="true" native="false" synchronized="false"
  5316. static="false" final="false" visibility="public"
  5317. deprecated="not deprecated">
  5318. <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5319. <doc>
  5320. <![CDATA[Set the <code>ApplicationId</code> of the resource to be used.
  5321. @param id <code>ApplicationId</code>]]>
  5322. </doc>
  5323. </method>
  5324. <method name="getResourceKey" return="java.lang.String"
  5325. abstract="true" native="false" synchronized="false"
  5326. static="false" final="false" visibility="public"
  5327. deprecated="not deprecated">
  5328. <doc>
  5329. <![CDATA[Get the <code>key</code> of the resource to be used.
  5330. @return <code>key</code>]]>
  5331. </doc>
  5332. </method>
  5333. <method name="setResourceKey"
  5334. abstract="true" native="false" synchronized="false"
  5335. static="false" final="false" visibility="public"
  5336. deprecated="not deprecated">
  5337. <param name="key" type="java.lang.String"/>
  5338. <doc>
  5339. <![CDATA[Set the <code>key</code> of the resource to be used.
  5340. @param key unique identifier for the resource]]>
  5341. </doc>
  5342. </method>
  5343. <doc>
  5344. <![CDATA[<p>
  5345. The request from clients to the <code>SharedCacheManager</code> that claims a
  5346. resource in the shared cache.
  5347. </p>]]>
  5348. </doc>
  5349. </class>
  5350. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
  5351. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
  5352. <class name="UseSharedCacheResourceResponse" extends="java.lang.Object"
  5353. abstract="true"
  5354. static="false" final="false" visibility="public"
  5355. deprecated="not deprecated">
  5356. <constructor name="UseSharedCacheResourceResponse"
  5357. static="false" final="false" visibility="public"
  5358. deprecated="not deprecated">
  5359. </constructor>
  5360. <method name="getPath" return="java.lang.String"
  5361. abstract="true" native="false" synchronized="false"
  5362. static="false" final="false" visibility="public"
  5363. deprecated="not deprecated">
  5364. <doc>
  5365. <![CDATA[Get the <code>Path</code> corresponding to the requested resource in the
  5366. shared cache.
  5367. @return String A <code>Path</code> if the resource exists in the shared
  5368. cache, <code>null</code> otherwise]]>
  5369. </doc>
  5370. </method>
  5371. <method name="setPath"
  5372. abstract="true" native="false" synchronized="false"
  5373. static="false" final="false" visibility="public"
  5374. deprecated="not deprecated">
  5375. <param name="p" type="java.lang.String"/>
  5376. <doc>
  5377. <![CDATA[Set the <code>Path</code> corresponding to a resource in the shared cache.
  5378. @param p A <code>Path</code> corresponding to a resource in the shared
  5379. cache]]>
  5380. </doc>
  5381. </method>
  5382. <doc>
  5383. <![CDATA[<p>
  5384. The response from the SharedCacheManager to the client that indicates whether
  5385. a requested resource exists in the cache.
  5386. </p>]]>
  5387. </doc>
  5388. </class>
  5389. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
  5390. </package>
  5391. <package name="org.apache.hadoop.yarn.api.records">
  5392. <!-- start class org.apache.hadoop.yarn.api.records.AMCommand -->
  5393. <class name="AMCommand" extends="java.lang.Enum"
  5394. abstract="false"
  5395. static="false" final="true" visibility="public"
  5396. deprecated="not deprecated">
  5397. <method name="values" return="org.apache.hadoop.yarn.api.records.AMCommand[]"
  5398. abstract="false" native="false" synchronized="false"
  5399. static="true" final="false" visibility="public"
  5400. deprecated="not deprecated">
  5401. </method>
  5402. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.AMCommand"
  5403. abstract="false" native="false" synchronized="false"
  5404. static="true" final="false" visibility="public"
  5405. deprecated="not deprecated">
  5406. <param name="name" type="java.lang.String"/>
  5407. </method>
  5408. <doc>
  5409. <![CDATA[Command sent by the Resource Manager to the Application Master in the
  5410. AllocateResponse
  5411. @see AllocateResponse]]>
  5412. </doc>
  5413. </class>
  5414. <!-- end class org.apache.hadoop.yarn.api.records.AMCommand -->
  5415. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
  5416. <class name="ApplicationAccessType" extends="java.lang.Enum"
  5417. abstract="false"
  5418. static="false" final="true" visibility="public"
  5419. deprecated="not deprecated">
  5420. <method name="values" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType[]"
  5421. abstract="false" native="false" synchronized="false"
  5422. static="true" final="false" visibility="public"
  5423. deprecated="not deprecated">
  5424. </method>
  5425. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType"
  5426. abstract="false" native="false" synchronized="false"
  5427. static="true" final="false" visibility="public"
  5428. deprecated="not deprecated">
  5429. <param name="name" type="java.lang.String"/>
  5430. </method>
  5431. <doc>
  5432. <![CDATA[Application access types.]]>
  5433. </doc>
  5434. </class>
  5435. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
  5436. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
  5437. <class name="ApplicationAttemptId" extends="java.lang.Object"
  5438. abstract="true"
  5439. static="false" final="false" visibility="public"
  5440. deprecated="not deprecated">
  5441. <implements name="java.lang.Comparable"/>
  5442. <constructor name="ApplicationAttemptId"
  5443. static="false" final="false" visibility="public"
  5444. deprecated="not deprecated">
  5445. </constructor>
  5446. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  5447. abstract="false" native="false" synchronized="false"
  5448. static="true" final="false" visibility="public"
  5449. deprecated="not deprecated">
  5450. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5451. <param name="attemptId" type="int"/>
  5452. </method>
  5453. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5454. abstract="true" native="false" synchronized="false"
  5455. static="false" final="false" visibility="public"
  5456. deprecated="not deprecated">
  5457. <doc>
  5458. <![CDATA[Get the <code>ApplicationId</code> of the <code>ApplicationAttempId</code>.
  5459. @return <code>ApplicationId</code> of the <code>ApplicationAttempId</code>]]>
  5460. </doc>
  5461. </method>
  5462. <method name="getAttemptId" return="int"
  5463. abstract="true" native="false" synchronized="false"
  5464. static="false" final="false" visibility="public"
  5465. deprecated="not deprecated">
  5466. <doc>
  5467. <![CDATA[Get the <code>attempt id</code> of the <code>Application</code>.
  5468. @return <code>attempt id</code> of the <code>Application</code>]]>
  5469. </doc>
  5470. </method>
  5471. <method name="hashCode" return="int"
  5472. abstract="false" native="false" synchronized="false"
  5473. static="false" final="false" visibility="public"
  5474. deprecated="not deprecated">
  5475. </method>
  5476. <method name="equals" return="boolean"
  5477. abstract="false" native="false" synchronized="false"
  5478. static="false" final="false" visibility="public"
  5479. deprecated="not deprecated">
  5480. <param name="obj" type="java.lang.Object"/>
  5481. </method>
  5482. <method name="compareTo" return="int"
  5483. abstract="false" native="false" synchronized="false"
  5484. static="false" final="false" visibility="public"
  5485. deprecated="not deprecated">
  5486. <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  5487. </method>
  5488. <method name="toString" return="java.lang.String"
  5489. abstract="false" native="false" synchronized="false"
  5490. static="false" final="false" visibility="public"
  5491. deprecated="not deprecated">
  5492. </method>
  5493. <method name="build"
  5494. abstract="true" native="false" synchronized="false"
  5495. static="false" final="false" visibility="protected"
  5496. deprecated="not deprecated">
  5497. </method>
  5498. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  5499. abstract="false" native="false" synchronized="false"
  5500. static="true" final="false" visibility="public"
  5501. deprecated="not deprecated">
  5502. <param name="appAttemptIdStr" type="java.lang.String"/>
  5503. </method>
  5504. <field name="appAttemptIdStrPrefix" type="java.lang.String"
  5505. transient="false" volatile="false"
  5506. static="true" final="true" visibility="public"
  5507. deprecated="not deprecated">
  5508. </field>
  5509. <doc>
  5510. <![CDATA[<p><code>ApplicationAttemptId</code> denotes the particular <em>attempt</em>
  5511. of an <code>ApplicationMaster</code> for a given {@link ApplicationId}.</p>
  5512. <p>Multiple attempts might be needed to run an application to completion due
  5513. to temporal failures of the <code>ApplicationMaster</code> such as hardware
  5514. failures, connectivity issues etc. on the node on which it was scheduled.</p>]]>
  5515. </doc>
  5516. </class>
  5517. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
  5518. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
  5519. <class name="ApplicationAttemptReport" extends="java.lang.Object"
  5520. abstract="true"
  5521. static="false" final="false" visibility="public"
  5522. deprecated="not deprecated">
  5523. <constructor name="ApplicationAttemptReport"
  5524. static="false" final="false" visibility="public"
  5525. deprecated="not deprecated">
  5526. </constructor>
  5527. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
  5528. abstract="false" native="false" synchronized="false"
  5529. static="true" final="false" visibility="public"
  5530. deprecated="not deprecated">
  5531. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  5532. <param name="host" type="java.lang.String"/>
  5533. <param name="rpcPort" type="int"/>
  5534. <param name="url" type="java.lang.String"/>
  5535. <param name="oUrl" type="java.lang.String"/>
  5536. <param name="diagnostics" type="java.lang.String"/>
  5537. <param name="state" type="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"/>
  5538. <param name="amContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5539. </method>
  5540. <method name="getYarnApplicationAttemptState" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
  5541. abstract="true" native="false" synchronized="false"
  5542. static="false" final="false" visibility="public"
  5543. deprecated="not deprecated">
  5544. <doc>
  5545. <![CDATA[Get the <em>YarnApplicationAttemptState</em> of the application attempt.
  5546. @return <em>YarnApplicationAttemptState</em> of the application attempt]]>
  5547. </doc>
  5548. </method>
  5549. <method name="getRpcPort" return="int"
  5550. abstract="true" native="false" synchronized="false"
  5551. static="false" final="false" visibility="public"
  5552. deprecated="not deprecated">
  5553. <doc>
  5554. <![CDATA[Get the <em>RPC port</em> of this attempt <code>ApplicationMaster</code>.
  5555. @return <em>RPC port</em> of this attempt <code>ApplicationMaster</code>]]>
  5556. </doc>
  5557. </method>
  5558. <method name="getHost" return="java.lang.String"
  5559. abstract="true" native="false" synchronized="false"
  5560. static="false" final="false" visibility="public"
  5561. deprecated="not deprecated">
  5562. <doc>
  5563. <![CDATA[Get the <em>host</em> on which this attempt of
  5564. <code>ApplicationMaster</code> is running.
  5565. @return <em>host</em> on which this attempt of
  5566. <code>ApplicationMaster</code> is running]]>
  5567. </doc>
  5568. </method>
  5569. <method name="getDiagnostics" return="java.lang.String"
  5570. abstract="true" native="false" synchronized="false"
  5571. static="false" final="false" visibility="public"
  5572. deprecated="not deprecated">
  5573. <doc>
  5574. <![CDATA[Get the <em>diagnositic information</em> of the application attempt in case
  5575. of errors.
  5576. @return <em>diagnositic information</em> of the application attempt in case
  5577. of errors]]>
  5578. </doc>
  5579. </method>
  5580. <method name="getTrackingUrl" return="java.lang.String"
  5581. abstract="true" native="false" synchronized="false"
  5582. static="false" final="false" visibility="public"
  5583. deprecated="not deprecated">
  5584. <doc>
  5585. <![CDATA[Get the <em>tracking url</em> for the application attempt.
  5586. @return <em>tracking url</em> for the application attempt]]>
  5587. </doc>
  5588. </method>
  5589. <method name="getOriginalTrackingUrl" return="java.lang.String"
  5590. abstract="true" native="false" synchronized="false"
  5591. static="false" final="false" visibility="public"
  5592. deprecated="not deprecated">
  5593. <doc>
  5594. <![CDATA[Get the <em>original tracking url</em> for the application attempt.
  5595. @return <em>original tracking url</em> for the application attempt]]>
  5596. </doc>
  5597. </method>
  5598. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  5599. abstract="true" native="false" synchronized="false"
  5600. static="false" final="false" visibility="public"
  5601. deprecated="not deprecated">
  5602. <doc>
  5603. <![CDATA[Get the <code>ApplicationAttemptId</code> of this attempt of the
  5604. application
  5605. @return <code>ApplicationAttemptId</code> of the attempt]]>
  5606. </doc>
  5607. </method>
  5608. <method name="getAMContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5609. abstract="true" native="false" synchronized="false"
  5610. static="false" final="false" visibility="public"
  5611. deprecated="not deprecated">
  5612. <doc>
  5613. <![CDATA[Get the <code>ContainerId</code> of AMContainer for this attempt
  5614. @return <code>ContainerId</code> of the attempt]]>
  5615. </doc>
  5616. </method>
  5617. <method name="getStartTime" return="long"
  5618. abstract="true" native="false" synchronized="false"
  5619. static="false" final="false" visibility="public"
  5620. deprecated="not deprecated">
  5621. </method>
  5622. <method name="getFinishTime" 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 <em>finish time</em> of the application.
  5628. @return <em>finish time</em> of the application]]>
  5629. </doc>
  5630. </method>
  5631. <doc>
  5632. <![CDATA[{@code ApplicationAttemptReport} is a report of an application attempt.
  5633. <p>
  5634. It includes details such as:
  5635. <ul>
  5636. <li>{@link ApplicationAttemptId} of the application.</li>
  5637. <li>Host on which the <code>ApplicationMaster</code> of this attempt is
  5638. running.</li>
  5639. <li>RPC port of the <code>ApplicationMaster</code> of this attempt.</li>
  5640. <li>Tracking URL.</li>
  5641. <li>Diagnostic information in case of errors.</li>
  5642. <li>{@link YarnApplicationAttemptState} of the application attempt.</li>
  5643. <li>{@link ContainerId} of the master Container.</li>
  5644. </ul>]]>
  5645. </doc>
  5646. </class>
  5647. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
  5648. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationId -->
  5649. <class name="ApplicationId" extends="java.lang.Object"
  5650. abstract="true"
  5651. static="false" final="false" visibility="public"
  5652. deprecated="not deprecated">
  5653. <implements name="java.lang.Comparable"/>
  5654. <constructor name="ApplicationId"
  5655. static="false" final="false" visibility="public"
  5656. deprecated="not deprecated">
  5657. </constructor>
  5658. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5659. abstract="false" native="false" synchronized="false"
  5660. static="true" final="false" visibility="public"
  5661. deprecated="not deprecated">
  5662. <param name="clusterTimestamp" type="long"/>
  5663. <param name="id" type="int"/>
  5664. </method>
  5665. <method name="getId" return="int"
  5666. abstract="true" native="false" synchronized="false"
  5667. static="false" final="false" visibility="public"
  5668. deprecated="not deprecated">
  5669. <doc>
  5670. <![CDATA[Get the short integer identifier of the <code>ApplicationId</code>
  5671. which is unique for all applications started by a particular instance
  5672. of the <code>ResourceManager</code>.
  5673. @return short integer identifier of the <code>ApplicationId</code>]]>
  5674. </doc>
  5675. </method>
  5676. <method name="getClusterTimestamp" return="long"
  5677. abstract="true" native="false" synchronized="false"
  5678. static="false" final="false" visibility="public"
  5679. deprecated="not deprecated">
  5680. <doc>
  5681. <![CDATA[Get the <em>start time</em> of the <code>ResourceManager</code> which is
  5682. used to generate globally unique <code>ApplicationId</code>.
  5683. @return <em>start time</em> of the <code>ResourceManager</code>]]>
  5684. </doc>
  5685. </method>
  5686. <method name="build"
  5687. abstract="true" native="false" synchronized="false"
  5688. static="false" final="false" visibility="protected"
  5689. deprecated="not deprecated">
  5690. </method>
  5691. <method name="compareTo" return="int"
  5692. abstract="false" native="false" synchronized="false"
  5693. static="false" final="false" visibility="public"
  5694. deprecated="not deprecated">
  5695. <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  5696. </method>
  5697. <method name="toString" return="java.lang.String"
  5698. abstract="false" native="false" synchronized="false"
  5699. static="false" final="false" visibility="public"
  5700. deprecated="not deprecated">
  5701. </method>
  5702. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5703. abstract="false" native="false" synchronized="false"
  5704. static="true" final="false" visibility="public"
  5705. deprecated="not deprecated">
  5706. <param name="appIdStr" type="java.lang.String"/>
  5707. </method>
  5708. <method name="hashCode" return="int"
  5709. abstract="false" native="false" synchronized="false"
  5710. static="false" final="false" visibility="public"
  5711. deprecated="not deprecated">
  5712. </method>
  5713. <method name="equals" return="boolean"
  5714. abstract="false" native="false" synchronized="false"
  5715. static="false" final="false" visibility="public"
  5716. deprecated="not deprecated">
  5717. <param name="obj" type="java.lang.Object"/>
  5718. </method>
  5719. <field name="appIdStrPrefix" type="java.lang.String"
  5720. transient="false" volatile="false"
  5721. static="true" final="true" visibility="public"
  5722. deprecated="not deprecated">
  5723. </field>
  5724. <doc>
  5725. <![CDATA[<p><code>ApplicationId</code> represents the <em>globally unique</em>
  5726. identifier for an application.</p>
  5727. <p>The globally unique nature of the identifier is achieved by using the
  5728. <em>cluster timestamp</em> i.e. start-time of the
  5729. <code>ResourceManager</code> along with a monotonically increasing counter
  5730. for the application.</p>]]>
  5731. </doc>
  5732. </class>
  5733. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationId -->
  5734. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationReport -->
  5735. <class name="ApplicationReport" extends="java.lang.Object"
  5736. abstract="true"
  5737. static="false" final="false" visibility="public"
  5738. deprecated="not deprecated">
  5739. <constructor name="ApplicationReport"
  5740. static="false" final="false" visibility="public"
  5741. deprecated="not deprecated">
  5742. </constructor>
  5743. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  5744. abstract="true" native="false" synchronized="false"
  5745. static="false" final="false" visibility="public"
  5746. deprecated="not deprecated">
  5747. <doc>
  5748. <![CDATA[Get the <code>ApplicationId</code> of the application.
  5749. @return <code>ApplicationId</code> of the application]]>
  5750. </doc>
  5751. </method>
  5752. <method name="getCurrentApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  5753. abstract="true" native="false" synchronized="false"
  5754. static="false" final="false" visibility="public"
  5755. deprecated="not deprecated">
  5756. <doc>
  5757. <![CDATA[Get the <code>ApplicationAttemptId</code> of the current
  5758. attempt of the application
  5759. @return <code>ApplicationAttemptId</code> of the attempt]]>
  5760. </doc>
  5761. </method>
  5762. <method name="getUser" return="java.lang.String"
  5763. abstract="true" native="false" synchronized="false"
  5764. static="false" final="false" visibility="public"
  5765. deprecated="not deprecated">
  5766. <doc>
  5767. <![CDATA[Get the <em>user</em> who submitted the application.
  5768. @return <em>user</em> who submitted the application]]>
  5769. </doc>
  5770. </method>
  5771. <method name="getQueue" return="java.lang.String"
  5772. abstract="true" native="false" synchronized="false"
  5773. static="false" final="false" visibility="public"
  5774. deprecated="not deprecated">
  5775. <doc>
  5776. <![CDATA[Get the <em>queue</em> to which the application was submitted.
  5777. @return <em>queue</em> to which the application was submitted]]>
  5778. </doc>
  5779. </method>
  5780. <method name="getName" return="java.lang.String"
  5781. abstract="true" native="false" synchronized="false"
  5782. static="false" final="false" visibility="public"
  5783. deprecated="not deprecated">
  5784. <doc>
  5785. <![CDATA[Get the user-defined <em>name</em> of the application.
  5786. @return <em>name</em> of the application]]>
  5787. </doc>
  5788. </method>
  5789. <method name="getHost" return="java.lang.String"
  5790. abstract="true" native="false" synchronized="false"
  5791. static="false" final="false" visibility="public"
  5792. deprecated="not deprecated">
  5793. <doc>
  5794. <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code>
  5795. is running.
  5796. @return <em>host</em> on which the <code>ApplicationMaster</code>
  5797. is running]]>
  5798. </doc>
  5799. </method>
  5800. <method name="getRpcPort" return="int"
  5801. abstract="true" native="false" synchronized="false"
  5802. static="false" final="false" visibility="public"
  5803. deprecated="not deprecated">
  5804. <doc>
  5805. <![CDATA[Get the <em>RPC port</em> of the <code>ApplicationMaster</code>.
  5806. @return <em>RPC port</em> of the <code>ApplicationMaster</code>]]>
  5807. </doc>
  5808. </method>
  5809. <method name="getClientToAMToken" return="org.apache.hadoop.yarn.api.records.Token"
  5810. abstract="true" native="false" synchronized="false"
  5811. static="false" final="false" visibility="public"
  5812. deprecated="not deprecated">
  5813. <doc>
  5814. <![CDATA[Get the <em>client token</em> for communicating with the
  5815. <code>ApplicationMaster</code>.
  5816. <p>
  5817. <em>ClientToAMToken</em> is the security token used by the AMs to verify
  5818. authenticity of any <code>client</code>.
  5819. </p>
  5820. <p>
  5821. The <code>ResourceManager</code>, provides a secure token (via
  5822. {@link ApplicationReport#getClientToAMToken()}) which is verified by the
  5823. ApplicationMaster when the client directly talks to an AM.
  5824. </p>
  5825. @return <em>client token</em> for communicating with the
  5826. <code>ApplicationMaster</code>]]>
  5827. </doc>
  5828. </method>
  5829. <method name="getYarnApplicationState" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
  5830. abstract="true" native="false" synchronized="false"
  5831. static="false" final="false" visibility="public"
  5832. deprecated="not deprecated">
  5833. <doc>
  5834. <![CDATA[Get the <code>YarnApplicationState</code> of the application.
  5835. @return <code>YarnApplicationState</code> of the application]]>
  5836. </doc>
  5837. </method>
  5838. <method name="getDiagnostics" return="java.lang.String"
  5839. abstract="true" native="false" synchronized="false"
  5840. static="false" final="false" visibility="public"
  5841. deprecated="not deprecated">
  5842. <doc>
  5843. <![CDATA[Get the <em>diagnositic information</em> of the application in case of
  5844. errors.
  5845. @return <em>diagnositic information</em> of the application in case
  5846. of errors]]>
  5847. </doc>
  5848. </method>
  5849. <method name="getTrackingUrl" return="java.lang.String"
  5850. abstract="true" native="false" synchronized="false"
  5851. static="false" final="false" visibility="public"
  5852. deprecated="not deprecated">
  5853. <doc>
  5854. <![CDATA[Get the <em>tracking url</em> for the application.
  5855. @return <em>tracking url</em> for the application]]>
  5856. </doc>
  5857. </method>
  5858. <method name="getStartTime" return="long"
  5859. abstract="true" native="false" synchronized="false"
  5860. static="false" final="false" visibility="public"
  5861. deprecated="not deprecated">
  5862. <doc>
  5863. <![CDATA[Get the <em>start time</em> of the application.
  5864. @return <em>start time</em> of the application]]>
  5865. </doc>
  5866. </method>
  5867. <method name="getSubmitTime" return="long"
  5868. abstract="true" native="false" synchronized="false"
  5869. static="false" final="false" visibility="public"
  5870. deprecated="not deprecated">
  5871. </method>
  5872. <method name="getLaunchTime" return="long"
  5873. abstract="true" native="false" synchronized="false"
  5874. static="false" final="false" visibility="public"
  5875. deprecated="not deprecated">
  5876. </method>
  5877. <method name="getFinishTime" return="long"
  5878. abstract="true" native="false" synchronized="false"
  5879. static="false" final="false" visibility="public"
  5880. deprecated="not deprecated">
  5881. <doc>
  5882. <![CDATA[Get the <em>finish time</em> of the application.
  5883. @return <em>finish time</em> of the application]]>
  5884. </doc>
  5885. </method>
  5886. <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  5887. abstract="true" native="false" synchronized="false"
  5888. static="false" final="false" visibility="public"
  5889. deprecated="not deprecated">
  5890. <doc>
  5891. <![CDATA[Get the <em>final finish status</em> of the application.
  5892. @return <em>final finish status</em> of the application]]>
  5893. </doc>
  5894. </method>
  5895. <method name="getApplicationResourceUsageReport" return="org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport"
  5896. abstract="true" native="false" synchronized="false"
  5897. static="false" final="false" visibility="public"
  5898. deprecated="not deprecated">
  5899. <doc>
  5900. <![CDATA[Retrieve the structure containing the job resources for this application
  5901. @return the job resources structure for this application]]>
  5902. </doc>
  5903. </method>
  5904. <method name="getProgress" return="float"
  5905. abstract="true" native="false" synchronized="false"
  5906. static="false" final="false" visibility="public"
  5907. deprecated="not deprecated">
  5908. <doc>
  5909. <![CDATA[Get the application's progress ( range 0.0 to 1.0 )
  5910. @return application's progress]]>
  5911. </doc>
  5912. </method>
  5913. <method name="getApplicationType" return="java.lang.String"
  5914. abstract="true" native="false" synchronized="false"
  5915. static="false" final="false" visibility="public"
  5916. deprecated="not deprecated">
  5917. <doc>
  5918. <![CDATA[Get the application's Type
  5919. @return application's Type]]>
  5920. </doc>
  5921. </method>
  5922. <method name="getApplicationTags" return="java.util.Set"
  5923. abstract="true" native="false" synchronized="false"
  5924. static="false" final="false" visibility="public"
  5925. deprecated="not deprecated">
  5926. <doc>
  5927. <![CDATA[Get all tags corresponding to the application
  5928. @return Application's tags]]>
  5929. </doc>
  5930. </method>
  5931. <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
  5932. abstract="true" native="false" synchronized="false"
  5933. static="false" final="false" visibility="public"
  5934. deprecated="not deprecated">
  5935. <doc>
  5936. <![CDATA[Get the AMRM token of the application.
  5937. <p>
  5938. The AMRM token is required for AM to RM scheduling operations. For
  5939. managed Application Masters Yarn takes care of injecting it. For unmanaged
  5940. Applications Masters, the token must be obtained via this method and set
  5941. in the {@link org.apache.hadoop.security.UserGroupInformation} of the
  5942. current user.
  5943. <p>
  5944. The AMRM token will be returned only if all the following conditions are
  5945. met:
  5946. <ul>
  5947. <li>the requester is the owner of the ApplicationMaster</li>
  5948. <li>the application master is an unmanaged ApplicationMaster</li>
  5949. <li>the application master is in ACCEPTED state</li>
  5950. </ul>
  5951. Else this method returns NULL.
  5952. @return the AM to RM token if available.]]>
  5953. </doc>
  5954. </method>
  5955. <method name="getLogAggregationStatus" return="org.apache.hadoop.yarn.api.records.LogAggregationStatus"
  5956. abstract="true" native="false" synchronized="false"
  5957. static="false" final="false" visibility="public"
  5958. deprecated="not deprecated">
  5959. <doc>
  5960. <![CDATA[Get log aggregation status for the application
  5961. @return Application's log aggregation status]]>
  5962. </doc>
  5963. </method>
  5964. <method name="isUnmanagedApp" return="boolean"
  5965. abstract="true" native="false" synchronized="false"
  5966. static="false" final="false" visibility="public"
  5967. deprecated="not deprecated">
  5968. <doc>
  5969. <![CDATA[@return true if the AM is not managed by the RM]]>
  5970. </doc>
  5971. </method>
  5972. <method name="setUnmanagedApp"
  5973. abstract="true" native="false" synchronized="false"
  5974. static="false" final="false" visibility="public"
  5975. deprecated="not deprecated">
  5976. <param name="unmanagedApplication" type="boolean"/>
  5977. <doc>
  5978. <![CDATA[@param unmanagedApplication true if RM should not manage the AM]]>
  5979. </doc>
  5980. </method>
  5981. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  5982. abstract="true" native="false" synchronized="false"
  5983. static="false" final="false" visibility="public"
  5984. deprecated="not deprecated">
  5985. <doc>
  5986. <![CDATA[Get priority of the application
  5987. @return Application's priority]]>
  5988. </doc>
  5989. </method>
  5990. <method name="getAppNodeLabelExpression" return="java.lang.String"
  5991. abstract="true" native="false" synchronized="false"
  5992. static="false" final="false" visibility="public"
  5993. deprecated="not deprecated">
  5994. <doc>
  5995. <![CDATA[Get the default Node Label expression for all the application's containers
  5996. @return Application's NodeLabelExpression]]>
  5997. </doc>
  5998. </method>
  5999. <method name="setAppNodeLabelExpression"
  6000. abstract="true" native="false" synchronized="false"
  6001. static="false" final="false" visibility="public"
  6002. deprecated="not deprecated">
  6003. <param name="appNodeLabelExpression" type="java.lang.String"/>
  6004. </method>
  6005. <method name="getAmNodeLabelExpression" return="java.lang.String"
  6006. abstract="true" native="false" synchronized="false"
  6007. static="false" final="false" visibility="public"
  6008. deprecated="not deprecated">
  6009. <doc>
  6010. <![CDATA[Get the default Node Label expression for all the application's containers
  6011. @return Application's NodeLabelExpression]]>
  6012. </doc>
  6013. </method>
  6014. <method name="setAmNodeLabelExpression"
  6015. abstract="true" native="false" synchronized="false"
  6016. static="false" final="false" visibility="public"
  6017. deprecated="not deprecated">
  6018. <param name="amNodeLabelExpression" type="java.lang.String"/>
  6019. </method>
  6020. <method name="getApplicationTimeouts" return="java.util.Map"
  6021. abstract="true" native="false" synchronized="false"
  6022. static="false" final="false" visibility="public"
  6023. deprecated="not deprecated">
  6024. </method>
  6025. <doc>
  6026. <![CDATA[{@code ApplicationReport} is a report of an application.
  6027. <p>
  6028. It includes details such as:
  6029. <ul>
  6030. <li>{@link ApplicationId} of the application.</li>
  6031. <li>Applications user.</li>
  6032. <li>Application queue.</li>
  6033. <li>Application name.</li>
  6034. <li>Host on which the <code>ApplicationMaster</code> is running.</li>
  6035. <li>RPC port of the <code>ApplicationMaster</code>.</li>
  6036. <li>Tracking URL.</li>
  6037. <li>{@link YarnApplicationState} of the application.</li>
  6038. <li>Diagnostic information in case of errors.</li>
  6039. <li>Start time of the application.</li>
  6040. <li>Client {@link Token} of the application (if security is enabled).</li>
  6041. </ul>
  6042. @see ApplicationClientProtocol#getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest)]]>
  6043. </doc>
  6044. </class>
  6045. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationReport -->
  6046. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
  6047. <class name="ApplicationResourceUsageReport" extends="java.lang.Object"
  6048. abstract="true"
  6049. static="false" final="false" visibility="public"
  6050. deprecated="not deprecated">
  6051. <constructor name="ApplicationResourceUsageReport"
  6052. static="false" final="false" visibility="public"
  6053. deprecated="not deprecated">
  6054. </constructor>
  6055. <method name="getNumUsedContainers" return="int"
  6056. abstract="true" native="false" synchronized="false"
  6057. static="false" final="false" visibility="public"
  6058. deprecated="not deprecated">
  6059. <doc>
  6060. <![CDATA[Get the number of used containers. -1 for invalid/inaccessible reports.
  6061. @return the number of used containers]]>
  6062. </doc>
  6063. </method>
  6064. <method name="getUsedResources" return="org.apache.hadoop.yarn.api.records.Resource"
  6065. abstract="true" native="false" synchronized="false"
  6066. static="false" final="false" visibility="public"
  6067. deprecated="not deprecated">
  6068. <doc>
  6069. <![CDATA[Get the used <code>Resource</code>. -1 for invalid/inaccessible reports.
  6070. @return the used <code>Resource</code>]]>
  6071. </doc>
  6072. </method>
  6073. <method name="getReservedResources" return="org.apache.hadoop.yarn.api.records.Resource"
  6074. abstract="true" native="false" synchronized="false"
  6075. static="false" final="false" visibility="public"
  6076. deprecated="not deprecated">
  6077. <doc>
  6078. <![CDATA[Get the reserved <code>Resource</code>. -1 for invalid/inaccessible reports.
  6079. @return the reserved <code>Resource</code>]]>
  6080. </doc>
  6081. </method>
  6082. <method name="getNeededResources" return="org.apache.hadoop.yarn.api.records.Resource"
  6083. abstract="true" native="false" synchronized="false"
  6084. static="false" final="false" visibility="public"
  6085. deprecated="not deprecated">
  6086. <doc>
  6087. <![CDATA[Get the needed <code>Resource</code>. -1 for invalid/inaccessible reports.
  6088. @return the needed <code>Resource</code>]]>
  6089. </doc>
  6090. </method>
  6091. <method name="getMemorySeconds" return="long"
  6092. abstract="true" native="false" synchronized="false"
  6093. static="false" final="false" visibility="public"
  6094. deprecated="not deprecated">
  6095. <doc>
  6096. <![CDATA[Get the aggregated amount of memory (in megabytes) the application has
  6097. allocated times the number of seconds the application has been running.
  6098. @return the aggregated amount of memory seconds]]>
  6099. </doc>
  6100. </method>
  6101. <method name="getVcoreSeconds" return="long"
  6102. abstract="true" native="false" synchronized="false"
  6103. static="false" final="false" visibility="public"
  6104. deprecated="not deprecated">
  6105. <doc>
  6106. <![CDATA[Get the aggregated number of vcores that the application has allocated
  6107. times the number of seconds the application has been running.
  6108. @return the aggregated number of vcore seconds]]>
  6109. </doc>
  6110. </method>
  6111. <method name="getQueueUsagePercentage" return="float"
  6112. abstract="true" native="false" synchronized="false"
  6113. static="false" final="false" visibility="public"
  6114. deprecated="not deprecated">
  6115. <doc>
  6116. <![CDATA[Get the percentage of resources of the queue that the app is using.
  6117. @return the percentage of resources of the queue that the app is using.]]>
  6118. </doc>
  6119. </method>
  6120. <method name="getClusterUsagePercentage" return="float"
  6121. abstract="true" native="false" synchronized="false"
  6122. static="false" final="false" visibility="public"
  6123. deprecated="not deprecated">
  6124. <doc>
  6125. <![CDATA[Get the percentage of resources of the cluster that the app is using.
  6126. @return the percentage of resources of the cluster that the app is using.]]>
  6127. </doc>
  6128. </method>
  6129. <method name="getPreemptedMemorySeconds" return="long"
  6130. abstract="true" native="false" synchronized="false"
  6131. static="false" final="false" visibility="public"
  6132. deprecated="not deprecated">
  6133. <doc>
  6134. <![CDATA[Get the aggregated amount of memory preempted(in megabytes)
  6135. the application has allocated times the number of
  6136. seconds the application has been running.
  6137. @return the aggregated amount of memory seconds]]>
  6138. </doc>
  6139. </method>
  6140. <method name="getPreemptedVcoreSeconds" return="long"
  6141. abstract="true" native="false" synchronized="false"
  6142. static="false" final="false" visibility="public"
  6143. deprecated="not deprecated">
  6144. <doc>
  6145. <![CDATA[Get the aggregated number of vcores preempted that the application has
  6146. allocated times the number of seconds the application has been running.
  6147. @return the aggregated number of vcore seconds]]>
  6148. </doc>
  6149. </method>
  6150. <method name="getResourceSecondsMap" return="java.util.Map"
  6151. abstract="true" native="false" synchronized="false"
  6152. static="false" final="false" visibility="public"
  6153. deprecated="not deprecated">
  6154. <doc>
  6155. <![CDATA[Get the aggregated number of resources that the application has
  6156. allocated times the number of seconds the application has been running.
  6157. @return map containing the resource name and aggregated resource-seconds]]>
  6158. </doc>
  6159. </method>
  6160. <method name="getPreemptedResourceSecondsMap" return="java.util.Map"
  6161. abstract="true" native="false" synchronized="false"
  6162. static="false" final="false" visibility="public"
  6163. deprecated="not deprecated">
  6164. <doc>
  6165. <![CDATA[Get the aggregated number of resources preempted that the application has
  6166. allocated times the number of seconds the application has been running.
  6167. @return map containing the resource name and aggregated preempted
  6168. resource-seconds]]>
  6169. </doc>
  6170. </method>
  6171. <doc>
  6172. <![CDATA[Contains various scheduling metrics to be reported by UI and CLI.]]>
  6173. </doc>
  6174. </class>
  6175. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
  6176. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
  6177. <class name="ApplicationSubmissionContext" extends="java.lang.Object"
  6178. abstract="true"
  6179. static="false" final="false" visibility="public"
  6180. deprecated="not deprecated">
  6181. <constructor name="ApplicationSubmissionContext"
  6182. static="false" final="false" visibility="public"
  6183. deprecated="not deprecated">
  6184. </constructor>
  6185. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6186. abstract="false" native="false" synchronized="false"
  6187. static="true" final="false" visibility="public"
  6188. deprecated="not deprecated">
  6189. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6190. <param name="applicationName" type="java.lang.String"/>
  6191. <param name="queue" type="java.lang.String"/>
  6192. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6193. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6194. <param name="isUnmanagedAM" type="boolean"/>
  6195. <param name="cancelTokensWhenComplete" type="boolean"/>
  6196. <param name="maxAppAttempts" type="int"/>
  6197. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6198. <param name="applicationType" type="java.lang.String"/>
  6199. <param name="keepContainers" type="boolean"/>
  6200. <param name="appLabelExpression" type="java.lang.String"/>
  6201. <param name="amContainerLabelExpression" type="java.lang.String"/>
  6202. </method>
  6203. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6204. abstract="false" native="false" synchronized="false"
  6205. static="true" final="false" visibility="public"
  6206. deprecated="not deprecated">
  6207. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6208. <param name="applicationName" type="java.lang.String"/>
  6209. <param name="queue" type="java.lang.String"/>
  6210. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6211. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6212. <param name="isUnmanagedAM" type="boolean"/>
  6213. <param name="cancelTokensWhenComplete" type="boolean"/>
  6214. <param name="maxAppAttempts" type="int"/>
  6215. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6216. <param name="applicationType" type="java.lang.String"/>
  6217. <param name="keepContainers" type="boolean"/>
  6218. </method>
  6219. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6220. abstract="false" native="false" synchronized="false"
  6221. static="true" final="false" visibility="public"
  6222. deprecated="not deprecated">
  6223. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6224. <param name="applicationName" type="java.lang.String"/>
  6225. <param name="queue" type="java.lang.String"/>
  6226. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6227. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6228. <param name="isUnmanagedAM" type="boolean"/>
  6229. <param name="cancelTokensWhenComplete" type="boolean"/>
  6230. <param name="maxAppAttempts" type="int"/>
  6231. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6232. <param name="applicationType" type="java.lang.String"/>
  6233. </method>
  6234. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6235. abstract="false" native="false" synchronized="false"
  6236. static="true" final="false" visibility="public"
  6237. deprecated="not deprecated">
  6238. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6239. <param name="applicationName" type="java.lang.String"/>
  6240. <param name="queue" type="java.lang.String"/>
  6241. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6242. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6243. <param name="isUnmanagedAM" type="boolean"/>
  6244. <param name="cancelTokensWhenComplete" type="boolean"/>
  6245. <param name="maxAppAttempts" type="int"/>
  6246. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6247. </method>
  6248. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6249. abstract="false" native="false" synchronized="false"
  6250. static="true" final="false" visibility="public"
  6251. deprecated="not deprecated">
  6252. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6253. <param name="applicationName" type="java.lang.String"/>
  6254. <param name="queue" type="java.lang.String"/>
  6255. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6256. <param name="isUnmanagedAM" type="boolean"/>
  6257. <param name="cancelTokensWhenComplete" type="boolean"/>
  6258. <param name="maxAppAttempts" type="int"/>
  6259. <param name="applicationType" type="java.lang.String"/>
  6260. <param name="keepContainers" type="boolean"/>
  6261. <param name="appLabelExpression" type="java.lang.String"/>
  6262. <param name="resourceRequest" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  6263. </method>
  6264. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6265. abstract="false" native="false" synchronized="false"
  6266. static="true" final="false" visibility="public"
  6267. deprecated="not deprecated">
  6268. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6269. <param name="applicationName" type="java.lang.String"/>
  6270. <param name="queue" type="java.lang.String"/>
  6271. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6272. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6273. <param name="isUnmanagedAM" type="boolean"/>
  6274. <param name="cancelTokensWhenComplete" type="boolean"/>
  6275. <param name="maxAppAttempts" type="int"/>
  6276. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6277. <param name="applicationType" type="java.lang.String"/>
  6278. <param name="keepContainers" type="boolean"/>
  6279. <param name="attemptFailuresValidityInterval" type="long"/>
  6280. </method>
  6281. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  6282. abstract="false" native="false" synchronized="false"
  6283. static="true" final="false" visibility="public"
  6284. deprecated="not deprecated">
  6285. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6286. <param name="applicationName" type="java.lang.String"/>
  6287. <param name="queue" type="java.lang.String"/>
  6288. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6289. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6290. <param name="isUnmanagedAM" type="boolean"/>
  6291. <param name="cancelTokensWhenComplete" type="boolean"/>
  6292. <param name="maxAppAttempts" type="int"/>
  6293. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6294. <param name="applicationType" type="java.lang.String"/>
  6295. <param name="keepContainers" type="boolean"/>
  6296. <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
  6297. </method>
  6298. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  6299. abstract="true" native="false" synchronized="false"
  6300. static="false" final="false" visibility="public"
  6301. deprecated="not deprecated">
  6302. <doc>
  6303. <![CDATA[Get the <code>ApplicationId</code> of the submitted application.
  6304. @return <code>ApplicationId</code> of the submitted application]]>
  6305. </doc>
  6306. </method>
  6307. <method name="setApplicationId"
  6308. abstract="true" native="false" synchronized="false"
  6309. static="false" final="false" visibility="public"
  6310. deprecated="not deprecated">
  6311. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  6312. <doc>
  6313. <![CDATA[Set the <code>ApplicationId</code> of the submitted application.
  6314. @param applicationId <code>ApplicationId</code> of the submitted
  6315. application]]>
  6316. </doc>
  6317. </method>
  6318. <method name="getApplicationName" return="java.lang.String"
  6319. abstract="true" native="false" synchronized="false"
  6320. static="false" final="false" visibility="public"
  6321. deprecated="not deprecated">
  6322. <doc>
  6323. <![CDATA[Get the application <em>name</em>.
  6324. @return application name]]>
  6325. </doc>
  6326. </method>
  6327. <method name="setApplicationName"
  6328. abstract="true" native="false" synchronized="false"
  6329. static="false" final="false" visibility="public"
  6330. deprecated="not deprecated">
  6331. <param name="applicationName" type="java.lang.String"/>
  6332. <doc>
  6333. <![CDATA[Set the application <em>name</em>.
  6334. @param applicationName application name]]>
  6335. </doc>
  6336. </method>
  6337. <method name="getQueue" return="java.lang.String"
  6338. abstract="true" native="false" synchronized="false"
  6339. static="false" final="false" visibility="public"
  6340. deprecated="not deprecated">
  6341. <doc>
  6342. <![CDATA[Get the <em>queue</em> to which the application is being submitted.
  6343. @return <em>queue</em> to which the application is being submitted]]>
  6344. </doc>
  6345. </method>
  6346. <method name="setQueue"
  6347. abstract="true" native="false" synchronized="false"
  6348. static="false" final="false" visibility="public"
  6349. deprecated="not deprecated">
  6350. <param name="queue" type="java.lang.String"/>
  6351. <doc>
  6352. <![CDATA[Set the <em>queue</em> to which the application is being submitted
  6353. @param queue <em>queue</em> to which the application is being submitted]]>
  6354. </doc>
  6355. </method>
  6356. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  6357. abstract="true" native="false" synchronized="false"
  6358. static="false" final="false" visibility="public"
  6359. deprecated="not deprecated">
  6360. <doc>
  6361. <![CDATA[Get the <code>Priority</code> of the application.
  6362. @return <code>Priority</code> of the application]]>
  6363. </doc>
  6364. </method>
  6365. <method name="getAMContainerSpec" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  6366. abstract="true" native="false" synchronized="false"
  6367. static="false" final="false" visibility="public"
  6368. deprecated="not deprecated">
  6369. <doc>
  6370. <![CDATA[Get the <code>ContainerLaunchContext</code> to describe the
  6371. <code>Container</code> with which the <code>ApplicationMaster</code> is
  6372. launched.
  6373. @return <code>ContainerLaunchContext</code> for the
  6374. <code>ApplicationMaster</code> container]]>
  6375. </doc>
  6376. </method>
  6377. <method name="setAMContainerSpec"
  6378. abstract="true" native="false" synchronized="false"
  6379. static="false" final="false" visibility="public"
  6380. deprecated="not deprecated">
  6381. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  6382. <doc>
  6383. <![CDATA[Set the <code>ContainerLaunchContext</code> to describe the
  6384. <code>Container</code> with which the <code>ApplicationMaster</code> is
  6385. launched.
  6386. @param amContainer <code>ContainerLaunchContext</code> for the
  6387. <code>ApplicationMaster</code> container]]>
  6388. </doc>
  6389. </method>
  6390. <method name="getUnmanagedAM" return="boolean"
  6391. abstract="true" native="false" synchronized="false"
  6392. static="false" final="false" visibility="public"
  6393. deprecated="not deprecated">
  6394. <doc>
  6395. <![CDATA[Get if the RM should manage the execution of the AM.
  6396. If true, then the RM
  6397. will not allocate a container for the AM and start it. It will expect the
  6398. AM to be launched and connect to the RM within the AM liveliness period and
  6399. fail the app otherwise. The client should launch the AM only after the RM
  6400. has ACCEPTED the application and changed the <code>YarnApplicationState</code>.
  6401. Such apps will not be retried by the RM on app attempt failure.
  6402. The default value is false.
  6403. @return true if the AM is not managed by the RM]]>
  6404. </doc>
  6405. </method>
  6406. <method name="setUnmanagedAM"
  6407. abstract="true" native="false" synchronized="false"
  6408. static="false" final="false" visibility="public"
  6409. deprecated="not deprecated">
  6410. <param name="value" type="boolean"/>
  6411. <doc>
  6412. <![CDATA[@param value true if RM should not manage the AM]]>
  6413. </doc>
  6414. </method>
  6415. <method name="getMaxAppAttempts" return="int"
  6416. abstract="true" native="false" synchronized="false"
  6417. static="false" final="false" visibility="public"
  6418. deprecated="not deprecated">
  6419. <doc>
  6420. <![CDATA[@return the number of max attempts of the application to be submitted]]>
  6421. </doc>
  6422. </method>
  6423. <method name="setMaxAppAttempts"
  6424. abstract="true" native="false" synchronized="false"
  6425. static="false" final="false" visibility="public"
  6426. deprecated="not deprecated">
  6427. <param name="maxAppAttempts" type="int"/>
  6428. <doc>
  6429. <![CDATA[Set the number of max attempts of the application to be submitted. WARNING:
  6430. it should be no larger than the global number of max attempts in the Yarn
  6431. configuration.
  6432. @param maxAppAttempts the number of max attempts of the application
  6433. to be submitted.]]>
  6434. </doc>
  6435. </method>
  6436. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  6437. abstract="true" native="false" synchronized="false"
  6438. static="false" final="false" visibility="public"
  6439. deprecated="not deprecated">
  6440. <doc>
  6441. <![CDATA[Get the resource required by the <code>ApplicationMaster</code> for this
  6442. application. Please note this will be DEPRECATED, use <em>getResource</em>
  6443. in <em>getAMContainerResourceRequest</em> instead.
  6444. @return the resource required by the <code>ApplicationMaster</code> for
  6445. this application.]]>
  6446. </doc>
  6447. </method>
  6448. <method name="setResource"
  6449. abstract="true" native="false" synchronized="false"
  6450. static="false" final="false" visibility="public"
  6451. deprecated="not deprecated">
  6452. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  6453. <doc>
  6454. <![CDATA[Set the resource required by the <code>ApplicationMaster</code> for this
  6455. application.
  6456. @param resource the resource required by the <code>ApplicationMaster</code>
  6457. for this application.]]>
  6458. </doc>
  6459. </method>
  6460. <method name="getApplicationType" return="java.lang.String"
  6461. abstract="true" native="false" synchronized="false"
  6462. static="false" final="false" visibility="public"
  6463. deprecated="not deprecated">
  6464. <doc>
  6465. <![CDATA[Get the application type
  6466. @return the application type]]>
  6467. </doc>
  6468. </method>
  6469. <method name="setApplicationType"
  6470. abstract="true" native="false" synchronized="false"
  6471. static="false" final="false" visibility="public"
  6472. deprecated="not deprecated">
  6473. <param name="applicationType" type="java.lang.String"/>
  6474. <doc>
  6475. <![CDATA[Set the application type
  6476. @param applicationType the application type]]>
  6477. </doc>
  6478. </method>
  6479. <method name="getKeepContainersAcrossApplicationAttempts" return="boolean"
  6480. abstract="true" native="false" synchronized="false"
  6481. static="false" final="false" visibility="public"
  6482. deprecated="not deprecated">
  6483. <doc>
  6484. <![CDATA[Get the flag which indicates whether to keep containers across application
  6485. attempts or not.
  6486. @return the flag which indicates whether to keep containers across
  6487. application attempts or not.]]>
  6488. </doc>
  6489. </method>
  6490. <method name="setKeepContainersAcrossApplicationAttempts"
  6491. abstract="true" native="false" synchronized="false"
  6492. static="false" final="false" visibility="public"
  6493. deprecated="not deprecated">
  6494. <param name="keepContainers" type="boolean"/>
  6495. <doc>
  6496. <![CDATA[Set the flag which indicates whether to keep containers across application
  6497. attempts.
  6498. <p>
  6499. For managed AM, if the flag is true, running containers will not be killed
  6500. when application attempt fails and these containers will be retrieved by
  6501. the new application attempt on registration via
  6502. {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}.
  6503. </p>
  6504. <p>
  6505. For unmanaged AM, if the flag is true, RM allows re-register and returns
  6506. the running containers in the same attempt back to the UAM for HA.
  6507. </p>
  6508. @param keepContainers the flag which indicates whether to keep containers
  6509. across application attempts.]]>
  6510. </doc>
  6511. </method>
  6512. <method name="getApplicationTags" return="java.util.Set"
  6513. abstract="true" native="false" synchronized="false"
  6514. static="false" final="false" visibility="public"
  6515. deprecated="not deprecated">
  6516. <doc>
  6517. <![CDATA[Get tags for the application
  6518. @return the application tags]]>
  6519. </doc>
  6520. </method>
  6521. <method name="setApplicationTags"
  6522. abstract="true" native="false" synchronized="false"
  6523. static="false" final="false" visibility="public"
  6524. deprecated="not deprecated">
  6525. <param name="tags" type="java.util.Set"/>
  6526. <doc>
  6527. <![CDATA[Set tags for the application. A maximum of
  6528. {@link YarnConfiguration#APPLICATION_MAX_TAGS} are allowed
  6529. per application. Each tag can be at most
  6530. {@link YarnConfiguration#APPLICATION_MAX_TAG_LENGTH}
  6531. characters, and can contain only ASCII characters.
  6532. @param tags tags to set]]>
  6533. </doc>
  6534. </method>
  6535. <method name="getNodeLabelExpression" return="java.lang.String"
  6536. abstract="true" native="false" synchronized="false"
  6537. static="false" final="false" visibility="public"
  6538. deprecated="not deprecated">
  6539. <doc>
  6540. <![CDATA[Get node-label-expression for this app. If this is set, all containers of
  6541. this application without setting node-label-expression in ResurceRequest
  6542. will get allocated resources on only those nodes that satisfy this
  6543. node-label-expression.
  6544. If different node-label-expression of this app and ResourceRequest are set
  6545. at the same time, the one set in ResourceRequest will be used when
  6546. allocating container
  6547. @return node-label-expression for this app]]>
  6548. </doc>
  6549. </method>
  6550. <method name="setNodeLabelExpression"
  6551. abstract="true" native="false" synchronized="false"
  6552. static="false" final="false" visibility="public"
  6553. deprecated="not deprecated">
  6554. <param name="nodeLabelExpression" type="java.lang.String"/>
  6555. <doc>
  6556. <![CDATA[Set node-label-expression for this app
  6557. @param nodeLabelExpression node-label-expression of this app]]>
  6558. </doc>
  6559. </method>
  6560. <method name="getAMContainerResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  6561. abstract="true" native="false" synchronized="false"
  6562. static="false" final="false" visibility="public"
  6563. deprecated="See {@link #getAMContainerResourceRequests()}">
  6564. <doc>
  6565. <![CDATA[Get the ResourceRequest of the AM container.
  6566. If this is not null, scheduler will use this to acquire resource for AM
  6567. container.
  6568. If this is null, scheduler will assemble a ResourceRequest by using
  6569. <em>getResource</em> and <em>getPriority</em> of
  6570. <em>ApplicationSubmissionContext</em>.
  6571. Number of containers and Priority will be ignored.
  6572. @return ResourceRequest of the AM container
  6573. @deprecated See {@link #getAMContainerResourceRequests()}]]>
  6574. </doc>
  6575. </method>
  6576. <method name="setAMContainerResourceRequest"
  6577. abstract="true" native="false" synchronized="false"
  6578. static="false" final="false" visibility="public"
  6579. deprecated="See {@link #setAMContainerResourceRequests(List)}">
  6580. <param name="request" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  6581. <doc>
  6582. <![CDATA[Set ResourceRequest of the AM container
  6583. @param request of the AM container
  6584. @deprecated See {@link #setAMContainerResourceRequests(List)}]]>
  6585. </doc>
  6586. </method>
  6587. <method name="getAMContainerResourceRequests" return="java.util.List"
  6588. abstract="true" native="false" synchronized="false"
  6589. static="false" final="false" visibility="public"
  6590. deprecated="not deprecated">
  6591. <doc>
  6592. <![CDATA[Get the ResourceRequests of the AM container.
  6593. If this is not null, scheduler will use this to acquire resource for AM
  6594. container.
  6595. If this is null, scheduler will use the ResourceRequest as determined by
  6596. <em>getAMContainerResourceRequest</em> and its behavior.
  6597. Number of containers and Priority will be ignored.
  6598. @return List of ResourceRequests of the AM container]]>
  6599. </doc>
  6600. </method>
  6601. <method name="setAMContainerResourceRequests"
  6602. abstract="true" native="false" synchronized="false"
  6603. static="false" final="false" visibility="public"
  6604. deprecated="not deprecated">
  6605. <param name="requests" type="java.util.List"/>
  6606. <doc>
  6607. <![CDATA[Set ResourceRequests of the AM container.
  6608. @param requests of the AM container]]>
  6609. </doc>
  6610. </method>
  6611. <method name="getAttemptFailuresValidityInterval" return="long"
  6612. abstract="true" native="false" synchronized="false"
  6613. static="false" final="false" visibility="public"
  6614. deprecated="not deprecated">
  6615. <doc>
  6616. <![CDATA[Get the attemptFailuresValidityInterval in milliseconds for the application
  6617. @return the attemptFailuresValidityInterval]]>
  6618. </doc>
  6619. </method>
  6620. <method name="setAttemptFailuresValidityInterval"
  6621. abstract="true" native="false" synchronized="false"
  6622. static="false" final="false" visibility="public"
  6623. deprecated="not deprecated">
  6624. <param name="attemptFailuresValidityInterval" type="long"/>
  6625. <doc>
  6626. <![CDATA[Set the attemptFailuresValidityInterval in milliseconds for the application
  6627. @param attemptFailuresValidityInterval]]>
  6628. </doc>
  6629. </method>
  6630. <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  6631. abstract="true" native="false" synchronized="false"
  6632. static="false" final="false" visibility="public"
  6633. deprecated="not deprecated">
  6634. <doc>
  6635. <![CDATA[Get <code>LogAggregationContext</code> of the application
  6636. @return <code>LogAggregationContext</code> of the application]]>
  6637. </doc>
  6638. </method>
  6639. <method name="setLogAggregationContext"
  6640. abstract="true" native="false" synchronized="false"
  6641. static="false" final="false" visibility="public"
  6642. deprecated="not deprecated">
  6643. <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
  6644. <doc>
  6645. <![CDATA[Set <code>LogAggregationContext</code> for the application
  6646. @param logAggregationContext
  6647. for the application]]>
  6648. </doc>
  6649. </method>
  6650. <method name="getReservationID" return="org.apache.hadoop.yarn.api.records.ReservationId"
  6651. abstract="true" native="false" synchronized="false"
  6652. static="false" final="false" visibility="public"
  6653. deprecated="not deprecated">
  6654. <doc>
  6655. <![CDATA[Get the reservation id, that corresponds to a valid resource allocation in
  6656. the scheduler (between start and end time of the corresponding reservation)
  6657. @return the reservation id representing the unique id of the corresponding
  6658. reserved resource allocation in the scheduler]]>
  6659. </doc>
  6660. </method>
  6661. <method name="setReservationID"
  6662. abstract="true" native="false" synchronized="false"
  6663. static="false" final="false" visibility="public"
  6664. deprecated="not deprecated">
  6665. <param name="reservationID" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  6666. <doc>
  6667. <![CDATA[Set the reservation id, that correspond to a valid resource allocation in
  6668. the scheduler (between start and end time of the corresponding reservation)
  6669. @param reservationID representing the unique id of the
  6670. corresponding reserved resource allocation in the scheduler]]>
  6671. </doc>
  6672. </method>
  6673. <method name="getApplicationTimeouts" return="java.util.Map"
  6674. abstract="true" native="false" synchronized="false"
  6675. static="false" final="false" visibility="public"
  6676. deprecated="not deprecated">
  6677. <doc>
  6678. <![CDATA[Get <code>ApplicationTimeouts</code> of the application. Timeout value is
  6679. in seconds.
  6680. @return all <code>ApplicationTimeouts</code> of the application.]]>
  6681. </doc>
  6682. </method>
  6683. <method name="setApplicationTimeouts"
  6684. abstract="true" native="false" synchronized="false"
  6685. static="false" final="false" visibility="public"
  6686. deprecated="not deprecated">
  6687. <param name="applicationTimeouts" type="java.util.Map"/>
  6688. <doc>
  6689. <![CDATA[Set the <code>ApplicationTimeouts</code> for the application in seconds.
  6690. All pre-existing Map entries are cleared before adding the new Map.
  6691. <p>
  6692. <b>Note:</b> If application timeout value is less than or equal to zero
  6693. then application submission will throw an exception.
  6694. </p>
  6695. @param applicationTimeouts <code>ApplicationTimeouts</code>s for the
  6696. application]]>
  6697. </doc>
  6698. </method>
  6699. <doc>
  6700. <![CDATA[{@code ApplicationSubmissionContext} represents all of the
  6701. information needed by the {@code ResourceManager} to launch
  6702. the {@code ApplicationMaster} for an application.
  6703. <p>
  6704. It includes details such as:
  6705. <ul>
  6706. <li>{@link ApplicationId} of the application.</li>
  6707. <li>Application user.</li>
  6708. <li>Application name.</li>
  6709. <li>{@link Priority} of the application.</li>
  6710. <li>
  6711. {@link ContainerLaunchContext} of the container in which the
  6712. <code>ApplicationMaster</code> is executed.
  6713. </li>
  6714. <li>
  6715. maxAppAttempts. The maximum number of application attempts.
  6716. It should be no larger than the global number of max attempts in the
  6717. Yarn configuration.
  6718. </li>
  6719. <li>
  6720. attemptFailuresValidityInterval. The default value is -1.
  6721. when attemptFailuresValidityInterval in milliseconds is set to
  6722. {@literal >} 0, the failure number will no take failures which happen
  6723. out of the validityInterval into failure count. If failure count
  6724. reaches to maxAppAttempts, the application will be failed.
  6725. </li>
  6726. <li>Optional, application-specific {@link LogAggregationContext}</li>
  6727. </ul>
  6728. @see ContainerLaunchContext
  6729. @see ApplicationClientProtocol#submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest)]]>
  6730. </doc>
  6731. </class>
  6732. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
  6733. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationTimeout -->
  6734. <class name="ApplicationTimeout" extends="java.lang.Object"
  6735. abstract="true"
  6736. static="false" final="false" visibility="public"
  6737. deprecated="not deprecated">
  6738. <constructor name="ApplicationTimeout"
  6739. static="false" final="false" visibility="public"
  6740. deprecated="not deprecated">
  6741. </constructor>
  6742. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationTimeout"
  6743. abstract="false" native="false" synchronized="false"
  6744. static="true" final="false" visibility="public"
  6745. deprecated="not deprecated">
  6746. <param name="type" type="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"/>
  6747. <param name="expiryTime" type="java.lang.String"/>
  6748. <param name="remainingTime" type="long"/>
  6749. </method>
  6750. <method name="getTimeoutType" return="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"
  6751. abstract="true" native="false" synchronized="false"
  6752. static="false" final="false" visibility="public"
  6753. deprecated="not deprecated">
  6754. <doc>
  6755. <![CDATA[Get the application timeout type.
  6756. @return timeoutType of an application timeout.]]>
  6757. </doc>
  6758. </method>
  6759. <method name="setTimeoutType"
  6760. abstract="true" native="false" synchronized="false"
  6761. static="false" final="false" visibility="public"
  6762. deprecated="not deprecated">
  6763. <param name="timeoutType" type="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"/>
  6764. <doc>
  6765. <![CDATA[Set the application timeout type.
  6766. @param timeoutType of an application timeout.]]>
  6767. </doc>
  6768. </method>
  6769. <method name="getExpiryTime" return="java.lang.String"
  6770. abstract="true" native="false" synchronized="false"
  6771. static="false" final="false" visibility="public"
  6772. deprecated="not deprecated">
  6773. <doc>
  6774. <![CDATA[Get <code>expiryTime</code> for given timeout type.
  6775. @return expiryTime in ISO8601 standard with format
  6776. <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.]]>
  6777. </doc>
  6778. </method>
  6779. <method name="setExpiryTime"
  6780. abstract="true" native="false" synchronized="false"
  6781. static="false" final="false" visibility="public"
  6782. deprecated="not deprecated">
  6783. <param name="expiryTime" type="java.lang.String"/>
  6784. <doc>
  6785. <![CDATA[Set <code>expiryTime</code> for given timeout type.
  6786. @param expiryTime in ISO8601 standard with format
  6787. <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.]]>
  6788. </doc>
  6789. </method>
  6790. <method name="getRemainingTime" return="long"
  6791. abstract="true" native="false" synchronized="false"
  6792. static="false" final="false" visibility="public"
  6793. deprecated="not deprecated">
  6794. <doc>
  6795. <![CDATA[Get <code>Remaining Time</code> of an application for given timeout type.
  6796. @return Remaining Time in seconds.]]>
  6797. </doc>
  6798. </method>
  6799. <method name="setRemainingTime"
  6800. abstract="true" native="false" synchronized="false"
  6801. static="false" final="false" visibility="public"
  6802. deprecated="not deprecated">
  6803. <param name="remainingTime" type="long"/>
  6804. <doc>
  6805. <![CDATA[Set <code>Remaining Time</code> of an application for given timeout type.
  6806. @param remainingTime in seconds.]]>
  6807. </doc>
  6808. </method>
  6809. <doc>
  6810. <![CDATA[{@code ApplicationTimeout} is a report for configured application timeouts.
  6811. It includes details such as:
  6812. <ul>
  6813. <li>{@link ApplicationTimeoutType} of the timeout type.</li>
  6814. <li>Expiry time in ISO8601 standard with format
  6815. <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b> or "UNLIMITED".</li>
  6816. <li>Remaining time in seconds.</li>
  6817. </ul>
  6818. The possible values for {ExpiryTime, RemainingTimeInSeconds} are
  6819. <ul>
  6820. <li>{UNLIMITED,-1} : Timeout is not configured for given timeout type
  6821. (LIFETIME).</li>
  6822. <li>{ISO8601 date string, 0} : Timeout is configured and application has
  6823. completed.</li>
  6824. <li>{ISO8601 date string, greater than zero} : Timeout is configured and
  6825. application is RUNNING. Application will be timed out after configured
  6826. value.</li>
  6827. </ul>]]>
  6828. </doc>
  6829. </class>
  6830. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationTimeout -->
  6831. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationTimeoutType -->
  6832. <class name="ApplicationTimeoutType" extends="java.lang.Enum"
  6833. abstract="false"
  6834. static="false" final="true" visibility="public"
  6835. deprecated="not deprecated">
  6836. <method name="values" return="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType[]"
  6837. abstract="false" native="false" synchronized="false"
  6838. static="true" final="false" visibility="public"
  6839. deprecated="not deprecated">
  6840. </method>
  6841. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"
  6842. abstract="false" native="false" synchronized="false"
  6843. static="true" final="false" visibility="public"
  6844. deprecated="not deprecated">
  6845. <param name="name" type="java.lang.String"/>
  6846. </method>
  6847. <doc>
  6848. <![CDATA[Application timeout type.]]>
  6849. </doc>
  6850. </class>
  6851. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationTimeoutType -->
  6852. <!-- start class org.apache.hadoop.yarn.api.records.CollectorInfo -->
  6853. <class name="CollectorInfo" extends="java.lang.Object"
  6854. abstract="true"
  6855. static="false" final="false" visibility="public"
  6856. deprecated="not deprecated">
  6857. <constructor name="CollectorInfo"
  6858. static="false" final="false" visibility="public"
  6859. deprecated="not deprecated">
  6860. </constructor>
  6861. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.CollectorInfo"
  6862. abstract="false" native="false" synchronized="false"
  6863. static="true" final="false" visibility="public"
  6864. deprecated="not deprecated">
  6865. <param name="collectorAddr" type="java.lang.String"/>
  6866. </method>
  6867. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.CollectorInfo"
  6868. abstract="false" native="false" synchronized="false"
  6869. static="true" final="false" visibility="public"
  6870. deprecated="not deprecated">
  6871. <param name="collectorAddr" type="java.lang.String"/>
  6872. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  6873. </method>
  6874. <method name="getCollectorAddr" return="java.lang.String"
  6875. abstract="true" native="false" synchronized="false"
  6876. static="false" final="false" visibility="public"
  6877. deprecated="not deprecated">
  6878. </method>
  6879. <method name="setCollectorAddr"
  6880. abstract="true" native="false" synchronized="false"
  6881. static="false" final="false" visibility="public"
  6882. deprecated="not deprecated">
  6883. <param name="addr" type="java.lang.String"/>
  6884. </method>
  6885. <method name="getCollectorToken" return="org.apache.hadoop.yarn.api.records.Token"
  6886. abstract="true" native="false" synchronized="false"
  6887. static="false" final="false" visibility="public"
  6888. deprecated="not deprecated">
  6889. <doc>
  6890. <![CDATA[Get delegation token for app collector which AM will use to publish
  6891. entities.
  6892. @return the delegation token for app collector.]]>
  6893. </doc>
  6894. </method>
  6895. <method name="setCollectorToken"
  6896. abstract="true" native="false" synchronized="false"
  6897. static="false" final="false" visibility="public"
  6898. deprecated="not deprecated">
  6899. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  6900. </method>
  6901. <field name="DEFAULT_TIMESTAMP_VALUE" type="long"
  6902. transient="false" volatile="false"
  6903. static="true" final="true" visibility="protected"
  6904. deprecated="not deprecated">
  6905. </field>
  6906. <doc>
  6907. <![CDATA[Collector info containing collector address and collector token passed from
  6908. RM to AM in Allocate Response.]]>
  6909. </doc>
  6910. </class>
  6911. <!-- end class org.apache.hadoop.yarn.api.records.CollectorInfo -->
  6912. <!-- start class org.apache.hadoop.yarn.api.records.Container -->
  6913. <class name="Container" extends="java.lang.Object"
  6914. abstract="true"
  6915. static="false" final="false" visibility="public"
  6916. deprecated="not deprecated">
  6917. <implements name="java.lang.Comparable"/>
  6918. <constructor name="Container"
  6919. static="false" final="false" visibility="public"
  6920. deprecated="not deprecated">
  6921. </constructor>
  6922. <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  6923. abstract="true" native="false" synchronized="false"
  6924. static="false" final="false" visibility="public"
  6925. deprecated="not deprecated">
  6926. <doc>
  6927. <![CDATA[Get the globally unique identifier for the container.
  6928. @return globally unique identifier for the container]]>
  6929. </doc>
  6930. </method>
  6931. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  6932. abstract="true" native="false" synchronized="false"
  6933. static="false" final="false" visibility="public"
  6934. deprecated="not deprecated">
  6935. <doc>
  6936. <![CDATA[Get the identifier of the node on which the container is allocated.
  6937. @return identifier of the node on which the container is allocated]]>
  6938. </doc>
  6939. </method>
  6940. <method name="getNodeHttpAddress" return="java.lang.String"
  6941. abstract="true" native="false" synchronized="false"
  6942. static="false" final="false" visibility="public"
  6943. deprecated="not deprecated">
  6944. <doc>
  6945. <![CDATA[Get the http uri of the node on which the container is allocated.
  6946. @return http uri of the node on which the container is allocated]]>
  6947. </doc>
  6948. </method>
  6949. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  6950. abstract="true" native="false" synchronized="false"
  6951. static="false" final="false" visibility="public"
  6952. deprecated="not deprecated">
  6953. <doc>
  6954. <![CDATA[Get the <code>Resource</code> allocated to the container.
  6955. @return <code>Resource</code> allocated to the container]]>
  6956. </doc>
  6957. </method>
  6958. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  6959. abstract="true" native="false" synchronized="false"
  6960. static="false" final="false" visibility="public"
  6961. deprecated="not deprecated">
  6962. <doc>
  6963. <![CDATA[Get the <code>Priority</code> at which the <code>Container</code> was
  6964. allocated.
  6965. @return <code>Priority</code> at which the <code>Container</code> was
  6966. allocated]]>
  6967. </doc>
  6968. </method>
  6969. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  6970. abstract="true" native="false" synchronized="false"
  6971. static="false" final="false" visibility="public"
  6972. deprecated="not deprecated">
  6973. <doc>
  6974. <![CDATA[Get the <code>ContainerToken</code> for the container.
  6975. <p><code>ContainerToken</code> is the security token used by the framework
  6976. to verify authenticity of any <code>Container</code>.</p>
  6977. <p>The <code>ResourceManager</code>, on container allocation provides a
  6978. secure token which is verified by the <code>NodeManager</code> on
  6979. container launch.</p>
  6980. <p>Applications do not need to care about <code>ContainerToken</code>, they
  6981. are transparently handled by the framework - the allocated
  6982. <code>Container</code> includes the <code>ContainerToken</code>.</p>
  6983. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
  6984. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
  6985. @return <code>ContainerToken</code> for the container]]>
  6986. </doc>
  6987. </method>
  6988. <method name="getAllocationRequestId" return="long"
  6989. abstract="false" native="false" synchronized="false"
  6990. static="false" final="false" visibility="public"
  6991. deprecated="not deprecated">
  6992. <doc>
  6993. <![CDATA[Get the optional <em>ID</em> corresponding to the original {@code
  6994. ResourceRequest{@link #getAllocationRequestId()}}s which is satisfied by
  6995. this allocated {@code Container}.
  6996. <p>
  6997. The scheduler may return multiple {@code AllocateResponse}s corresponding
  6998. to the same ID as and when scheduler allocates {@code Container}s.
  6999. <b>Applications</b> can continue to completely ignore the returned ID in
  7000. the response and use the allocation for any of their outstanding requests.
  7001. <p>
  7002. @return the <em>ID</em> corresponding to the original allocation request
  7003. which is satisfied by this allocation.]]>
  7004. </doc>
  7005. </method>
  7006. <doc>
  7007. <![CDATA[{@code Container} represents an allocated resource in the cluster.
  7008. <p>
  7009. The {@code ResourceManager} is the sole authority to allocate any
  7010. {@code Container} to applications. The allocated {@code Container}
  7011. is always on a single node and has a unique {@link ContainerId}. It has
  7012. a specific amount of {@link Resource} allocated.
  7013. <p>
  7014. It includes details such as:
  7015. <ul>
  7016. <li>{@link ContainerId} for the container, which is globally unique.</li>
  7017. <li>
  7018. {@link NodeId} of the node on which it is allocated.
  7019. </li>
  7020. <li>HTTP uri of the node.</li>
  7021. <li>{@link Resource} allocated to the container.</li>
  7022. <li>{@link Priority} at which the container was allocated.</li>
  7023. <li>
  7024. Container {@link Token} of the container, used to securely verify
  7025. authenticity of the allocation.
  7026. </li>
  7027. </ul>
  7028. Typically, an {@code ApplicationMaster} receives the {@code Container}
  7029. from the {@code ResourceManager} during resource-negotiation and then
  7030. talks to the {@code NodeManager} to start/stop containers.
  7031. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
  7032. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
  7033. @see ContainerManagementProtocol#stopContainers(org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest)]]>
  7034. </doc>
  7035. </class>
  7036. <!-- end class org.apache.hadoop.yarn.api.records.Container -->
  7037. <!-- start class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
  7038. <class name="ContainerExitStatus" extends="java.lang.Object"
  7039. abstract="false"
  7040. static="false" final="false" visibility="public"
  7041. deprecated="not deprecated">
  7042. <constructor name="ContainerExitStatus"
  7043. static="false" final="false" visibility="public"
  7044. deprecated="not deprecated">
  7045. </constructor>
  7046. <field name="SUCCESS" type="int"
  7047. transient="false" volatile="false"
  7048. static="true" final="true" visibility="public"
  7049. deprecated="not deprecated">
  7050. </field>
  7051. <field name="INVALID" type="int"
  7052. transient="false" volatile="false"
  7053. static="true" final="true" visibility="public"
  7054. deprecated="not deprecated">
  7055. </field>
  7056. <field name="ABORTED" type="int"
  7057. transient="false" volatile="false"
  7058. static="true" final="true" visibility="public"
  7059. deprecated="not deprecated">
  7060. <doc>
  7061. <![CDATA[Containers killed by the framework, either due to being released by
  7062. the application or being 'lost' due to node failures etc.]]>
  7063. </doc>
  7064. </field>
  7065. <field name="DISKS_FAILED" type="int"
  7066. transient="false" volatile="false"
  7067. static="true" final="true" visibility="public"
  7068. deprecated="not deprecated">
  7069. <doc>
  7070. <![CDATA[When threshold number of the nodemanager-local-directories or
  7071. threshold number of the nodemanager-log-directories become bad.]]>
  7072. </doc>
  7073. </field>
  7074. <field name="PREEMPTED" type="int"
  7075. transient="false" volatile="false"
  7076. static="true" final="true" visibility="public"
  7077. deprecated="not deprecated">
  7078. <doc>
  7079. <![CDATA[Containers preempted by the framework.]]>
  7080. </doc>
  7081. </field>
  7082. <field name="KILLED_EXCEEDED_VMEM" type="int"
  7083. transient="false" volatile="false"
  7084. static="true" final="true" visibility="public"
  7085. deprecated="not deprecated">
  7086. <doc>
  7087. <![CDATA[Container terminated because of exceeding allocated virtual memory.]]>
  7088. </doc>
  7089. </field>
  7090. <field name="KILLED_EXCEEDED_PMEM" type="int"
  7091. transient="false" volatile="false"
  7092. static="true" final="true" visibility="public"
  7093. deprecated="not deprecated">
  7094. <doc>
  7095. <![CDATA[Container terminated because of exceeding allocated physical memory.]]>
  7096. </doc>
  7097. </field>
  7098. <field name="KILLED_BY_APPMASTER" type="int"
  7099. transient="false" volatile="false"
  7100. static="true" final="true" visibility="public"
  7101. deprecated="not deprecated">
  7102. <doc>
  7103. <![CDATA[Container was terminated by stop request by the app master.]]>
  7104. </doc>
  7105. </field>
  7106. <field name="KILLED_BY_RESOURCEMANAGER" type="int"
  7107. transient="false" volatile="false"
  7108. static="true" final="true" visibility="public"
  7109. deprecated="not deprecated">
  7110. <doc>
  7111. <![CDATA[Container was terminated by the resource manager.]]>
  7112. </doc>
  7113. </field>
  7114. <field name="KILLED_AFTER_APP_COMPLETION" type="int"
  7115. transient="false" volatile="false"
  7116. static="true" final="true" visibility="public"
  7117. deprecated="not deprecated">
  7118. <doc>
  7119. <![CDATA[Container was terminated after the application finished.]]>
  7120. </doc>
  7121. </field>
  7122. <field name="KILLED_BY_CONTAINER_SCHEDULER" type="int"
  7123. transient="false" volatile="false"
  7124. static="true" final="true" visibility="public"
  7125. deprecated="not deprecated">
  7126. <doc>
  7127. <![CDATA[Container was terminated by the ContainerScheduler to make room
  7128. for another container...]]>
  7129. </doc>
  7130. </field>
  7131. <doc>
  7132. <![CDATA[Container exit statuses indicating special exit circumstances.]]>
  7133. </doc>
  7134. </class>
  7135. <!-- end class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
  7136. <!-- start class org.apache.hadoop.yarn.api.records.ContainerId -->
  7137. <class name="ContainerId" extends="java.lang.Object"
  7138. abstract="true"
  7139. static="false" final="false" visibility="public"
  7140. deprecated="not deprecated">
  7141. <implements name="java.lang.Comparable"/>
  7142. <constructor name="ContainerId"
  7143. static="false" final="false" visibility="public"
  7144. deprecated="not deprecated">
  7145. </constructor>
  7146. <method name="newContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  7147. abstract="false" native="false" synchronized="false"
  7148. static="true" final="false" visibility="public"
  7149. deprecated="not deprecated">
  7150. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  7151. <param name="containerId" type="long"/>
  7152. </method>
  7153. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  7154. abstract="true" native="false" synchronized="false"
  7155. static="false" final="false" visibility="public"
  7156. deprecated="not deprecated">
  7157. <doc>
  7158. <![CDATA[Get the <code>ApplicationAttemptId</code> of the application to which the
  7159. <code>Container</code> was assigned.
  7160. <p>
  7161. Note: If containers are kept alive across application attempts via
  7162. {@link ApplicationSubmissionContext#setKeepContainersAcrossApplicationAttempts(boolean)}
  7163. the <code>ContainerId</code> does not necessarily contain the current
  7164. running application attempt's <code>ApplicationAttemptId</code> This
  7165. container can be allocated by previously exited application attempt and
  7166. managed by the current running attempt thus have the previous application
  7167. attempt's <code>ApplicationAttemptId</code>.
  7168. </p>
  7169. @return <code>ApplicationAttemptId</code> of the application to which the
  7170. <code>Container</code> was assigned]]>
  7171. </doc>
  7172. </method>
  7173. <method name="getId" return="int"
  7174. abstract="true" native="false" synchronized="false"
  7175. static="false" final="false" visibility="public"
  7176. deprecated="not deprecated">
  7177. <doc>
  7178. <![CDATA[Get the lower 32 bits of identifier of the <code>ContainerId</code>,
  7179. which doesn't include epoch. Note that this method will be marked as
  7180. deprecated, so please use <code>getContainerId</code> instead.
  7181. @return lower 32 bits of identifier of the <code>ContainerId</code>]]>
  7182. </doc>
  7183. </method>
  7184. <method name="getContainerId" return="long"
  7185. abstract="true" native="false" synchronized="false"
  7186. static="false" final="false" visibility="public"
  7187. deprecated="not deprecated">
  7188. <doc>
  7189. <![CDATA[Get the identifier of the <code>ContainerId</code>. Upper 24 bits are
  7190. reserved as epoch of cluster, and lower 40 bits are reserved as
  7191. sequential number of containers.
  7192. @return identifier of the <code>ContainerId</code>]]>
  7193. </doc>
  7194. </method>
  7195. <method name="hashCode" return="int"
  7196. abstract="false" native="false" synchronized="false"
  7197. static="false" final="false" visibility="public"
  7198. deprecated="not deprecated">
  7199. </method>
  7200. <method name="equals" return="boolean"
  7201. abstract="false" native="false" synchronized="false"
  7202. static="false" final="false" visibility="public"
  7203. deprecated="not deprecated">
  7204. <param name="obj" type="java.lang.Object"/>
  7205. </method>
  7206. <method name="compareTo" return="int"
  7207. abstract="false" native="false" synchronized="false"
  7208. static="false" final="false" visibility="public"
  7209. deprecated="not deprecated">
  7210. <param name="other" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  7211. </method>
  7212. <method name="toString" return="java.lang.String"
  7213. abstract="false" native="false" synchronized="false"
  7214. static="false" final="false" visibility="public"
  7215. deprecated="not deprecated">
  7216. <doc>
  7217. <![CDATA[@return A string representation of containerId. The format is
  7218. container_e*epoch*_*clusterTimestamp*_*appId*_*attemptId*_*containerId*
  7219. when epoch is larger than 0
  7220. (e.g. container_e17_1410901177871_0001_01_000005).
  7221. *epoch* is increased when RM restarts or fails over.
  7222. When epoch is 0, epoch is omitted
  7223. (e.g. container_1410901177871_0001_01_000005).]]>
  7224. </doc>
  7225. </method>
  7226. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ContainerId"
  7227. abstract="false" native="false" synchronized="false"
  7228. static="true" final="false" visibility="public"
  7229. deprecated="not deprecated">
  7230. <param name="containerIdStr" type="java.lang.String"/>
  7231. </method>
  7232. <method name="build"
  7233. abstract="true" native="false" synchronized="false"
  7234. static="false" final="false" visibility="protected"
  7235. deprecated="not deprecated">
  7236. </method>
  7237. <field name="CONTAINER_ID_BITMASK" type="long"
  7238. transient="false" volatile="false"
  7239. static="true" final="true" visibility="public"
  7240. deprecated="not deprecated">
  7241. </field>
  7242. <doc>
  7243. <![CDATA[<p><code>ContainerId</code> represents a globally unique identifier
  7244. for a {@link Container} in the cluster.</p>]]>
  7245. </doc>
  7246. </class>
  7247. <!-- end class org.apache.hadoop.yarn.api.records.ContainerId -->
  7248. <!-- start class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
  7249. <class name="ContainerLaunchContext" extends="java.lang.Object"
  7250. abstract="true"
  7251. static="false" final="false" visibility="public"
  7252. deprecated="not deprecated">
  7253. <constructor name="ContainerLaunchContext"
  7254. static="false" final="false" visibility="public"
  7255. deprecated="not deprecated">
  7256. </constructor>
  7257. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  7258. abstract="false" native="false" synchronized="false"
  7259. static="true" final="false" visibility="public"
  7260. deprecated="not deprecated">
  7261. <param name="localResources" type="java.util.Map"/>
  7262. <param name="environment" type="java.util.Map"/>
  7263. <param name="commands" type="java.util.List"/>
  7264. <param name="serviceData" type="java.util.Map"/>
  7265. <param name="tokens" type="java.nio.ByteBuffer"/>
  7266. <param name="acls" type="java.util.Map"/>
  7267. </method>
  7268. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  7269. abstract="false" native="false" synchronized="false"
  7270. static="true" final="false" visibility="public"
  7271. deprecated="not deprecated">
  7272. <param name="localResources" type="java.util.Map"/>
  7273. <param name="environment" type="java.util.Map"/>
  7274. <param name="commands" type="java.util.List"/>
  7275. <param name="serviceData" type="java.util.Map"/>
  7276. <param name="tokens" type="java.nio.ByteBuffer"/>
  7277. <param name="acls" type="java.util.Map"/>
  7278. <param name="containerRetryContext" type="org.apache.hadoop.yarn.api.records.ContainerRetryContext"/>
  7279. </method>
  7280. <method name="getTokens" return="java.nio.ByteBuffer"
  7281. abstract="true" native="false" synchronized="false"
  7282. static="false" final="false" visibility="public"
  7283. deprecated="not deprecated">
  7284. <doc>
  7285. <![CDATA[Get all the tokens needed by this container. It may include file-system
  7286. tokens, ApplicationMaster related tokens if this container is an
  7287. ApplicationMaster or framework level tokens needed by this container to
  7288. communicate to various services in a secure manner.
  7289. @return tokens needed by this container.]]>
  7290. </doc>
  7291. </method>
  7292. <method name="setTokens"
  7293. abstract="true" native="false" synchronized="false"
  7294. static="false" final="false" visibility="public"
  7295. deprecated="not deprecated">
  7296. <param name="tokens" type="java.nio.ByteBuffer"/>
  7297. <doc>
  7298. <![CDATA[Set security tokens needed by this container.
  7299. @param tokens security tokens]]>
  7300. </doc>
  7301. </method>
  7302. <method name="getTokensConf" return="java.nio.ByteBuffer"
  7303. abstract="true" native="false" synchronized="false"
  7304. static="false" final="false" visibility="public"
  7305. deprecated="not deprecated">
  7306. <doc>
  7307. <![CDATA[Get the configuration used by RM to renew tokens.
  7308. @return The configuration used by RM to renew the tokens.]]>
  7309. </doc>
  7310. </method>
  7311. <method name="setTokensConf"
  7312. abstract="true" native="false" synchronized="false"
  7313. static="false" final="false" visibility="public"
  7314. deprecated="not deprecated">
  7315. <param name="tokensConf" type="java.nio.ByteBuffer"/>
  7316. <doc>
  7317. <![CDATA[Set the configuration used by RM to renew the tokens.
  7318. @param tokensConf The configuration used by RM to renew the tokens]]>
  7319. </doc>
  7320. </method>
  7321. <method name="getLocalResources" return="java.util.Map"
  7322. abstract="true" native="false" synchronized="false"
  7323. static="false" final="false" visibility="public"
  7324. deprecated="not deprecated">
  7325. <doc>
  7326. <![CDATA[Get <code>LocalResource</code> required by the container.
  7327. @return all <code>LocalResource</code> required by the container]]>
  7328. </doc>
  7329. </method>
  7330. <method name="setLocalResources"
  7331. abstract="true" native="false" synchronized="false"
  7332. static="false" final="false" visibility="public"
  7333. deprecated="not deprecated">
  7334. <param name="localResources" type="java.util.Map"/>
  7335. <doc>
  7336. <![CDATA[Set <code>LocalResource</code> required by the container. All pre-existing
  7337. Map entries are cleared before adding the new Map
  7338. @param localResources <code>LocalResource</code> required by the container]]>
  7339. </doc>
  7340. </method>
  7341. <method name="getServiceData" return="java.util.Map"
  7342. abstract="true" native="false" synchronized="false"
  7343. static="false" final="false" visibility="public"
  7344. deprecated="not deprecated">
  7345. <doc>
  7346. <![CDATA[<p>
  7347. Get application-specific binary <em>service data</em>. This is a map keyed
  7348. by the name of each {@link AuxiliaryService} that is configured on a
  7349. NodeManager and value correspond to the application specific data targeted
  7350. for the keyed {@link AuxiliaryService}.
  7351. </p>
  7352. <p>
  7353. This will be used to initialize this application on the specific
  7354. {@link AuxiliaryService} running on the NodeManager by calling
  7355. {@link AuxiliaryService#initializeApplication(ApplicationInitializationContext)}
  7356. </p>
  7357. @return application-specific binary <em>service data</em>]]>
  7358. </doc>
  7359. </method>
  7360. <method name="setServiceData"
  7361. abstract="true" native="false" synchronized="false"
  7362. static="false" final="false" visibility="public"
  7363. deprecated="not deprecated">
  7364. <param name="serviceData" type="java.util.Map"/>
  7365. <doc>
  7366. <![CDATA[<p>
  7367. Set application-specific binary <em>service data</em>. This is a map keyed
  7368. by the name of each {@link AuxiliaryService} that is configured on a
  7369. NodeManager and value correspond to the application specific data targeted
  7370. for the keyed {@link AuxiliaryService}. All pre-existing Map entries are
  7371. preserved.
  7372. </p>
  7373. @param serviceData
  7374. application-specific binary <em>service data</em>]]>
  7375. </doc>
  7376. </method>
  7377. <method name="getEnvironment" return="java.util.Map"
  7378. abstract="true" native="false" synchronized="false"
  7379. static="false" final="false" visibility="public"
  7380. deprecated="not deprecated">
  7381. <doc>
  7382. <![CDATA[Get <em>environment variables</em> for the container.
  7383. @return <em>environment variables</em> for the container]]>
  7384. </doc>
  7385. </method>
  7386. <method name="setEnvironment"
  7387. abstract="true" native="false" synchronized="false"
  7388. static="false" final="false" visibility="public"
  7389. deprecated="not deprecated">
  7390. <param name="environment" type="java.util.Map"/>
  7391. <doc>
  7392. <![CDATA[Add <em>environment variables</em> for the container. All pre-existing Map
  7393. entries are cleared before adding the new Map
  7394. @param environment <em>environment variables</em> for the container]]>
  7395. </doc>
  7396. </method>
  7397. <method name="getCommands" return="java.util.List"
  7398. abstract="true" native="false" synchronized="false"
  7399. static="false" final="false" visibility="public"
  7400. deprecated="not deprecated">
  7401. <doc>
  7402. <![CDATA[Get the list of <em>commands</em> for launching the container.
  7403. @return the list of <em>commands</em> for launching the container]]>
  7404. </doc>
  7405. </method>
  7406. <method name="setCommands"
  7407. abstract="true" native="false" synchronized="false"
  7408. static="false" final="false" visibility="public"
  7409. deprecated="not deprecated">
  7410. <param name="commands" type="java.util.List"/>
  7411. <doc>
  7412. <![CDATA[Add the list of <em>commands</em> for launching the container. All
  7413. pre-existing List entries are cleared before adding the new List
  7414. @param commands the list of <em>commands</em> for launching the container]]>
  7415. </doc>
  7416. </method>
  7417. <method name="getApplicationACLs" return="java.util.Map"
  7418. abstract="true" native="false" synchronized="false"
  7419. static="false" final="false" visibility="public"
  7420. deprecated="not deprecated">
  7421. <doc>
  7422. <![CDATA[Get the <code>ApplicationACL</code>s for the application.
  7423. @return all the <code>ApplicationACL</code>s]]>
  7424. </doc>
  7425. </method>
  7426. <method name="setApplicationACLs"
  7427. abstract="true" native="false" synchronized="false"
  7428. static="false" final="false" visibility="public"
  7429. deprecated="not deprecated">
  7430. <param name="acls" type="java.util.Map"/>
  7431. <doc>
  7432. <![CDATA[Set the <code>ApplicationACL</code>s for the application. All pre-existing
  7433. Map entries are cleared before adding the new Map
  7434. @param acls <code>ApplicationACL</code>s for the application]]>
  7435. </doc>
  7436. </method>
  7437. <method name="getContainerRetryContext" return="org.apache.hadoop.yarn.api.records.ContainerRetryContext"
  7438. abstract="true" native="false" synchronized="false"
  7439. static="false" final="false" visibility="public"
  7440. deprecated="not deprecated">
  7441. <doc>
  7442. <![CDATA[Get the <code>ContainerRetryContext</code> to relaunch container.
  7443. @return <code>ContainerRetryContext</code> to relaunch container.]]>
  7444. </doc>
  7445. </method>
  7446. <method name="setContainerRetryContext"
  7447. abstract="true" native="false" synchronized="false"
  7448. static="false" final="false" visibility="public"
  7449. deprecated="not deprecated">
  7450. <param name="containerRetryContext" type="org.apache.hadoop.yarn.api.records.ContainerRetryContext"/>
  7451. <doc>
  7452. <![CDATA[Set the <code>ContainerRetryContext</code> to relaunch container.
  7453. @param containerRetryContext <code>ContainerRetryContext</code> to
  7454. relaunch container.]]>
  7455. </doc>
  7456. </method>
  7457. <doc>
  7458. <![CDATA[{@code ContainerLaunchContext} represents all of the information
  7459. needed by the {@code NodeManager} to launch a container.
  7460. <p>
  7461. It includes details such as:
  7462. <ul>
  7463. <li>{@link ContainerId} of the container.</li>
  7464. <li>{@link Resource} allocated to the container.</li>
  7465. <li>User to whom the container is allocated.</li>
  7466. <li>Security tokens (if security is enabled).</li>
  7467. <li>
  7468. {@link LocalResource} necessary for running the container such
  7469. as binaries, jar, shared-objects, side-files etc.
  7470. </li>
  7471. <li>Optional, application-specific binary service data.</li>
  7472. <li>Environment variables for the launched process.</li>
  7473. <li>Command to launch the container.</li>
  7474. <li>Retry strategy when container exits with failure.</li>
  7475. </ul>
  7476. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  7477. </doc>
  7478. </class>
  7479. <!-- end class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
  7480. <!-- start class org.apache.hadoop.yarn.api.records.ContainerReport -->
  7481. <class name="ContainerReport" extends="java.lang.Object"
  7482. abstract="true"
  7483. static="false" final="false" visibility="public"
  7484. deprecated="not deprecated">
  7485. <constructor name="ContainerReport"
  7486. static="false" final="false" visibility="public"
  7487. deprecated="not deprecated">
  7488. </constructor>
  7489. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  7490. abstract="true" native="false" synchronized="false"
  7491. static="false" final="false" visibility="public"
  7492. deprecated="not deprecated">
  7493. <doc>
  7494. <![CDATA[Get the <code>ContainerId</code> of the container.
  7495. @return <code>ContainerId</code> of the container.]]>
  7496. </doc>
  7497. </method>
  7498. <method name="setContainerId"
  7499. abstract="true" native="false" synchronized="false"
  7500. static="false" final="false" visibility="public"
  7501. deprecated="not deprecated">
  7502. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  7503. </method>
  7504. <method name="getAllocatedResource" return="org.apache.hadoop.yarn.api.records.Resource"
  7505. abstract="true" native="false" synchronized="false"
  7506. static="false" final="false" visibility="public"
  7507. deprecated="not deprecated">
  7508. <doc>
  7509. <![CDATA[Get the allocated <code>Resource</code> of the container.
  7510. @return allocated <code>Resource</code> of the container.]]>
  7511. </doc>
  7512. </method>
  7513. <method name="setAllocatedResource"
  7514. abstract="true" native="false" synchronized="false"
  7515. static="false" final="false" visibility="public"
  7516. deprecated="not deprecated">
  7517. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7518. </method>
  7519. <method name="getAssignedNode" return="org.apache.hadoop.yarn.api.records.NodeId"
  7520. abstract="true" native="false" synchronized="false"
  7521. static="false" final="false" visibility="public"
  7522. deprecated="not deprecated">
  7523. <doc>
  7524. <![CDATA[Get the allocated <code>NodeId</code> where container is running.
  7525. @return allocated <code>NodeId</code> where container is running.]]>
  7526. </doc>
  7527. </method>
  7528. <method name="setAssignedNode"
  7529. abstract="true" native="false" synchronized="false"
  7530. static="false" final="false" visibility="public"
  7531. deprecated="not deprecated">
  7532. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  7533. </method>
  7534. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  7535. abstract="true" native="false" synchronized="false"
  7536. static="false" final="false" visibility="public"
  7537. deprecated="not deprecated">
  7538. <doc>
  7539. <![CDATA[Get the allocated <code>Priority</code> of the container.
  7540. @return allocated <code>Priority</code> of the container.]]>
  7541. </doc>
  7542. </method>
  7543. <method name="setPriority"
  7544. abstract="true" native="false" synchronized="false"
  7545. static="false" final="false" visibility="public"
  7546. deprecated="not deprecated">
  7547. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  7548. </method>
  7549. <method name="getCreationTime" return="long"
  7550. abstract="true" native="false" synchronized="false"
  7551. static="false" final="false" visibility="public"
  7552. deprecated="not deprecated">
  7553. <doc>
  7554. <![CDATA[Get the creation time of the container.
  7555. @return creation time of the container]]>
  7556. </doc>
  7557. </method>
  7558. <method name="setCreationTime"
  7559. abstract="true" native="false" synchronized="false"
  7560. static="false" final="false" visibility="public"
  7561. deprecated="not deprecated">
  7562. <param name="creationTime" type="long"/>
  7563. </method>
  7564. <method name="getFinishTime" return="long"
  7565. abstract="true" native="false" synchronized="false"
  7566. static="false" final="false" visibility="public"
  7567. deprecated="not deprecated">
  7568. <doc>
  7569. <![CDATA[Get the Finish time of the container.
  7570. @return Finish time of the container]]>
  7571. </doc>
  7572. </method>
  7573. <method name="setFinishTime"
  7574. abstract="true" native="false" synchronized="false"
  7575. static="false" final="false" visibility="public"
  7576. deprecated="not deprecated">
  7577. <param name="finishTime" type="long"/>
  7578. </method>
  7579. <method name="getDiagnosticsInfo" return="java.lang.String"
  7580. abstract="true" native="false" synchronized="false"
  7581. static="false" final="false" visibility="public"
  7582. deprecated="not deprecated">
  7583. <doc>
  7584. <![CDATA[Get the DiagnosticsInfo of the container.
  7585. @return DiagnosticsInfo of the container]]>
  7586. </doc>
  7587. </method>
  7588. <method name="setDiagnosticsInfo"
  7589. abstract="true" native="false" synchronized="false"
  7590. static="false" final="false" visibility="public"
  7591. deprecated="not deprecated">
  7592. <param name="diagnosticsInfo" type="java.lang.String"/>
  7593. </method>
  7594. <method name="getLogUrl" return="java.lang.String"
  7595. abstract="true" native="false" synchronized="false"
  7596. static="false" final="false" visibility="public"
  7597. deprecated="not deprecated">
  7598. <doc>
  7599. <![CDATA[Get the LogURL of the container.
  7600. @return LogURL of the container]]>
  7601. </doc>
  7602. </method>
  7603. <method name="setLogUrl"
  7604. abstract="true" native="false" synchronized="false"
  7605. static="false" final="false" visibility="public"
  7606. deprecated="not deprecated">
  7607. <param name="logUrl" type="java.lang.String"/>
  7608. </method>
  7609. <method name="getContainerState" return="org.apache.hadoop.yarn.api.records.ContainerState"
  7610. abstract="true" native="false" synchronized="false"
  7611. static="false" final="false" visibility="public"
  7612. deprecated="not deprecated">
  7613. <doc>
  7614. <![CDATA[Get the final <code>ContainerState</code> of the container.
  7615. @return final <code>ContainerState</code> of the container.]]>
  7616. </doc>
  7617. </method>
  7618. <method name="setContainerState"
  7619. abstract="true" native="false" synchronized="false"
  7620. static="false" final="false" visibility="public"
  7621. deprecated="not deprecated">
  7622. <param name="containerState" type="org.apache.hadoop.yarn.api.records.ContainerState"/>
  7623. </method>
  7624. <method name="getContainerExitStatus" return="int"
  7625. abstract="true" native="false" synchronized="false"
  7626. static="false" final="false" visibility="public"
  7627. deprecated="not deprecated">
  7628. <doc>
  7629. <![CDATA[Get the final <code>exit status</code> of the container.
  7630. @return final <code>exit status</code> of the container.]]>
  7631. </doc>
  7632. </method>
  7633. <method name="setContainerExitStatus"
  7634. abstract="true" native="false" synchronized="false"
  7635. static="false" final="false" visibility="public"
  7636. deprecated="not deprecated">
  7637. <param name="containerExitStatus" type="int"/>
  7638. </method>
  7639. <method name="getNodeHttpAddress" return="java.lang.String"
  7640. abstract="true" native="false" synchronized="false"
  7641. static="false" final="false" visibility="public"
  7642. deprecated="not deprecated">
  7643. <doc>
  7644. <![CDATA[Get the Node Http address of the container
  7645. @return the node http address of the container]]>
  7646. </doc>
  7647. </method>
  7648. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  7649. abstract="true" native="false" synchronized="false"
  7650. static="false" final="false" visibility="public"
  7651. deprecated="not deprecated">
  7652. <doc>
  7653. <![CDATA[Get the execution type of the container.
  7654. @return the execution type of the container]]>
  7655. </doc>
  7656. </method>
  7657. <doc>
  7658. <![CDATA[{@code ContainerReport} is a report of an container.
  7659. <p>
  7660. It includes details such as:
  7661. <ul>
  7662. <li>{@link ContainerId} of the container.</li>
  7663. <li>Allocated Resources to the container.</li>
  7664. <li>Assigned Node id.</li>
  7665. <li>Assigned Priority.</li>
  7666. <li>Creation Time.</li>
  7667. <li>Finish Time.</li>
  7668. <li>Container Exit Status.</li>
  7669. <li>{@link ContainerState} of the container.</li>
  7670. <li>Diagnostic information in case of errors.</li>
  7671. <li>Log URL.</li>
  7672. <li>nodeHttpAddress</li>
  7673. </ul>]]>
  7674. </doc>
  7675. </class>
  7676. <!-- end class org.apache.hadoop.yarn.api.records.ContainerReport -->
  7677. <!-- start class org.apache.hadoop.yarn.api.records.ContainerRetryContext -->
  7678. <class name="ContainerRetryContext" extends="java.lang.Object"
  7679. abstract="true"
  7680. static="false" final="false" visibility="public"
  7681. deprecated="not deprecated">
  7682. <constructor name="ContainerRetryContext"
  7683. static="false" final="false" visibility="public"
  7684. deprecated="not deprecated">
  7685. </constructor>
  7686. <method name="getRetryPolicy" return="org.apache.hadoop.yarn.api.records.ContainerRetryPolicy"
  7687. abstract="true" native="false" synchronized="false"
  7688. static="false" final="false" visibility="public"
  7689. deprecated="not deprecated">
  7690. </method>
  7691. <method name="setRetryPolicy"
  7692. abstract="true" native="false" synchronized="false"
  7693. static="false" final="false" visibility="public"
  7694. deprecated="not deprecated">
  7695. <param name="retryPolicy" type="org.apache.hadoop.yarn.api.records.ContainerRetryPolicy"/>
  7696. </method>
  7697. <method name="getErrorCodes" return="java.util.Set"
  7698. abstract="true" native="false" synchronized="false"
  7699. static="false" final="false" visibility="public"
  7700. deprecated="not deprecated">
  7701. </method>
  7702. <method name="setErrorCodes"
  7703. abstract="true" native="false" synchronized="false"
  7704. static="false" final="false" visibility="public"
  7705. deprecated="not deprecated">
  7706. <param name="errorCodes" type="java.util.Set"/>
  7707. </method>
  7708. <method name="getMaxRetries" return="int"
  7709. abstract="true" native="false" synchronized="false"
  7710. static="false" final="false" visibility="public"
  7711. deprecated="not deprecated">
  7712. </method>
  7713. <method name="setMaxRetries"
  7714. abstract="true" native="false" synchronized="false"
  7715. static="false" final="false" visibility="public"
  7716. deprecated="not deprecated">
  7717. <param name="maxRetries" type="int"/>
  7718. </method>
  7719. <method name="getRetryInterval" return="int"
  7720. abstract="true" native="false" synchronized="false"
  7721. static="false" final="false" visibility="public"
  7722. deprecated="not deprecated">
  7723. </method>
  7724. <method name="setRetryInterval"
  7725. abstract="true" native="false" synchronized="false"
  7726. static="false" final="false" visibility="public"
  7727. deprecated="not deprecated">
  7728. <param name="retryInterval" type="int"/>
  7729. </method>
  7730. <field name="RETRY_FOREVER" type="int"
  7731. transient="false" volatile="false"
  7732. static="true" final="true" visibility="public"
  7733. deprecated="not deprecated">
  7734. </field>
  7735. <field name="RETRY_INVALID" type="int"
  7736. transient="false" volatile="false"
  7737. static="true" final="true" visibility="public"
  7738. deprecated="not deprecated">
  7739. </field>
  7740. <field name="NEVER_RETRY_CONTEXT" type="org.apache.hadoop.yarn.api.records.ContainerRetryContext"
  7741. transient="false" volatile="false"
  7742. static="true" final="true" visibility="public"
  7743. deprecated="not deprecated">
  7744. </field>
  7745. <doc>
  7746. <![CDATA[{@code ContainerRetryContext} indicates how container retry after it fails
  7747. to run.
  7748. <p>
  7749. It provides details such as:
  7750. <ul>
  7751. <li>
  7752. {@link ContainerRetryPolicy} :
  7753. - NEVER_RETRY(DEFAULT value): no matter what error code is when container
  7754. fails to run, just do not retry.
  7755. - RETRY_ON_ALL_ERRORS: no matter what error code is, when container fails
  7756. to run, just retry.
  7757. - RETRY_ON_SPECIFIC_ERROR_CODES: when container fails to run, do retry if
  7758. the error code is one of <em>errorCodes</em>, otherwise do not retry.
  7759. Note: if error code is 137(SIGKILL) or 143(SIGTERM), it will not retry
  7760. because it is usually killed on purpose.
  7761. </li>
  7762. <li>
  7763. <em>maxRetries</em> specifies how many times to retry if need to retry.
  7764. If the value is -1, it means retry forever.
  7765. </li>
  7766. <li><em>retryInterval</em> specifies delaying some time before relaunch
  7767. container, the unit is millisecond.</li>
  7768. </ul>]]>
  7769. </doc>
  7770. </class>
  7771. <!-- end class org.apache.hadoop.yarn.api.records.ContainerRetryContext -->
  7772. <!-- start class org.apache.hadoop.yarn.api.records.ContainerRetryPolicy -->
  7773. <class name="ContainerRetryPolicy" extends="java.lang.Enum"
  7774. abstract="false"
  7775. static="false" final="true" visibility="public"
  7776. deprecated="not deprecated">
  7777. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerRetryPolicy[]"
  7778. abstract="false" native="false" synchronized="false"
  7779. static="true" final="false" visibility="public"
  7780. deprecated="not deprecated">
  7781. </method>
  7782. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerRetryPolicy"
  7783. abstract="false" native="false" synchronized="false"
  7784. static="true" final="false" visibility="public"
  7785. deprecated="not deprecated">
  7786. <param name="name" type="java.lang.String"/>
  7787. </method>
  7788. <doc>
  7789. <![CDATA[<p>Retry policy for relaunching a <code>Container</code>.</p>]]>
  7790. </doc>
  7791. </class>
  7792. <!-- end class org.apache.hadoop.yarn.api.records.ContainerRetryPolicy -->
  7793. <!-- start class org.apache.hadoop.yarn.api.records.ContainerState -->
  7794. <class name="ContainerState" extends="java.lang.Enum"
  7795. abstract="false"
  7796. static="false" final="true" visibility="public"
  7797. deprecated="not deprecated">
  7798. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerState[]"
  7799. abstract="false" native="false" synchronized="false"
  7800. static="true" final="false" visibility="public"
  7801. deprecated="not deprecated">
  7802. </method>
  7803. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerState"
  7804. abstract="false" native="false" synchronized="false"
  7805. static="true" final="false" visibility="public"
  7806. deprecated="not deprecated">
  7807. <param name="name" type="java.lang.String"/>
  7808. </method>
  7809. <doc>
  7810. <![CDATA[<p>State of a <code>Container</code>.</p>]]>
  7811. </doc>
  7812. </class>
  7813. <!-- end class org.apache.hadoop.yarn.api.records.ContainerState -->
  7814. <!-- start class org.apache.hadoop.yarn.api.records.ContainerStatus -->
  7815. <class name="ContainerStatus" extends="java.lang.Object"
  7816. abstract="true"
  7817. static="false" final="false" visibility="public"
  7818. deprecated="not deprecated">
  7819. <constructor name="ContainerStatus"
  7820. static="false" final="false" visibility="public"
  7821. deprecated="not deprecated">
  7822. </constructor>
  7823. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  7824. abstract="true" native="false" synchronized="false"
  7825. static="false" final="false" visibility="public"
  7826. deprecated="not deprecated">
  7827. <doc>
  7828. <![CDATA[Get the <code>ContainerId</code> of the container.
  7829. @return <code>ContainerId</code> of the container]]>
  7830. </doc>
  7831. </method>
  7832. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  7833. abstract="false" native="false" synchronized="false"
  7834. static="false" final="false" visibility="public"
  7835. deprecated="not deprecated">
  7836. <doc>
  7837. <![CDATA[Get the <code>ExecutionType</code> of the container.
  7838. @return <code>ExecutionType</code> of the container]]>
  7839. </doc>
  7840. </method>
  7841. <method name="getState" return="org.apache.hadoop.yarn.api.records.ContainerState"
  7842. abstract="true" native="false" synchronized="false"
  7843. static="false" final="false" visibility="public"
  7844. deprecated="not deprecated">
  7845. <doc>
  7846. <![CDATA[Get the <code>ContainerState</code> of the container.
  7847. @return <code>ContainerState</code> of the container]]>
  7848. </doc>
  7849. </method>
  7850. <method name="getExitStatus" return="int"
  7851. abstract="true" native="false" synchronized="false"
  7852. static="false" final="false" visibility="public"
  7853. deprecated="not deprecated">
  7854. <doc>
  7855. <![CDATA[<p>Get the <em>exit status</em> for the container.</p>
  7856. <p>Note: This is valid only for completed containers i.e. containers
  7857. with state {@link ContainerState#COMPLETE}.
  7858. Otherwise, it returns an ContainerExitStatus.INVALID.
  7859. </p>
  7860. <p>Containers killed by the framework, either due to being released by
  7861. the application or being 'lost' due to node failures etc. have a special
  7862. exit code of ContainerExitStatus.ABORTED.</p>
  7863. <p>When threshold number of the nodemanager-local-directories or
  7864. threshold number of the nodemanager-log-directories become bad, then
  7865. container is not launched and is exited with ContainersExitStatus.DISKS_FAILED.
  7866. </p>
  7867. @return <em>exit status</em> for the container]]>
  7868. </doc>
  7869. </method>
  7870. <method name="getDiagnostics" return="java.lang.String"
  7871. abstract="true" native="false" synchronized="false"
  7872. static="false" final="false" visibility="public"
  7873. deprecated="not deprecated">
  7874. <doc>
  7875. <![CDATA[Get <em>diagnostic messages</em> for failed containers.
  7876. @return <em>diagnostic messages</em> for failed containers]]>
  7877. </doc>
  7878. </method>
  7879. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  7880. abstract="false" native="false" synchronized="false"
  7881. static="false" final="false" visibility="public"
  7882. deprecated="not deprecated">
  7883. <doc>
  7884. <![CDATA[Get the <code>Resource</code> allocated to the container.
  7885. @return <code>Resource</code> allocated to the container]]>
  7886. </doc>
  7887. </method>
  7888. <method name="getIPs" return="java.util.List"
  7889. abstract="false" native="false" synchronized="false"
  7890. static="false" final="false" visibility="public"
  7891. deprecated="not deprecated">
  7892. <doc>
  7893. <![CDATA[Get all the IP addresses with which the container run.
  7894. @return The IP address where the container runs.]]>
  7895. </doc>
  7896. </method>
  7897. <method name="getHost" return="java.lang.String"
  7898. abstract="false" native="false" synchronized="false"
  7899. static="false" final="false" visibility="public"
  7900. deprecated="not deprecated">
  7901. <doc>
  7902. <![CDATA[Get the hostname where the container runs.
  7903. @return The hostname where the container runs.]]>
  7904. </doc>
  7905. </method>
  7906. <doc>
  7907. <![CDATA[{@code ContainerStatus} represents the current status of a
  7908. {@code Container}.
  7909. <p>
  7910. It provides details such as:
  7911. <ul>
  7912. <li>{@code ContainerId} of the container.</li>
  7913. <li>{@code ExecutionType} of the container.</li>
  7914. <li>{@code ContainerState} of the container.</li>
  7915. <li><em>Exit status</em> of a completed container.</li>
  7916. <li><em>Diagnostic</em> message for a failed container.</li>
  7917. <li>{@link Resource} allocated to the container.</li>
  7918. </ul>]]>
  7919. </doc>
  7920. </class>
  7921. <!-- end class org.apache.hadoop.yarn.api.records.ContainerStatus -->
  7922. <!-- start class org.apache.hadoop.yarn.api.records.ContainerSubState -->
  7923. <class name="ContainerSubState" extends="java.lang.Enum"
  7924. abstract="false"
  7925. static="false" final="true" visibility="public"
  7926. deprecated="not deprecated">
  7927. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerSubState[]"
  7928. abstract="false" native="false" synchronized="false"
  7929. static="true" final="false" visibility="public"
  7930. deprecated="not deprecated">
  7931. </method>
  7932. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerSubState"
  7933. abstract="false" native="false" synchronized="false"
  7934. static="true" final="false" visibility="public"
  7935. deprecated="not deprecated">
  7936. <param name="name" type="java.lang.String"/>
  7937. </method>
  7938. <doc>
  7939. <![CDATA[Container Sub-State.]]>
  7940. </doc>
  7941. </class>
  7942. <!-- end class org.apache.hadoop.yarn.api.records.ContainerSubState -->
  7943. <!-- start class org.apache.hadoop.yarn.api.records.ContainerUpdateType -->
  7944. <class name="ContainerUpdateType" extends="java.lang.Enum"
  7945. abstract="false"
  7946. static="false" final="true" visibility="public"
  7947. deprecated="not deprecated">
  7948. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType[]"
  7949. abstract="false" native="false" synchronized="false"
  7950. static="true" final="false" visibility="public"
  7951. deprecated="not deprecated">
  7952. </method>
  7953. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType"
  7954. abstract="false" native="false" synchronized="false"
  7955. static="true" final="false" visibility="public"
  7956. deprecated="not deprecated">
  7957. <param name="name" type="java.lang.String"/>
  7958. </method>
  7959. <doc>
  7960. <![CDATA[Encodes the type of Container Update.]]>
  7961. </doc>
  7962. </class>
  7963. <!-- end class org.apache.hadoop.yarn.api.records.ContainerUpdateType -->
  7964. <!-- start class org.apache.hadoop.yarn.api.records.ExecutionType -->
  7965. <class name="ExecutionType" extends="java.lang.Enum"
  7966. abstract="false"
  7967. static="false" final="true" visibility="public"
  7968. deprecated="not deprecated">
  7969. <method name="values" return="org.apache.hadoop.yarn.api.records.ExecutionType[]"
  7970. abstract="false" native="false" synchronized="false"
  7971. static="true" final="false" visibility="public"
  7972. deprecated="not deprecated">
  7973. </method>
  7974. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  7975. abstract="false" native="false" synchronized="false"
  7976. static="true" final="false" visibility="public"
  7977. deprecated="not deprecated">
  7978. <param name="name" type="java.lang.String"/>
  7979. </method>
  7980. <doc>
  7981. <![CDATA[Container property encoding execution semantics.
  7982. <p>
  7983. The execution types are the following:
  7984. <ul>
  7985. <li>{@link #GUARANTEED} - this container is guaranteed to start its
  7986. execution, once the corresponding start container request is received by
  7987. an NM.
  7988. <li>{@link #OPPORTUNISTIC} - the execution of this container may not start
  7989. immediately at the NM that receives the corresponding start container
  7990. request (depending on the NM's available resources). Moreover, it may be
  7991. preempted if it blocks a GUARANTEED container from being executed.
  7992. </ul>]]>
  7993. </doc>
  7994. </class>
  7995. <!-- end class org.apache.hadoop.yarn.api.records.ExecutionType -->
  7996. <!-- start class org.apache.hadoop.yarn.api.records.ExecutionTypeRequest -->
  7997. <class name="ExecutionTypeRequest" extends="java.lang.Object"
  7998. abstract="true"
  7999. static="false" final="false" visibility="public"
  8000. deprecated="not deprecated">
  8001. <implements name="java.lang.Comparable"/>
  8002. <constructor name="ExecutionTypeRequest"
  8003. static="false" final="false" visibility="public"
  8004. deprecated="not deprecated">
  8005. </constructor>
  8006. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
  8007. abstract="false" native="false" synchronized="false"
  8008. static="true" final="false" visibility="public"
  8009. deprecated="not deprecated">
  8010. </method>
  8011. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
  8012. abstract="false" native="false" synchronized="false"
  8013. static="true" final="false" visibility="public"
  8014. deprecated="not deprecated">
  8015. <param name="execType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  8016. </method>
  8017. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
  8018. abstract="false" native="false" synchronized="false"
  8019. static="true" final="false" visibility="public"
  8020. deprecated="not deprecated">
  8021. <param name="execType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  8022. <param name="ensureExecutionType" type="boolean"/>
  8023. </method>
  8024. <method name="setExecutionType"
  8025. abstract="true" native="false" synchronized="false"
  8026. static="false" final="false" visibility="public"
  8027. deprecated="not deprecated">
  8028. <param name="execType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  8029. <doc>
  8030. <![CDATA[Set the <code>ExecutionType</code> of the requested container.
  8031. @param execType
  8032. ExecutionType of the requested container]]>
  8033. </doc>
  8034. </method>
  8035. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  8036. abstract="true" native="false" synchronized="false"
  8037. static="false" final="false" visibility="public"
  8038. deprecated="not deprecated">
  8039. <doc>
  8040. <![CDATA[Get <code>ExecutionType</code>.
  8041. @return <code>ExecutionType</code>.]]>
  8042. </doc>
  8043. </method>
  8044. <method name="setEnforceExecutionType"
  8045. abstract="true" native="false" synchronized="false"
  8046. static="false" final="false" visibility="public"
  8047. deprecated="not deprecated">
  8048. <param name="enforceExecutionType" type="boolean"/>
  8049. <doc>
  8050. <![CDATA[Set to true to explicitly ask that the Scheduling Authority return
  8051. Containers of exactly the Execution Type requested.
  8052. @param enforceExecutionType whether ExecutionType request should be
  8053. strictly honored.]]>
  8054. </doc>
  8055. </method>
  8056. <method name="getEnforceExecutionType" return="boolean"
  8057. abstract="true" native="false" synchronized="false"
  8058. static="false" final="false" visibility="public"
  8059. deprecated="not deprecated">
  8060. <doc>
  8061. <![CDATA[Get whether Scheduling Authority should return Containers of exactly the
  8062. Execution Type requested for this <code>ResourceRequest</code>.
  8063. Defaults to false.
  8064. @return whether ExecutionType request should be strictly honored]]>
  8065. </doc>
  8066. </method>
  8067. <method name="hashCode" return="int"
  8068. abstract="false" native="false" synchronized="false"
  8069. static="false" final="false" visibility="public"
  8070. deprecated="not deprecated">
  8071. </method>
  8072. <method name="equals" return="boolean"
  8073. abstract="false" native="false" synchronized="false"
  8074. static="false" final="false" visibility="public"
  8075. deprecated="not deprecated">
  8076. <param name="obj" type="java.lang.Object"/>
  8077. </method>
  8078. <doc>
  8079. <![CDATA[An object of this class represents a specification of the execution
  8080. guarantee of the Containers associated with a ResourceRequest. It consists
  8081. of an <code>ExecutionType</code> as well as flag that explicitly asks the
  8082. configuredScheduler to return Containers of exactly the Execution Type
  8083. requested.]]>
  8084. </doc>
  8085. </class>
  8086. <!-- end class org.apache.hadoop.yarn.api.records.ExecutionTypeRequest -->
  8087. <!-- start class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
  8088. <class name="FinalApplicationStatus" extends="java.lang.Enum"
  8089. abstract="false"
  8090. static="false" final="true" visibility="public"
  8091. deprecated="not deprecated">
  8092. <method name="values" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus[]"
  8093. abstract="false" native="false" synchronized="false"
  8094. static="true" final="false" visibility="public"
  8095. deprecated="not deprecated">
  8096. </method>
  8097. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  8098. abstract="false" native="false" synchronized="false"
  8099. static="true" final="false" visibility="public"
  8100. deprecated="not deprecated">
  8101. <param name="name" type="java.lang.String"/>
  8102. </method>
  8103. <doc>
  8104. <![CDATA[Enumeration of various final states of an <code>Application</code>.]]>
  8105. </doc>
  8106. </class>
  8107. <!-- end class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
  8108. <!-- start class org.apache.hadoop.yarn.api.records.LocalResource -->
  8109. <class name="LocalResource" extends="java.lang.Object"
  8110. abstract="true"
  8111. static="false" final="false" visibility="public"
  8112. deprecated="not deprecated">
  8113. <constructor name="LocalResource"
  8114. static="false" final="false" visibility="public"
  8115. deprecated="not deprecated">
  8116. </constructor>
  8117. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  8118. abstract="false" native="false" synchronized="false"
  8119. static="true" final="false" visibility="public"
  8120. deprecated="not deprecated">
  8121. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  8122. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  8123. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  8124. <param name="size" type="long"/>
  8125. <param name="timestamp" type="long"/>
  8126. <param name="pattern" type="java.lang.String"/>
  8127. </method>
  8128. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  8129. abstract="false" native="false" synchronized="false"
  8130. static="true" final="false" visibility="public"
  8131. deprecated="not deprecated">
  8132. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  8133. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  8134. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  8135. <param name="size" type="long"/>
  8136. <param name="timestamp" type="long"/>
  8137. <param name="pattern" type="java.lang.String"/>
  8138. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  8139. </method>
  8140. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  8141. abstract="false" native="false" synchronized="false"
  8142. static="true" final="false" visibility="public"
  8143. deprecated="not deprecated">
  8144. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  8145. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  8146. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  8147. <param name="size" type="long"/>
  8148. <param name="timestamp" type="long"/>
  8149. </method>
  8150. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  8151. abstract="false" native="false" synchronized="false"
  8152. static="true" final="false" visibility="public"
  8153. deprecated="not deprecated">
  8154. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  8155. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  8156. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  8157. <param name="size" type="long"/>
  8158. <param name="timestamp" type="long"/>
  8159. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  8160. </method>
  8161. <method name="getResource" return="org.apache.hadoop.yarn.api.records.URL"
  8162. abstract="true" native="false" synchronized="false"
  8163. static="false" final="false" visibility="public"
  8164. deprecated="not deprecated">
  8165. <doc>
  8166. <![CDATA[Get the <em>location</em> of the resource to be localized.
  8167. @return <em>location</em> of the resource to be localized]]>
  8168. </doc>
  8169. </method>
  8170. <method name="setResource"
  8171. abstract="true" native="false" synchronized="false"
  8172. static="false" final="false" visibility="public"
  8173. deprecated="not deprecated">
  8174. <param name="resource" type="org.apache.hadoop.yarn.api.records.URL"/>
  8175. <doc>
  8176. <![CDATA[Set <em>location</em> of the resource to be localized.
  8177. @param resource <em>location</em> of the resource to be localized]]>
  8178. </doc>
  8179. </method>
  8180. <method name="getSize" return="long"
  8181. abstract="true" native="false" synchronized="false"
  8182. static="false" final="false" visibility="public"
  8183. deprecated="not deprecated">
  8184. <doc>
  8185. <![CDATA[Get the <em>size</em> of the resource to be localized.
  8186. @return <em>size</em> of the resource to be localized]]>
  8187. </doc>
  8188. </method>
  8189. <method name="setSize"
  8190. abstract="true" native="false" synchronized="false"
  8191. static="false" final="false" visibility="public"
  8192. deprecated="not deprecated">
  8193. <param name="size" type="long"/>
  8194. <doc>
  8195. <![CDATA[Set the <em>size</em> of the resource to be localized.
  8196. @param size <em>size</em> of the resource to be localized]]>
  8197. </doc>
  8198. </method>
  8199. <method name="getTimestamp" return="long"
  8200. abstract="true" native="false" synchronized="false"
  8201. static="false" final="false" visibility="public"
  8202. deprecated="not deprecated">
  8203. <doc>
  8204. <![CDATA[Get the original <em>timestamp</em> of the resource to be localized, used
  8205. for verification.
  8206. @return <em>timestamp</em> of the resource to be localized]]>
  8207. </doc>
  8208. </method>
  8209. <method name="setTimestamp"
  8210. abstract="true" native="false" synchronized="false"
  8211. static="false" final="false" visibility="public"
  8212. deprecated="not deprecated">
  8213. <param name="timestamp" type="long"/>
  8214. <doc>
  8215. <![CDATA[Set the <em>timestamp</em> of the resource to be localized, used
  8216. for verification.
  8217. @param timestamp <em>timestamp</em> of the resource to be localized]]>
  8218. </doc>
  8219. </method>
  8220. <method name="getType" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
  8221. abstract="true" native="false" synchronized="false"
  8222. static="false" final="false" visibility="public"
  8223. deprecated="not deprecated">
  8224. <doc>
  8225. <![CDATA[Get the <code>LocalResourceType</code> of the resource to be localized.
  8226. @return <code>LocalResourceType</code> of the resource to be localized]]>
  8227. </doc>
  8228. </method>
  8229. <method name="setType"
  8230. abstract="true" native="false" synchronized="false"
  8231. static="false" final="false" visibility="public"
  8232. deprecated="not deprecated">
  8233. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  8234. <doc>
  8235. <![CDATA[Set the <code>LocalResourceType</code> of the resource to be localized.
  8236. @param type <code>LocalResourceType</code> of the resource to be localized]]>
  8237. </doc>
  8238. </method>
  8239. <method name="getVisibility" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
  8240. abstract="true" native="false" synchronized="false"
  8241. static="false" final="false" visibility="public"
  8242. deprecated="not deprecated">
  8243. <doc>
  8244. <![CDATA[Get the <code>LocalResourceVisibility</code> of the resource to be
  8245. localized.
  8246. @return <code>LocalResourceVisibility</code> of the resource to be
  8247. localized]]>
  8248. </doc>
  8249. </method>
  8250. <method name="setVisibility"
  8251. abstract="true" native="false" synchronized="false"
  8252. static="false" final="false" visibility="public"
  8253. deprecated="not deprecated">
  8254. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  8255. <doc>
  8256. <![CDATA[Set the <code>LocalResourceVisibility</code> of the resource to be
  8257. localized.
  8258. @param visibility <code>LocalResourceVisibility</code> of the resource to be
  8259. localized]]>
  8260. </doc>
  8261. </method>
  8262. <method name="getPattern" return="java.lang.String"
  8263. abstract="true" native="false" synchronized="false"
  8264. static="false" final="false" visibility="public"
  8265. deprecated="not deprecated">
  8266. <doc>
  8267. <![CDATA[Get the <em>pattern</em> that should be used to extract entries from the
  8268. archive (only used when type is <code>PATTERN</code>).
  8269. @return <em>pattern</em> that should be used to extract entries from the
  8270. archive.]]>
  8271. </doc>
  8272. </method>
  8273. <method name="setPattern"
  8274. abstract="true" native="false" synchronized="false"
  8275. static="false" final="false" visibility="public"
  8276. deprecated="not deprecated">
  8277. <param name="pattern" type="java.lang.String"/>
  8278. <doc>
  8279. <![CDATA[Set the <em>pattern</em> that should be used to extract entries from the
  8280. archive (only used when type is <code>PATTERN</code>).
  8281. @param pattern <em>pattern</em> that should be used to extract entries
  8282. from the archive.]]>
  8283. </doc>
  8284. </method>
  8285. <method name="getShouldBeUploadedToSharedCache" return="boolean"
  8286. abstract="true" native="false" synchronized="false"
  8287. static="false" final="false" visibility="public"
  8288. deprecated="not deprecated">
  8289. <doc>
  8290. <![CDATA[NM uses it to decide whether if it is necessary to upload the resource to
  8291. the shared cache
  8292. @return true if it is necessary to upload the resource
  8293. to the shared cache,
  8294. false otherwise]]>
  8295. </doc>
  8296. </method>
  8297. <method name="setShouldBeUploadedToSharedCache"
  8298. abstract="true" native="false" synchronized="false"
  8299. static="false" final="false" visibility="public"
  8300. deprecated="not deprecated">
  8301. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  8302. <doc>
  8303. <![CDATA[Inform NM whether upload to SCM is needed.
  8304. @param shouldBeUploadedToSharedCache <em>shouldBeUploadedToSharedCache</em>
  8305. of this request]]>
  8306. </doc>
  8307. </method>
  8308. <doc>
  8309. <![CDATA[<p><code>LocalResource</code> represents a local resource required to
  8310. run a container.</p>
  8311. <p>The <code>NodeManager</code> is responsible for localizing the resource
  8312. prior to launching the container.</p>
  8313. <p>Applications can specify {@link LocalResourceType} and
  8314. {@link LocalResourceVisibility}.</p>
  8315. @see LocalResourceType
  8316. @see LocalResourceVisibility
  8317. @see ContainerLaunchContext
  8318. @see ApplicationSubmissionContext
  8319. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  8320. </doc>
  8321. </class>
  8322. <!-- end class org.apache.hadoop.yarn.api.records.LocalResource -->
  8323. <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceType -->
  8324. <class name="LocalResourceType" extends="java.lang.Enum"
  8325. abstract="false"
  8326. static="false" final="true" visibility="public"
  8327. deprecated="not deprecated">
  8328. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceType[]"
  8329. abstract="false" native="false" synchronized="false"
  8330. static="true" final="false" visibility="public"
  8331. deprecated="not deprecated">
  8332. </method>
  8333. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
  8334. abstract="false" native="false" synchronized="false"
  8335. static="true" final="false" visibility="public"
  8336. deprecated="not deprecated">
  8337. <param name="name" type="java.lang.String"/>
  8338. </method>
  8339. <doc>
  8340. <![CDATA[{@code LocalResourceType} specifies the <em>type</em>
  8341. of a resource localized by the {@code NodeManager}.
  8342. <p>
  8343. The <em>type</em> can be one of:
  8344. <ul>
  8345. <li>
  8346. {@link #FILE} - Regular file i.e. uninterpreted bytes.
  8347. </li>
  8348. <li>
  8349. {@link #ARCHIVE} - Archive, which is automatically unarchived by the
  8350. <code>NodeManager</code>.
  8351. </li>
  8352. <li>
  8353. {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}.
  8354. </li>
  8355. </ul>
  8356. @see LocalResource
  8357. @see ContainerLaunchContext
  8358. @see ApplicationSubmissionContext
  8359. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  8360. </doc>
  8361. </class>
  8362. <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceType -->
  8363. <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
  8364. <class name="LocalResourceVisibility" extends="java.lang.Enum"
  8365. abstract="false"
  8366. static="false" final="true" visibility="public"
  8367. deprecated="not deprecated">
  8368. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility[]"
  8369. abstract="false" native="false" synchronized="false"
  8370. static="true" final="false" visibility="public"
  8371. deprecated="not deprecated">
  8372. </method>
  8373. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
  8374. abstract="false" native="false" synchronized="false"
  8375. static="true" final="false" visibility="public"
  8376. deprecated="not deprecated">
  8377. <param name="name" type="java.lang.String"/>
  8378. </method>
  8379. <doc>
  8380. <![CDATA[{@code LocalResourceVisibility} specifies the <em>visibility</em>
  8381. of a resource localized by the {@code NodeManager}.
  8382. <p>
  8383. The <em>visibility</em> can be one of:
  8384. <ul>
  8385. <li>{@link #PUBLIC} - Shared by all users on the node.</li>
  8386. <li>
  8387. {@link #PRIVATE} - Shared among all applications of the
  8388. <em>same user</em> on the node.
  8389. </li>
  8390. <li>
  8391. {@link #APPLICATION} - Shared only among containers of the
  8392. <em>same application</em> on the node.
  8393. </li>
  8394. </ul>
  8395. @see LocalResource
  8396. @see ContainerLaunchContext
  8397. @see ApplicationSubmissionContext
  8398. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  8399. </doc>
  8400. </class>
  8401. <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
  8402. <!-- start class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
  8403. <class name="LogAggregationContext" extends="java.lang.Object"
  8404. abstract="true"
  8405. static="false" final="false" visibility="public"
  8406. deprecated="not deprecated">
  8407. <constructor name="LogAggregationContext"
  8408. static="false" final="false" visibility="public"
  8409. deprecated="not deprecated">
  8410. </constructor>
  8411. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  8412. abstract="false" native="false" synchronized="false"
  8413. static="true" final="false" visibility="public"
  8414. deprecated="not deprecated">
  8415. <param name="includePattern" type="java.lang.String"/>
  8416. <param name="excludePattern" type="java.lang.String"/>
  8417. </method>
  8418. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  8419. abstract="false" native="false" synchronized="false"
  8420. static="true" final="false" visibility="public"
  8421. deprecated="not deprecated">
  8422. <param name="includePattern" type="java.lang.String"/>
  8423. <param name="excludePattern" type="java.lang.String"/>
  8424. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  8425. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  8426. </method>
  8427. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  8428. abstract="false" native="false" synchronized="false"
  8429. static="true" final="false" visibility="public"
  8430. deprecated="not deprecated">
  8431. <param name="includePattern" type="java.lang.String"/>
  8432. <param name="excludePattern" type="java.lang.String"/>
  8433. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  8434. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  8435. <param name="policyClassName" type="java.lang.String"/>
  8436. <param name="policyParameters" type="java.lang.String"/>
  8437. </method>
  8438. <method name="getIncludePattern" return="java.lang.String"
  8439. abstract="true" native="false" synchronized="false"
  8440. static="false" final="false" visibility="public"
  8441. deprecated="not deprecated">
  8442. <doc>
  8443. <![CDATA[Get include pattern. This includePattern only takes affect
  8444. on logs that exist at the time of application finish.
  8445. @return include pattern]]>
  8446. </doc>
  8447. </method>
  8448. <method name="setIncludePattern"
  8449. abstract="true" native="false" synchronized="false"
  8450. static="false" final="false" visibility="public"
  8451. deprecated="not deprecated">
  8452. <param name="includePattern" type="java.lang.String"/>
  8453. <doc>
  8454. <![CDATA[Set include pattern. This includePattern only takes affect
  8455. on logs that exist at the time of application finish.
  8456. @param includePattern]]>
  8457. </doc>
  8458. </method>
  8459. <method name="getExcludePattern" return="java.lang.String"
  8460. abstract="true" native="false" synchronized="false"
  8461. static="false" final="false" visibility="public"
  8462. deprecated="not deprecated">
  8463. <doc>
  8464. <![CDATA[Get exclude pattern. This excludePattern only takes affect
  8465. on logs that exist at the time of application finish.
  8466. @return exclude pattern]]>
  8467. </doc>
  8468. </method>
  8469. <method name="setExcludePattern"
  8470. abstract="true" native="false" synchronized="false"
  8471. static="false" final="false" visibility="public"
  8472. deprecated="not deprecated">
  8473. <param name="excludePattern" type="java.lang.String"/>
  8474. <doc>
  8475. <![CDATA[Set exclude pattern. This excludePattern only takes affect
  8476. on logs that exist at the time of application finish.
  8477. @param excludePattern]]>
  8478. </doc>
  8479. </method>
  8480. <method name="getRolledLogsIncludePattern" return="java.lang.String"
  8481. abstract="true" native="false" synchronized="false"
  8482. static="false" final="false" visibility="public"
  8483. deprecated="not deprecated">
  8484. <doc>
  8485. <![CDATA[Get include pattern in a rolling fashion.
  8486. @return include pattern]]>
  8487. </doc>
  8488. </method>
  8489. <method name="setRolledLogsIncludePattern"
  8490. abstract="true" native="false" synchronized="false"
  8491. static="false" final="false" visibility="public"
  8492. deprecated="not deprecated">
  8493. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  8494. <doc>
  8495. <![CDATA[Set include pattern in a rolling fashion.
  8496. @param rolledLogsIncludePattern]]>
  8497. </doc>
  8498. </method>
  8499. <method name="getRolledLogsExcludePattern" return="java.lang.String"
  8500. abstract="true" native="false" synchronized="false"
  8501. static="false" final="false" visibility="public"
  8502. deprecated="not deprecated">
  8503. <doc>
  8504. <![CDATA[Get exclude pattern for aggregation in a rolling fashion.
  8505. @return exclude pattern]]>
  8506. </doc>
  8507. </method>
  8508. <method name="setRolledLogsExcludePattern"
  8509. abstract="true" native="false" synchronized="false"
  8510. static="false" final="false" visibility="public"
  8511. deprecated="not deprecated">
  8512. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  8513. <doc>
  8514. <![CDATA[Set exclude pattern for in a rolling fashion.
  8515. @param rolledLogsExcludePattern]]>
  8516. </doc>
  8517. </method>
  8518. <method name="getLogAggregationPolicyClassName" return="java.lang.String"
  8519. abstract="true" native="false" synchronized="false"
  8520. static="false" final="false" visibility="public"
  8521. deprecated="not deprecated">
  8522. <doc>
  8523. <![CDATA[Get the log aggregation policy class.
  8524. @return log aggregation policy class]]>
  8525. </doc>
  8526. </method>
  8527. <method name="setLogAggregationPolicyClassName"
  8528. abstract="true" native="false" synchronized="false"
  8529. static="false" final="false" visibility="public"
  8530. deprecated="not deprecated">
  8531. <param name="className" type="java.lang.String"/>
  8532. <doc>
  8533. <![CDATA[Set the log aggregation policy class.
  8534. @param className]]>
  8535. </doc>
  8536. </method>
  8537. <method name="getLogAggregationPolicyParameters" return="java.lang.String"
  8538. abstract="true" native="false" synchronized="false"
  8539. static="false" final="false" visibility="public"
  8540. deprecated="not deprecated">
  8541. <doc>
  8542. <![CDATA[Get the log aggregation policy parameters.
  8543. @return log aggregation policy parameters]]>
  8544. </doc>
  8545. </method>
  8546. <method name="setLogAggregationPolicyParameters"
  8547. abstract="true" native="false" synchronized="false"
  8548. static="false" final="false" visibility="public"
  8549. deprecated="not deprecated">
  8550. <param name="parameters" type="java.lang.String"/>
  8551. <doc>
  8552. <![CDATA[Set the log aggregation policy parameters.
  8553. There is no schema defined for the parameters string.
  8554. It is up to the log aggregation policy class to decide how to parse
  8555. the parameters string.
  8556. @param parameters]]>
  8557. </doc>
  8558. </method>
  8559. <doc>
  8560. <![CDATA[{@code LogAggregationContext} represents all of the
  8561. information needed by the {@code NodeManager} to handle
  8562. the logs for an application.
  8563. <p>
  8564. It includes details such as:
  8565. <ul>
  8566. <li>
  8567. includePattern. It uses Java Regex to filter the log files
  8568. which match the defined include pattern and those log files
  8569. will be uploaded when the application finishes.
  8570. </li>
  8571. <li>
  8572. excludePattern. It uses Java Regex to filter the log files
  8573. which match the defined exclude pattern and those log files
  8574. will not be uploaded when application finishes. If the log file
  8575. name matches both the include and the exclude pattern, this file
  8576. will be excluded eventually.
  8577. </li>
  8578. <li>
  8579. rolledLogsIncludePattern. It uses Java Regex to filter the log files
  8580. which match the defined include pattern and those log files
  8581. will be aggregated in a rolling fashion.
  8582. </li>
  8583. <li>
  8584. rolledLogsExcludePattern. It uses Java Regex to filter the log files
  8585. which match the defined exclude pattern and those log files
  8586. will not be aggregated in a rolling fashion. If the log file
  8587. name matches both the include and the exclude pattern, this file
  8588. will be excluded eventually.
  8589. </li>
  8590. <li>
  8591. policyClassName. The policy class name that implements
  8592. ContainerLogAggregationPolicy. At runtime, nodemanager will the policy
  8593. if a given container's log should be aggregated based on the
  8594. ContainerType and other runtime state such as exit code by calling
  8595. ContainerLogAggregationPolicy#shouldDoLogAggregation.
  8596. This is useful when the app only wants to aggregate logs of a subset of
  8597. containers. Here are the available policies. Please make sure to specify
  8598. the canonical name by prefixing org.apache.hadoop.yarn.server.
  8599. nodemanager.containermanager.logaggregation.
  8600. to the class simple name below.
  8601. NoneContainerLogAggregationPolicy: skip aggregation for all containers.
  8602. AllContainerLogAggregationPolicy: aggregate all containers.
  8603. AMOrFailedContainerLogAggregationPolicy: aggregate application master
  8604. or failed containers.
  8605. FailedOrKilledContainerLogAggregationPolicy: aggregate failed or killed
  8606. containers
  8607. FailedContainerLogAggregationPolicy: aggregate failed containers
  8608. AMOnlyLogAggregationPolicy: aggregate application master containers
  8609. SampleContainerLogAggregationPolicy: sample logs of successful worker
  8610. containers, in addition to application master and failed/killed
  8611. containers.
  8612. If it isn't specified, it will use the cluster-wide default policy
  8613. defined by configuration yarn.nodemanager.log-aggregation.policy.class.
  8614. The default value of yarn.nodemanager.log-aggregation.policy.class is
  8615. AllContainerLogAggregationPolicy.
  8616. </li>
  8617. <li>
  8618. policyParameters. The parameters passed to the policy class via
  8619. ContainerLogAggregationPolicy#parseParameters during the policy object
  8620. initialization. This is optional. Some policy class might use parameters
  8621. to adjust its settings. It is up to policy class to define the scheme of
  8622. parameters.
  8623. For example, SampleContainerLogAggregationPolicy supports the format of
  8624. "SR:0.5,MIN:50", which means sample rate of 50% beyond the first 50
  8625. successful worker containers.
  8626. </li>
  8627. </ul>
  8628. @see ApplicationSubmissionContext]]>
  8629. </doc>
  8630. </class>
  8631. <!-- end class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
  8632. <!-- start class org.apache.hadoop.yarn.api.records.NMToken -->
  8633. <class name="NMToken" extends="java.lang.Object"
  8634. abstract="true"
  8635. static="false" final="false" visibility="public"
  8636. deprecated="not deprecated">
  8637. <constructor name="NMToken"
  8638. static="false" final="false" visibility="public"
  8639. deprecated="not deprecated">
  8640. </constructor>
  8641. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  8642. abstract="true" native="false" synchronized="false"
  8643. static="false" final="false" visibility="public"
  8644. deprecated="not deprecated">
  8645. <doc>
  8646. <![CDATA[Get the {@link NodeId} of the <code>NodeManager</code> for which the NMToken
  8647. is used to authenticate.
  8648. @return the {@link NodeId} of the <code>NodeManager</code> for which the
  8649. NMToken is used to authenticate.]]>
  8650. </doc>
  8651. </method>
  8652. <method name="setNodeId"
  8653. abstract="true" native="false" synchronized="false"
  8654. static="false" final="false" visibility="public"
  8655. deprecated="not deprecated">
  8656. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  8657. </method>
  8658. <method name="getToken" return="org.apache.hadoop.yarn.api.records.Token"
  8659. abstract="true" native="false" synchronized="false"
  8660. static="false" final="false" visibility="public"
  8661. deprecated="not deprecated">
  8662. <doc>
  8663. <![CDATA[Get the {@link Token} used for authenticating with <code>NodeManager</code>
  8664. @return the {@link Token} used for authenticating with <code>NodeManager</code>]]>
  8665. </doc>
  8666. </method>
  8667. <method name="setToken"
  8668. abstract="true" native="false" synchronized="false"
  8669. static="false" final="false" visibility="public"
  8670. deprecated="not deprecated">
  8671. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  8672. </method>
  8673. <method name="hashCode" return="int"
  8674. abstract="false" native="false" synchronized="false"
  8675. static="false" final="false" visibility="public"
  8676. deprecated="not deprecated">
  8677. </method>
  8678. <method name="equals" return="boolean"
  8679. abstract="false" native="false" synchronized="false"
  8680. static="false" final="false" visibility="public"
  8681. deprecated="not deprecated">
  8682. <param name="obj" type="java.lang.Object"/>
  8683. </method>
  8684. <doc>
  8685. <![CDATA[<p>The NMToken is used for authenticating communication with
  8686. <code>NodeManager</code></p>
  8687. <p>It is issued by <code>ResourceMananger</code> when <code>ApplicationMaster</code>
  8688. negotiates resource with <code>ResourceManager</code> and
  8689. validated on <code>NodeManager</code> side.</p>
  8690. @see AllocateResponse#getNMTokens()]]>
  8691. </doc>
  8692. </class>
  8693. <!-- end class org.apache.hadoop.yarn.api.records.NMToken -->
  8694. <!-- start class org.apache.hadoop.yarn.api.records.NodeId -->
  8695. <class name="NodeId" extends="java.lang.Object"
  8696. abstract="true"
  8697. static="false" final="false" visibility="public"
  8698. deprecated="not deprecated">
  8699. <implements name="java.lang.Comparable"/>
  8700. <constructor name="NodeId"
  8701. static="false" final="false" visibility="public"
  8702. deprecated="not deprecated">
  8703. </constructor>
  8704. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeId"
  8705. abstract="false" native="false" synchronized="false"
  8706. static="true" final="false" visibility="public"
  8707. deprecated="not deprecated">
  8708. <param name="host" type="java.lang.String"/>
  8709. <param name="port" type="int"/>
  8710. </method>
  8711. <method name="getHost" return="java.lang.String"
  8712. abstract="true" native="false" synchronized="false"
  8713. static="false" final="false" visibility="public"
  8714. deprecated="not deprecated">
  8715. <doc>
  8716. <![CDATA[Get the <em>hostname</em> of the node.
  8717. @return <em>hostname</em> of the node]]>
  8718. </doc>
  8719. </method>
  8720. <method name="getPort" return="int"
  8721. abstract="true" native="false" synchronized="false"
  8722. static="false" final="false" visibility="public"
  8723. deprecated="not deprecated">
  8724. <doc>
  8725. <![CDATA[Get the <em>port</em> for communicating with the node.
  8726. @return <em>port</em> for communicating with the node]]>
  8727. </doc>
  8728. </method>
  8729. <method name="toString" return="java.lang.String"
  8730. abstract="false" native="false" synchronized="false"
  8731. static="false" final="false" visibility="public"
  8732. deprecated="not deprecated">
  8733. </method>
  8734. <method name="hashCode" return="int"
  8735. abstract="false" native="false" synchronized="false"
  8736. static="false" final="false" visibility="public"
  8737. deprecated="not deprecated">
  8738. </method>
  8739. <method name="equals" return="boolean"
  8740. abstract="false" native="false" synchronized="false"
  8741. static="false" final="false" visibility="public"
  8742. deprecated="not deprecated">
  8743. <param name="obj" type="java.lang.Object"/>
  8744. </method>
  8745. <method name="compareTo" return="int"
  8746. abstract="false" native="false" synchronized="false"
  8747. static="false" final="false" visibility="public"
  8748. deprecated="not deprecated">
  8749. <param name="other" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  8750. </method>
  8751. <method name="fromString" return="org.apache.hadoop.yarn.api.records.NodeId"
  8752. abstract="false" native="false" synchronized="false"
  8753. static="true" final="false" visibility="public"
  8754. deprecated="not deprecated">
  8755. <param name="nodeIdStr" type="java.lang.String"/>
  8756. </method>
  8757. <method name="build"
  8758. abstract="true" native="false" synchronized="false"
  8759. static="false" final="false" visibility="protected"
  8760. deprecated="not deprecated">
  8761. </method>
  8762. <doc>
  8763. <![CDATA[<p><code>NodeId</code> is the unique identifier for a node.</p>
  8764. <p>It includes the <em>hostname</em> and <em>port</em> to uniquely
  8765. identify the node. Thus, it is unique across restarts of any
  8766. <code>NodeManager</code>.</p>]]>
  8767. </doc>
  8768. </class>
  8769. <!-- end class org.apache.hadoop.yarn.api.records.NodeId -->
  8770. <!-- start class org.apache.hadoop.yarn.api.records.NodeLabel -->
  8771. <class name="NodeLabel" extends="java.lang.Object"
  8772. abstract="true"
  8773. static="false" final="false" visibility="public"
  8774. deprecated="not deprecated">
  8775. <implements name="java.lang.Comparable"/>
  8776. <constructor name="NodeLabel"
  8777. static="false" final="false" visibility="public"
  8778. deprecated="not deprecated">
  8779. </constructor>
  8780. <method name="getName" return="java.lang.String"
  8781. abstract="true" native="false" synchronized="false"
  8782. static="false" final="false" visibility="public"
  8783. deprecated="not deprecated">
  8784. </method>
  8785. <method name="isExclusive" return="boolean"
  8786. abstract="true" native="false" synchronized="false"
  8787. static="false" final="false" visibility="public"
  8788. deprecated="not deprecated">
  8789. </method>
  8790. <method name="compareTo" return="int"
  8791. abstract="false" native="false" synchronized="false"
  8792. static="false" final="false" visibility="public"
  8793. deprecated="not deprecated">
  8794. <param name="other" type="org.apache.hadoop.yarn.api.records.NodeLabel"/>
  8795. </method>
  8796. <method name="equals" return="boolean"
  8797. abstract="false" native="false" synchronized="false"
  8798. static="false" final="false" visibility="public"
  8799. deprecated="not deprecated">
  8800. <param name="obj" type="java.lang.Object"/>
  8801. </method>
  8802. <method name="toString" return="java.lang.String"
  8803. abstract="false" native="false" synchronized="false"
  8804. static="false" final="false" visibility="public"
  8805. deprecated="not deprecated">
  8806. </method>
  8807. <method name="hashCode" return="int"
  8808. abstract="false" native="false" synchronized="false"
  8809. static="false" final="false" visibility="public"
  8810. deprecated="not deprecated">
  8811. </method>
  8812. <field name="DEFAULT_NODE_LABEL_PARTITION" type="java.lang.String"
  8813. transient="false" volatile="false"
  8814. static="true" final="true" visibility="public"
  8815. deprecated="not deprecated">
  8816. <doc>
  8817. <![CDATA[Default node label partition used for displaying.]]>
  8818. </doc>
  8819. </field>
  8820. <field name="NODE_LABEL_EXPRESSION_NOT_SET" type="java.lang.String"
  8821. transient="false" volatile="false"
  8822. static="true" final="true" visibility="public"
  8823. deprecated="not deprecated">
  8824. <doc>
  8825. <![CDATA[Node Label expression not set .]]>
  8826. </doc>
  8827. </field>
  8828. <field name="DEFAULT_NODE_LABEL_EXCLUSIVITY" type="boolean"
  8829. transient="false" volatile="false"
  8830. static="true" final="true" visibility="public"
  8831. deprecated="not deprecated">
  8832. <doc>
  8833. <![CDATA[By default, node label is exclusive or not]]>
  8834. </doc>
  8835. </field>
  8836. </class>
  8837. <!-- end class org.apache.hadoop.yarn.api.records.NodeLabel -->
  8838. <!-- start class org.apache.hadoop.yarn.api.records.NodeReport -->
  8839. <class name="NodeReport" extends="java.lang.Object"
  8840. abstract="true"
  8841. static="false" final="false" visibility="public"
  8842. deprecated="not deprecated">
  8843. <constructor name="NodeReport"
  8844. static="false" final="false" visibility="public"
  8845. deprecated="not deprecated">
  8846. </constructor>
  8847. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  8848. abstract="true" native="false" synchronized="false"
  8849. static="false" final="false" visibility="public"
  8850. deprecated="not deprecated">
  8851. <doc>
  8852. <![CDATA[Get the <code>NodeId</code> of the node.
  8853. @return <code>NodeId</code> of the node]]>
  8854. </doc>
  8855. </method>
  8856. <method name="getNodeState" return="org.apache.hadoop.yarn.api.records.NodeState"
  8857. abstract="true" native="false" synchronized="false"
  8858. static="false" final="false" visibility="public"
  8859. deprecated="not deprecated">
  8860. <doc>
  8861. <![CDATA[Get the <code>NodeState</code> of the node.
  8862. @return <code>NodeState</code> of the node]]>
  8863. </doc>
  8864. </method>
  8865. <method name="getHttpAddress" return="java.lang.String"
  8866. abstract="true" native="false" synchronized="false"
  8867. static="false" final="false" visibility="public"
  8868. deprecated="not deprecated">
  8869. <doc>
  8870. <![CDATA[Get the <em>http address</em> of the node.
  8871. @return <em>http address</em> of the node]]>
  8872. </doc>
  8873. </method>
  8874. <method name="getRackName" return="java.lang.String"
  8875. abstract="true" native="false" synchronized="false"
  8876. static="false" final="false" visibility="public"
  8877. deprecated="not deprecated">
  8878. <doc>
  8879. <![CDATA[Get the <em>rack name</em> for the node.
  8880. @return <em>rack name</em> for the node]]>
  8881. </doc>
  8882. </method>
  8883. <method name="getUsed" return="org.apache.hadoop.yarn.api.records.Resource"
  8884. abstract="true" native="false" synchronized="false"
  8885. static="false" final="false" visibility="public"
  8886. deprecated="not deprecated">
  8887. <doc>
  8888. <![CDATA[Get <em>used</em> <code>Resource</code> on the node.
  8889. @return <em>used</em> <code>Resource</code> on the node]]>
  8890. </doc>
  8891. </method>
  8892. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  8893. abstract="true" native="false" synchronized="false"
  8894. static="false" final="false" visibility="public"
  8895. deprecated="not deprecated">
  8896. <doc>
  8897. <![CDATA[Get the <em>total</em> <code>Resource</code> on the node.
  8898. @return <em>total</em> <code>Resource</code> on the node]]>
  8899. </doc>
  8900. </method>
  8901. <method name="getHealthReport" return="java.lang.String"
  8902. abstract="true" native="false" synchronized="false"
  8903. static="false" final="false" visibility="public"
  8904. deprecated="not deprecated">
  8905. <doc>
  8906. <![CDATA[Get the <em>diagnostic health report</em> of the node.
  8907. @return <em>diagnostic health report</em> of the node]]>
  8908. </doc>
  8909. </method>
  8910. <method name="getLastHealthReportTime" return="long"
  8911. abstract="true" native="false" synchronized="false"
  8912. static="false" final="false" visibility="public"
  8913. deprecated="not deprecated">
  8914. <doc>
  8915. <![CDATA[Get the <em>last timestamp</em> at which the health report was received.
  8916. @return <em>last timestamp</em> at which the health report was received]]>
  8917. </doc>
  8918. </method>
  8919. <method name="getNodeLabels" return="java.util.Set"
  8920. abstract="true" native="false" synchronized="false"
  8921. static="false" final="false" visibility="public"
  8922. deprecated="not deprecated">
  8923. <doc>
  8924. <![CDATA[Get labels of this node
  8925. @return labels of this node]]>
  8926. </doc>
  8927. </method>
  8928. <method name="getAggregatedContainersUtilization" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  8929. abstract="false" native="false" synchronized="false"
  8930. static="false" final="false" visibility="public"
  8931. deprecated="not deprecated">
  8932. <doc>
  8933. <![CDATA[Get containers aggregated resource utilization in a node
  8934. @return containers resource utilization]]>
  8935. </doc>
  8936. </method>
  8937. <method name="getNodeUtilization" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  8938. abstract="true" native="false" synchronized="false"
  8939. static="false" final="false" visibility="public"
  8940. deprecated="not deprecated">
  8941. <doc>
  8942. <![CDATA[Get node resource utilization
  8943. @return node resource utilization]]>
  8944. </doc>
  8945. </method>
  8946. <doc>
  8947. <![CDATA[{@code NodeReport} is a summary of runtime information of a node
  8948. in the cluster.
  8949. <p>
  8950. It includes details such as:
  8951. <ul>
  8952. <li>{@link NodeId} of the node.</li>
  8953. <li>HTTP Tracking URL of the node.</li>
  8954. <li>Rack name for the node.</li>
  8955. <li>Used {@link Resource} on the node.</li>
  8956. <li>Total available {@link Resource} of the node.</li>
  8957. <li>Number of running containers on the node.</li>
  8958. </ul>
  8959. @see ApplicationClientProtocol#getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)]]>
  8960. </doc>
  8961. </class>
  8962. <!-- end class org.apache.hadoop.yarn.api.records.NodeReport -->
  8963. <!-- start class org.apache.hadoop.yarn.api.records.NodeState -->
  8964. <class name="NodeState" extends="java.lang.Enum"
  8965. abstract="false"
  8966. static="false" final="true" visibility="public"
  8967. deprecated="not deprecated">
  8968. <method name="values" return="org.apache.hadoop.yarn.api.records.NodeState[]"
  8969. abstract="false" native="false" synchronized="false"
  8970. static="true" final="false" visibility="public"
  8971. deprecated="not deprecated">
  8972. </method>
  8973. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.NodeState"
  8974. abstract="false" native="false" synchronized="false"
  8975. static="true" final="false" visibility="public"
  8976. deprecated="not deprecated">
  8977. <param name="name" type="java.lang.String"/>
  8978. </method>
  8979. <method name="isUnusable" return="boolean"
  8980. abstract="false" native="false" synchronized="false"
  8981. static="false" final="false" visibility="public"
  8982. deprecated="not deprecated">
  8983. </method>
  8984. <method name="isInactiveState" return="boolean"
  8985. abstract="false" native="false" synchronized="false"
  8986. static="false" final="false" visibility="public"
  8987. deprecated="not deprecated">
  8988. </method>
  8989. <method name="isActiveState" return="boolean"
  8990. abstract="false" native="false" synchronized="false"
  8991. static="false" final="false" visibility="public"
  8992. deprecated="not deprecated">
  8993. </method>
  8994. <doc>
  8995. <![CDATA[<p>State of a <code>Node</code>.</p>]]>
  8996. </doc>
  8997. </class>
  8998. <!-- end class org.apache.hadoop.yarn.api.records.NodeState -->
  8999. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
  9000. <class name="PreemptionContainer" extends="java.lang.Object"
  9001. abstract="true"
  9002. static="false" final="false" visibility="public"
  9003. deprecated="not deprecated">
  9004. <constructor name="PreemptionContainer"
  9005. static="false" final="false" visibility="public"
  9006. deprecated="not deprecated">
  9007. </constructor>
  9008. <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  9009. abstract="true" native="false" synchronized="false"
  9010. static="false" final="false" visibility="public"
  9011. deprecated="not deprecated">
  9012. <doc>
  9013. <![CDATA[@return Container referenced by this handle.]]>
  9014. </doc>
  9015. </method>
  9016. <doc>
  9017. <![CDATA[Specific container requested back by the <code>ResourceManager</code>.
  9018. @see PreemptionContract
  9019. @see StrictPreemptionContract]]>
  9020. </doc>
  9021. </class>
  9022. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
  9023. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContract -->
  9024. <class name="PreemptionContract" extends="java.lang.Object"
  9025. abstract="true"
  9026. static="false" final="false" visibility="public"
  9027. deprecated="not deprecated">
  9028. <constructor name="PreemptionContract"
  9029. static="false" final="false" visibility="public"
  9030. deprecated="not deprecated">
  9031. </constructor>
  9032. <method name="getResourceRequest" return="java.util.List"
  9033. abstract="true" native="false" synchronized="false"
  9034. static="false" final="false" visibility="public"
  9035. deprecated="not deprecated">
  9036. <doc>
  9037. <![CDATA[If the AM releases resources matching these requests, then the {@link
  9038. PreemptionContainer}s enumerated in {@link #getContainers()} should not be
  9039. evicted from the cluster. Due to delays in propagating cluster state and
  9040. sending these messages, there are conditions where satisfied contracts may
  9041. not prevent the platform from killing containers.
  9042. @return List of {@link PreemptionResourceRequest} to update the
  9043. <code>ApplicationMaster</code> about resources requested back by the
  9044. <code>ResourceManager</code>.
  9045. @see AllocateRequest#setAskList(List)]]>
  9046. </doc>
  9047. </method>
  9048. <method name="getContainers" return="java.util.Set"
  9049. abstract="true" native="false" synchronized="false"
  9050. static="false" final="false" visibility="public"
  9051. deprecated="not deprecated">
  9052. <doc>
  9053. <![CDATA[Assign the set of {@link PreemptionContainer} specifying which containers
  9054. owned by the <code>ApplicationMaster</code> that may be reclaimed by the
  9055. <code>ResourceManager</code>. If the AM prefers a different set of
  9056. containers, then it may checkpoint or kill containers matching the
  9057. description in {@link #getResourceRequest}.
  9058. @return Set of containers at risk if the contract is not met.]]>
  9059. </doc>
  9060. </method>
  9061. <doc>
  9062. <![CDATA[Description of resources requested back by the <code>ResourceManager</code>.
  9063. The <code>ApplicationMaster</code> (AM) can satisfy this request according
  9064. to its own priorities to prevent containers from being forcibly killed by
  9065. the platform.
  9066. @see PreemptionMessage]]>
  9067. </doc>
  9068. </class>
  9069. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContract -->
  9070. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
  9071. <class name="PreemptionMessage" extends="java.lang.Object"
  9072. abstract="true"
  9073. static="false" final="false" visibility="public"
  9074. deprecated="not deprecated">
  9075. <constructor name="PreemptionMessage"
  9076. static="false" final="false" visibility="public"
  9077. deprecated="not deprecated">
  9078. </constructor>
  9079. <method name="getStrictContract" return="org.apache.hadoop.yarn.api.records.StrictPreemptionContract"
  9080. abstract="true" native="false" synchronized="false"
  9081. static="false" final="false" visibility="public"
  9082. deprecated="not deprecated">
  9083. <doc>
  9084. <![CDATA[@return Specific resources that may be killed by the
  9085. <code>ResourceManager</code>]]>
  9086. </doc>
  9087. </method>
  9088. <method name="getContract" return="org.apache.hadoop.yarn.api.records.PreemptionContract"
  9089. abstract="true" native="false" synchronized="false"
  9090. static="false" final="false" visibility="public"
  9091. deprecated="not deprecated">
  9092. <doc>
  9093. <![CDATA[@return Contract describing resources to return to the cluster.]]>
  9094. </doc>
  9095. </method>
  9096. <doc>
  9097. <![CDATA[A {@link PreemptionMessage} is part of the RM-AM protocol, and it is used by
  9098. the RM to specify resources that the RM wants to reclaim from this
  9099. {@code ApplicationMaster} (AM). The AM receives a {@link
  9100. StrictPreemptionContract} message encoding which containers the platform may
  9101. forcibly kill, granting it an opportunity to checkpoint state or adjust its
  9102. execution plan. The message may also include a {@link PreemptionContract}
  9103. granting the AM more latitude in selecting which resources to return to the
  9104. cluster.
  9105. <p>
  9106. The AM should decode both parts of the message. The {@link
  9107. StrictPreemptionContract} specifies particular allocations that the RM
  9108. requires back. The AM can checkpoint containers' state, adjust its execution
  9109. plan to move the computation, or take no action and hope that conditions that
  9110. caused the RM to ask for the container will change.
  9111. <p>
  9112. In contrast, the {@link PreemptionContract} also includes a description of
  9113. resources with a set of containers. If the AM releases containers matching
  9114. that profile, then the containers enumerated in {@link
  9115. PreemptionContract#getContainers()} may not be killed.
  9116. <p>
  9117. Each preemption message reflects the RM's current understanding of the
  9118. cluster state, so a request to return <em>N</em> containers may not
  9119. reflect containers the AM is releasing, recently exited containers the RM has
  9120. yet to learn about, or new containers allocated before the message was
  9121. generated. Conversely, an RM may request a different profile of containers in
  9122. subsequent requests.
  9123. <p>
  9124. The policy enforced by the RM is part of the scheduler. Generally, only
  9125. containers that have been requested consistently should be killed, but the
  9126. details are not specified.]]>
  9127. </doc>
  9128. </class>
  9129. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
  9130. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
  9131. <class name="PreemptionResourceRequest" extends="java.lang.Object"
  9132. abstract="true"
  9133. static="false" final="false" visibility="public"
  9134. deprecated="not deprecated">
  9135. <constructor name="PreemptionResourceRequest"
  9136. static="false" final="false" visibility="public"
  9137. deprecated="not deprecated">
  9138. </constructor>
  9139. <method name="getResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  9140. abstract="true" native="false" synchronized="false"
  9141. static="false" final="false" visibility="public"
  9142. deprecated="not deprecated">
  9143. <doc>
  9144. <![CDATA[@return Resource described in this request, to be matched against running
  9145. containers.]]>
  9146. </doc>
  9147. </method>
  9148. <doc>
  9149. <![CDATA[Description of resources requested back by the cluster.
  9150. @see PreemptionContract
  9151. @see AllocateRequest#setAskList(java.util.List)]]>
  9152. </doc>
  9153. </class>
  9154. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
  9155. <!-- start class org.apache.hadoop.yarn.api.records.Priority -->
  9156. <class name="Priority" extends="java.lang.Object"
  9157. abstract="true"
  9158. static="false" final="false" visibility="public"
  9159. deprecated="not deprecated">
  9160. <implements name="java.lang.Comparable"/>
  9161. <constructor name="Priority"
  9162. static="false" final="false" visibility="public"
  9163. deprecated="not deprecated">
  9164. </constructor>
  9165. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Priority"
  9166. abstract="false" native="false" synchronized="false"
  9167. static="true" final="false" visibility="public"
  9168. deprecated="not deprecated">
  9169. <param name="p" type="int"/>
  9170. </method>
  9171. <method name="getPriority" return="int"
  9172. abstract="true" native="false" synchronized="false"
  9173. static="false" final="false" visibility="public"
  9174. deprecated="not deprecated">
  9175. <doc>
  9176. <![CDATA[Get the assigned priority
  9177. @return the assigned priority]]>
  9178. </doc>
  9179. </method>
  9180. <method name="setPriority"
  9181. abstract="true" native="false" synchronized="false"
  9182. static="false" final="false" visibility="public"
  9183. deprecated="not deprecated">
  9184. <param name="priority" type="int"/>
  9185. <doc>
  9186. <![CDATA[Set the assigned priority
  9187. @param priority the assigned priority]]>
  9188. </doc>
  9189. </method>
  9190. <method name="hashCode" return="int"
  9191. abstract="false" native="false" synchronized="false"
  9192. static="false" final="false" visibility="public"
  9193. deprecated="not deprecated">
  9194. </method>
  9195. <method name="equals" return="boolean"
  9196. abstract="false" native="false" synchronized="false"
  9197. static="false" final="false" visibility="public"
  9198. deprecated="not deprecated">
  9199. <param name="obj" type="java.lang.Object"/>
  9200. </method>
  9201. <method name="compareTo" return="int"
  9202. abstract="false" native="false" synchronized="false"
  9203. static="false" final="false" visibility="public"
  9204. deprecated="not deprecated">
  9205. <param name="other" type="org.apache.hadoop.yarn.api.records.Priority"/>
  9206. </method>
  9207. <method name="toString" return="java.lang.String"
  9208. abstract="false" native="false" synchronized="false"
  9209. static="false" final="false" visibility="public"
  9210. deprecated="not deprecated">
  9211. </method>
  9212. <field name="UNDEFINED" type="org.apache.hadoop.yarn.api.records.Priority"
  9213. transient="false" volatile="false"
  9214. static="true" final="true" visibility="public"
  9215. deprecated="not deprecated">
  9216. </field>
  9217. <doc>
  9218. <![CDATA[The priority assigned to a ResourceRequest or Application or Container
  9219. allocation]]>
  9220. </doc>
  9221. </class>
  9222. <!-- end class org.apache.hadoop.yarn.api.records.Priority -->
  9223. <!-- start class org.apache.hadoop.yarn.api.records.QueueACL -->
  9224. <class name="QueueACL" extends="java.lang.Enum"
  9225. abstract="false"
  9226. static="false" final="true" visibility="public"
  9227. deprecated="not deprecated">
  9228. <method name="values" return="org.apache.hadoop.yarn.api.records.QueueACL[]"
  9229. abstract="false" native="false" synchronized="false"
  9230. static="true" final="false" visibility="public"
  9231. deprecated="not deprecated">
  9232. </method>
  9233. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueACL"
  9234. abstract="false" native="false" synchronized="false"
  9235. static="true" final="false" visibility="public"
  9236. deprecated="not deprecated">
  9237. <param name="name" type="java.lang.String"/>
  9238. </method>
  9239. <doc>
  9240. <![CDATA[{@code QueueACL} enumerates the various ACLs for queues.
  9241. <p>
  9242. The ACL is one of:
  9243. <ul>
  9244. <li>
  9245. {@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the queue.
  9246. </li>
  9247. <li>{@link #ADMINISTER_QUEUE} - ACL to administer the queue.</li>
  9248. </ul>
  9249. @see QueueInfo
  9250. @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
  9251. </doc>
  9252. </class>
  9253. <!-- end class org.apache.hadoop.yarn.api.records.QueueACL -->
  9254. <!-- start class org.apache.hadoop.yarn.api.records.QueueInfo -->
  9255. <class name="QueueInfo" extends="java.lang.Object"
  9256. abstract="true"
  9257. static="false" final="false" visibility="public"
  9258. deprecated="not deprecated">
  9259. <constructor name="QueueInfo"
  9260. static="false" final="false" visibility="public"
  9261. deprecated="not deprecated">
  9262. </constructor>
  9263. <method name="getQueueName" return="java.lang.String"
  9264. abstract="true" native="false" synchronized="false"
  9265. static="false" final="false" visibility="public"
  9266. deprecated="not deprecated">
  9267. <doc>
  9268. <![CDATA[Get the <em>name</em> of the queue.
  9269. @return <em>name</em> of the queue]]>
  9270. </doc>
  9271. </method>
  9272. <method name="getCapacity" return="float"
  9273. abstract="true" native="false" synchronized="false"
  9274. static="false" final="false" visibility="public"
  9275. deprecated="not deprecated">
  9276. <doc>
  9277. <![CDATA[Get the <em>configured capacity</em> of the queue.
  9278. @return <em>configured capacity</em> of the queue]]>
  9279. </doc>
  9280. </method>
  9281. <method name="getMaximumCapacity" return="float"
  9282. abstract="true" native="false" synchronized="false"
  9283. static="false" final="false" visibility="public"
  9284. deprecated="not deprecated">
  9285. <doc>
  9286. <![CDATA[Get the <em>maximum capacity</em> of the queue.
  9287. @return <em>maximum capacity</em> of the queue]]>
  9288. </doc>
  9289. </method>
  9290. <method name="getCurrentCapacity" return="float"
  9291. abstract="true" native="false" synchronized="false"
  9292. static="false" final="false" visibility="public"
  9293. deprecated="not deprecated">
  9294. <doc>
  9295. <![CDATA[Get the <em>current capacity</em> of the queue.
  9296. @return <em>current capacity</em> of the queue]]>
  9297. </doc>
  9298. </method>
  9299. <method name="getChildQueues" return="java.util.List"
  9300. abstract="true" native="false" synchronized="false"
  9301. static="false" final="false" visibility="public"
  9302. deprecated="not deprecated">
  9303. <doc>
  9304. <![CDATA[Get the <em>child queues</em> of the queue.
  9305. @return <em>child queues</em> of the queue]]>
  9306. </doc>
  9307. </method>
  9308. <method name="getApplications" return="java.util.List"
  9309. abstract="true" native="false" synchronized="false"
  9310. static="false" final="false" visibility="public"
  9311. deprecated="not deprecated">
  9312. <doc>
  9313. <![CDATA[Get the <em>running applications</em> of the queue.
  9314. @return <em>running applications</em> of the queue]]>
  9315. </doc>
  9316. </method>
  9317. <method name="getQueueState" return="org.apache.hadoop.yarn.api.records.QueueState"
  9318. abstract="true" native="false" synchronized="false"
  9319. static="false" final="false" visibility="public"
  9320. deprecated="not deprecated">
  9321. <doc>
  9322. <![CDATA[Get the <code>QueueState</code> of the queue.
  9323. @return <code>QueueState</code> of the queue]]>
  9324. </doc>
  9325. </method>
  9326. <method name="getAccessibleNodeLabels" return="java.util.Set"
  9327. abstract="true" native="false" synchronized="false"
  9328. static="false" final="false" visibility="public"
  9329. deprecated="not deprecated">
  9330. <doc>
  9331. <![CDATA[Get the <code>accessible node labels</code> of the queue.
  9332. @return <code>accessible node labels</code> of the queue]]>
  9333. </doc>
  9334. </method>
  9335. <method name="getDefaultNodeLabelExpression" return="java.lang.String"
  9336. abstract="true" native="false" synchronized="false"
  9337. static="false" final="false" visibility="public"
  9338. deprecated="not deprecated">
  9339. <doc>
  9340. <![CDATA[Get the <code>default node label expression</code> of the queue, this takes
  9341. affect only when the <code>ApplicationSubmissionContext</code> and
  9342. <code>ResourceRequest</code> don't specify their
  9343. <code>NodeLabelExpression</code>.
  9344. @return <code>default node label expression</code> of the queue]]>
  9345. </doc>
  9346. </method>
  9347. <method name="setDefaultNodeLabelExpression"
  9348. abstract="true" native="false" synchronized="false"
  9349. static="false" final="false" visibility="public"
  9350. deprecated="not deprecated">
  9351. <param name="defaultLabelExpression" type="java.lang.String"/>
  9352. </method>
  9353. <method name="getQueueStatistics" return="org.apache.hadoop.yarn.api.records.QueueStatistics"
  9354. abstract="true" native="false" synchronized="false"
  9355. static="false" final="false" visibility="public"
  9356. deprecated="not deprecated">
  9357. <doc>
  9358. <![CDATA[Get the <code>queue stats</code> for the queue
  9359. @return <code>queue stats</code> of the queue]]>
  9360. </doc>
  9361. </method>
  9362. <method name="setQueueStatistics"
  9363. abstract="true" native="false" synchronized="false"
  9364. static="false" final="false" visibility="public"
  9365. deprecated="not deprecated">
  9366. <param name="queueStatistics" type="org.apache.hadoop.yarn.api.records.QueueStatistics"/>
  9367. <doc>
  9368. <![CDATA[Set the queue statistics for the queue
  9369. @param queueStatistics
  9370. the queue statistics]]>
  9371. </doc>
  9372. </method>
  9373. <method name="getPreemptionDisabled" return="java.lang.Boolean"
  9374. abstract="true" native="false" synchronized="false"
  9375. static="false" final="false" visibility="public"
  9376. deprecated="not deprecated">
  9377. <doc>
  9378. <![CDATA[Get the <em>preemption status</em> of the queue.
  9379. @return if property is not in proto, return null;
  9380. otherwise, return <em>preemption status</em> of the queue]]>
  9381. </doc>
  9382. </method>
  9383. <method name="getQueueConfigurations" return="java.util.Map"
  9384. abstract="true" native="false" synchronized="false"
  9385. static="false" final="false" visibility="public"
  9386. deprecated="not deprecated">
  9387. <doc>
  9388. <![CDATA[Get the per-node-label queue configurations of the queue.
  9389. @return the per-node-label queue configurations of the queue.]]>
  9390. </doc>
  9391. </method>
  9392. <method name="getIntraQueuePreemptionDisabled" return="java.lang.Boolean"
  9393. abstract="true" native="false" synchronized="false"
  9394. static="false" final="false" visibility="public"
  9395. deprecated="not deprecated">
  9396. <doc>
  9397. <![CDATA[Get the intra-queue preemption status of the queue.
  9398. @return if property is not in proto, return null;
  9399. otherwise, return intra-queue preemption status of the queue]]>
  9400. </doc>
  9401. </method>
  9402. <doc>
  9403. <![CDATA[QueueInfo is a report of the runtime information of the queue.
  9404. <p>
  9405. It includes information such as:
  9406. <ul>
  9407. <li>Queue name.</li>
  9408. <li>Capacity of the queue.</li>
  9409. <li>Maximum capacity of the queue.</li>
  9410. <li>Current capacity of the queue.</li>
  9411. <li>Child queues.</li>
  9412. <li>Running applications.</li>
  9413. <li>{@link QueueState} of the queue.</li>
  9414. <li>{@link QueueConfigurations} of the queue.</li>
  9415. </ul>
  9416. @see QueueState
  9417. @see QueueConfigurations
  9418. @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
  9419. </doc>
  9420. </class>
  9421. <!-- end class org.apache.hadoop.yarn.api.records.QueueInfo -->
  9422. <!-- start class org.apache.hadoop.yarn.api.records.QueueState -->
  9423. <class name="QueueState" extends="java.lang.Enum"
  9424. abstract="false"
  9425. static="false" final="true" visibility="public"
  9426. deprecated="not deprecated">
  9427. <method name="values" return="org.apache.hadoop.yarn.api.records.QueueState[]"
  9428. abstract="false" native="false" synchronized="false"
  9429. static="true" final="false" visibility="public"
  9430. deprecated="not deprecated">
  9431. </method>
  9432. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueState"
  9433. abstract="false" native="false" synchronized="false"
  9434. static="true" final="false" visibility="public"
  9435. deprecated="not deprecated">
  9436. <param name="name" type="java.lang.String"/>
  9437. </method>
  9438. <doc>
  9439. <![CDATA[State of a Queue.
  9440. <p>
  9441. A queue is in one of:
  9442. <ul>
  9443. <li>{@link #RUNNING} - normal state.</li>
  9444. <li>{@link #STOPPED} - not accepting new application submissions.</li>
  9445. <li>
  9446. {@link #DRAINING} - not accepting new application submissions
  9447. and waiting for applications finish.
  9448. </li>
  9449. </ul>
  9450. @see QueueInfo
  9451. @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
  9452. </doc>
  9453. </class>
  9454. <!-- end class org.apache.hadoop.yarn.api.records.QueueState -->
  9455. <!-- start class org.apache.hadoop.yarn.api.records.QueueStatistics -->
  9456. <class name="QueueStatistics" extends="java.lang.Object"
  9457. abstract="true"
  9458. static="false" final="false" visibility="public"
  9459. deprecated="not deprecated">
  9460. <constructor name="QueueStatistics"
  9461. static="false" final="false" visibility="public"
  9462. deprecated="not deprecated">
  9463. </constructor>
  9464. <method name="getNumAppsSubmitted" return="long"
  9465. abstract="true" native="false" synchronized="false"
  9466. static="false" final="false" visibility="public"
  9467. deprecated="not deprecated">
  9468. <doc>
  9469. <![CDATA[Get the number of apps submitted
  9470. @return the number of apps submitted]]>
  9471. </doc>
  9472. </method>
  9473. <method name="setNumAppsSubmitted"
  9474. abstract="true" native="false" synchronized="false"
  9475. static="false" final="false" visibility="public"
  9476. deprecated="not deprecated">
  9477. <param name="numAppsSubmitted" type="long"/>
  9478. <doc>
  9479. <![CDATA[Set the number of apps submitted
  9480. @param numAppsSubmitted
  9481. the number of apps submitted]]>
  9482. </doc>
  9483. </method>
  9484. <method name="getNumAppsRunning" return="long"
  9485. abstract="true" native="false" synchronized="false"
  9486. static="false" final="false" visibility="public"
  9487. deprecated="not deprecated">
  9488. <doc>
  9489. <![CDATA[Get the number of running apps
  9490. @return the number of running apps]]>
  9491. </doc>
  9492. </method>
  9493. <method name="setNumAppsRunning"
  9494. abstract="true" native="false" synchronized="false"
  9495. static="false" final="false" visibility="public"
  9496. deprecated="not deprecated">
  9497. <param name="numAppsRunning" type="long"/>
  9498. <doc>
  9499. <![CDATA[Set the number of running apps
  9500. @param numAppsRunning
  9501. the number of running apps]]>
  9502. </doc>
  9503. </method>
  9504. <method name="getNumAppsPending" return="long"
  9505. abstract="true" native="false" synchronized="false"
  9506. static="false" final="false" visibility="public"
  9507. deprecated="not deprecated">
  9508. <doc>
  9509. <![CDATA[Get the number of pending apps
  9510. @return the number of pending apps]]>
  9511. </doc>
  9512. </method>
  9513. <method name="setNumAppsPending"
  9514. abstract="true" native="false" synchronized="false"
  9515. static="false" final="false" visibility="public"
  9516. deprecated="not deprecated">
  9517. <param name="numAppsPending" type="long"/>
  9518. <doc>
  9519. <![CDATA[Set the number of pending apps
  9520. @param numAppsPending
  9521. the number of pending apps]]>
  9522. </doc>
  9523. </method>
  9524. <method name="getNumAppsCompleted" return="long"
  9525. abstract="true" native="false" synchronized="false"
  9526. static="false" final="false" visibility="public"
  9527. deprecated="not deprecated">
  9528. <doc>
  9529. <![CDATA[Get the number of completed apps
  9530. @return the number of completed apps]]>
  9531. </doc>
  9532. </method>
  9533. <method name="setNumAppsCompleted"
  9534. abstract="true" native="false" synchronized="false"
  9535. static="false" final="false" visibility="public"
  9536. deprecated="not deprecated">
  9537. <param name="numAppsCompleted" type="long"/>
  9538. <doc>
  9539. <![CDATA[Set the number of completed apps
  9540. @param numAppsCompleted
  9541. the number of completed apps]]>
  9542. </doc>
  9543. </method>
  9544. <method name="getNumAppsKilled" return="long"
  9545. abstract="true" native="false" synchronized="false"
  9546. static="false" final="false" visibility="public"
  9547. deprecated="not deprecated">
  9548. <doc>
  9549. <![CDATA[Get the number of killed apps
  9550. @return the number of killed apps]]>
  9551. </doc>
  9552. </method>
  9553. <method name="setNumAppsKilled"
  9554. abstract="true" native="false" synchronized="false"
  9555. static="false" final="false" visibility="public"
  9556. deprecated="not deprecated">
  9557. <param name="numAppsKilled" type="long"/>
  9558. <doc>
  9559. <![CDATA[Set the number of killed apps
  9560. @param numAppsKilled
  9561. the number of killed apps]]>
  9562. </doc>
  9563. </method>
  9564. <method name="getNumAppsFailed" return="long"
  9565. abstract="true" native="false" synchronized="false"
  9566. static="false" final="false" visibility="public"
  9567. deprecated="not deprecated">
  9568. <doc>
  9569. <![CDATA[Get the number of failed apps
  9570. @return the number of failed apps]]>
  9571. </doc>
  9572. </method>
  9573. <method name="setNumAppsFailed"
  9574. abstract="true" native="false" synchronized="false"
  9575. static="false" final="false" visibility="public"
  9576. deprecated="not deprecated">
  9577. <param name="numAppsFailed" type="long"/>
  9578. <doc>
  9579. <![CDATA[Set the number of failed apps
  9580. @param numAppsFailed
  9581. the number of failed apps]]>
  9582. </doc>
  9583. </method>
  9584. <method name="getNumActiveUsers" return="long"
  9585. abstract="true" native="false" synchronized="false"
  9586. static="false" final="false" visibility="public"
  9587. deprecated="not deprecated">
  9588. <doc>
  9589. <![CDATA[Get the number of active users
  9590. @return the number of active users]]>
  9591. </doc>
  9592. </method>
  9593. <method name="setNumActiveUsers"
  9594. abstract="true" native="false" synchronized="false"
  9595. static="false" final="false" visibility="public"
  9596. deprecated="not deprecated">
  9597. <param name="numActiveUsers" type="long"/>
  9598. <doc>
  9599. <![CDATA[Set the number of active users
  9600. @param numActiveUsers
  9601. the number of active users]]>
  9602. </doc>
  9603. </method>
  9604. <method name="getAvailableMemoryMB" return="long"
  9605. abstract="true" native="false" synchronized="false"
  9606. static="false" final="false" visibility="public"
  9607. deprecated="not deprecated">
  9608. <doc>
  9609. <![CDATA[Get the available memory in MB
  9610. @return the available memory]]>
  9611. </doc>
  9612. </method>
  9613. <method name="setAvailableMemoryMB"
  9614. abstract="true" native="false" synchronized="false"
  9615. static="false" final="false" visibility="public"
  9616. deprecated="not deprecated">
  9617. <param name="availableMemoryMB" type="long"/>
  9618. <doc>
  9619. <![CDATA[Set the available memory in MB
  9620. @param availableMemoryMB
  9621. the available memory]]>
  9622. </doc>
  9623. </method>
  9624. <method name="getAllocatedMemoryMB" return="long"
  9625. abstract="true" native="false" synchronized="false"
  9626. static="false" final="false" visibility="public"
  9627. deprecated="not deprecated">
  9628. <doc>
  9629. <![CDATA[Get the allocated memory in MB
  9630. @return the allocated memory]]>
  9631. </doc>
  9632. </method>
  9633. <method name="setAllocatedMemoryMB"
  9634. abstract="true" native="false" synchronized="false"
  9635. static="false" final="false" visibility="public"
  9636. deprecated="not deprecated">
  9637. <param name="allocatedMemoryMB" type="long"/>
  9638. <doc>
  9639. <![CDATA[Set the allocated memory in MB
  9640. @param allocatedMemoryMB
  9641. the allocate memory]]>
  9642. </doc>
  9643. </method>
  9644. <method name="getPendingMemoryMB" return="long"
  9645. abstract="true" native="false" synchronized="false"
  9646. static="false" final="false" visibility="public"
  9647. deprecated="not deprecated">
  9648. <doc>
  9649. <![CDATA[Get the pending memory in MB
  9650. @return the pending memory]]>
  9651. </doc>
  9652. </method>
  9653. <method name="setPendingMemoryMB"
  9654. abstract="true" native="false" synchronized="false"
  9655. static="false" final="false" visibility="public"
  9656. deprecated="not deprecated">
  9657. <param name="pendingMemoryMB" type="long"/>
  9658. <doc>
  9659. <![CDATA[Set the pending memory in MB
  9660. @param pendingMemoryMB
  9661. the pending memory]]>
  9662. </doc>
  9663. </method>
  9664. <method name="getReservedMemoryMB" return="long"
  9665. abstract="true" native="false" synchronized="false"
  9666. static="false" final="false" visibility="public"
  9667. deprecated="not deprecated">
  9668. <doc>
  9669. <![CDATA[Get the reserved memory in MB
  9670. @return the reserved memory]]>
  9671. </doc>
  9672. </method>
  9673. <method name="setReservedMemoryMB"
  9674. abstract="true" native="false" synchronized="false"
  9675. static="false" final="false" visibility="public"
  9676. deprecated="not deprecated">
  9677. <param name="reservedMemoryMB" type="long"/>
  9678. <doc>
  9679. <![CDATA[Set the reserved memory in MB
  9680. @param reservedMemoryMB
  9681. the reserved memory]]>
  9682. </doc>
  9683. </method>
  9684. <method name="getAvailableVCores" return="long"
  9685. abstract="true" native="false" synchronized="false"
  9686. static="false" final="false" visibility="public"
  9687. deprecated="not deprecated">
  9688. <doc>
  9689. <![CDATA[Get the available vcores
  9690. @return the available vcores]]>
  9691. </doc>
  9692. </method>
  9693. <method name="setAvailableVCores"
  9694. abstract="true" native="false" synchronized="false"
  9695. static="false" final="false" visibility="public"
  9696. deprecated="not deprecated">
  9697. <param name="availableVCores" type="long"/>
  9698. <doc>
  9699. <![CDATA[Set the available vcores
  9700. @param availableVCores
  9701. the available vcores]]>
  9702. </doc>
  9703. </method>
  9704. <method name="getAllocatedVCores" return="long"
  9705. abstract="true" native="false" synchronized="false"
  9706. static="false" final="false" visibility="public"
  9707. deprecated="not deprecated">
  9708. <doc>
  9709. <![CDATA[Get the allocated vcores
  9710. @return the allocated vcores]]>
  9711. </doc>
  9712. </method>
  9713. <method name="setAllocatedVCores"
  9714. abstract="true" native="false" synchronized="false"
  9715. static="false" final="false" visibility="public"
  9716. deprecated="not deprecated">
  9717. <param name="allocatedVCores" type="long"/>
  9718. <doc>
  9719. <![CDATA[Set the allocated vcores
  9720. @param allocatedVCores
  9721. the allocated vcores]]>
  9722. </doc>
  9723. </method>
  9724. <method name="getPendingVCores" return="long"
  9725. abstract="true" native="false" synchronized="false"
  9726. static="false" final="false" visibility="public"
  9727. deprecated="not deprecated">
  9728. <doc>
  9729. <![CDATA[Get the pending vcores
  9730. @return the pending vcores]]>
  9731. </doc>
  9732. </method>
  9733. <method name="setPendingVCores"
  9734. abstract="true" native="false" synchronized="false"
  9735. static="false" final="false" visibility="public"
  9736. deprecated="not deprecated">
  9737. <param name="pendingVCores" type="long"/>
  9738. <doc>
  9739. <![CDATA[Set the pending vcores
  9740. @param pendingVCores
  9741. the pending vcores]]>
  9742. </doc>
  9743. </method>
  9744. <method name="getPendingContainers" return="long"
  9745. abstract="true" native="false" synchronized="false"
  9746. static="false" final="false" visibility="public"
  9747. deprecated="not deprecated">
  9748. <doc>
  9749. <![CDATA[Get the number of pending containers.
  9750. @return the number of pending containers.]]>
  9751. </doc>
  9752. </method>
  9753. <method name="setPendingContainers"
  9754. abstract="true" native="false" synchronized="false"
  9755. static="false" final="false" visibility="public"
  9756. deprecated="not deprecated">
  9757. <param name="pendingContainers" type="long"/>
  9758. <doc>
  9759. <![CDATA[Set the number of pending containers.
  9760. @param pendingContainers the pending containers.]]>
  9761. </doc>
  9762. </method>
  9763. <method name="getAllocatedContainers" return="long"
  9764. abstract="true" native="false" synchronized="false"
  9765. static="false" final="false" visibility="public"
  9766. deprecated="not deprecated">
  9767. <doc>
  9768. <![CDATA[Get the number of allocated containers.
  9769. @return the number of allocated containers.]]>
  9770. </doc>
  9771. </method>
  9772. <method name="setAllocatedContainers"
  9773. abstract="true" native="false" synchronized="false"
  9774. static="false" final="false" visibility="public"
  9775. deprecated="not deprecated">
  9776. <param name="allocatedContainers" type="long"/>
  9777. <doc>
  9778. <![CDATA[Set the number of allocated containers.
  9779. @param allocatedContainers the allocated containers.]]>
  9780. </doc>
  9781. </method>
  9782. <method name="getReservedContainers" return="long"
  9783. abstract="true" native="false" synchronized="false"
  9784. static="false" final="false" visibility="public"
  9785. deprecated="not deprecated">
  9786. <doc>
  9787. <![CDATA[Get the number of reserved containers.
  9788. @return the number of reserved containers.]]>
  9789. </doc>
  9790. </method>
  9791. <method name="setReservedContainers"
  9792. abstract="true" native="false" synchronized="false"
  9793. static="false" final="false" visibility="public"
  9794. deprecated="not deprecated">
  9795. <param name="reservedContainers" type="long"/>
  9796. <doc>
  9797. <![CDATA[Set the number of reserved containers.
  9798. @param reservedContainers the reserved containers.]]>
  9799. </doc>
  9800. </method>
  9801. <method name="getReservedVCores" return="long"
  9802. abstract="true" native="false" synchronized="false"
  9803. static="false" final="false" visibility="public"
  9804. deprecated="not deprecated">
  9805. <doc>
  9806. <![CDATA[Get the reserved vcores
  9807. @return the reserved vcores]]>
  9808. </doc>
  9809. </method>
  9810. <method name="setReservedVCores"
  9811. abstract="true" native="false" synchronized="false"
  9812. static="false" final="false" visibility="public"
  9813. deprecated="not deprecated">
  9814. <param name="reservedVCores" type="long"/>
  9815. <doc>
  9816. <![CDATA[Set the reserved vcores
  9817. @param reservedVCores
  9818. the reserved vcores]]>
  9819. </doc>
  9820. </method>
  9821. </class>
  9822. <!-- end class org.apache.hadoop.yarn.api.records.QueueStatistics -->
  9823. <!-- start class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
  9824. <class name="QueueUserACLInfo" extends="java.lang.Object"
  9825. abstract="true"
  9826. static="false" final="false" visibility="public"
  9827. deprecated="not deprecated">
  9828. <constructor name="QueueUserACLInfo"
  9829. static="false" final="false" visibility="public"
  9830. deprecated="not deprecated">
  9831. </constructor>
  9832. <method name="getQueueName" return="java.lang.String"
  9833. abstract="true" native="false" synchronized="false"
  9834. static="false" final="false" visibility="public"
  9835. deprecated="not deprecated">
  9836. <doc>
  9837. <![CDATA[Get the <em>queue name</em> of the queue.
  9838. @return <em>queue name</em> of the queue]]>
  9839. </doc>
  9840. </method>
  9841. <method name="getUserAcls" return="java.util.List"
  9842. abstract="true" native="false" synchronized="false"
  9843. static="false" final="false" visibility="public"
  9844. deprecated="not deprecated">
  9845. <doc>
  9846. <![CDATA[Get the list of <code>QueueACL</code> for the given user.
  9847. @return list of <code>QueueACL</code> for the given user]]>
  9848. </doc>
  9849. </method>
  9850. <doc>
  9851. <![CDATA[<p><code>QueueUserACLInfo</code> provides information {@link QueueACL} for
  9852. the given user.</p>
  9853. @see QueueACL
  9854. @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
  9855. </doc>
  9856. </class>
  9857. <!-- end class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
  9858. <!-- start class org.apache.hadoop.yarn.api.records.ReservationACL -->
  9859. <class name="ReservationACL" extends="java.lang.Enum"
  9860. abstract="false"
  9861. static="false" final="true" visibility="public"
  9862. deprecated="not deprecated">
  9863. <method name="values" return="org.apache.hadoop.yarn.api.records.ReservationACL[]"
  9864. abstract="false" native="false" synchronized="false"
  9865. static="true" final="false" visibility="public"
  9866. deprecated="not deprecated">
  9867. </method>
  9868. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ReservationACL"
  9869. abstract="false" native="false" synchronized="false"
  9870. static="true" final="false" visibility="public"
  9871. deprecated="not deprecated">
  9872. <param name="name" type="java.lang.String"/>
  9873. </method>
  9874. <doc>
  9875. <![CDATA[{@code ReservationACL} enumerates the various ACLs for reservations.
  9876. <p>
  9877. The ACL is one of:
  9878. <ul>
  9879. <li>
  9880. {@link #ADMINISTER_RESERVATIONS} - ACL to create, list, update and
  9881. delete reservations.
  9882. </li>
  9883. <li> {@link #LIST_RESERVATIONS} - ACL to list reservations. </li>
  9884. <li> {@link #SUBMIT_RESERVATIONS} - ACL to create reservations. </li>
  9885. </ul>
  9886. Users can always list, update and delete their own reservations.]]>
  9887. </doc>
  9888. </class>
  9889. <!-- end class org.apache.hadoop.yarn.api.records.ReservationACL -->
  9890. <!-- start class org.apache.hadoop.yarn.api.records.ReservationAllocationState -->
  9891. <class name="ReservationAllocationState" extends="java.lang.Object"
  9892. abstract="true"
  9893. static="false" final="false" visibility="public"
  9894. deprecated="not deprecated">
  9895. <constructor name="ReservationAllocationState"
  9896. static="false" final="false" visibility="public"
  9897. deprecated="not deprecated">
  9898. </constructor>
  9899. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationAllocationState"
  9900. abstract="false" native="false" synchronized="false"
  9901. static="true" final="false" visibility="public"
  9902. deprecated="not deprecated">
  9903. <param name="acceptanceTime" type="long"/>
  9904. <param name="user" type="java.lang.String"/>
  9905. <param name="resourceAllocations" type="java.util.List"/>
  9906. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  9907. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  9908. <doc>
  9909. <![CDATA[@param acceptanceTime The acceptance time of the reservation.
  9910. @param user The username of the user who made the reservation.
  9911. @param resourceAllocations List of {@link ResourceAllocationRequest}
  9912. representing the current state of the
  9913. reservation resource allocations. This is
  9914. subject to change in the event of re-planning.
  9915. @param reservationId {@link ReservationId } of the reservation being
  9916. listed.
  9917. @param reservationDefinition {@link ReservationDefinition} used to make
  9918. the reservation.
  9919. @return {@code ReservationAllocationState} that represents the state of
  9920. the reservation.]]>
  9921. </doc>
  9922. </method>
  9923. <method name="getAcceptanceTime" return="long"
  9924. abstract="true" native="false" synchronized="false"
  9925. static="false" final="false" visibility="public"
  9926. deprecated="not deprecated">
  9927. <doc>
  9928. <![CDATA[Get the acceptance time of the reservation.
  9929. @return the time that the reservation was accepted.]]>
  9930. </doc>
  9931. </method>
  9932. <method name="getUser" return="java.lang.String"
  9933. abstract="true" native="false" synchronized="false"
  9934. static="false" final="false" visibility="public"
  9935. deprecated="not deprecated">
  9936. <doc>
  9937. <![CDATA[Get the user who made the reservation.
  9938. @return the name of the user who made the reservation.]]>
  9939. </doc>
  9940. </method>
  9941. <method name="getResourceAllocationRequests" return="java.util.List"
  9942. abstract="true" native="false" synchronized="false"
  9943. static="false" final="false" visibility="public"
  9944. deprecated="not deprecated">
  9945. <doc>
  9946. <![CDATA[Get the Resource allocations of the reservation based on the current state
  9947. of the plan. This is subject to change in the event of re-planning.
  9948. The allocations will be constraint to the user contract as described by
  9949. the {@link ReservationDefinition}
  9950. @return a list of resource allocations for the reservation.]]>
  9951. </doc>
  9952. </method>
  9953. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  9954. abstract="true" native="false" synchronized="false"
  9955. static="false" final="false" visibility="public"
  9956. deprecated="not deprecated">
  9957. <doc>
  9958. <![CDATA[Get the id of the reservation.
  9959. @return the reservation id corresponding to the reservation.]]>
  9960. </doc>
  9961. </method>
  9962. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  9963. abstract="true" native="false" synchronized="false"
  9964. static="false" final="false" visibility="public"
  9965. deprecated="not deprecated">
  9966. <doc>
  9967. <![CDATA[Get the reservation definition used to make the reservation.
  9968. @return the reservation definition used to make the reservation.]]>
  9969. </doc>
  9970. </method>
  9971. <doc>
  9972. <![CDATA[{@code ReservationAllocationState} represents the reservation that is
  9973. made by a user.
  9974. <p>
  9975. It includes:
  9976. <ul>
  9977. <li>Duration of the reservation.</li>
  9978. <li>Acceptance time of the duration.</li>
  9979. <li>
  9980. List of {@link ResourceAllocationRequest}, which includes the time
  9981. interval, and capability of the allocation.
  9982. {@code ResourceAllocationRequest} represents an allocation
  9983. made for a reservation for the current state of the queue. This can be
  9984. changed for reasons such as re-planning, but will always be subject to
  9985. the constraints of the user contract as described by
  9986. {@link ReservationDefinition}
  9987. </li>
  9988. <li>{@link ReservationId} of the reservation.</li>
  9989. <li>{@link ReservationDefinition} used to make the reservation.</li>
  9990. </ul>
  9991. @see ResourceAllocationRequest
  9992. @see ReservationId
  9993. @see ReservationDefinition]]>
  9994. </doc>
  9995. </class>
  9996. <!-- end class org.apache.hadoop.yarn.api.records.ReservationAllocationState -->
  9997. <!-- start class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
  9998. <class name="ReservationDefinition" extends="java.lang.Object"
  9999. abstract="true"
  10000. static="false" final="false" visibility="public"
  10001. deprecated="not deprecated">
  10002. <constructor name="ReservationDefinition"
  10003. static="false" final="false" visibility="public"
  10004. deprecated="not deprecated">
  10005. </constructor>
  10006. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  10007. abstract="false" native="false" synchronized="false"
  10008. static="true" final="false" visibility="public"
  10009. deprecated="not deprecated">
  10010. <param name="arrival" type="long"/>
  10011. <param name="deadline" type="long"/>
  10012. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  10013. <param name="name" type="java.lang.String"/>
  10014. <param name="recurrenceExpression" type="java.lang.String"/>
  10015. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  10016. </method>
  10017. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  10018. abstract="false" native="false" synchronized="false"
  10019. static="true" final="false" visibility="public"
  10020. deprecated="not deprecated">
  10021. <param name="arrival" type="long"/>
  10022. <param name="deadline" type="long"/>
  10023. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  10024. <param name="name" type="java.lang.String"/>
  10025. </method>
  10026. <method name="getArrival" return="long"
  10027. abstract="true" native="false" synchronized="false"
  10028. static="false" final="false" visibility="public"
  10029. deprecated="not deprecated">
  10030. <doc>
  10031. <![CDATA[Get the arrival time or the earliest time from which the resource(s) can be
  10032. allocated. Time expressed as UTC.
  10033. @return the earliest valid time for this reservation]]>
  10034. </doc>
  10035. </method>
  10036. <method name="setArrival"
  10037. abstract="true" native="false" synchronized="false"
  10038. static="false" final="false" visibility="public"
  10039. deprecated="not deprecated">
  10040. <param name="earliestStartTime" type="long"/>
  10041. <doc>
  10042. <![CDATA[Set the arrival time or the earliest time from which the resource(s) can be
  10043. allocated. Time expressed as UTC.
  10044. @param earliestStartTime the earliest valid time for this reservation]]>
  10045. </doc>
  10046. </method>
  10047. <method name="getDeadline" return="long"
  10048. abstract="true" native="false" synchronized="false"
  10049. static="false" final="false" visibility="public"
  10050. deprecated="not deprecated">
  10051. <doc>
  10052. <![CDATA[Get the deadline or the latest time by when the resource(s) must be
  10053. allocated. Time expressed as UTC.
  10054. @return the deadline or the latest time by when the resource(s) must be
  10055. allocated]]>
  10056. </doc>
  10057. </method>
  10058. <method name="setDeadline"
  10059. abstract="true" native="false" synchronized="false"
  10060. static="false" final="false" visibility="public"
  10061. deprecated="not deprecated">
  10062. <param name="latestEndTime" type="long"/>
  10063. <doc>
  10064. <![CDATA[Set the deadline or the latest time by when the resource(s) must be
  10065. allocated. Time expressed as UTC.
  10066. @param latestEndTime the deadline or the latest time by when the
  10067. resource(s) should be allocated]]>
  10068. </doc>
  10069. </method>
  10070. <method name="getReservationRequests" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
  10071. abstract="true" native="false" synchronized="false"
  10072. static="false" final="false" visibility="public"
  10073. deprecated="not deprecated">
  10074. <doc>
  10075. <![CDATA[Get the list of {@link ReservationRequests} representing the resources
  10076. required by the application
  10077. @return the list of {@link ReservationRequests}]]>
  10078. </doc>
  10079. </method>
  10080. <method name="setReservationRequests"
  10081. abstract="true" native="false" synchronized="false"
  10082. static="false" final="false" visibility="public"
  10083. deprecated="not deprecated">
  10084. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  10085. <doc>
  10086. <![CDATA[Set the list of {@link ReservationRequests} representing the resources
  10087. required by the application
  10088. @param reservationRequests the list of {@link ReservationRequests}]]>
  10089. </doc>
  10090. </method>
  10091. <method name="getReservationName" return="java.lang.String"
  10092. abstract="true" native="false" synchronized="false"
  10093. static="false" final="false" visibility="public"
  10094. deprecated="not deprecated">
  10095. <doc>
  10096. <![CDATA[Get the name for this reservation. The name need-not be unique, and it is
  10097. just a mnemonic for the user (akin to job names). Accepted reservations are
  10098. uniquely identified by a system-generated ReservationId.
  10099. @return string representing the name of the corresponding reserved resource
  10100. allocation in the scheduler]]>
  10101. </doc>
  10102. </method>
  10103. <method name="setReservationName"
  10104. abstract="true" native="false" synchronized="false"
  10105. static="false" final="false" visibility="public"
  10106. deprecated="not deprecated">
  10107. <param name="name" type="java.lang.String"/>
  10108. <doc>
  10109. <![CDATA[Set the name for this reservation. The name need-not be unique, and it is
  10110. just a mnemonic for the user (akin to job names). Accepted reservations are
  10111. uniquely identified by a system-generated ReservationId.
  10112. @param name representing the name of the corresponding reserved resource
  10113. allocation in the scheduler]]>
  10114. </doc>
  10115. </method>
  10116. <method name="getRecurrenceExpression" return="java.lang.String"
  10117. abstract="true" native="false" synchronized="false"
  10118. static="false" final="false" visibility="public"
  10119. deprecated="not deprecated">
  10120. <doc>
  10121. <![CDATA[Get the recurrence of this reservation representing the time period of
  10122. the periodic job. Currently, only long values are supported. Later,
  10123. support for regular expressions denoting arbitrary recurrence patterns
  10124. (e.g., every Tuesday and Thursday) will be added.
  10125. Recurrence is represented in milliseconds for periodic jobs.
  10126. Recurrence is 0 for non-periodic jobs. Periodic jobs are valid until they
  10127. are explicitly cancelled and have higher priority than non-periodic jobs
  10128. (during initial placement and replanning). Periodic job allocations are
  10129. consistent across runs (flexibility in allocation is leveraged only during
  10130. initial placement, allocations remain consistent thereafter). Note that
  10131. as a long, the recurrence expression must be greater than the duration of
  10132. the reservation (deadline - arrival). Also note that the configured max
  10133. period must be divisible by the recurrence expression if expressed as a
  10134. long.
  10135. @return recurrence of this reservation]]>
  10136. </doc>
  10137. </method>
  10138. <method name="setRecurrenceExpression"
  10139. abstract="true" native="false" synchronized="false"
  10140. static="false" final="false" visibility="public"
  10141. deprecated="not deprecated">
  10142. <param name="recurrenceExpression" type="java.lang.String"/>
  10143. <doc>
  10144. <![CDATA[Set the recurrence of this reservation representing the time period of
  10145. the periodic job. Currently, only long values are supported. Later,
  10146. support for regular expressions denoting arbitrary recurrence patterns
  10147. (e.g., every Tuesday and Thursday) will be added.
  10148. Recurrence is represented in milliseconds for periodic jobs.
  10149. Recurrence is 0 for non-periodic jobs. Periodic jobs are valid until they
  10150. are explicitly cancelled and have higher priority than non-periodic jobs
  10151. (during initial placement and replanning). Periodic job allocations are
  10152. consistent across runs (flexibility in allocation is leveraged only during
  10153. initial placement, allocations remain consistent thereafter). Note that
  10154. as a long, the recurrence expression must be greater than the duration of
  10155. the reservation (deadline - arrival). Also note that the configured max
  10156. period must be divisible by the recurrence expression if expressed as a
  10157. long.
  10158. @param recurrenceExpression recurrence interval of this reservation]]>
  10159. </doc>
  10160. </method>
  10161. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  10162. abstract="true" native="false" synchronized="false"
  10163. static="false" final="false" visibility="public"
  10164. deprecated="not deprecated">
  10165. <doc>
  10166. <![CDATA[Get the priority for this reservation. A lower number for priority
  10167. indicates a higher priority reservation. Recurring reservations are
  10168. always higher priority than non-recurring reservations. Priority for
  10169. non-recurring reservations are only compared with non-recurring
  10170. reservations. Likewise for recurring reservations.
  10171. @return int representing the priority of the reserved resource
  10172. allocation in the scheduler]]>
  10173. </doc>
  10174. </method>
  10175. <method name="setPriority"
  10176. abstract="true" native="false" synchronized="false"
  10177. static="false" final="false" visibility="public"
  10178. deprecated="not deprecated">
  10179. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  10180. <doc>
  10181. <![CDATA[Set the priority for this reservation. A lower number for priority
  10182. indicates a higher priority reservation. Recurring reservations are
  10183. always higher priority than non-recurring reservations. Priority for
  10184. non-recurring reservations are only compared with non-recurring
  10185. reservations. Likewise for recurring reservations.
  10186. @param priority representing the priority of the reserved resource
  10187. allocation in the scheduler]]>
  10188. </doc>
  10189. </method>
  10190. <doc>
  10191. <![CDATA[{@link ReservationDefinition} captures the set of resource and time
  10192. constraints the user cares about regarding a reservation.
  10193. @see ResourceRequest]]>
  10194. </doc>
  10195. </class>
  10196. <!-- end class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
  10197. <!-- start class org.apache.hadoop.yarn.api.records.ReservationId -->
  10198. <class name="ReservationId" extends="java.lang.Object"
  10199. abstract="true"
  10200. static="false" final="false" visibility="public"
  10201. deprecated="not deprecated">
  10202. <implements name="java.lang.Comparable"/>
  10203. <constructor name="ReservationId"
  10204. static="false" final="false" visibility="public"
  10205. deprecated="not deprecated">
  10206. </constructor>
  10207. <method name="getId" return="long"
  10208. abstract="true" native="false" synchronized="false"
  10209. static="false" final="false" visibility="public"
  10210. deprecated="not deprecated">
  10211. <doc>
  10212. <![CDATA[Get the long identifier of the {@link ReservationId} which is unique for
  10213. all Reservations started by a particular instance of the
  10214. {@code ResourceManager}.
  10215. @return long identifier of the {@link ReservationId}]]>
  10216. </doc>
  10217. </method>
  10218. <method name="getClusterTimestamp" return="long"
  10219. abstract="true" native="false" synchronized="false"
  10220. static="false" final="false" visibility="public"
  10221. deprecated="not deprecated">
  10222. <doc>
  10223. <![CDATA[Get the <em>start time</em> of the {@code ResourceManager} which is used to
  10224. generate globally unique {@link ReservationId}.
  10225. @return <em>start time</em> of the {@code ResourceManager}]]>
  10226. </doc>
  10227. </method>
  10228. <method name="build"
  10229. abstract="true" native="false" synchronized="false"
  10230. static="false" final="false" visibility="protected"
  10231. deprecated="not deprecated">
  10232. </method>
  10233. <method name="compareTo" return="int"
  10234. abstract="false" native="false" synchronized="false"
  10235. static="false" final="false" visibility="public"
  10236. deprecated="not deprecated">
  10237. <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  10238. </method>
  10239. <method name="toString" return="java.lang.String"
  10240. abstract="false" native="false" synchronized="false"
  10241. static="false" final="false" visibility="public"
  10242. deprecated="not deprecated">
  10243. </method>
  10244. <method name="parseReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  10245. abstract="false" native="false" synchronized="false"
  10246. static="true" final="false" visibility="public"
  10247. deprecated="not deprecated">
  10248. <param name="reservationId" type="java.lang.String"/>
  10249. <exception name="IOException" type="java.io.IOException"/>
  10250. <doc>
  10251. <![CDATA[Parse the string argument as a {@link ReservationId}
  10252. @param reservationId the string representation of the {@link ReservationId}
  10253. @return the {@link ReservationId} corresponding to the input string if
  10254. valid, null if input is null
  10255. @throws IOException if unable to parse the input string]]>
  10256. </doc>
  10257. </method>
  10258. <method name="hashCode" return="int"
  10259. abstract="false" native="false" synchronized="false"
  10260. static="false" final="false" visibility="public"
  10261. deprecated="not deprecated">
  10262. </method>
  10263. <method name="equals" return="boolean"
  10264. abstract="false" native="false" synchronized="false"
  10265. static="false" final="false" visibility="public"
  10266. deprecated="not deprecated">
  10267. <param name="obj" type="java.lang.Object"/>
  10268. </method>
  10269. <field name="reserveIdStrPrefix" type="java.lang.String"
  10270. transient="false" volatile="false"
  10271. static="true" final="true" visibility="public"
  10272. deprecated="not deprecated">
  10273. </field>
  10274. <field name="clusterTimestamp" type="long"
  10275. transient="false" volatile="false"
  10276. static="false" final="false" visibility="protected"
  10277. deprecated="not deprecated">
  10278. </field>
  10279. <field name="id" type="long"
  10280. transient="false" volatile="false"
  10281. static="false" final="false" visibility="protected"
  10282. deprecated="not deprecated">
  10283. </field>
  10284. <doc>
  10285. <![CDATA[<p>
  10286. {@link ReservationId} represents the <em>globally unique</em> identifier for
  10287. a reservation.
  10288. </p>
  10289. <p>
  10290. The globally unique nature of the identifier is achieved by using the
  10291. <em>cluster timestamp</em> i.e. start-time of the {@code ResourceManager}
  10292. along with a monotonically increasing counter for the reservation.
  10293. </p>]]>
  10294. </doc>
  10295. </class>
  10296. <!-- end class org.apache.hadoop.yarn.api.records.ReservationId -->
  10297. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest -->
  10298. <class name="ReservationRequest" extends="java.lang.Object"
  10299. abstract="true"
  10300. static="false" final="false" visibility="public"
  10301. deprecated="not deprecated">
  10302. <implements name="java.lang.Comparable"/>
  10303. <constructor name="ReservationRequest"
  10304. static="false" final="false" visibility="public"
  10305. deprecated="not deprecated">
  10306. </constructor>
  10307. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
  10308. abstract="false" native="false" synchronized="false"
  10309. static="true" final="false" visibility="public"
  10310. deprecated="not deprecated">
  10311. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  10312. <param name="numContainers" type="int"/>
  10313. </method>
  10314. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
  10315. abstract="false" native="false" synchronized="false"
  10316. static="true" final="false" visibility="public"
  10317. deprecated="not deprecated">
  10318. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  10319. <param name="numContainers" type="int"/>
  10320. <param name="concurrency" type="int"/>
  10321. <param name="duration" type="long"/>
  10322. </method>
  10323. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  10324. abstract="true" native="false" synchronized="false"
  10325. static="false" final="false" visibility="public"
  10326. deprecated="not deprecated">
  10327. <doc>
  10328. <![CDATA[Get the {@link Resource} capability of the request.
  10329. @return {@link Resource} capability of the request]]>
  10330. </doc>
  10331. </method>
  10332. <method name="setCapability"
  10333. abstract="true" native="false" synchronized="false"
  10334. static="false" final="false" visibility="public"
  10335. deprecated="not deprecated">
  10336. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  10337. <doc>
  10338. <![CDATA[Set the {@link Resource} capability of the request
  10339. @param capability {@link Resource} capability of the request]]>
  10340. </doc>
  10341. </method>
  10342. <method name="getNumContainers" return="int"
  10343. abstract="true" native="false" synchronized="false"
  10344. static="false" final="false" visibility="public"
  10345. deprecated="not deprecated">
  10346. <doc>
  10347. <![CDATA[Get the number of containers required with the given specifications.
  10348. @return number of containers required with the given specifications]]>
  10349. </doc>
  10350. </method>
  10351. <method name="setNumContainers"
  10352. abstract="true" native="false" synchronized="false"
  10353. static="false" final="false" visibility="public"
  10354. deprecated="not deprecated">
  10355. <param name="numContainers" type="int"/>
  10356. <doc>
  10357. <![CDATA[Set the number of containers required with the given specifications
  10358. @param numContainers number of containers required with the given
  10359. specifications]]>
  10360. </doc>
  10361. </method>
  10362. <method name="getConcurrency" return="int"
  10363. abstract="true" native="false" synchronized="false"
  10364. static="false" final="false" visibility="public"
  10365. deprecated="not deprecated">
  10366. <doc>
  10367. <![CDATA[Get the number of containers that need to be scheduled concurrently. The
  10368. default value of 1 would fall back to the current non concurrency
  10369. constraints on the scheduling behavior.
  10370. @return the number of containers to be concurrently scheduled]]>
  10371. </doc>
  10372. </method>
  10373. <method name="setConcurrency"
  10374. abstract="true" native="false" synchronized="false"
  10375. static="false" final="false" visibility="public"
  10376. deprecated="not deprecated">
  10377. <param name="numContainers" type="int"/>
  10378. <doc>
  10379. <![CDATA[Set the number of containers that need to be scheduled concurrently. The
  10380. default value of 1 would fall back to the current non concurrency
  10381. constraints on the scheduling behavior.
  10382. @param numContainers the number of containers to be concurrently scheduled]]>
  10383. </doc>
  10384. </method>
  10385. <method name="getDuration" return="long"
  10386. abstract="true" native="false" synchronized="false"
  10387. static="false" final="false" visibility="public"
  10388. deprecated="not deprecated">
  10389. <doc>
  10390. <![CDATA[Get the duration in milliseconds for which the resource is required. A
  10391. default value of -1, indicates an unspecified lease duration, and fallback
  10392. to current behavior.
  10393. @return the duration in milliseconds for which the resource is required]]>
  10394. </doc>
  10395. </method>
  10396. <method name="setDuration"
  10397. abstract="true" native="false" synchronized="false"
  10398. static="false" final="false" visibility="public"
  10399. deprecated="not deprecated">
  10400. <param name="duration" type="long"/>
  10401. <doc>
  10402. <![CDATA[Set the duration in milliseconds for which the resource is required.
  10403. @param duration the duration in milliseconds for which the resource is
  10404. required]]>
  10405. </doc>
  10406. </method>
  10407. <method name="hashCode" return="int"
  10408. abstract="false" native="false" synchronized="false"
  10409. static="false" final="false" visibility="public"
  10410. deprecated="not deprecated">
  10411. </method>
  10412. <method name="equals" return="boolean"
  10413. abstract="false" native="false" synchronized="false"
  10414. static="false" final="false" visibility="public"
  10415. deprecated="not deprecated">
  10416. <param name="obj" type="java.lang.Object"/>
  10417. </method>
  10418. <method name="compareTo" return="int"
  10419. abstract="false" native="false" synchronized="false"
  10420. static="false" final="false" visibility="public"
  10421. deprecated="not deprecated">
  10422. <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  10423. </method>
  10424. <doc>
  10425. <![CDATA[{@link ReservationRequest} represents the request made by an application to
  10426. the {@code ResourceManager} to reserve {@link Resource}s.
  10427. <p>
  10428. It includes:
  10429. <ul>
  10430. <li>{@link Resource} required for each request.</li>
  10431. <li>
  10432. Number of containers, of above specifications, which are required by the
  10433. application.
  10434. </li>
  10435. <li>Concurrency that indicates the gang size of the request.</li>
  10436. </ul>]]>
  10437. </doc>
  10438. </class>
  10439. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest -->
  10440. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
  10441. <class name="ReservationRequest.ReservationRequestComparator" extends="java.lang.Object"
  10442. abstract="false"
  10443. static="true" final="false" visibility="public"
  10444. deprecated="not deprecated">
  10445. <implements name="java.util.Comparator"/>
  10446. <implements name="java.io.Serializable"/>
  10447. <constructor name="ReservationRequest.ReservationRequestComparator"
  10448. static="false" final="false" visibility="public"
  10449. deprecated="not deprecated">
  10450. </constructor>
  10451. <method name="compare" return="int"
  10452. abstract="false" native="false" synchronized="false"
  10453. static="false" final="false" visibility="public"
  10454. deprecated="not deprecated">
  10455. <param name="r1" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  10456. <param name="r2" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  10457. </method>
  10458. </class>
  10459. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
  10460. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
  10461. <class name="ReservationRequestInterpreter" extends="java.lang.Enum"
  10462. abstract="false"
  10463. static="false" final="true" visibility="public"
  10464. deprecated="not deprecated">
  10465. <method name="values" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter[]"
  10466. abstract="false" native="false" synchronized="false"
  10467. static="true" final="false" visibility="public"
  10468. deprecated="not deprecated">
  10469. </method>
  10470. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
  10471. abstract="false" native="false" synchronized="false"
  10472. static="true" final="false" visibility="public"
  10473. deprecated="not deprecated">
  10474. <param name="name" type="java.lang.String"/>
  10475. </method>
  10476. <doc>
  10477. <![CDATA[Enumeration of various types of dependencies among multiple
  10478. {@link ReservationRequests} within one {@link ReservationDefinition} (from
  10479. least constraining to most constraining).]]>
  10480. </doc>
  10481. </class>
  10482. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
  10483. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequests -->
  10484. <class name="ReservationRequests" extends="java.lang.Object"
  10485. abstract="true"
  10486. static="false" final="false" visibility="public"
  10487. deprecated="not deprecated">
  10488. <constructor name="ReservationRequests"
  10489. static="false" final="false" visibility="public"
  10490. deprecated="not deprecated">
  10491. </constructor>
  10492. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
  10493. abstract="false" native="false" synchronized="false"
  10494. static="true" final="false" visibility="public"
  10495. deprecated="not deprecated">
  10496. <param name="reservationResources" type="java.util.List"/>
  10497. <param name="type" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
  10498. </method>
  10499. <method name="getReservationResources" return="java.util.List"
  10500. abstract="true" native="false" synchronized="false"
  10501. static="false" final="false" visibility="public"
  10502. deprecated="not deprecated">
  10503. <doc>
  10504. <![CDATA[Get the list of {@link ReservationRequest} representing the resources
  10505. required by the application
  10506. @return the list of {@link ReservationRequest}]]>
  10507. </doc>
  10508. </method>
  10509. <method name="setReservationResources"
  10510. abstract="true" native="false" synchronized="false"
  10511. static="false" final="false" visibility="public"
  10512. deprecated="not deprecated">
  10513. <param name="reservationResources" type="java.util.List"/>
  10514. <doc>
  10515. <![CDATA[Set the list of {@link ReservationRequest} representing the resources
  10516. required by the application
  10517. @param reservationResources the list of {@link ReservationRequest}]]>
  10518. </doc>
  10519. </method>
  10520. <method name="getInterpreter" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
  10521. abstract="true" native="false" synchronized="false"
  10522. static="false" final="false" visibility="public"
  10523. deprecated="not deprecated">
  10524. <doc>
  10525. <![CDATA[Get the {@link ReservationRequestInterpreter}, representing how the list of
  10526. resources should be allocated, this captures temporal ordering and other
  10527. constraints.
  10528. @return the list of {@link ReservationRequestInterpreter}]]>
  10529. </doc>
  10530. </method>
  10531. <method name="setInterpreter"
  10532. abstract="true" native="false" synchronized="false"
  10533. static="false" final="false" visibility="public"
  10534. deprecated="not deprecated">
  10535. <param name="interpreter" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
  10536. <doc>
  10537. <![CDATA[Set the {@link ReservationRequestInterpreter}, representing how the list of
  10538. resources should be allocated, this captures temporal ordering and other
  10539. constraints.
  10540. @param interpreter the {@link ReservationRequestInterpreter} for this
  10541. reservation]]>
  10542. </doc>
  10543. </method>
  10544. <doc>
  10545. <![CDATA[{@link ReservationRequests} captures the set of resource and constraints the
  10546. user cares about regarding a reservation.
  10547. @see ReservationRequest]]>
  10548. </doc>
  10549. </class>
  10550. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequests -->
  10551. <!-- start class org.apache.hadoop.yarn.api.records.Resource -->
  10552. <class name="Resource" extends="java.lang.Object"
  10553. abstract="true"
  10554. static="false" final="false" visibility="public"
  10555. deprecated="not deprecated">
  10556. <implements name="java.lang.Comparable"/>
  10557. <constructor name="Resource"
  10558. static="false" final="false" visibility="public"
  10559. deprecated="not deprecated">
  10560. </constructor>
  10561. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
  10562. abstract="false" native="false" synchronized="false"
  10563. static="true" final="false" visibility="public"
  10564. deprecated="not deprecated">
  10565. <param name="memory" type="int"/>
  10566. <param name="vCores" type="int"/>
  10567. </method>
  10568. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
  10569. abstract="false" native="false" synchronized="false"
  10570. static="true" final="false" visibility="public"
  10571. deprecated="not deprecated">
  10572. <param name="memory" type="long"/>
  10573. <param name="vCores" type="int"/>
  10574. </method>
  10575. <method name="getMemory" return="int"
  10576. abstract="true" native="false" synchronized="false"
  10577. static="false" final="false" visibility="public"
  10578. deprecated="not deprecated">
  10579. <doc>
  10580. <![CDATA[This method is DEPRECATED:
  10581. Use {@link Resource#getMemorySize()} instead
  10582. Get <em>memory</em> of the resource. Note - while memory has
  10583. never had a unit specified, all YARN configurations have specified memory
  10584. in MB. The assumption has been that the daemons and applications are always
  10585. using the same units. With the introduction of the ResourceInformation
  10586. class we have support for units - so this function will continue to return
  10587. memory but in the units of MB
  10588. @return <em>memory</em>(in MB) of the resource]]>
  10589. </doc>
  10590. </method>
  10591. <method name="getMemorySize" return="long"
  10592. abstract="false" native="false" synchronized="false"
  10593. static="false" final="false" visibility="public"
  10594. deprecated="not deprecated">
  10595. <doc>
  10596. <![CDATA[Get <em>memory</em> of the resource. Note - while memory has
  10597. never had a unit specified, all YARN configurations have specified memory
  10598. in MB. The assumption has been that the daemons and applications are always
  10599. using the same units. With the introduction of the ResourceInformation
  10600. class we have support for units - so this function will continue to return
  10601. memory but in the units of MB
  10602. @return <em>memory</em> of the resource]]>
  10603. </doc>
  10604. </method>
  10605. <method name="setMemory"
  10606. abstract="true" native="false" synchronized="false"
  10607. static="false" final="false" visibility="public"
  10608. deprecated="not deprecated">
  10609. <param name="memory" type="int"/>
  10610. <doc>
  10611. <![CDATA[Set <em>memory</em> of the resource. Note - while memory has
  10612. never had a unit specified, all YARN configurations have specified memory
  10613. in MB. The assumption has been that the daemons and applications are always
  10614. using the same units. With the introduction of the ResourceInformation
  10615. class we have support for units - so this function will continue to set
  10616. memory but the assumption is that the value passed is in units of MB.
  10617. @param memory <em>memory</em>(in MB) of the resource]]>
  10618. </doc>
  10619. </method>
  10620. <method name="setMemorySize"
  10621. abstract="false" native="false" synchronized="false"
  10622. static="false" final="false" visibility="public"
  10623. deprecated="not deprecated">
  10624. <param name="memory" type="long"/>
  10625. <doc>
  10626. <![CDATA[Set <em>memory</em> of the resource.
  10627. @param memory <em>memory</em> of the resource]]>
  10628. </doc>
  10629. </method>
  10630. <method name="getVirtualCores" return="int"
  10631. abstract="true" native="false" synchronized="false"
  10632. static="false" final="false" visibility="public"
  10633. deprecated="not deprecated">
  10634. <doc>
  10635. <![CDATA[Get <em>number of virtual cpu cores</em> of the resource.
  10636. Virtual cores are a unit for expressing CPU parallelism. A node's capacity
  10637. should be configured with virtual cores equal to its number of physical
  10638. cores. A container should be requested with the number of cores it can
  10639. saturate, i.e. the average number of threads it expects to have runnable
  10640. at a time.
  10641. @return <em>num of virtual cpu cores</em> of the resource]]>
  10642. </doc>
  10643. </method>
  10644. <method name="setVirtualCores"
  10645. abstract="true" native="false" synchronized="false"
  10646. static="false" final="false" visibility="public"
  10647. deprecated="not deprecated">
  10648. <param name="vCores" type="int"/>
  10649. <doc>
  10650. <![CDATA[Set <em>number of virtual cpu cores</em> of the resource.
  10651. Virtual cores are a unit for expressing CPU parallelism. A node's capacity
  10652. should be configured with virtual cores equal to its number of physical
  10653. cores. A container should be requested with the number of cores it can
  10654. saturate, i.e. the average number of threads it expects to have runnable
  10655. at a time.
  10656. @param vCores <em>number of virtual cpu cores</em> of the resource]]>
  10657. </doc>
  10658. </method>
  10659. <method name="getResourceInformation" return="org.apache.hadoop.yarn.api.records.ResourceInformation"
  10660. abstract="false" native="false" synchronized="false"
  10661. static="false" final="false" visibility="public"
  10662. deprecated="not deprecated">
  10663. <param name="resource" type="java.lang.String"/>
  10664. <exception name="ResourceNotFoundException" type="org.apache.hadoop.yarn.exceptions.ResourceNotFoundException"/>
  10665. <doc>
  10666. <![CDATA[Get ResourceInformation for a specified resource.
  10667. @param resource name of the resource
  10668. @return the ResourceInformation object for the resource
  10669. @throws ResourceNotFoundException if the resource can't be found]]>
  10670. </doc>
  10671. </method>
  10672. <method name="getResourceValue" return="long"
  10673. abstract="false" native="false" synchronized="false"
  10674. static="false" final="false" visibility="public"
  10675. deprecated="not deprecated">
  10676. <param name="resource" type="java.lang.String"/>
  10677. <exception name="ResourceNotFoundException" type="org.apache.hadoop.yarn.exceptions.ResourceNotFoundException"/>
  10678. <doc>
  10679. <![CDATA[Get the value for a specified resource. No information about the units is
  10680. returned.
  10681. @param resource name of the resource
  10682. @return the value for the resource
  10683. @throws ResourceNotFoundException if the resource can't be found]]>
  10684. </doc>
  10685. </method>
  10686. <method name="setResourceInformation"
  10687. abstract="false" native="false" synchronized="false"
  10688. static="false" final="false" visibility="public"
  10689. deprecated="not deprecated">
  10690. <param name="resource" type="java.lang.String"/>
  10691. <param name="resourceInformation" type="org.apache.hadoop.yarn.api.records.ResourceInformation"/>
  10692. <exception name="ResourceNotFoundException" type="org.apache.hadoop.yarn.exceptions.ResourceNotFoundException"/>
  10693. <doc>
  10694. <![CDATA[Set the ResourceInformation object for a particular resource.
  10695. @param resource the resource for which the ResourceInformation is provided
  10696. @param resourceInformation ResourceInformation object
  10697. @throws ResourceNotFoundException if the resource is not found]]>
  10698. </doc>
  10699. </method>
  10700. <method name="setResourceValue"
  10701. abstract="false" native="false" synchronized="false"
  10702. static="false" final="false" visibility="public"
  10703. deprecated="not deprecated">
  10704. <param name="resource" type="java.lang.String"/>
  10705. <param name="value" type="long"/>
  10706. <exception name="ResourceNotFoundException" type="org.apache.hadoop.yarn.exceptions.ResourceNotFoundException"/>
  10707. <doc>
  10708. <![CDATA[Set the value of a resource in the ResourceInformation object. The unit of
  10709. the value is assumed to be the one in the ResourceInformation object.
  10710. @param resource the resource for which the value is provided.
  10711. @param value the value to set
  10712. @throws ResourceNotFoundException if the resource is not found]]>
  10713. </doc>
  10714. </method>
  10715. <method name="throwExceptionWhenArrayOutOfBound"
  10716. abstract="false" native="false" synchronized="false"
  10717. static="false" final="false" visibility="protected"
  10718. deprecated="not deprecated">
  10719. <param name="index" type="int"/>
  10720. </method>
  10721. <method name="equals" return="boolean"
  10722. abstract="false" native="false" synchronized="false"
  10723. static="false" final="false" visibility="public"
  10724. deprecated="not deprecated">
  10725. <param name="obj" type="java.lang.Object"/>
  10726. </method>
  10727. <method name="compareTo" return="int"
  10728. abstract="false" native="false" synchronized="false"
  10729. static="false" final="false" visibility="public"
  10730. deprecated="not deprecated">
  10731. <param name="other" type="org.apache.hadoop.yarn.api.records.Resource"/>
  10732. </method>
  10733. <method name="toString" return="java.lang.String"
  10734. abstract="false" native="false" synchronized="false"
  10735. static="false" final="false" visibility="public"
  10736. deprecated="not deprecated">
  10737. </method>
  10738. <method name="hashCode" return="int"
  10739. abstract="false" native="false" synchronized="false"
  10740. static="false" final="false" visibility="public"
  10741. deprecated="not deprecated">
  10742. </method>
  10743. <method name="castToIntSafely" return="int"
  10744. abstract="false" native="false" synchronized="false"
  10745. static="true" final="false" visibility="protected"
  10746. deprecated="not deprecated">
  10747. <param name="value" type="long"/>
  10748. <doc>
  10749. <![CDATA[Convert long to int for a resource value safely. This method assumes
  10750. resource value is positive.
  10751. @param value long resource value
  10752. @return int resource value]]>
  10753. </doc>
  10754. </method>
  10755. <method name="newDefaultInformation" return="org.apache.hadoop.yarn.api.records.ResourceInformation"
  10756. abstract="false" native="false" synchronized="false"
  10757. static="true" final="false" visibility="protected"
  10758. deprecated="not deprecated">
  10759. <param name="name" type="java.lang.String"/>
  10760. <param name="unit" type="java.lang.String"/>
  10761. <param name="value" type="long"/>
  10762. <doc>
  10763. <![CDATA[Create ResourceInformation with basic fields.
  10764. @param name Resource Type Name
  10765. @param unit Default unit of provided resource type
  10766. @param value Value associated with giveb resource
  10767. @return ResourceInformation object]]>
  10768. </doc>
  10769. </method>
  10770. <field name="resources" type="org.apache.hadoop.yarn.api.records.ResourceInformation[]"
  10771. transient="false" volatile="false"
  10772. static="false" final="false" visibility="protected"
  10773. deprecated="not deprecated">
  10774. </field>
  10775. <field name="NUM_MANDATORY_RESOURCES" type="int"
  10776. transient="false" volatile="false"
  10777. static="true" final="true" visibility="protected"
  10778. deprecated="not deprecated">
  10779. </field>
  10780. <field name="MEMORY_INDEX" type="int"
  10781. transient="false" volatile="false"
  10782. static="true" final="true" visibility="protected"
  10783. deprecated="not deprecated">
  10784. </field>
  10785. <field name="VCORES_INDEX" type="int"
  10786. transient="false" volatile="false"
  10787. static="true" final="true" visibility="protected"
  10788. deprecated="not deprecated">
  10789. </field>
  10790. <doc>
  10791. <![CDATA[<p><code>Resource</code> models a set of computer resources in the
  10792. cluster.</p>
  10793. <p>Currently it models both <em>memory</em> and <em>CPU</em>.</p>
  10794. <p>The unit for memory is megabytes. CPU is modeled with virtual cores
  10795. (vcores), a unit for expressing parallelism. A node's capacity should
  10796. be configured with virtual cores equal to its number of physical cores. A
  10797. container should be requested with the number of cores it can saturate, i.e.
  10798. the average number of threads it expects to have runnable at a time.</p>
  10799. <p>Virtual cores take integer values and thus currently CPU-scheduling is
  10800. very coarse. A complementary axis for CPU requests that represents
  10801. processing power will likely be added in the future to enable finer-grained
  10802. resource configuration.</p>
  10803. <p>Typically, applications request <code>Resource</code> of suitable
  10804. capability to run their component tasks.</p>
  10805. @see ResourceRequest
  10806. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  10807. </doc>
  10808. </class>
  10809. <!-- end class org.apache.hadoop.yarn.api.records.Resource -->
  10810. <!-- start class org.apache.hadoop.yarn.api.records.ResourceAllocationRequest -->
  10811. <class name="ResourceAllocationRequest" extends="java.lang.Object"
  10812. abstract="true"
  10813. static="false" final="false" visibility="public"
  10814. deprecated="not deprecated">
  10815. <constructor name="ResourceAllocationRequest"
  10816. static="false" final="false" visibility="public"
  10817. deprecated="not deprecated">
  10818. </constructor>
  10819. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceAllocationRequest"
  10820. abstract="false" native="false" synchronized="false"
  10821. static="true" final="false" visibility="public"
  10822. deprecated="not deprecated">
  10823. <param name="startTime" type="long"/>
  10824. <param name="endTime" type="long"/>
  10825. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  10826. <doc>
  10827. <![CDATA[@param startTime The start time that the capability is reserved for.
  10828. @param endTime The end time that the capability is reserved for.
  10829. @param capability {@link Resource} representing the capability of the
  10830. resource allocation.
  10831. @return {ResourceAllocationRequest} which represents the capability of
  10832. the resource allocation for a time interval.]]>
  10833. </doc>
  10834. </method>
  10835. <method name="getStartTime" return="long"
  10836. abstract="true" native="false" synchronized="false"
  10837. static="false" final="false" visibility="public"
  10838. deprecated="not deprecated">
  10839. <doc>
  10840. <![CDATA[Get the start time that the resource is allocated.
  10841. @return the start time that the resource is allocated.]]>
  10842. </doc>
  10843. </method>
  10844. <method name="getEndTime" return="long"
  10845. abstract="true" native="false" synchronized="false"
  10846. static="false" final="false" visibility="public"
  10847. deprecated="not deprecated">
  10848. <doc>
  10849. <![CDATA[Get the end time that the resource is allocated.
  10850. @return the end time that the resource is allocated.]]>
  10851. </doc>
  10852. </method>
  10853. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  10854. abstract="true" native="false" synchronized="false"
  10855. static="false" final="false" visibility="public"
  10856. deprecated="not deprecated">
  10857. <doc>
  10858. <![CDATA[Get the allocated resource.
  10859. @return the allocated resource.]]>
  10860. </doc>
  10861. </method>
  10862. <doc>
  10863. <![CDATA[{@code ResourceAllocationRequest} represents an allocation
  10864. made for a reservation for the current state of the plan. This can be
  10865. changed for reasons such as re-planning, but will always be subject to the
  10866. constraints of the user contract as described by
  10867. {@link ReservationDefinition}
  10868. {@link Resource}
  10869. <p>
  10870. It includes:
  10871. <ul>
  10872. <li>StartTime of the allocation.</li>
  10873. <li>EndTime of the allocation.</li>
  10874. <li>{@link Resource} reserved for the allocation.</li>
  10875. </ul>
  10876. @see Resource]]>
  10877. </doc>
  10878. </class>
  10879. <!-- end class org.apache.hadoop.yarn.api.records.ResourceAllocationRequest -->
  10880. <!-- start class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
  10881. <class name="ResourceBlacklistRequest" extends="java.lang.Object"
  10882. abstract="true"
  10883. static="false" final="false" visibility="public"
  10884. deprecated="not deprecated">
  10885. <constructor name="ResourceBlacklistRequest"
  10886. static="false" final="false" visibility="public"
  10887. deprecated="not deprecated">
  10888. </constructor>
  10889. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
  10890. abstract="false" native="false" synchronized="false"
  10891. static="true" final="false" visibility="public"
  10892. deprecated="not deprecated">
  10893. <param name="additions" type="java.util.List"/>
  10894. <param name="removals" type="java.util.List"/>
  10895. </method>
  10896. <method name="getBlacklistAdditions" return="java.util.List"
  10897. abstract="true" native="false" synchronized="false"
  10898. static="false" final="false" visibility="public"
  10899. deprecated="not deprecated">
  10900. <doc>
  10901. <![CDATA[Get the list of resource-names which should be added to the
  10902. application blacklist.
  10903. @return list of resource-names which should be added to the
  10904. application blacklist]]>
  10905. </doc>
  10906. </method>
  10907. <method name="setBlacklistAdditions"
  10908. abstract="true" native="false" synchronized="false"
  10909. static="false" final="false" visibility="public"
  10910. deprecated="not deprecated">
  10911. <param name="resourceNames" type="java.util.List"/>
  10912. <doc>
  10913. <![CDATA[Set list of resource-names which should be added to the application blacklist.
  10914. @param resourceNames list of resource-names which should be added to the
  10915. application blacklist]]>
  10916. </doc>
  10917. </method>
  10918. <method name="getBlacklistRemovals" return="java.util.List"
  10919. abstract="true" native="false" synchronized="false"
  10920. static="false" final="false" visibility="public"
  10921. deprecated="not deprecated">
  10922. <doc>
  10923. <![CDATA[Get the list of resource-names which should be removed from the
  10924. application blacklist.
  10925. @return list of resource-names which should be removed from the
  10926. application blacklist]]>
  10927. </doc>
  10928. </method>
  10929. <method name="setBlacklistRemovals"
  10930. abstract="true" native="false" synchronized="false"
  10931. static="false" final="false" visibility="public"
  10932. deprecated="not deprecated">
  10933. <param name="resourceNames" type="java.util.List"/>
  10934. <doc>
  10935. <![CDATA[Set list of resource-names which should be removed from the
  10936. application blacklist.
  10937. @param resourceNames list of resource-names which should be removed from the
  10938. application blacklist]]>
  10939. </doc>
  10940. </method>
  10941. <doc>
  10942. <![CDATA[{@link ResourceBlacklistRequest} encapsulates the list of resource-names
  10943. which should be added or removed from the <em>blacklist</em> of resources
  10944. for the application.
  10945. @see ResourceRequest
  10946. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  10947. </doc>
  10948. </class>
  10949. <!-- end class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
  10950. <!-- start class org.apache.hadoop.yarn.api.records.ResourceOption -->
  10951. <class name="ResourceOption" extends="java.lang.Object"
  10952. abstract="true"
  10953. static="false" final="false" visibility="public"
  10954. deprecated="not deprecated">
  10955. <constructor name="ResourceOption"
  10956. static="false" final="false" visibility="public"
  10957. deprecated="not deprecated">
  10958. </constructor>
  10959. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceOption"
  10960. abstract="false" native="false" synchronized="false"
  10961. static="true" final="false" visibility="public"
  10962. deprecated="not deprecated">
  10963. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  10964. <param name="overCommitTimeout" type="int"/>
  10965. </method>
  10966. <method name="toString" return="java.lang.String"
  10967. abstract="false" native="false" synchronized="false"
  10968. static="false" final="false" visibility="public"
  10969. deprecated="not deprecated">
  10970. </method>
  10971. <field name="OVER_COMMIT_TIMEOUT_MILLIS_DEFAULT" type="int"
  10972. transient="false" volatile="false"
  10973. static="true" final="true" visibility="public"
  10974. deprecated="not deprecated">
  10975. <doc>
  10976. <![CDATA[Negative value means no timeout.]]>
  10977. </doc>
  10978. </field>
  10979. </class>
  10980. <!-- end class org.apache.hadoop.yarn.api.records.ResourceOption -->
  10981. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest -->
  10982. <class name="ResourceRequest" extends="java.lang.Object"
  10983. abstract="true"
  10984. static="false" final="false" visibility="public"
  10985. deprecated="not deprecated">
  10986. <implements name="java.lang.Comparable"/>
  10987. <constructor name="ResourceRequest"
  10988. static="false" final="false" visibility="public"
  10989. deprecated="not deprecated">
  10990. </constructor>
  10991. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  10992. abstract="false" native="false" synchronized="false"
  10993. static="true" final="false" visibility="public"
  10994. deprecated="not deprecated">
  10995. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  10996. <param name="hostName" type="java.lang.String"/>
  10997. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  10998. <param name="numContainers" type="int"/>
  10999. </method>
  11000. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  11001. abstract="false" native="false" synchronized="false"
  11002. static="true" final="false" visibility="public"
  11003. deprecated="not deprecated">
  11004. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  11005. <param name="hostName" type="java.lang.String"/>
  11006. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11007. <param name="numContainers" type="int"/>
  11008. <param name="relaxLocality" type="boolean"/>
  11009. </method>
  11010. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  11011. abstract="false" native="false" synchronized="false"
  11012. static="true" final="false" visibility="public"
  11013. deprecated="not deprecated">
  11014. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  11015. <param name="hostName" type="java.lang.String"/>
  11016. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11017. <param name="numContainers" type="int"/>
  11018. <param name="relaxLocality" type="boolean"/>
  11019. <param name="labelExpression" type="java.lang.String"/>
  11020. </method>
  11021. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  11022. abstract="false" native="false" synchronized="false"
  11023. static="true" final="false" visibility="public"
  11024. deprecated="not deprecated">
  11025. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  11026. <param name="hostName" type="java.lang.String"/>
  11027. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11028. <param name="numContainers" type="int"/>
  11029. <param name="relaxLocality" type="boolean"/>
  11030. <param name="labelExpression" type="java.lang.String"/>
  11031. <param name="executionTypeRequest" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  11032. </method>
  11033. <method name="clone" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  11034. abstract="false" native="false" synchronized="false"
  11035. static="true" final="false" visibility="public"
  11036. deprecated="not deprecated">
  11037. <param name="rr" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  11038. <doc>
  11039. <![CDATA[Clone a ResourceRequest object (shallow copy). Please keep it loaded with
  11040. all (new) fields
  11041. @param rr the object to copy from
  11042. @return the copied object]]>
  11043. </doc>
  11044. </method>
  11045. <method name="newBuilder" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  11046. abstract="false" native="false" synchronized="false"
  11047. static="true" final="false" visibility="public"
  11048. deprecated="not deprecated">
  11049. </method>
  11050. <method name="isAnyLocation" return="boolean"
  11051. abstract="false" native="false" synchronized="false"
  11052. static="true" final="false" visibility="public"
  11053. deprecated="not deprecated">
  11054. <param name="hostName" type="java.lang.String"/>
  11055. <doc>
  11056. <![CDATA[Check whether the given <em>host/rack</em> string represents an arbitrary
  11057. host name.
  11058. @param hostName <em>host/rack</em> on which the allocation is desired
  11059. @return whether the given <em>host/rack</em> string represents an arbitrary
  11060. host name]]>
  11061. </doc>
  11062. </method>
  11063. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  11064. abstract="true" native="false" synchronized="false"
  11065. static="false" final="false" visibility="public"
  11066. deprecated="not deprecated">
  11067. <doc>
  11068. <![CDATA[Get the <code>Priority</code> of the request.
  11069. @return <code>Priority</code> of the request]]>
  11070. </doc>
  11071. </method>
  11072. <method name="setPriority"
  11073. abstract="true" native="false" synchronized="false"
  11074. static="false" final="false" visibility="public"
  11075. deprecated="not deprecated">
  11076. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  11077. <doc>
  11078. <![CDATA[Set the <code>Priority</code> of the request
  11079. @param priority <code>Priority</code> of the request]]>
  11080. </doc>
  11081. </method>
  11082. <method name="getResourceName" return="java.lang.String"
  11083. abstract="true" native="false" synchronized="false"
  11084. static="false" final="false" visibility="public"
  11085. deprecated="not deprecated">
  11086. <doc>
  11087. <![CDATA[Get the resource (e.g. <em>host/rack</em>) on which the allocation
  11088. is desired.
  11089. A special value of <em>*</em> signifies that <em>any</em> resource
  11090. (host/rack) is acceptable.
  11091. @return resource (e.g. <em>host/rack</em>) on which the allocation
  11092. is desired]]>
  11093. </doc>
  11094. </method>
  11095. <method name="setResourceName"
  11096. abstract="true" native="false" synchronized="false"
  11097. static="false" final="false" visibility="public"
  11098. deprecated="not deprecated">
  11099. <param name="resourceName" type="java.lang.String"/>
  11100. <doc>
  11101. <![CDATA[Set the resource name (e.g. <em>host/rack</em>) on which the allocation
  11102. is desired.
  11103. A special value of <em>*</em> signifies that <em>any</em> resource name
  11104. (e.g. host/rack) is acceptable.
  11105. @param resourceName (e.g. <em>host/rack</em>) on which the
  11106. allocation is desired]]>
  11107. </doc>
  11108. </method>
  11109. <method name="getNumContainers" return="int"
  11110. abstract="true" native="false" synchronized="false"
  11111. static="false" final="false" visibility="public"
  11112. deprecated="not deprecated">
  11113. <doc>
  11114. <![CDATA[Get the number of containers required with the given specifications.
  11115. @return number of containers required with the given specifications]]>
  11116. </doc>
  11117. </method>
  11118. <method name="setNumContainers"
  11119. abstract="true" native="false" synchronized="false"
  11120. static="false" final="false" visibility="public"
  11121. deprecated="not deprecated">
  11122. <param name="numContainers" type="int"/>
  11123. <doc>
  11124. <![CDATA[Set the number of containers required with the given specifications
  11125. @param numContainers number of containers required with the given
  11126. specifications]]>
  11127. </doc>
  11128. </method>
  11129. <method name="getRelaxLocality" return="boolean"
  11130. abstract="true" native="false" synchronized="false"
  11131. static="false" final="false" visibility="public"
  11132. deprecated="not deprecated">
  11133. <doc>
  11134. <![CDATA[Get whether locality relaxation is enabled with this
  11135. <code>ResourceRequest</code>. Defaults to true.
  11136. @return whether locality relaxation is enabled with this
  11137. <code>ResourceRequest</code>.]]>
  11138. </doc>
  11139. </method>
  11140. <method name="setExecutionTypeRequest"
  11141. abstract="false" native="false" synchronized="false"
  11142. static="false" final="false" visibility="public"
  11143. deprecated="not deprecated">
  11144. <param name="execSpec" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  11145. <doc>
  11146. <![CDATA[Set the <code>ExecutionTypeRequest</code> of the requested container.
  11147. @param execSpec
  11148. ExecutionTypeRequest of the requested container]]>
  11149. </doc>
  11150. </method>
  11151. <method name="getExecutionTypeRequest" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
  11152. abstract="false" native="false" synchronized="false"
  11153. static="false" final="false" visibility="public"
  11154. deprecated="not deprecated">
  11155. <doc>
  11156. <![CDATA[Get whether locality relaxation is enabled with this
  11157. <code>ResourceRequest</code>. Defaults to true.
  11158. @return whether locality relaxation is enabled with this
  11159. <code>ResourceRequest</code>.]]>
  11160. </doc>
  11161. </method>
  11162. <method name="setRelaxLocality"
  11163. abstract="true" native="false" synchronized="false"
  11164. static="false" final="false" visibility="public"
  11165. deprecated="not deprecated">
  11166. <param name="relaxLocality" type="boolean"/>
  11167. <doc>
  11168. <![CDATA[<p>For a request at a network hierarchy level, set whether locality can be relaxed
  11169. to that level and beyond.<p>
  11170. <p>If the flag is off on a rack-level <code>ResourceRequest</code>,
  11171. containers at that request's priority will not be assigned to nodes on that
  11172. request's rack unless requests specifically for those nodes have also been
  11173. submitted.<p>
  11174. <p>If the flag is off on an {@link ResourceRequest#ANY}-level
  11175. <code>ResourceRequest</code>, containers at that request's priority will
  11176. only be assigned on racks for which specific requests have also been
  11177. submitted.<p>
  11178. <p>For example, to request a container strictly on a specific node, the
  11179. corresponding rack-level and any-level requests should have locality
  11180. relaxation set to false. Similarly, to request a container strictly on a
  11181. specific rack, the corresponding any-level request should have locality
  11182. relaxation set to false.<p>
  11183. @param relaxLocality whether locality relaxation is enabled with this
  11184. <code>ResourceRequest</code>.]]>
  11185. </doc>
  11186. </method>
  11187. <method name="getNodeLabelExpression" return="java.lang.String"
  11188. abstract="true" native="false" synchronized="false"
  11189. static="false" final="false" visibility="public"
  11190. deprecated="not deprecated">
  11191. <doc>
  11192. <![CDATA[Get node-label-expression for this Resource Request. If this is set, all
  11193. containers allocated to satisfy this resource-request will be only on those
  11194. nodes that satisfy this node-label-expression.
  11195. Please note that node label expression now can only take effect when the
  11196. resource request has resourceName = ANY
  11197. @return node-label-expression]]>
  11198. </doc>
  11199. </method>
  11200. <method name="setNodeLabelExpression"
  11201. abstract="true" native="false" synchronized="false"
  11202. static="false" final="false" visibility="public"
  11203. deprecated="not deprecated">
  11204. <param name="nodelabelExpression" type="java.lang.String"/>
  11205. <doc>
  11206. <![CDATA[Set node label expression of this resource request. Now only support
  11207. specifying a single node label. In the future we will support more complex
  11208. node label expression specification like {@code AND(&&), OR(||)}, etc.
  11209. Any please note that node label expression now can only take effect when
  11210. the resource request has resourceName = ANY
  11211. @param nodelabelExpression
  11212. node-label-expression of this ResourceRequest]]>
  11213. </doc>
  11214. </method>
  11215. <method name="getAllocationRequestId" return="long"
  11216. abstract="false" native="false" synchronized="false"
  11217. static="false" final="false" visibility="public"
  11218. deprecated="not deprecated">
  11219. <doc>
  11220. <![CDATA[Get the optional <em>ID</em> corresponding to this allocation request. This
  11221. ID is an identifier for different {@code ResourceRequest}s from the <b>same
  11222. application</b>. The allocated {@code Container}(s) received as part of the
  11223. {@code AllocateResponse} response will have the ID corresponding to the
  11224. original {@code ResourceRequest} for which the RM made the allocation.
  11225. <p>
  11226. The scheduler may return multiple {@code AllocateResponse}s corresponding
  11227. to the same ID as and when scheduler allocates {@code Container}(s).
  11228. <b>Applications</b> can continue to completely ignore the returned ID in
  11229. the response and use the allocation for any of their outstanding requests.
  11230. <p>
  11231. If one wishes to replace an entire {@code ResourceRequest} corresponding to
  11232. a specific ID, they can simply cancel the corresponding {@code
  11233. ResourceRequest} and submit a new one afresh.
  11234. @return the <em>ID</em> corresponding to this allocation request.]]>
  11235. </doc>
  11236. </method>
  11237. <method name="setAllocationRequestId"
  11238. abstract="false" native="false" synchronized="false"
  11239. static="false" final="false" visibility="public"
  11240. deprecated="not deprecated">
  11241. <param name="allocationRequestID" type="long"/>
  11242. <doc>
  11243. <![CDATA[Set the optional <em>ID</em> corresponding to this allocation request. This
  11244. ID is an identifier for different {@code ResourceRequest}s from the <b>same
  11245. application</b>. The allocated {@code Container}(s) received as part of the
  11246. {@code AllocateResponse} response will have the ID corresponding to the
  11247. original {@code ResourceRequest} for which the RM made the allocation.
  11248. <p>
  11249. The scheduler may return multiple {@code AllocateResponse}s corresponding
  11250. to the same ID as and when scheduler allocates {@code Container}(s).
  11251. <b>Applications</b> can continue to completely ignore the returned ID in
  11252. the response and use the allocation for any of their outstanding requests.
  11253. <p>
  11254. If one wishes to replace an entire {@code ResourceRequest} corresponding to
  11255. a specific ID, they can simply cancel the corresponding {@code
  11256. ResourceRequest} and submit a new one afresh.
  11257. <p>
  11258. If the ID is not set, scheduler will continue to work as previously and all
  11259. allocated {@code Container}(s) will have the default ID, -1.
  11260. @param allocationRequestID the <em>ID</em> corresponding to this allocation
  11261. request.]]>
  11262. </doc>
  11263. </method>
  11264. <method name="setCapability"
  11265. abstract="true" native="false" synchronized="false"
  11266. static="false" final="false" visibility="public"
  11267. deprecated="not deprecated">
  11268. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11269. <doc>
  11270. <![CDATA[Set the <code>Resource</code> capability of the request.
  11271. @param capability <code>Resource</code> capability of the request]]>
  11272. </doc>
  11273. </method>
  11274. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  11275. abstract="true" native="false" synchronized="false"
  11276. static="false" final="false" visibility="public"
  11277. deprecated="not deprecated">
  11278. <doc>
  11279. <![CDATA[Get the <code>Resource</code> capability of the request.
  11280. @return <code>Resource</code> capability of the request]]>
  11281. </doc>
  11282. </method>
  11283. <method name="hashCode" return="int"
  11284. abstract="false" native="false" synchronized="false"
  11285. static="false" final="false" visibility="public"
  11286. deprecated="not deprecated">
  11287. </method>
  11288. <method name="equals" return="boolean"
  11289. abstract="false" native="false" synchronized="false"
  11290. static="false" final="false" visibility="public"
  11291. deprecated="not deprecated">
  11292. <param name="obj" type="java.lang.Object"/>
  11293. </method>
  11294. <method name="compareTo" return="int"
  11295. abstract="false" native="false" synchronized="false"
  11296. static="false" final="false" visibility="public"
  11297. deprecated="not deprecated">
  11298. <param name="other" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  11299. </method>
  11300. <field name="ANY" type="java.lang.String"
  11301. transient="false" volatile="false"
  11302. static="true" final="true" visibility="public"
  11303. deprecated="not deprecated">
  11304. <doc>
  11305. <![CDATA[The constant string representing no locality.
  11306. It should be used by all references that want to pass an arbitrary host
  11307. name in.]]>
  11308. </doc>
  11309. </field>
  11310. <doc>
  11311. <![CDATA[{@code ResourceRequest} represents the request made
  11312. by an application to the {@code ResourceManager}
  11313. to obtain various {@code Container} allocations.
  11314. <p>
  11315. It includes:
  11316. <ul>
  11317. <li>{@link Priority} of the request.</li>
  11318. <li>
  11319. The <em>name</em> of the host or rack on which the allocation is
  11320. desired. A special value of <em>*</em> signifies that
  11321. <em>any</em> host/rack is acceptable to the application.
  11322. </li>
  11323. <li>{@link Resource} required for each request.</li>
  11324. <li>
  11325. Number of containers, of above specifications, which are required
  11326. by the application.
  11327. </li>
  11328. <li>
  11329. A boolean <em>relaxLocality</em> flag, defaulting to {@code true},
  11330. which tells the {@code ResourceManager} if the application wants
  11331. locality to be loose (i.e. allows fall-through to rack or <em>any</em>)
  11332. or strict (i.e. specify hard constraint on resource allocation).
  11333. </li>
  11334. </ul>
  11335. @see Resource
  11336. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  11337. </doc>
  11338. </class>
  11339. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest -->
  11340. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder -->
  11341. <class name="ResourceRequest.ResourceRequestBuilder" extends="java.lang.Object"
  11342. abstract="false"
  11343. static="true" final="true" visibility="public"
  11344. deprecated="not deprecated">
  11345. <method name="priority" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  11346. abstract="false" native="false" synchronized="false"
  11347. static="false" final="false" visibility="public"
  11348. deprecated="not deprecated">
  11349. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  11350. <doc>
  11351. <![CDATA[Set the <code>priority</code> of the request.
  11352. @see ResourceRequest#setPriority(Priority)
  11353. @param priority <code>priority</code> of the request
  11354. @return {@link ResourceRequestBuilder}]]>
  11355. </doc>
  11356. </method>
  11357. <method name="resourceName" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  11358. abstract="false" native="false" synchronized="false"
  11359. static="false" final="false" visibility="public"
  11360. deprecated="not deprecated">
  11361. <param name="resourceName" type="java.lang.String"/>
  11362. <doc>
  11363. <![CDATA[Set the <code>resourceName</code> of the request.
  11364. @see ResourceRequest#setResourceName(String)
  11365. @param resourceName <code>resourceName</code> of the request
  11366. @return {@link ResourceRequestBuilder}]]>
  11367. </doc>
  11368. </method>
  11369. <method name="capability" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  11370. abstract="false" native="false" synchronized="false"
  11371. static="false" final="false" visibility="public"
  11372. deprecated="not deprecated">
  11373. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11374. <doc>
  11375. <![CDATA[Set the <code>capability</code> of the request.
  11376. @see ResourceRequest#setCapability(Resource)
  11377. @param capability <code>capability</code> of the request
  11378. @return {@link ResourceRequestBuilder}]]>
  11379. </doc>
  11380. </method>
  11381. <method name="numContainers" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  11382. abstract="false" native="false" synchronized="false"
  11383. static="false" final="false" visibility="public"
  11384. deprecated="not deprecated">
  11385. <param name="numContainers" type="int"/>
  11386. <doc>
  11387. <![CDATA[Set the <code>numContainers</code> of the request.
  11388. @see ResourceRequest#setNumContainers(int)
  11389. @param numContainers <code>numContainers</code> of the request
  11390. @return {@link ResourceRequestBuilder}]]>
  11391. </doc>
  11392. </method>
  11393. <method name="relaxLocality" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  11394. abstract="false" native="false" synchronized="false"
  11395. static="false" final="false" visibility="public"
  11396. deprecated="not deprecated">
  11397. <param name="relaxLocality" type="boolean"/>
  11398. <doc>
  11399. <![CDATA[Set the <code>relaxLocality</code> of the request.
  11400. @see ResourceRequest#setRelaxLocality(boolean)
  11401. @param relaxLocality <code>relaxLocality</code> of the request
  11402. @return {@link ResourceRequestBuilder}]]>
  11403. </doc>
  11404. </method>
  11405. <method name="nodeLabelExpression" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  11406. abstract="false" native="false" synchronized="false"
  11407. static="false" final="false" visibility="public"
  11408. deprecated="not deprecated">
  11409. <param name="nodeLabelExpression" type="java.lang.String"/>
  11410. <doc>
  11411. <![CDATA[Set the <code>nodeLabelExpression</code> of the request.
  11412. @see ResourceRequest#setNodeLabelExpression(String)
  11413. @param nodeLabelExpression
  11414. <code>nodeLabelExpression</code> of the request
  11415. @return {@link ResourceRequestBuilder}]]>
  11416. </doc>
  11417. </method>
  11418. <method name="executionTypeRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  11419. abstract="false" native="false" synchronized="false"
  11420. static="false" final="false" visibility="public"
  11421. deprecated="not deprecated">
  11422. <param name="executionTypeRequest" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
  11423. <doc>
  11424. <![CDATA[Set the <code>executionTypeRequest</code> of the request.
  11425. @see ResourceRequest#setExecutionTypeRequest(
  11426. ExecutionTypeRequest)
  11427. @param executionTypeRequest
  11428. <code>executionTypeRequest</code> of the request
  11429. @return {@link ResourceRequestBuilder}]]>
  11430. </doc>
  11431. </method>
  11432. <method name="executionType" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  11433. abstract="false" native="false" synchronized="false"
  11434. static="false" final="false" visibility="public"
  11435. deprecated="not deprecated">
  11436. <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  11437. <doc>
  11438. <![CDATA[Set the <code>executionTypeRequest</code> of the request with 'ensure
  11439. execution type' flag set to true.
  11440. @see ResourceRequest#setExecutionTypeRequest(
  11441. ExecutionTypeRequest)
  11442. @param executionType <code>executionType</code> of the request.
  11443. @return {@link ResourceRequestBuilder}]]>
  11444. </doc>
  11445. </method>
  11446. <method name="allocationRequestId" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
  11447. abstract="false" native="false" synchronized="false"
  11448. static="false" final="false" visibility="public"
  11449. deprecated="not deprecated">
  11450. <param name="allocationRequestId" type="long"/>
  11451. <doc>
  11452. <![CDATA[Set the <code>allocationRequestId</code> of the request.
  11453. @see ResourceRequest#setAllocationRequestId(long)
  11454. @param allocationRequestId
  11455. <code>allocationRequestId</code> of the request
  11456. @return {@link ResourceRequestBuilder}]]>
  11457. </doc>
  11458. </method>
  11459. <method name="build" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  11460. abstract="false" native="false" synchronized="false"
  11461. static="false" final="false" visibility="public"
  11462. deprecated="not deprecated">
  11463. <doc>
  11464. <![CDATA[Return generated {@link ResourceRequest} object.
  11465. @return {@link ResourceRequest}]]>
  11466. </doc>
  11467. </method>
  11468. <doc>
  11469. <![CDATA[Class to construct instances of {@link ResourceRequest} with specific
  11470. options.]]>
  11471. </doc>
  11472. </class>
  11473. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder -->
  11474. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
  11475. <class name="ResourceRequest.ResourceRequestComparator" extends="java.lang.Object"
  11476. abstract="false"
  11477. static="true" final="false" visibility="public"
  11478. deprecated="not deprecated">
  11479. <implements name="java.util.Comparator"/>
  11480. <implements name="java.io.Serializable"/>
  11481. <constructor name="ResourceRequest.ResourceRequestComparator"
  11482. static="false" final="false" visibility="public"
  11483. deprecated="not deprecated">
  11484. </constructor>
  11485. <method name="compare" return="int"
  11486. abstract="false" native="false" synchronized="false"
  11487. static="false" final="false" visibility="public"
  11488. deprecated="not deprecated">
  11489. <param name="r1" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  11490. <param name="r2" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  11491. </method>
  11492. </class>
  11493. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
  11494. <!-- start class org.apache.hadoop.yarn.api.records.ResourceUtilization -->
  11495. <class name="ResourceUtilization" extends="java.lang.Object"
  11496. abstract="true"
  11497. static="false" final="false" visibility="public"
  11498. deprecated="not deprecated">
  11499. <implements name="java.lang.Comparable"/>
  11500. <constructor name="ResourceUtilization"
  11501. static="false" final="false" visibility="public"
  11502. deprecated="not deprecated">
  11503. </constructor>
  11504. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  11505. abstract="false" native="false" synchronized="false"
  11506. static="true" final="false" visibility="public"
  11507. deprecated="not deprecated">
  11508. <param name="pmem" type="int"/>
  11509. <param name="vmem" type="int"/>
  11510. <param name="cpu" type="float"/>
  11511. </method>
  11512. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
  11513. abstract="false" native="false" synchronized="false"
  11514. static="true" final="false" visibility="public"
  11515. deprecated="not deprecated">
  11516. <param name="resourceUtil" type="org.apache.hadoop.yarn.api.records.ResourceUtilization"/>
  11517. </method>
  11518. <method name="getVirtualMemory" return="int"
  11519. abstract="true" native="false" synchronized="false"
  11520. static="false" final="false" visibility="public"
  11521. deprecated="not deprecated">
  11522. <doc>
  11523. <![CDATA[Get used <em>virtual memory</em>.
  11524. @return <em>virtual memory</em> in MB]]>
  11525. </doc>
  11526. </method>
  11527. <method name="setVirtualMemory"
  11528. abstract="true" native="false" synchronized="false"
  11529. static="false" final="false" visibility="public"
  11530. deprecated="not deprecated">
  11531. <param name="vmem" type="int"/>
  11532. <doc>
  11533. <![CDATA[Set used <em>virtual memory</em>.
  11534. @param vmem <em>virtual memory</em> in MB]]>
  11535. </doc>
  11536. </method>
  11537. <method name="getPhysicalMemory" return="int"
  11538. abstract="true" native="false" synchronized="false"
  11539. static="false" final="false" visibility="public"
  11540. deprecated="not deprecated">
  11541. <doc>
  11542. <![CDATA[Get <em>physical memory</em>.
  11543. @return <em>physical memory</em> in MB]]>
  11544. </doc>
  11545. </method>
  11546. <method name="setPhysicalMemory"
  11547. abstract="true" native="false" synchronized="false"
  11548. static="false" final="false" visibility="public"
  11549. deprecated="not deprecated">
  11550. <param name="pmem" type="int"/>
  11551. <doc>
  11552. <![CDATA[Set <em>physical memory</em>.
  11553. @param pmem <em>physical memory</em> in MB]]>
  11554. </doc>
  11555. </method>
  11556. <method name="getCPU" return="float"
  11557. abstract="true" native="false" synchronized="false"
  11558. static="false" final="false" visibility="public"
  11559. deprecated="not deprecated">
  11560. <doc>
  11561. <![CDATA[Get <em>CPU</em> utilization.
  11562. @return <em>CPU utilization</em> normalized to 1 CPU]]>
  11563. </doc>
  11564. </method>
  11565. <method name="setCPU"
  11566. abstract="true" native="false" synchronized="false"
  11567. static="false" final="false" visibility="public"
  11568. deprecated="not deprecated">
  11569. <param name="cpu" type="float"/>
  11570. <doc>
  11571. <![CDATA[Set <em>CPU</em> utilization.
  11572. @param cpu <em>CPU utilization</em> normalized to 1 CPU]]>
  11573. </doc>
  11574. </method>
  11575. <method name="hashCode" return="int"
  11576. abstract="false" native="false" synchronized="false"
  11577. static="false" final="false" visibility="public"
  11578. deprecated="not deprecated">
  11579. </method>
  11580. <method name="equals" return="boolean"
  11581. abstract="false" native="false" synchronized="false"
  11582. static="false" final="false" visibility="public"
  11583. deprecated="not deprecated">
  11584. <param name="obj" type="java.lang.Object"/>
  11585. </method>
  11586. <method name="toString" return="java.lang.String"
  11587. abstract="false" native="false" synchronized="false"
  11588. static="false" final="false" visibility="public"
  11589. deprecated="not deprecated">
  11590. </method>
  11591. <method name="addTo"
  11592. abstract="false" native="false" synchronized="false"
  11593. static="false" final="false" visibility="public"
  11594. deprecated="not deprecated">
  11595. <param name="pmem" type="int"/>
  11596. <param name="vmem" type="int"/>
  11597. <param name="cpu" type="float"/>
  11598. <doc>
  11599. <![CDATA[Add utilization to the current one.
  11600. @param pmem Physical memory used to add.
  11601. @param vmem Virtual memory used to add.
  11602. @param cpu CPU utilization to add.]]>
  11603. </doc>
  11604. </method>
  11605. <method name="subtractFrom"
  11606. abstract="false" native="false" synchronized="false"
  11607. static="false" final="false" visibility="public"
  11608. deprecated="not deprecated">
  11609. <param name="pmem" type="int"/>
  11610. <param name="vmem" type="int"/>
  11611. <param name="cpu" type="float"/>
  11612. <doc>
  11613. <![CDATA[Subtract utilization from the current one.
  11614. @param pmem Physical memory to be subtracted.
  11615. @param vmem Virtual memory to be subtracted.
  11616. @param cpu CPU utilization to be subtracted.]]>
  11617. </doc>
  11618. </method>
  11619. <doc>
  11620. <![CDATA[<p>
  11621. <code>ResourceUtilization</code> models the utilization of a set of computer
  11622. resources in the cluster.
  11623. </p>]]>
  11624. </doc>
  11625. </class>
  11626. <!-- end class org.apache.hadoop.yarn.api.records.ResourceUtilization -->
  11627. <!-- start class org.apache.hadoop.yarn.api.records.SignalContainerCommand -->
  11628. <class name="SignalContainerCommand" extends="java.lang.Enum"
  11629. abstract="false"
  11630. static="false" final="true" visibility="public"
  11631. deprecated="not deprecated">
  11632. <method name="values" return="org.apache.hadoop.yarn.api.records.SignalContainerCommand[]"
  11633. abstract="false" native="false" synchronized="false"
  11634. static="true" final="false" visibility="public"
  11635. deprecated="not deprecated">
  11636. </method>
  11637. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.SignalContainerCommand"
  11638. abstract="false" native="false" synchronized="false"
  11639. static="true" final="false" visibility="public"
  11640. deprecated="not deprecated">
  11641. <param name="name" type="java.lang.String"/>
  11642. </method>
  11643. <doc>
  11644. <![CDATA[Enumeration of various signal container commands.]]>
  11645. </doc>
  11646. </class>
  11647. <!-- end class org.apache.hadoop.yarn.api.records.SignalContainerCommand -->
  11648. <!-- start class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
  11649. <class name="StrictPreemptionContract" extends="java.lang.Object"
  11650. abstract="true"
  11651. static="false" final="false" visibility="public"
  11652. deprecated="not deprecated">
  11653. <constructor name="StrictPreemptionContract"
  11654. static="false" final="false" visibility="public"
  11655. deprecated="not deprecated">
  11656. </constructor>
  11657. <method name="getContainers" return="java.util.Set"
  11658. abstract="true" native="false" synchronized="false"
  11659. static="false" final="false" visibility="public"
  11660. deprecated="not deprecated">
  11661. <doc>
  11662. <![CDATA[Get the set of {@link PreemptionContainer} specifying containers owned by
  11663. the <code>ApplicationMaster</code> that may be reclaimed by the
  11664. <code>ResourceManager</code>.
  11665. @return the set of {@link ContainerId} to be preempted.]]>
  11666. </doc>
  11667. </method>
  11668. <doc>
  11669. <![CDATA[Enumeration of particular allocations to be reclaimed. The platform will
  11670. reclaim exactly these resources, so the <code>ApplicationMaster</code> (AM)
  11671. may attempt to checkpoint work or adjust its execution plan to accommodate
  11672. it. In contrast to {@link PreemptionContract}, the AM has no flexibility in
  11673. selecting which resources to return to the cluster.
  11674. @see PreemptionMessage]]>
  11675. </doc>
  11676. </class>
  11677. <!-- end class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
  11678. <!-- start class org.apache.hadoop.yarn.api.records.Token -->
  11679. <class name="Token" extends="java.lang.Object"
  11680. abstract="true"
  11681. static="false" final="false" visibility="public"
  11682. deprecated="not deprecated">
  11683. <constructor name="Token"
  11684. static="false" final="false" visibility="public"
  11685. deprecated="not deprecated">
  11686. </constructor>
  11687. <method name="getIdentifier" return="java.nio.ByteBuffer"
  11688. abstract="true" native="false" synchronized="false"
  11689. static="false" final="false" visibility="public"
  11690. deprecated="not deprecated">
  11691. <doc>
  11692. <![CDATA[Get the token identifier.
  11693. @return token identifier]]>
  11694. </doc>
  11695. </method>
  11696. <method name="getPassword" return="java.nio.ByteBuffer"
  11697. abstract="true" native="false" synchronized="false"
  11698. static="false" final="false" visibility="public"
  11699. deprecated="not deprecated">
  11700. <doc>
  11701. <![CDATA[Get the token password
  11702. @return token password]]>
  11703. </doc>
  11704. </method>
  11705. <method name="getKind" return="java.lang.String"
  11706. abstract="true" native="false" synchronized="false"
  11707. static="false" final="false" visibility="public"
  11708. deprecated="not deprecated">
  11709. <doc>
  11710. <![CDATA[Get the token kind.
  11711. @return token kind]]>
  11712. </doc>
  11713. </method>
  11714. <method name="getService" return="java.lang.String"
  11715. abstract="true" native="false" synchronized="false"
  11716. static="false" final="false" visibility="public"
  11717. deprecated="not deprecated">
  11718. <doc>
  11719. <![CDATA[Get the service to which the token is allocated.
  11720. @return service to which the token is allocated]]>
  11721. </doc>
  11722. </method>
  11723. <doc>
  11724. <![CDATA[<p><code>Token</code> is the security entity used by the framework
  11725. to verify authenticity of any resource.</p>]]>
  11726. </doc>
  11727. </class>
  11728. <!-- end class org.apache.hadoop.yarn.api.records.Token -->
  11729. <!-- start class org.apache.hadoop.yarn.api.records.UpdateContainerError -->
  11730. <class name="UpdateContainerError" extends="java.lang.Object"
  11731. abstract="true"
  11732. static="false" final="false" visibility="public"
  11733. deprecated="not deprecated">
  11734. <constructor name="UpdateContainerError"
  11735. static="false" final="false" visibility="public"
  11736. deprecated="not deprecated">
  11737. </constructor>
  11738. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdateContainerError"
  11739. abstract="false" native="false" synchronized="false"
  11740. static="true" final="false" visibility="public"
  11741. deprecated="not deprecated">
  11742. <param name="reason" type="java.lang.String"/>
  11743. <param name="updateContainerRequest" type="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"/>
  11744. </method>
  11745. <method name="getReason" return="java.lang.String"
  11746. abstract="true" native="false" synchronized="false"
  11747. static="false" final="false" visibility="public"
  11748. deprecated="not deprecated">
  11749. <doc>
  11750. <![CDATA[Get reason why the update request was not satisfiable.
  11751. @return Reason]]>
  11752. </doc>
  11753. </method>
  11754. <method name="setReason"
  11755. abstract="true" native="false" synchronized="false"
  11756. static="false" final="false" visibility="public"
  11757. deprecated="not deprecated">
  11758. <param name="reason" type="java.lang.String"/>
  11759. <doc>
  11760. <![CDATA[Set reason why the update request was not satisfiable.
  11761. @param reason Reason]]>
  11762. </doc>
  11763. </method>
  11764. <method name="getCurrentContainerVersion" return="int"
  11765. abstract="true" native="false" synchronized="false"
  11766. static="false" final="false" visibility="public"
  11767. deprecated="not deprecated">
  11768. <doc>
  11769. <![CDATA[Get current container version.
  11770. @return Current container Version.]]>
  11771. </doc>
  11772. </method>
  11773. <method name="setCurrentContainerVersion"
  11774. abstract="true" native="false" synchronized="false"
  11775. static="false" final="false" visibility="public"
  11776. deprecated="not deprecated">
  11777. <param name="currentVersion" type="int"/>
  11778. <doc>
  11779. <![CDATA[Set current container version.
  11780. @param currentVersion Current container version.]]>
  11781. </doc>
  11782. </method>
  11783. <method name="getUpdateContainerRequest" return="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"
  11784. abstract="true" native="false" synchronized="false"
  11785. static="false" final="false" visibility="public"
  11786. deprecated="not deprecated">
  11787. <doc>
  11788. <![CDATA[Get the {@code UpdateContainerRequest} that was not satisfiable.
  11789. @return UpdateContainerRequest]]>
  11790. </doc>
  11791. </method>
  11792. <method name="setUpdateContainerRequest"
  11793. abstract="true" native="false" synchronized="false"
  11794. static="false" final="false" visibility="public"
  11795. deprecated="not deprecated">
  11796. <param name="updateContainerRequest" type="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"/>
  11797. <doc>
  11798. <![CDATA[Set the {@code UpdateContainerRequest} that was not satisfiable.
  11799. @param updateContainerRequest Update Container Request]]>
  11800. </doc>
  11801. </method>
  11802. <method name="hashCode" return="int"
  11803. abstract="false" native="false" synchronized="false"
  11804. static="false" final="false" visibility="public"
  11805. deprecated="not deprecated">
  11806. </method>
  11807. <method name="toString" return="java.lang.String"
  11808. abstract="false" native="false" synchronized="false"
  11809. static="false" final="false" visibility="public"
  11810. deprecated="not deprecated">
  11811. </method>
  11812. <method name="equals" return="boolean"
  11813. abstract="false" native="false" synchronized="false"
  11814. static="false" final="false" visibility="public"
  11815. deprecated="not deprecated">
  11816. <param name="obj" type="java.lang.Object"/>
  11817. </method>
  11818. <doc>
  11819. <![CDATA[{@code UpdateContainerError} is used by the Scheduler to notify the
  11820. ApplicationMaster of an UpdateContainerRequest it cannot satisfy due to
  11821. an error in the request. It includes the update request as well as
  11822. a reason for why the request was not satisfiable.]]>
  11823. </doc>
  11824. </class>
  11825. <!-- end class org.apache.hadoop.yarn.api.records.UpdateContainerError -->
  11826. <!-- start class org.apache.hadoop.yarn.api.records.UpdateContainerRequest -->
  11827. <class name="UpdateContainerRequest" extends="java.lang.Object"
  11828. abstract="true"
  11829. static="false" final="false" visibility="public"
  11830. deprecated="not deprecated">
  11831. <constructor name="UpdateContainerRequest"
  11832. static="false" final="false" visibility="public"
  11833. deprecated="not deprecated">
  11834. </constructor>
  11835. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"
  11836. abstract="false" native="false" synchronized="false"
  11837. static="true" final="false" visibility="public"
  11838. deprecated="not deprecated">
  11839. <param name="version" type="int"/>
  11840. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  11841. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  11842. <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11843. <param name="targetExecutionType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  11844. </method>
  11845. <method name="getContainerVersion" return="int"
  11846. abstract="true" native="false" synchronized="false"
  11847. static="false" final="false" visibility="public"
  11848. deprecated="not deprecated">
  11849. <doc>
  11850. <![CDATA[Get the <code>ContainerId</code> of the container.
  11851. @return <code>ContainerId</code> of the container]]>
  11852. </doc>
  11853. </method>
  11854. <method name="setContainerVersion"
  11855. abstract="true" native="false" synchronized="false"
  11856. static="false" final="false" visibility="public"
  11857. deprecated="not deprecated">
  11858. <param name="containerVersion" type="int"/>
  11859. <doc>
  11860. <![CDATA[Set the current version of the container.
  11861. @param containerVersion of the container]]>
  11862. </doc>
  11863. </method>
  11864. <method name="getContainerUpdateType" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType"
  11865. abstract="true" native="false" synchronized="false"
  11866. static="false" final="false" visibility="public"
  11867. deprecated="not deprecated">
  11868. <doc>
  11869. <![CDATA[Get the <code>ContainerUpdateType</code> of the container.
  11870. @return <code>ContainerUpdateType</code> of the container.]]>
  11871. </doc>
  11872. </method>
  11873. <method name="setContainerUpdateType"
  11874. abstract="true" native="false" synchronized="false"
  11875. static="false" final="false" visibility="public"
  11876. deprecated="not deprecated">
  11877. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  11878. <doc>
  11879. <![CDATA[Set the <code>ContainerUpdateType</code> of the container.
  11880. @param updateType of the Container]]>
  11881. </doc>
  11882. </method>
  11883. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  11884. abstract="true" native="false" synchronized="false"
  11885. static="false" final="false" visibility="public"
  11886. deprecated="not deprecated">
  11887. <doc>
  11888. <![CDATA[Get the <code>ContainerId</code> of the container.
  11889. @return <code>ContainerId</code> of the container]]>
  11890. </doc>
  11891. </method>
  11892. <method name="setContainerId"
  11893. abstract="true" native="false" synchronized="false"
  11894. static="false" final="false" visibility="public"
  11895. deprecated="not deprecated">
  11896. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  11897. <doc>
  11898. <![CDATA[Set the <code>ContainerId</code> of the container.
  11899. @param containerId <code>ContainerId</code> of the container]]>
  11900. </doc>
  11901. </method>
  11902. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  11903. abstract="true" native="false" synchronized="false"
  11904. static="false" final="false" visibility="public"
  11905. deprecated="not deprecated">
  11906. <doc>
  11907. <![CDATA[Get the target <code>ExecutionType</code> of the container.
  11908. @return <code>ExecutionType</code> of the container]]>
  11909. </doc>
  11910. </method>
  11911. <method name="setExecutionType"
  11912. abstract="true" native="false" synchronized="false"
  11913. static="false" final="false" visibility="public"
  11914. deprecated="not deprecated">
  11915. <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
  11916. <doc>
  11917. <![CDATA[Set the target <code>ExecutionType</code> of the container.
  11918. @param executionType <code>ExecutionType</code> of the container]]>
  11919. </doc>
  11920. </method>
  11921. <method name="setCapability"
  11922. abstract="true" native="false" synchronized="false"
  11923. static="false" final="false" visibility="public"
  11924. deprecated="not deprecated">
  11925. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  11926. <doc>
  11927. <![CDATA[Set the <code>Resource</code> capability of the request.
  11928. @param capability <code>Resource</code> capability of the request]]>
  11929. </doc>
  11930. </method>
  11931. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  11932. abstract="true" native="false" synchronized="false"
  11933. static="false" final="false" visibility="public"
  11934. deprecated="not deprecated">
  11935. <doc>
  11936. <![CDATA[Get the <code>Resource</code> capability of the request.
  11937. @return <code>Resource</code> capability of the request]]>
  11938. </doc>
  11939. </method>
  11940. <method name="hashCode" return="int"
  11941. abstract="false" native="false" synchronized="false"
  11942. static="false" final="false" visibility="public"
  11943. deprecated="not deprecated">
  11944. </method>
  11945. <method name="toString" return="java.lang.String"
  11946. abstract="false" native="false" synchronized="false"
  11947. static="false" final="false" visibility="public"
  11948. deprecated="not deprecated">
  11949. </method>
  11950. <method name="equals" return="boolean"
  11951. abstract="false" native="false" synchronized="false"
  11952. static="false" final="false" visibility="public"
  11953. deprecated="not deprecated">
  11954. <param name="obj" type="java.lang.Object"/>
  11955. </method>
  11956. <doc>
  11957. <![CDATA[{@code UpdateContainerRequest} represents the request made by an
  11958. application to the {@code ResourceManager} to update an attribute of a
  11959. {@code Container} such as its Resource allocation or (@code ExecutionType}
  11960. <p>
  11961. It includes:
  11962. <ul>
  11963. <li>version for the container.</li>
  11964. <li>{@link ContainerId} for the container.</li>
  11965. <li>
  11966. {@link Resource} capability of the container after the update request
  11967. is completed.
  11968. </li>
  11969. <li>
  11970. {@link ExecutionType} of the container after the update request is
  11971. completed.
  11972. </li>
  11973. </ul>
  11974. Update rules:
  11975. <ul>
  11976. <li>
  11977. Currently only ONE aspect of the container can be updated per request
  11978. (user can either update Capability OR ExecutionType in one request..
  11979. not both).
  11980. </li>
  11981. <li>
  11982. There must be only 1 update request per container in an allocate call.
  11983. </li>
  11984. <li>
  11985. If a new update request is sent for a container (in a subsequent allocate
  11986. call) before the first one is satisfied by the Scheduler, it will
  11987. overwrite the previous request.
  11988. </li>
  11989. </ul>
  11990. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  11991. </doc>
  11992. </class>
  11993. <!-- end class org.apache.hadoop.yarn.api.records.UpdateContainerRequest -->
  11994. <!-- start class org.apache.hadoop.yarn.api.records.UpdatedContainer -->
  11995. <class name="UpdatedContainer" extends="java.lang.Object"
  11996. abstract="true"
  11997. static="false" final="false" visibility="public"
  11998. deprecated="not deprecated">
  11999. <constructor name="UpdatedContainer"
  12000. static="false" final="false" visibility="public"
  12001. deprecated="not deprecated">
  12002. </constructor>
  12003. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdatedContainer"
  12004. abstract="false" native="false" synchronized="false"
  12005. static="true" final="false" visibility="public"
  12006. deprecated="not deprecated">
  12007. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  12008. <param name="container" type="org.apache.hadoop.yarn.api.records.Container"/>
  12009. <doc>
  12010. <![CDATA[Static Factory method.
  12011. @param updateType ContainerUpdateType
  12012. @param container Container
  12013. @return UpdatedContainer]]>
  12014. </doc>
  12015. </method>
  12016. <method name="getUpdateType" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType"
  12017. abstract="true" native="false" synchronized="false"
  12018. static="false" final="false" visibility="public"
  12019. deprecated="not deprecated">
  12020. <doc>
  12021. <![CDATA[Get the <code>ContainerUpdateType</code>.
  12022. @return ContainerUpdateType]]>
  12023. </doc>
  12024. </method>
  12025. <method name="setUpdateType"
  12026. abstract="true" native="false" synchronized="false"
  12027. static="false" final="false" visibility="public"
  12028. deprecated="not deprecated">
  12029. <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
  12030. <doc>
  12031. <![CDATA[Set the <code>ContainerUpdateType</code>.
  12032. @param updateType ContainerUpdateType]]>
  12033. </doc>
  12034. </method>
  12035. <method name="getContainer" return="org.apache.hadoop.yarn.api.records.Container"
  12036. abstract="true" native="false" synchronized="false"
  12037. static="false" final="false" visibility="public"
  12038. deprecated="not deprecated">
  12039. <doc>
  12040. <![CDATA[Get the <code>Container</code>.
  12041. @return Container]]>
  12042. </doc>
  12043. </method>
  12044. <method name="setContainer"
  12045. abstract="true" native="false" synchronized="false"
  12046. static="false" final="false" visibility="public"
  12047. deprecated="not deprecated">
  12048. <param name="container" type="org.apache.hadoop.yarn.api.records.Container"/>
  12049. <doc>
  12050. <![CDATA[Set the <code>Container</code>.
  12051. @param container Container]]>
  12052. </doc>
  12053. </method>
  12054. <method name="hashCode" return="int"
  12055. abstract="false" native="false" synchronized="false"
  12056. static="false" final="false" visibility="public"
  12057. deprecated="not deprecated">
  12058. </method>
  12059. <method name="equals" return="boolean"
  12060. abstract="false" native="false" synchronized="false"
  12061. static="false" final="false" visibility="public"
  12062. deprecated="not deprecated">
  12063. <param name="obj" type="java.lang.Object"/>
  12064. </method>
  12065. <doc>
  12066. <![CDATA[An object that encapsulates an updated container and the
  12067. type of Update.]]>
  12068. </doc>
  12069. </class>
  12070. <!-- end class org.apache.hadoop.yarn.api.records.UpdatedContainer -->
  12071. <!-- start class org.apache.hadoop.yarn.api.records.URL -->
  12072. <class name="URL" extends="java.lang.Object"
  12073. abstract="true"
  12074. static="false" final="false" visibility="public"
  12075. deprecated="not deprecated">
  12076. <constructor name="URL"
  12077. static="false" final="false" visibility="public"
  12078. deprecated="not deprecated">
  12079. </constructor>
  12080. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.URL"
  12081. abstract="false" native="false" synchronized="false"
  12082. static="true" final="false" visibility="public"
  12083. deprecated="not deprecated">
  12084. <param name="scheme" type="java.lang.String"/>
  12085. <param name="host" type="java.lang.String"/>
  12086. <param name="port" type="int"/>
  12087. <param name="file" type="java.lang.String"/>
  12088. </method>
  12089. <method name="getScheme" return="java.lang.String"
  12090. abstract="true" native="false" synchronized="false"
  12091. static="false" final="false" visibility="public"
  12092. deprecated="not deprecated">
  12093. <doc>
  12094. <![CDATA[Get the scheme of the URL.
  12095. @return scheme of the URL]]>
  12096. </doc>
  12097. </method>
  12098. <method name="setScheme"
  12099. abstract="true" native="false" synchronized="false"
  12100. static="false" final="false" visibility="public"
  12101. deprecated="not deprecated">
  12102. <param name="scheme" type="java.lang.String"/>
  12103. <doc>
  12104. <![CDATA[Set the scheme of the URL
  12105. @param scheme scheme of the URL]]>
  12106. </doc>
  12107. </method>
  12108. <method name="getUserInfo" return="java.lang.String"
  12109. abstract="true" native="false" synchronized="false"
  12110. static="false" final="false" visibility="public"
  12111. deprecated="not deprecated">
  12112. <doc>
  12113. <![CDATA[Get the user info of the URL.
  12114. @return user info of the URL]]>
  12115. </doc>
  12116. </method>
  12117. <method name="setUserInfo"
  12118. abstract="true" native="false" synchronized="false"
  12119. static="false" final="false" visibility="public"
  12120. deprecated="not deprecated">
  12121. <param name="userInfo" type="java.lang.String"/>
  12122. <doc>
  12123. <![CDATA[Set the user info of the URL.
  12124. @param userInfo user info of the URL]]>
  12125. </doc>
  12126. </method>
  12127. <method name="getHost" return="java.lang.String"
  12128. abstract="true" native="false" synchronized="false"
  12129. static="false" final="false" visibility="public"
  12130. deprecated="not deprecated">
  12131. <doc>
  12132. <![CDATA[Get the host of the URL.
  12133. @return host of the URL]]>
  12134. </doc>
  12135. </method>
  12136. <method name="setHost"
  12137. abstract="true" native="false" synchronized="false"
  12138. static="false" final="false" visibility="public"
  12139. deprecated="not deprecated">
  12140. <param name="host" type="java.lang.String"/>
  12141. <doc>
  12142. <![CDATA[Set the host of the URL.
  12143. @param host host of the URL]]>
  12144. </doc>
  12145. </method>
  12146. <method name="getPort" return="int"
  12147. abstract="true" native="false" synchronized="false"
  12148. static="false" final="false" visibility="public"
  12149. deprecated="not deprecated">
  12150. <doc>
  12151. <![CDATA[Get the port of the URL.
  12152. @return port of the URL]]>
  12153. </doc>
  12154. </method>
  12155. <method name="setPort"
  12156. abstract="true" native="false" synchronized="false"
  12157. static="false" final="false" visibility="public"
  12158. deprecated="not deprecated">
  12159. <param name="port" type="int"/>
  12160. <doc>
  12161. <![CDATA[Set the port of the URL
  12162. @param port port of the URL]]>
  12163. </doc>
  12164. </method>
  12165. <method name="getFile" return="java.lang.String"
  12166. abstract="true" native="false" synchronized="false"
  12167. static="false" final="false" visibility="public"
  12168. deprecated="not deprecated">
  12169. <doc>
  12170. <![CDATA[Get the file of the URL.
  12171. @return file of the URL]]>
  12172. </doc>
  12173. </method>
  12174. <method name="setFile"
  12175. abstract="true" native="false" synchronized="false"
  12176. static="false" final="false" visibility="public"
  12177. deprecated="not deprecated">
  12178. <param name="file" type="java.lang.String"/>
  12179. <doc>
  12180. <![CDATA[Set the file of the URL.
  12181. @param file file of the URL]]>
  12182. </doc>
  12183. </method>
  12184. <method name="toPath" return="org.apache.hadoop.fs.Path"
  12185. abstract="false" native="false" synchronized="false"
  12186. static="false" final="false" visibility="public"
  12187. deprecated="not deprecated">
  12188. <exception name="URISyntaxException" type="java.net.URISyntaxException"/>
  12189. </method>
  12190. <method name="fromURI" return="org.apache.hadoop.yarn.api.records.URL"
  12191. abstract="false" native="false" synchronized="false"
  12192. static="true" final="false" visibility="public"
  12193. deprecated="not deprecated">
  12194. <param name="uri" type="java.net.URI"/>
  12195. </method>
  12196. <method name="fromPath" return="org.apache.hadoop.yarn.api.records.URL"
  12197. abstract="false" native="false" synchronized="false"
  12198. static="true" final="false" visibility="public"
  12199. deprecated="not deprecated">
  12200. <param name="path" type="org.apache.hadoop.fs.Path"/>
  12201. </method>
  12202. <doc>
  12203. <![CDATA[<p><code>URL</code> represents a serializable {@link java.net.URL}.</p>]]>
  12204. </doc>
  12205. </class>
  12206. <!-- end class org.apache.hadoop.yarn.api.records.URL -->
  12207. <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
  12208. <class name="YarnApplicationAttemptState" extends="java.lang.Enum"
  12209. abstract="false"
  12210. static="false" final="true" visibility="public"
  12211. deprecated="not deprecated">
  12212. <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState[]"
  12213. abstract="false" native="false" synchronized="false"
  12214. static="true" final="false" visibility="public"
  12215. deprecated="not deprecated">
  12216. </method>
  12217. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
  12218. abstract="false" native="false" synchronized="false"
  12219. static="true" final="false" visibility="public"
  12220. deprecated="not deprecated">
  12221. <param name="name" type="java.lang.String"/>
  12222. </method>
  12223. <doc>
  12224. <![CDATA[Enumeration of various states of a <code>RMAppAttempt</code>.]]>
  12225. </doc>
  12226. </class>
  12227. <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
  12228. <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
  12229. <class name="YarnApplicationState" extends="java.lang.Enum"
  12230. abstract="false"
  12231. static="false" final="true" visibility="public"
  12232. deprecated="not deprecated">
  12233. <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationState[]"
  12234. abstract="false" native="false" synchronized="false"
  12235. static="true" final="false" visibility="public"
  12236. deprecated="not deprecated">
  12237. </method>
  12238. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
  12239. abstract="false" native="false" synchronized="false"
  12240. static="true" final="false" visibility="public"
  12241. deprecated="not deprecated">
  12242. <param name="name" type="java.lang.String"/>
  12243. </method>
  12244. <doc>
  12245. <![CDATA[Enumeration of various states of an <code>ApplicationMaster</code>.]]>
  12246. </doc>
  12247. </class>
  12248. <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
  12249. <!-- start class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
  12250. <class name="YarnClusterMetrics" extends="java.lang.Object"
  12251. abstract="true"
  12252. static="false" final="false" visibility="public"
  12253. deprecated="not deprecated">
  12254. <constructor name="YarnClusterMetrics"
  12255. static="false" final="false" visibility="public"
  12256. deprecated="not deprecated">
  12257. </constructor>
  12258. <method name="getNumNodeManagers" return="int"
  12259. abstract="true" native="false" synchronized="false"
  12260. static="false" final="false" visibility="public"
  12261. deprecated="not deprecated">
  12262. <doc>
  12263. <![CDATA[Get the number of <code>NodeManager</code>s in the cluster.
  12264. @return number of <code>NodeManager</code>s in the cluster]]>
  12265. </doc>
  12266. </method>
  12267. <method name="getNumDecommissionedNodeManagers" return="int"
  12268. abstract="true" native="false" synchronized="false"
  12269. static="false" final="false" visibility="public"
  12270. deprecated="not deprecated">
  12271. <doc>
  12272. <![CDATA[Get the number of <code>DecommissionedNodeManager</code>s in the cluster.
  12273. @return number of <code>DecommissionedNodeManager</code>s in the cluster]]>
  12274. </doc>
  12275. </method>
  12276. <method name="getNumActiveNodeManagers" return="int"
  12277. abstract="true" native="false" synchronized="false"
  12278. static="false" final="false" visibility="public"
  12279. deprecated="not deprecated">
  12280. <doc>
  12281. <![CDATA[Get the number of <code>ActiveNodeManager</code>s in the cluster.
  12282. @return number of <code>ActiveNodeManager</code>s in the cluster]]>
  12283. </doc>
  12284. </method>
  12285. <method name="getNumLostNodeManagers" return="int"
  12286. abstract="true" native="false" synchronized="false"
  12287. static="false" final="false" visibility="public"
  12288. deprecated="not deprecated">
  12289. <doc>
  12290. <![CDATA[Get the number of <code>LostNodeManager</code>s in the cluster.
  12291. @return number of <code>LostNodeManager</code>s in the cluster]]>
  12292. </doc>
  12293. </method>
  12294. <method name="getNumUnhealthyNodeManagers" return="int"
  12295. abstract="true" native="false" synchronized="false"
  12296. static="false" final="false" visibility="public"
  12297. deprecated="not deprecated">
  12298. <doc>
  12299. <![CDATA[Get the number of <code>UnhealthyNodeManager</code>s in the cluster.
  12300. @return number of <code>UnhealthyNodeManager</code>s in the cluster]]>
  12301. </doc>
  12302. </method>
  12303. <method name="getNumRebootedNodeManagers" return="int"
  12304. abstract="true" native="false" synchronized="false"
  12305. static="false" final="false" visibility="public"
  12306. deprecated="not deprecated">
  12307. <doc>
  12308. <![CDATA[Get the number of <code>RebootedNodeManager</code>s in the cluster.
  12309. @return number of <code>RebootedNodeManager</code>s in the cluster]]>
  12310. </doc>
  12311. </method>
  12312. <doc>
  12313. <![CDATA[<p><code>YarnClusterMetrics</code> represents cluster metrics.</p>
  12314. <p>Currently only number of <code>NodeManager</code>s is provided.</p>]]>
  12315. </doc>
  12316. </class>
  12317. <!-- end class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
  12318. </package>
  12319. <package name="org.apache.hadoop.yarn.api.records.impl">
  12320. </package>
  12321. <package name="org.apache.hadoop.yarn.api.records.timeline">
  12322. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineAbout -->
  12323. <class name="TimelineAbout" extends="java.lang.Object"
  12324. abstract="false"
  12325. static="false" final="false" visibility="public"
  12326. deprecated="not deprecated">
  12327. <constructor name="TimelineAbout"
  12328. static="false" final="false" visibility="public"
  12329. deprecated="not deprecated">
  12330. </constructor>
  12331. <constructor name="TimelineAbout" type="java.lang.String"
  12332. static="false" final="false" visibility="public"
  12333. deprecated="not deprecated">
  12334. </constructor>
  12335. <method name="getAbout" return="java.lang.String"
  12336. abstract="false" native="false" synchronized="false"
  12337. static="false" final="false" visibility="public"
  12338. deprecated="not deprecated">
  12339. </method>
  12340. <method name="setAbout"
  12341. abstract="false" native="false" synchronized="false"
  12342. static="false" final="false" visibility="public"
  12343. deprecated="not deprecated">
  12344. <param name="about" type="java.lang.String"/>
  12345. </method>
  12346. <method name="getTimelineServiceVersion" return="java.lang.String"
  12347. abstract="false" native="false" synchronized="false"
  12348. static="false" final="false" visibility="public"
  12349. deprecated="not deprecated">
  12350. </method>
  12351. <method name="setTimelineServiceVersion"
  12352. abstract="false" native="false" synchronized="false"
  12353. static="false" final="false" visibility="public"
  12354. deprecated="not deprecated">
  12355. <param name="timelineServiceVersion" type="java.lang.String"/>
  12356. </method>
  12357. <method name="getTimelineServiceBuildVersion" return="java.lang.String"
  12358. abstract="false" native="false" synchronized="false"
  12359. static="false" final="false" visibility="public"
  12360. deprecated="not deprecated">
  12361. </method>
  12362. <method name="setTimelineServiceBuildVersion"
  12363. abstract="false" native="false" synchronized="false"
  12364. static="false" final="false" visibility="public"
  12365. deprecated="not deprecated">
  12366. <param name="timelineServiceBuildVersion" type="java.lang.String"/>
  12367. </method>
  12368. <method name="getTimelineServiceVersionBuiltOn" return="java.lang.String"
  12369. abstract="false" native="false" synchronized="false"
  12370. static="false" final="false" visibility="public"
  12371. deprecated="not deprecated">
  12372. </method>
  12373. <method name="setTimelineServiceVersionBuiltOn"
  12374. abstract="false" native="false" synchronized="false"
  12375. static="false" final="false" visibility="public"
  12376. deprecated="not deprecated">
  12377. <param name="timelineServiceVersionBuiltOn" type="java.lang.String"/>
  12378. </method>
  12379. <method name="getHadoopVersion" return="java.lang.String"
  12380. abstract="false" native="false" synchronized="false"
  12381. static="false" final="false" visibility="public"
  12382. deprecated="not deprecated">
  12383. </method>
  12384. <method name="setHadoopVersion"
  12385. abstract="false" native="false" synchronized="false"
  12386. static="false" final="false" visibility="public"
  12387. deprecated="not deprecated">
  12388. <param name="hadoopVersion" type="java.lang.String"/>
  12389. </method>
  12390. <method name="getHadoopBuildVersion" return="java.lang.String"
  12391. abstract="false" native="false" synchronized="false"
  12392. static="false" final="false" visibility="public"
  12393. deprecated="not deprecated">
  12394. </method>
  12395. <method name="setHadoopBuildVersion"
  12396. abstract="false" native="false" synchronized="false"
  12397. static="false" final="false" visibility="public"
  12398. deprecated="not deprecated">
  12399. <param name="hadoopBuildVersion" type="java.lang.String"/>
  12400. </method>
  12401. <method name="getHadoopVersionBuiltOn" return="java.lang.String"
  12402. abstract="false" native="false" synchronized="false"
  12403. static="false" final="false" visibility="public"
  12404. deprecated="not deprecated">
  12405. </method>
  12406. <method name="setHadoopVersionBuiltOn"
  12407. abstract="false" native="false" synchronized="false"
  12408. static="false" final="false" visibility="public"
  12409. deprecated="not deprecated">
  12410. <param name="hadoopVersionBuiltOn" type="java.lang.String"/>
  12411. </method>
  12412. </class>
  12413. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineAbout -->
  12414. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
  12415. <class name="TimelineDelegationTokenResponse" extends="java.lang.Object"
  12416. abstract="false"
  12417. static="false" final="false" visibility="public"
  12418. deprecated="not deprecated">
  12419. <constructor name="TimelineDelegationTokenResponse"
  12420. static="false" final="false" visibility="public"
  12421. deprecated="not deprecated">
  12422. </constructor>
  12423. <method name="getType" return="java.lang.String"
  12424. abstract="false" native="false" synchronized="false"
  12425. static="false" final="false" visibility="public"
  12426. deprecated="not deprecated">
  12427. </method>
  12428. <method name="setType"
  12429. abstract="false" native="false" synchronized="false"
  12430. static="false" final="false" visibility="public"
  12431. deprecated="not deprecated">
  12432. <param name="type" type="java.lang.String"/>
  12433. </method>
  12434. <method name="getContent" return="java.lang.Object"
  12435. abstract="false" native="false" synchronized="false"
  12436. static="false" final="false" visibility="public"
  12437. deprecated="not deprecated">
  12438. </method>
  12439. <method name="setContent"
  12440. abstract="false" native="false" synchronized="false"
  12441. static="false" final="false" visibility="public"
  12442. deprecated="not deprecated">
  12443. <param name="content" type="java.lang.Object"/>
  12444. </method>
  12445. <doc>
  12446. <![CDATA[The response of delegation token related request]]>
  12447. </doc>
  12448. </class>
  12449. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
  12450. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
  12451. <class name="TimelineDomain" extends="java.lang.Object"
  12452. abstract="false"
  12453. static="false" final="false" visibility="public"
  12454. deprecated="not deprecated">
  12455. <constructor name="TimelineDomain"
  12456. static="false" final="false" visibility="public"
  12457. deprecated="not deprecated">
  12458. </constructor>
  12459. <method name="getId" return="java.lang.String"
  12460. abstract="false" native="false" synchronized="false"
  12461. static="false" final="false" visibility="public"
  12462. deprecated="not deprecated">
  12463. <doc>
  12464. <![CDATA[Get the domain ID
  12465. @return the domain ID]]>
  12466. </doc>
  12467. </method>
  12468. <method name="setId"
  12469. abstract="false" native="false" synchronized="false"
  12470. static="false" final="false" visibility="public"
  12471. deprecated="not deprecated">
  12472. <param name="id" type="java.lang.String"/>
  12473. <doc>
  12474. <![CDATA[Set the domain ID
  12475. @param id the domain ID]]>
  12476. </doc>
  12477. </method>
  12478. <method name="getDescription" return="java.lang.String"
  12479. abstract="false" native="false" synchronized="false"
  12480. static="false" final="false" visibility="public"
  12481. deprecated="not deprecated">
  12482. <doc>
  12483. <![CDATA[Get the domain description
  12484. @return the domain description]]>
  12485. </doc>
  12486. </method>
  12487. <method name="setDescription"
  12488. abstract="false" native="false" synchronized="false"
  12489. static="false" final="false" visibility="public"
  12490. deprecated="not deprecated">
  12491. <param name="description" type="java.lang.String"/>
  12492. <doc>
  12493. <![CDATA[Set the domain description
  12494. @param description the domain description]]>
  12495. </doc>
  12496. </method>
  12497. <method name="getOwner" return="java.lang.String"
  12498. abstract="false" native="false" synchronized="false"
  12499. static="false" final="false" visibility="public"
  12500. deprecated="not deprecated">
  12501. <doc>
  12502. <![CDATA[Get the domain owner
  12503. @return the domain owner]]>
  12504. </doc>
  12505. </method>
  12506. <method name="setOwner"
  12507. abstract="false" native="false" synchronized="false"
  12508. static="false" final="false" visibility="public"
  12509. deprecated="not deprecated">
  12510. <param name="owner" type="java.lang.String"/>
  12511. <doc>
  12512. <![CDATA[Set the domain owner. The user doesn't need to set it, which will
  12513. automatically set to the user who puts the domain.
  12514. @param owner the domain owner]]>
  12515. </doc>
  12516. </method>
  12517. <method name="getReaders" return="java.lang.String"
  12518. abstract="false" native="false" synchronized="false"
  12519. static="false" final="false" visibility="public"
  12520. deprecated="not deprecated">
  12521. <doc>
  12522. <![CDATA[Get the reader (and/or reader group) list string
  12523. @return the reader (and/or reader group) list string]]>
  12524. </doc>
  12525. </method>
  12526. <method name="setReaders"
  12527. abstract="false" native="false" synchronized="false"
  12528. static="false" final="false" visibility="public"
  12529. deprecated="not deprecated">
  12530. <param name="readers" type="java.lang.String"/>
  12531. <doc>
  12532. <![CDATA[Set the reader (and/or reader group) list string
  12533. @param readers the reader (and/or reader group) list string]]>
  12534. </doc>
  12535. </method>
  12536. <method name="getWriters" return="java.lang.String"
  12537. abstract="false" native="false" synchronized="false"
  12538. static="false" final="false" visibility="public"
  12539. deprecated="not deprecated">
  12540. <doc>
  12541. <![CDATA[Get the writer (and/or writer group) list string
  12542. @return the writer (and/or writer group) list string]]>
  12543. </doc>
  12544. </method>
  12545. <method name="setWriters"
  12546. abstract="false" native="false" synchronized="false"
  12547. static="false" final="false" visibility="public"
  12548. deprecated="not deprecated">
  12549. <param name="writers" type="java.lang.String"/>
  12550. <doc>
  12551. <![CDATA[Set the writer (and/or writer group) list string
  12552. @param writers the writer (and/or writer group) list string]]>
  12553. </doc>
  12554. </method>
  12555. <method name="getCreatedTime" return="java.lang.Long"
  12556. abstract="false" native="false" synchronized="false"
  12557. static="false" final="false" visibility="public"
  12558. deprecated="not deprecated">
  12559. <doc>
  12560. <![CDATA[Get the created time of the domain
  12561. @return the created time of the domain]]>
  12562. </doc>
  12563. </method>
  12564. <method name="setCreatedTime"
  12565. abstract="false" native="false" synchronized="false"
  12566. static="false" final="false" visibility="public"
  12567. deprecated="not deprecated">
  12568. <param name="createdTime" type="java.lang.Long"/>
  12569. <doc>
  12570. <![CDATA[Set the created time of the domain
  12571. @param createdTime the created time of the domain]]>
  12572. </doc>
  12573. </method>
  12574. <method name="getModifiedTime" return="java.lang.Long"
  12575. abstract="false" native="false" synchronized="false"
  12576. static="false" final="false" visibility="public"
  12577. deprecated="not deprecated">
  12578. <doc>
  12579. <![CDATA[Get the modified time of the domain
  12580. @return the modified time of the domain]]>
  12581. </doc>
  12582. </method>
  12583. <method name="setModifiedTime"
  12584. abstract="false" native="false" synchronized="false"
  12585. static="false" final="false" visibility="public"
  12586. deprecated="not deprecated">
  12587. <param name="modifiedTime" type="java.lang.Long"/>
  12588. <doc>
  12589. <![CDATA[Set the modified time of the domain
  12590. @param modifiedTime the modified time of the domain]]>
  12591. </doc>
  12592. </method>
  12593. <doc>
  12594. <![CDATA[<p>
  12595. This class contains the information about a timeline domain, which is used
  12596. to a user to host a number of timeline entities, isolating them from others'.
  12597. The user can also define the reader and writer users/groups for the the
  12598. domain, which is used to control the access to its entities.
  12599. </p>
  12600. <p>
  12601. The reader and writer users/groups pattern that the user can supply is the
  12602. same as what <code>AccessControlList</code> takes.
  12603. </p>]]>
  12604. </doc>
  12605. </class>
  12606. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
  12607. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
  12608. <class name="TimelineDomains" extends="java.lang.Object"
  12609. abstract="false"
  12610. static="false" final="false" visibility="public"
  12611. deprecated="not deprecated">
  12612. <constructor name="TimelineDomains"
  12613. static="false" final="false" visibility="public"
  12614. deprecated="not deprecated">
  12615. </constructor>
  12616. <method name="getDomains" return="java.util.List"
  12617. abstract="false" native="false" synchronized="false"
  12618. static="false" final="false" visibility="public"
  12619. deprecated="not deprecated">
  12620. <doc>
  12621. <![CDATA[Get a list of domains
  12622. @return a list of domains]]>
  12623. </doc>
  12624. </method>
  12625. <method name="addDomain"
  12626. abstract="false" native="false" synchronized="false"
  12627. static="false" final="false" visibility="public"
  12628. deprecated="not deprecated">
  12629. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  12630. <doc>
  12631. <![CDATA[Add a single domain into the existing domain list
  12632. @param domain
  12633. a single domain]]>
  12634. </doc>
  12635. </method>
  12636. <method name="addDomains"
  12637. abstract="false" native="false" synchronized="false"
  12638. static="false" final="false" visibility="public"
  12639. deprecated="not deprecated">
  12640. <param name="domains" type="java.util.List"/>
  12641. <doc>
  12642. <![CDATA[All a list of domains into the existing domain list
  12643. @param domains
  12644. a list of domains]]>
  12645. </doc>
  12646. </method>
  12647. <method name="setDomains"
  12648. abstract="false" native="false" synchronized="false"
  12649. static="false" final="false" visibility="public"
  12650. deprecated="not deprecated">
  12651. <param name="domains" type="java.util.List"/>
  12652. <doc>
  12653. <![CDATA[Set the domain list to the given list of domains
  12654. @param domains
  12655. a list of domains]]>
  12656. </doc>
  12657. </method>
  12658. <doc>
  12659. <![CDATA[The class that hosts a list of timeline domains.]]>
  12660. </doc>
  12661. </class>
  12662. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
  12663. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
  12664. <class name="TimelineEntities" extends="java.lang.Object"
  12665. abstract="false"
  12666. static="false" final="false" visibility="public"
  12667. deprecated="not deprecated">
  12668. <constructor name="TimelineEntities"
  12669. static="false" final="false" visibility="public"
  12670. deprecated="not deprecated">
  12671. </constructor>
  12672. <method name="getEntities" return="java.util.List"
  12673. abstract="false" native="false" synchronized="false"
  12674. static="false" final="false" visibility="public"
  12675. deprecated="not deprecated">
  12676. <doc>
  12677. <![CDATA[Get a list of entities
  12678. @return a list of entities]]>
  12679. </doc>
  12680. </method>
  12681. <method name="addEntity"
  12682. abstract="false" native="false" synchronized="false"
  12683. static="false" final="false" visibility="public"
  12684. deprecated="not deprecated">
  12685. <param name="entity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
  12686. <doc>
  12687. <![CDATA[Add a single entity into the existing entity list
  12688. @param entity
  12689. a single entity]]>
  12690. </doc>
  12691. </method>
  12692. <method name="addEntities"
  12693. abstract="false" native="false" synchronized="false"
  12694. static="false" final="false" visibility="public"
  12695. deprecated="not deprecated">
  12696. <param name="entities" type="java.util.List"/>
  12697. <doc>
  12698. <![CDATA[All a list of entities into the existing entity list
  12699. @param entities
  12700. a list of entities]]>
  12701. </doc>
  12702. </method>
  12703. <method name="setEntities"
  12704. abstract="false" native="false" synchronized="false"
  12705. static="false" final="false" visibility="public"
  12706. deprecated="not deprecated">
  12707. <param name="entities" type="java.util.List"/>
  12708. <doc>
  12709. <![CDATA[Set the entity list to the given list of entities
  12710. @param entities
  12711. a list of entities]]>
  12712. </doc>
  12713. </method>
  12714. <doc>
  12715. <![CDATA[The class that hosts a list of timeline entities.]]>
  12716. </doc>
  12717. </class>
  12718. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
  12719. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
  12720. <class name="TimelineEntity" extends="java.lang.Object"
  12721. abstract="false"
  12722. static="false" final="false" visibility="public"
  12723. deprecated="not deprecated">
  12724. <implements name="java.lang.Comparable"/>
  12725. <constructor name="TimelineEntity"
  12726. static="false" final="false" visibility="public"
  12727. deprecated="not deprecated">
  12728. </constructor>
  12729. <method name="getEntityType" return="java.lang.String"
  12730. abstract="false" native="false" synchronized="false"
  12731. static="false" final="false" visibility="public"
  12732. deprecated="not deprecated">
  12733. <doc>
  12734. <![CDATA[Get the entity type
  12735. @return the entity type]]>
  12736. </doc>
  12737. </method>
  12738. <method name="setEntityType"
  12739. abstract="false" native="false" synchronized="false"
  12740. static="false" final="false" visibility="public"
  12741. deprecated="not deprecated">
  12742. <param name="entityType" type="java.lang.String"/>
  12743. <doc>
  12744. <![CDATA[Set the entity type
  12745. @param entityType
  12746. the entity type]]>
  12747. </doc>
  12748. </method>
  12749. <method name="getEntityId" return="java.lang.String"
  12750. abstract="false" native="false" synchronized="false"
  12751. static="false" final="false" visibility="public"
  12752. deprecated="not deprecated">
  12753. <doc>
  12754. <![CDATA[Get the entity Id
  12755. @return the entity Id]]>
  12756. </doc>
  12757. </method>
  12758. <method name="setEntityId"
  12759. abstract="false" native="false" synchronized="false"
  12760. static="false" final="false" visibility="public"
  12761. deprecated="not deprecated">
  12762. <param name="entityId" type="java.lang.String"/>
  12763. <doc>
  12764. <![CDATA[Set the entity Id
  12765. @param entityId
  12766. the entity Id]]>
  12767. </doc>
  12768. </method>
  12769. <method name="getStartTime" return="java.lang.Long"
  12770. abstract="false" native="false" synchronized="false"
  12771. static="false" final="false" visibility="public"
  12772. deprecated="not deprecated">
  12773. <doc>
  12774. <![CDATA[Get the start time of the entity
  12775. @return the start time of the entity]]>
  12776. </doc>
  12777. </method>
  12778. <method name="setStartTime"
  12779. abstract="false" native="false" synchronized="false"
  12780. static="false" final="false" visibility="public"
  12781. deprecated="not deprecated">
  12782. <param name="startTime" type="java.lang.Long"/>
  12783. <doc>
  12784. <![CDATA[Set the start time of the entity
  12785. @param startTime
  12786. the start time of the entity]]>
  12787. </doc>
  12788. </method>
  12789. <method name="getEvents" return="java.util.List"
  12790. abstract="false" native="false" synchronized="false"
  12791. static="false" final="false" visibility="public"
  12792. deprecated="not deprecated">
  12793. <doc>
  12794. <![CDATA[Get a list of events related to the entity
  12795. @return a list of events related to the entity]]>
  12796. </doc>
  12797. </method>
  12798. <method name="addEvent"
  12799. abstract="false" native="false" synchronized="false"
  12800. static="false" final="false" visibility="public"
  12801. deprecated="not deprecated">
  12802. <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  12803. <doc>
  12804. <![CDATA[Add a single event related to the entity to the existing event list
  12805. @param event
  12806. a single event related to the entity]]>
  12807. </doc>
  12808. </method>
  12809. <method name="addEvents"
  12810. abstract="false" native="false" synchronized="false"
  12811. static="false" final="false" visibility="public"
  12812. deprecated="not deprecated">
  12813. <param name="events" type="java.util.List"/>
  12814. <doc>
  12815. <![CDATA[Add a list of events related to the entity to the existing event list
  12816. @param events
  12817. a list of events related to the entity]]>
  12818. </doc>
  12819. </method>
  12820. <method name="setEvents"
  12821. abstract="false" native="false" synchronized="false"
  12822. static="false" final="false" visibility="public"
  12823. deprecated="not deprecated">
  12824. <param name="events" type="java.util.List"/>
  12825. <doc>
  12826. <![CDATA[Set the event list to the given list of events related to the entity
  12827. @param events
  12828. events a list of events related to the entity]]>
  12829. </doc>
  12830. </method>
  12831. <method name="getRelatedEntities" return="java.util.Map"
  12832. abstract="false" native="false" synchronized="false"
  12833. static="false" final="false" visibility="public"
  12834. deprecated="not deprecated">
  12835. <doc>
  12836. <![CDATA[Get the related entities
  12837. @return the related entities]]>
  12838. </doc>
  12839. </method>
  12840. <method name="addRelatedEntity"
  12841. abstract="false" native="false" synchronized="false"
  12842. static="false" final="false" visibility="public"
  12843. deprecated="not deprecated">
  12844. <param name="entityType" type="java.lang.String"/>
  12845. <param name="entityId" type="java.lang.String"/>
  12846. <doc>
  12847. <![CDATA[Add an entity to the existing related entity map
  12848. @param entityType
  12849. the entity type
  12850. @param entityId
  12851. the entity Id]]>
  12852. </doc>
  12853. </method>
  12854. <method name="addRelatedEntities"
  12855. abstract="false" native="false" synchronized="false"
  12856. static="false" final="false" visibility="public"
  12857. deprecated="not deprecated">
  12858. <param name="relatedEntities" type="java.util.Map"/>
  12859. <doc>
  12860. <![CDATA[Add a map of related entities to the existing related entity map
  12861. @param relatedEntities
  12862. a map of related entities]]>
  12863. </doc>
  12864. </method>
  12865. <method name="setRelatedEntities"
  12866. abstract="false" native="false" synchronized="false"
  12867. static="false" final="false" visibility="public"
  12868. deprecated="not deprecated">
  12869. <param name="relatedEntities" type="java.util.Map"/>
  12870. <doc>
  12871. <![CDATA[Set the related entity map to the given map of related entities
  12872. @param relatedEntities
  12873. a map of related entities]]>
  12874. </doc>
  12875. </method>
  12876. <method name="getPrimaryFilters" return="java.util.Map"
  12877. abstract="false" native="false" synchronized="false"
  12878. static="false" final="false" visibility="public"
  12879. deprecated="not deprecated">
  12880. <doc>
  12881. <![CDATA[Get the primary filters
  12882. @return the primary filters]]>
  12883. </doc>
  12884. </method>
  12885. <method name="addPrimaryFilter"
  12886. abstract="false" native="false" synchronized="false"
  12887. static="false" final="false" visibility="public"
  12888. deprecated="not deprecated">
  12889. <param name="key" type="java.lang.String"/>
  12890. <param name="value" type="java.lang.Object"/>
  12891. <doc>
  12892. <![CDATA[Add a single piece of primary filter to the existing primary filter map
  12893. @param key
  12894. the primary filter key
  12895. @param value
  12896. the primary filter value]]>
  12897. </doc>
  12898. </method>
  12899. <method name="addPrimaryFilters"
  12900. abstract="false" native="false" synchronized="false"
  12901. static="false" final="false" visibility="public"
  12902. deprecated="not deprecated">
  12903. <param name="primaryFilters" type="java.util.Map"/>
  12904. <doc>
  12905. <![CDATA[Add a map of primary filters to the existing primary filter map
  12906. @param primaryFilters
  12907. a map of primary filters]]>
  12908. </doc>
  12909. </method>
  12910. <method name="setPrimaryFilters"
  12911. abstract="false" native="false" synchronized="false"
  12912. static="false" final="false" visibility="public"
  12913. deprecated="not deprecated">
  12914. <param name="primaryFilters" type="java.util.Map"/>
  12915. <doc>
  12916. <![CDATA[Set the primary filter map to the given map of primary filters
  12917. @param primaryFilters
  12918. a map of primary filters]]>
  12919. </doc>
  12920. </method>
  12921. <method name="getOtherInfo" return="java.util.Map"
  12922. abstract="false" native="false" synchronized="false"
  12923. static="false" final="false" visibility="public"
  12924. deprecated="not deprecated">
  12925. <doc>
  12926. <![CDATA[Get the other information of the entity
  12927. @return the other information of the entity]]>
  12928. </doc>
  12929. </method>
  12930. <method name="addOtherInfo"
  12931. abstract="false" native="false" synchronized="false"
  12932. static="false" final="false" visibility="public"
  12933. deprecated="not deprecated">
  12934. <param name="key" type="java.lang.String"/>
  12935. <param name="value" type="java.lang.Object"/>
  12936. <doc>
  12937. <![CDATA[Add one piece of other information of the entity to the existing other info
  12938. map
  12939. @param key
  12940. the other information key
  12941. @param value
  12942. the other information value]]>
  12943. </doc>
  12944. </method>
  12945. <method name="addOtherInfo"
  12946. abstract="false" native="false" synchronized="false"
  12947. static="false" final="false" visibility="public"
  12948. deprecated="not deprecated">
  12949. <param name="otherInfo" type="java.util.Map"/>
  12950. <doc>
  12951. <![CDATA[Add a map of other information of the entity to the existing other info map
  12952. @param otherInfo
  12953. a map of other information]]>
  12954. </doc>
  12955. </method>
  12956. <method name="setOtherInfo"
  12957. abstract="false" native="false" synchronized="false"
  12958. static="false" final="false" visibility="public"
  12959. deprecated="not deprecated">
  12960. <param name="otherInfo" type="java.util.Map"/>
  12961. <doc>
  12962. <![CDATA[Set the other info map to the given map of other information
  12963. @param otherInfo
  12964. a map of other information]]>
  12965. </doc>
  12966. </method>
  12967. <method name="getDomainId" return="java.lang.String"
  12968. abstract="false" native="false" synchronized="false"
  12969. static="false" final="false" visibility="public"
  12970. deprecated="not deprecated">
  12971. <doc>
  12972. <![CDATA[Get the ID of the domain that the entity is to be put
  12973. @return the domain ID]]>
  12974. </doc>
  12975. </method>
  12976. <method name="setDomainId"
  12977. abstract="false" native="false" synchronized="false"
  12978. static="false" final="false" visibility="public"
  12979. deprecated="not deprecated">
  12980. <param name="domainId" type="java.lang.String"/>
  12981. <doc>
  12982. <![CDATA[Set the ID of the domain that the entity is to be put
  12983. @param domainId
  12984. the name space ID]]>
  12985. </doc>
  12986. </method>
  12987. <method name="hashCode" return="int"
  12988. abstract="false" native="false" synchronized="false"
  12989. static="false" final="false" visibility="public"
  12990. deprecated="not deprecated">
  12991. </method>
  12992. <method name="equals" return="boolean"
  12993. abstract="false" native="false" synchronized="false"
  12994. static="false" final="false" visibility="public"
  12995. deprecated="not deprecated">
  12996. <param name="obj" type="java.lang.Object"/>
  12997. </method>
  12998. <method name="compareTo" return="int"
  12999. abstract="false" native="false" synchronized="false"
  13000. static="false" final="false" visibility="public"
  13001. deprecated="not deprecated">
  13002. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
  13003. </method>
  13004. <doc>
  13005. <![CDATA[<p>
  13006. The class that contains the the meta information of some conceptual entity
  13007. and its related events. The entity can be an application, an application
  13008. attempt, a container or whatever the user-defined object.
  13009. </p>
  13010. <p>
  13011. Primary filters will be used to index the entities in
  13012. <code>TimelineStore</code>, such that users should carefully choose the
  13013. information they want to store as the primary filters. The remaining can be
  13014. stored as other information.
  13015. </p>]]>
  13016. </doc>
  13017. </class>
  13018. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
  13019. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId -->
  13020. <class name="TimelineEntityGroupId" extends="java.lang.Object"
  13021. abstract="false"
  13022. static="false" final="false" visibility="public"
  13023. deprecated="not deprecated">
  13024. <implements name="java.lang.Comparable"/>
  13025. <constructor name="TimelineEntityGroupId"
  13026. static="false" final="false" visibility="public"
  13027. deprecated="not deprecated">
  13028. </constructor>
  13029. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"
  13030. abstract="false" native="false" synchronized="false"
  13031. static="true" final="false" visibility="public"
  13032. deprecated="not deprecated">
  13033. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  13034. <param name="id" type="java.lang.String"/>
  13035. </method>
  13036. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  13037. abstract="false" native="false" synchronized="false"
  13038. static="false" final="false" visibility="public"
  13039. deprecated="not deprecated">
  13040. <doc>
  13041. <![CDATA[Get the <code>ApplicationId</code> of the
  13042. <code>TimelineEntityGroupId</code>.
  13043. @return <code>ApplicationId</code> of the
  13044. <code>TimelineEntityGroupId</code>]]>
  13045. </doc>
  13046. </method>
  13047. <method name="setApplicationId"
  13048. abstract="false" native="false" synchronized="false"
  13049. static="false" final="false" visibility="public"
  13050. deprecated="not deprecated">
  13051. <param name="appID" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  13052. </method>
  13053. <method name="getTimelineEntityGroupId" return="java.lang.String"
  13054. abstract="false" native="false" synchronized="false"
  13055. static="false" final="false" visibility="public"
  13056. deprecated="not deprecated">
  13057. <doc>
  13058. <![CDATA[Get the <code>timelineEntityGroupId</code>.
  13059. @return <code>timelineEntityGroupId</code>]]>
  13060. </doc>
  13061. </method>
  13062. <method name="hashCode" return="int"
  13063. abstract="false" native="false" synchronized="false"
  13064. static="false" final="false" visibility="public"
  13065. deprecated="not deprecated">
  13066. </method>
  13067. <method name="equals" return="boolean"
  13068. abstract="false" native="false" synchronized="false"
  13069. static="false" final="false" visibility="public"
  13070. deprecated="not deprecated">
  13071. <param name="obj" type="java.lang.Object"/>
  13072. </method>
  13073. <method name="compareTo" return="int"
  13074. abstract="false" native="false" synchronized="false"
  13075. static="false" final="false" visibility="public"
  13076. deprecated="not deprecated">
  13077. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"/>
  13078. </method>
  13079. <method name="toString" return="java.lang.String"
  13080. abstract="false" native="false" synchronized="false"
  13081. static="false" final="false" visibility="public"
  13082. deprecated="not deprecated">
  13083. </method>
  13084. <method name="fromString" return="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"
  13085. abstract="false" native="false" synchronized="false"
  13086. static="true" final="false" visibility="public"
  13087. deprecated="not deprecated">
  13088. <param name="timelineEntityGroupIdStr" type="java.lang.String"/>
  13089. </method>
  13090. <field name="TIMELINE_ENTITY_GROUPID_STR_PREFIX" type="java.lang.String"
  13091. transient="false" volatile="false"
  13092. static="true" final="true" visibility="public"
  13093. deprecated="not deprecated">
  13094. </field>
  13095. <doc>
  13096. <![CDATA[<p><code>TimelineEntityGroupId</code> is an abstract way for
  13097. timeline service users to represent #a group of related timeline data.
  13098. For example, all entities that represents one data flow DAG execution
  13099. can be grouped into one timeline entity group. </p>]]>
  13100. </doc>
  13101. </class>
  13102. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId -->
  13103. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
  13104. <class name="TimelineEvent" extends="java.lang.Object"
  13105. abstract="false"
  13106. static="false" final="false" visibility="public"
  13107. deprecated="not deprecated">
  13108. <implements name="java.lang.Comparable"/>
  13109. <constructor name="TimelineEvent"
  13110. static="false" final="false" visibility="public"
  13111. deprecated="not deprecated">
  13112. </constructor>
  13113. <method name="getTimestamp" return="long"
  13114. abstract="false" native="false" synchronized="false"
  13115. static="false" final="false" visibility="public"
  13116. deprecated="not deprecated">
  13117. <doc>
  13118. <![CDATA[Get the timestamp of the event
  13119. @return the timestamp of the event]]>
  13120. </doc>
  13121. </method>
  13122. <method name="setTimestamp"
  13123. abstract="false" native="false" synchronized="false"
  13124. static="false" final="false" visibility="public"
  13125. deprecated="not deprecated">
  13126. <param name="timestamp" type="long"/>
  13127. <doc>
  13128. <![CDATA[Set the timestamp of the event
  13129. @param timestamp
  13130. the timestamp of the event]]>
  13131. </doc>
  13132. </method>
  13133. <method name="getEventType" return="java.lang.String"
  13134. abstract="false" native="false" synchronized="false"
  13135. static="false" final="false" visibility="public"
  13136. deprecated="not deprecated">
  13137. <doc>
  13138. <![CDATA[Get the event type
  13139. @return the event type]]>
  13140. </doc>
  13141. </method>
  13142. <method name="setEventType"
  13143. abstract="false" native="false" synchronized="false"
  13144. static="false" final="false" visibility="public"
  13145. deprecated="not deprecated">
  13146. <param name="eventType" type="java.lang.String"/>
  13147. <doc>
  13148. <![CDATA[Set the event type
  13149. @param eventType
  13150. the event type]]>
  13151. </doc>
  13152. </method>
  13153. <method name="getEventInfo" return="java.util.Map"
  13154. abstract="false" native="false" synchronized="false"
  13155. static="false" final="false" visibility="public"
  13156. deprecated="not deprecated">
  13157. <doc>
  13158. <![CDATA[Set the information of the event
  13159. @return the information of the event]]>
  13160. </doc>
  13161. </method>
  13162. <method name="addEventInfo"
  13163. abstract="false" native="false" synchronized="false"
  13164. static="false" final="false" visibility="public"
  13165. deprecated="not deprecated">
  13166. <param name="key" type="java.lang.String"/>
  13167. <param name="value" type="java.lang.Object"/>
  13168. <doc>
  13169. <![CDATA[Add one piece of the information of the event to the existing information
  13170. map
  13171. @param key
  13172. the information key
  13173. @param value
  13174. the information value]]>
  13175. </doc>
  13176. </method>
  13177. <method name="addEventInfo"
  13178. abstract="false" native="false" synchronized="false"
  13179. static="false" final="false" visibility="public"
  13180. deprecated="not deprecated">
  13181. <param name="eventInfo" type="java.util.Map"/>
  13182. <doc>
  13183. <![CDATA[Add a map of the information of the event to the existing information map
  13184. @param eventInfo
  13185. a map of of the information of the event]]>
  13186. </doc>
  13187. </method>
  13188. <method name="setEventInfo"
  13189. abstract="false" native="false" synchronized="false"
  13190. static="false" final="false" visibility="public"
  13191. deprecated="not deprecated">
  13192. <param name="eventInfo" type="java.util.Map"/>
  13193. <doc>
  13194. <![CDATA[Set the information map to the given map of the information of the event
  13195. @param eventInfo
  13196. a map of of the information of the event]]>
  13197. </doc>
  13198. </method>
  13199. <method name="compareTo" return="int"
  13200. abstract="false" native="false" synchronized="false"
  13201. static="false" final="false" visibility="public"
  13202. deprecated="not deprecated">
  13203. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  13204. </method>
  13205. <method name="equals" return="boolean"
  13206. abstract="false" native="false" synchronized="false"
  13207. static="false" final="false" visibility="public"
  13208. deprecated="not deprecated">
  13209. <param name="o" type="java.lang.Object"/>
  13210. </method>
  13211. <method name="hashCode" return="int"
  13212. abstract="false" native="false" synchronized="false"
  13213. static="false" final="false" visibility="public"
  13214. deprecated="not deprecated">
  13215. </method>
  13216. <doc>
  13217. <![CDATA[The class that contains the information of an event that is related to some
  13218. conceptual entity of an application. Users are free to define what the event
  13219. means, such as starting an application, getting allocated a container and
  13220. etc.]]>
  13221. </doc>
  13222. </class>
  13223. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
  13224. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
  13225. <class name="TimelineEvents" extends="java.lang.Object"
  13226. abstract="false"
  13227. static="false" final="false" visibility="public"
  13228. deprecated="not deprecated">
  13229. <constructor name="TimelineEvents"
  13230. static="false" final="false" visibility="public"
  13231. deprecated="not deprecated">
  13232. </constructor>
  13233. <method name="getAllEvents" return="java.util.List"
  13234. abstract="false" native="false" synchronized="false"
  13235. static="false" final="false" visibility="public"
  13236. deprecated="not deprecated">
  13237. <doc>
  13238. <![CDATA[Get a list of {@link EventsOfOneEntity} instances
  13239. @return a list of {@link EventsOfOneEntity} instances]]>
  13240. </doc>
  13241. </method>
  13242. <method name="addEvent"
  13243. abstract="false" native="false" synchronized="false"
  13244. static="false" final="false" visibility="public"
  13245. deprecated="not deprecated">
  13246. <param name="eventsOfOneEntity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity"/>
  13247. <doc>
  13248. <![CDATA[Add a single {@link EventsOfOneEntity} instance into the existing list
  13249. @param eventsOfOneEntity
  13250. a single {@link EventsOfOneEntity} instance]]>
  13251. </doc>
  13252. </method>
  13253. <method name="addEvents"
  13254. abstract="false" native="false" synchronized="false"
  13255. static="false" final="false" visibility="public"
  13256. deprecated="not deprecated">
  13257. <param name="allEvents" type="java.util.List"/>
  13258. <doc>
  13259. <![CDATA[Add a list of {@link EventsOfOneEntity} instances into the existing list
  13260. @param allEvents
  13261. a list of {@link EventsOfOneEntity} instances]]>
  13262. </doc>
  13263. </method>
  13264. <method name="setEvents"
  13265. abstract="false" native="false" synchronized="false"
  13266. static="false" final="false" visibility="public"
  13267. deprecated="not deprecated">
  13268. <param name="allEvents" type="java.util.List"/>
  13269. <doc>
  13270. <![CDATA[Set the list to the given list of {@link EventsOfOneEntity} instances
  13271. @param allEvents
  13272. a list of {@link EventsOfOneEntity} instances]]>
  13273. </doc>
  13274. </method>
  13275. <doc>
  13276. <![CDATA[The class that hosts a list of events, which are categorized according to
  13277. their related entities.]]>
  13278. </doc>
  13279. </class>
  13280. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
  13281. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
  13282. <class name="TimelineEvents.EventsOfOneEntity" extends="java.lang.Object"
  13283. abstract="false"
  13284. static="true" final="false" visibility="public"
  13285. deprecated="not deprecated">
  13286. <constructor name="TimelineEvents.EventsOfOneEntity"
  13287. static="false" final="false" visibility="public"
  13288. deprecated="not deprecated">
  13289. </constructor>
  13290. <method name="getEntityId" return="java.lang.String"
  13291. abstract="false" native="false" synchronized="false"
  13292. static="false" final="false" visibility="public"
  13293. deprecated="not deprecated">
  13294. <doc>
  13295. <![CDATA[Get the entity Id
  13296. @return the entity Id]]>
  13297. </doc>
  13298. </method>
  13299. <method name="setEntityId"
  13300. abstract="false" native="false" synchronized="false"
  13301. static="false" final="false" visibility="public"
  13302. deprecated="not deprecated">
  13303. <param name="entityId" type="java.lang.String"/>
  13304. <doc>
  13305. <![CDATA[Set the entity Id
  13306. @param entityId
  13307. the entity Id]]>
  13308. </doc>
  13309. </method>
  13310. <method name="getEntityType" return="java.lang.String"
  13311. abstract="false" native="false" synchronized="false"
  13312. static="false" final="false" visibility="public"
  13313. deprecated="not deprecated">
  13314. <doc>
  13315. <![CDATA[Get the entity type
  13316. @return the entity type]]>
  13317. </doc>
  13318. </method>
  13319. <method name="setEntityType"
  13320. abstract="false" native="false" synchronized="false"
  13321. static="false" final="false" visibility="public"
  13322. deprecated="not deprecated">
  13323. <param name="entityType" type="java.lang.String"/>
  13324. <doc>
  13325. <![CDATA[Set the entity type
  13326. @param entityType
  13327. the entity type]]>
  13328. </doc>
  13329. </method>
  13330. <method name="getEvents" return="java.util.List"
  13331. abstract="false" native="false" synchronized="false"
  13332. static="false" final="false" visibility="public"
  13333. deprecated="not deprecated">
  13334. <doc>
  13335. <![CDATA[Get a list of events
  13336. @return a list of events]]>
  13337. </doc>
  13338. </method>
  13339. <method name="addEvent"
  13340. abstract="false" native="false" synchronized="false"
  13341. static="false" final="false" visibility="public"
  13342. deprecated="not deprecated">
  13343. <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  13344. <doc>
  13345. <![CDATA[Add a single event to the existing event list
  13346. @param event
  13347. a single event]]>
  13348. </doc>
  13349. </method>
  13350. <method name="addEvents"
  13351. abstract="false" native="false" synchronized="false"
  13352. static="false" final="false" visibility="public"
  13353. deprecated="not deprecated">
  13354. <param name="events" type="java.util.List"/>
  13355. <doc>
  13356. <![CDATA[Add a list of event to the existing event list
  13357. @param events
  13358. a list of events]]>
  13359. </doc>
  13360. </method>
  13361. <method name="setEvents"
  13362. abstract="false" native="false" synchronized="false"
  13363. static="false" final="false" visibility="public"
  13364. deprecated="not deprecated">
  13365. <param name="events" type="java.util.List"/>
  13366. <doc>
  13367. <![CDATA[Set the event list to the given list of events
  13368. @param events
  13369. a list of events]]>
  13370. </doc>
  13371. </method>
  13372. <doc>
  13373. <![CDATA[The class that hosts a list of events that are only related to one entity.]]>
  13374. </doc>
  13375. </class>
  13376. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
  13377. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
  13378. <class name="TimelinePutResponse" extends="java.lang.Object"
  13379. abstract="false"
  13380. static="false" final="false" visibility="public"
  13381. deprecated="not deprecated">
  13382. <constructor name="TimelinePutResponse"
  13383. static="false" final="false" visibility="public"
  13384. deprecated="not deprecated">
  13385. </constructor>
  13386. <method name="getErrors" return="java.util.List"
  13387. abstract="false" native="false" synchronized="false"
  13388. static="false" final="false" visibility="public"
  13389. deprecated="not deprecated">
  13390. <doc>
  13391. <![CDATA[Get a list of {@link TimelinePutError} instances
  13392. @return a list of {@link TimelinePutError} instances]]>
  13393. </doc>
  13394. </method>
  13395. <method name="addError"
  13396. abstract="false" native="false" synchronized="false"
  13397. static="false" final="false" visibility="public"
  13398. deprecated="not deprecated">
  13399. <param name="error" type="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError"/>
  13400. <doc>
  13401. <![CDATA[Add a single {@link TimelinePutError} instance into the existing list
  13402. @param error
  13403. a single {@link TimelinePutError} instance]]>
  13404. </doc>
  13405. </method>
  13406. <method name="addErrors"
  13407. abstract="false" native="false" synchronized="false"
  13408. static="false" final="false" visibility="public"
  13409. deprecated="not deprecated">
  13410. <param name="errors" type="java.util.List"/>
  13411. <doc>
  13412. <![CDATA[Add a list of {@link TimelinePutError} instances into the existing list
  13413. @param errors
  13414. a list of {@link TimelinePutError} instances]]>
  13415. </doc>
  13416. </method>
  13417. <method name="setErrors"
  13418. abstract="false" native="false" synchronized="false"
  13419. static="false" final="false" visibility="public"
  13420. deprecated="not deprecated">
  13421. <param name="errors" type="java.util.List"/>
  13422. <doc>
  13423. <![CDATA[Set the list to the given list of {@link TimelinePutError} instances
  13424. @param errors
  13425. a list of {@link TimelinePutError} instances]]>
  13426. </doc>
  13427. </method>
  13428. <doc>
  13429. <![CDATA[A class that holds a list of put errors. This is the response returned when a
  13430. list of {@link TimelineEntity} objects is added to the timeline. If there are errors
  13431. in storing individual entity objects, they will be indicated in the list of
  13432. errors.]]>
  13433. </doc>
  13434. </class>
  13435. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
  13436. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
  13437. <class name="TimelinePutResponse.TimelinePutError" extends="java.lang.Object"
  13438. abstract="false"
  13439. static="true" final="false" visibility="public"
  13440. deprecated="not deprecated">
  13441. <constructor name="TimelinePutResponse.TimelinePutError"
  13442. static="false" final="false" visibility="public"
  13443. deprecated="not deprecated">
  13444. </constructor>
  13445. <method name="getEntityId" return="java.lang.String"
  13446. abstract="false" native="false" synchronized="false"
  13447. static="false" final="false" visibility="public"
  13448. deprecated="not deprecated">
  13449. <doc>
  13450. <![CDATA[Get the entity Id
  13451. @return the entity Id]]>
  13452. </doc>
  13453. </method>
  13454. <method name="setEntityId"
  13455. abstract="false" native="false" synchronized="false"
  13456. static="false" final="false" visibility="public"
  13457. deprecated="not deprecated">
  13458. <param name="entityId" type="java.lang.String"/>
  13459. <doc>
  13460. <![CDATA[Set the entity Id
  13461. @param entityId
  13462. the entity Id]]>
  13463. </doc>
  13464. </method>
  13465. <method name="getEntityType" return="java.lang.String"
  13466. abstract="false" native="false" synchronized="false"
  13467. static="false" final="false" visibility="public"
  13468. deprecated="not deprecated">
  13469. <doc>
  13470. <![CDATA[Get the entity type
  13471. @return the entity type]]>
  13472. </doc>
  13473. </method>
  13474. <method name="setEntityType"
  13475. abstract="false" native="false" synchronized="false"
  13476. static="false" final="false" visibility="public"
  13477. deprecated="not deprecated">
  13478. <param name="entityType" type="java.lang.String"/>
  13479. <doc>
  13480. <![CDATA[Set the entity type
  13481. @param entityType
  13482. the entity type]]>
  13483. </doc>
  13484. </method>
  13485. <method name="getErrorCode" return="int"
  13486. abstract="false" native="false" synchronized="false"
  13487. static="false" final="false" visibility="public"
  13488. deprecated="not deprecated">
  13489. <doc>
  13490. <![CDATA[Get the error code
  13491. @return an error code]]>
  13492. </doc>
  13493. </method>
  13494. <method name="setErrorCode"
  13495. abstract="false" native="false" synchronized="false"
  13496. static="false" final="false" visibility="public"
  13497. deprecated="not deprecated">
  13498. <param name="errorCode" type="int"/>
  13499. <doc>
  13500. <![CDATA[Set the error code to the given error code
  13501. @param errorCode
  13502. an error code]]>
  13503. </doc>
  13504. </method>
  13505. <field name="NO_START_TIME" type="int"
  13506. transient="false" volatile="false"
  13507. static="true" final="true" visibility="public"
  13508. deprecated="not deprecated">
  13509. <doc>
  13510. <![CDATA[Error code returned when no start time can be found when putting an
  13511. entity. This occurs when the entity does not already exist in the store
  13512. and it is put with no start time or events specified.]]>
  13513. </doc>
  13514. </field>
  13515. <field name="IO_EXCEPTION" type="int"
  13516. transient="false" volatile="false"
  13517. static="true" final="true" visibility="public"
  13518. deprecated="not deprecated">
  13519. <doc>
  13520. <![CDATA[Error code returned if an IOException is encountered when putting an
  13521. entity.]]>
  13522. </doc>
  13523. </field>
  13524. <field name="SYSTEM_FILTER_CONFLICT" type="int"
  13525. transient="false" volatile="false"
  13526. static="true" final="true" visibility="public"
  13527. deprecated="not deprecated">
  13528. <doc>
  13529. <![CDATA[Error code returned if the user specifies the timeline system reserved
  13530. filter key]]>
  13531. </doc>
  13532. </field>
  13533. <field name="ACCESS_DENIED" type="int"
  13534. transient="false" volatile="false"
  13535. static="true" final="true" visibility="public"
  13536. deprecated="not deprecated">
  13537. <doc>
  13538. <![CDATA[Error code returned if the user is denied to access the timeline data]]>
  13539. </doc>
  13540. </field>
  13541. <field name="NO_DOMAIN" type="int"
  13542. transient="false" volatile="false"
  13543. static="true" final="true" visibility="public"
  13544. deprecated="not deprecated">
  13545. <doc>
  13546. <![CDATA[Error code returned if the entity doesn't have an valid domain ID]]>
  13547. </doc>
  13548. </field>
  13549. <field name="FORBIDDEN_RELATION" type="int"
  13550. transient="false" volatile="false"
  13551. static="true" final="true" visibility="public"
  13552. deprecated="not deprecated">
  13553. <doc>
  13554. <![CDATA[Error code returned if the user is denied to relate the entity to another
  13555. one in different domain]]>
  13556. </doc>
  13557. </field>
  13558. <field name="EXPIRED_ENTITY" type="int"
  13559. transient="false" volatile="false"
  13560. static="true" final="true" visibility="public"
  13561. deprecated="not deprecated">
  13562. <doc>
  13563. <![CDATA[Error code returned if the entity start time is before the eviction
  13564. period of old data.]]>
  13565. </doc>
  13566. </field>
  13567. <doc>
  13568. <![CDATA[A class that holds the error code for one entity.]]>
  13569. </doc>
  13570. </class>
  13571. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
  13572. </package>
  13573. <package name="org.apache.hadoop.yarn.api.records.timelineservice">
  13574. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationAttemptEntity -->
  13575. <class name="ApplicationAttemptEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  13576. abstract="false"
  13577. static="false" final="false" visibility="public"
  13578. deprecated="not deprecated">
  13579. <constructor name="ApplicationAttemptEntity"
  13580. static="false" final="false" visibility="public"
  13581. deprecated="not deprecated">
  13582. </constructor>
  13583. <constructor name="ApplicationAttemptEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  13584. static="false" final="false" visibility="public"
  13585. deprecated="not deprecated">
  13586. </constructor>
  13587. <doc>
  13588. <![CDATA[This entity represents an application attempt.]]>
  13589. </doc>
  13590. </class>
  13591. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationAttemptEntity -->
  13592. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationEntity -->
  13593. <class name="ApplicationEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  13594. abstract="false"
  13595. static="false" final="false" visibility="public"
  13596. deprecated="not deprecated">
  13597. <constructor name="ApplicationEntity"
  13598. static="false" final="false" visibility="public"
  13599. deprecated="not deprecated">
  13600. </constructor>
  13601. <constructor name="ApplicationEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  13602. static="false" final="false" visibility="public"
  13603. deprecated="not deprecated">
  13604. </constructor>
  13605. <method name="getQueue" return="java.lang.String"
  13606. abstract="false" native="false" synchronized="false"
  13607. static="false" final="false" visibility="public"
  13608. deprecated="not deprecated">
  13609. </method>
  13610. <method name="setQueue"
  13611. abstract="false" native="false" synchronized="false"
  13612. static="false" final="false" visibility="public"
  13613. deprecated="not deprecated">
  13614. <param name="queue" type="java.lang.String"/>
  13615. </method>
  13616. <method name="isApplicationEntity" return="boolean"
  13617. abstract="false" native="false" synchronized="false"
  13618. static="true" final="false" visibility="public"
  13619. deprecated="not deprecated">
  13620. <param name="te" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  13621. <doc>
  13622. <![CDATA[Checks if the input TimelineEntity object is an ApplicationEntity.
  13623. @param te TimelineEntity object.
  13624. @return true if input is an ApplicationEntity, false otherwise]]>
  13625. </doc>
  13626. </method>
  13627. <method name="getApplicationEvent" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent"
  13628. abstract="false" native="false" synchronized="false"
  13629. static="true" final="false" visibility="public"
  13630. deprecated="not deprecated">
  13631. <param name="te" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  13632. <param name="eventId" type="java.lang.String"/>
  13633. <doc>
  13634. <![CDATA[@param te TimelineEntity object.
  13635. @param eventId event with this id needs to be fetched
  13636. @return TimelineEvent if TimelineEntity contains the desired event.]]>
  13637. </doc>
  13638. </method>
  13639. <field name="QUEUE_INFO_KEY" type="java.lang.String"
  13640. transient="false" volatile="false"
  13641. static="true" final="true" visibility="public"
  13642. deprecated="not deprecated">
  13643. </field>
  13644. <doc>
  13645. <![CDATA[This entity represents an application.]]>
  13646. </doc>
  13647. </class>
  13648. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationEntity -->
  13649. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ClusterEntity -->
  13650. <class name="ClusterEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  13651. abstract="false"
  13652. static="false" final="false" visibility="public"
  13653. deprecated="not deprecated">
  13654. <constructor name="ClusterEntity"
  13655. static="false" final="false" visibility="public"
  13656. deprecated="not deprecated">
  13657. </constructor>
  13658. <constructor name="ClusterEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  13659. static="false" final="false" visibility="public"
  13660. deprecated="not deprecated">
  13661. </constructor>
  13662. <doc>
  13663. <![CDATA[This entity represents a YARN cluster.]]>
  13664. </doc>
  13665. </class>
  13666. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ClusterEntity -->
  13667. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ContainerEntity -->
  13668. <class name="ContainerEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  13669. abstract="false"
  13670. static="false" final="false" visibility="public"
  13671. deprecated="not deprecated">
  13672. <constructor name="ContainerEntity"
  13673. static="false" final="false" visibility="public"
  13674. deprecated="not deprecated">
  13675. </constructor>
  13676. <constructor name="ContainerEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  13677. static="false" final="false" visibility="public"
  13678. deprecated="not deprecated">
  13679. </constructor>
  13680. <doc>
  13681. <![CDATA[This entity represents a container belonging to an application attempt.]]>
  13682. </doc>
  13683. </class>
  13684. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ContainerEntity -->
  13685. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.FlowActivityEntity -->
  13686. <class name="FlowActivityEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  13687. abstract="false"
  13688. static="false" final="false" visibility="public"
  13689. deprecated="not deprecated">
  13690. <constructor name="FlowActivityEntity"
  13691. static="false" final="false" visibility="public"
  13692. deprecated="not deprecated">
  13693. </constructor>
  13694. <constructor name="FlowActivityEntity" type="java.lang.String, long, java.lang.String, java.lang.String"
  13695. static="false" final="false" visibility="public"
  13696. deprecated="not deprecated">
  13697. </constructor>
  13698. <constructor name="FlowActivityEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  13699. static="false" final="false" visibility="public"
  13700. deprecated="not deprecated">
  13701. </constructor>
  13702. <method name="getId" return="java.lang.String"
  13703. abstract="false" native="false" synchronized="false"
  13704. static="false" final="false" visibility="public"
  13705. deprecated="not deprecated">
  13706. </method>
  13707. <method name="compareTo" return="int"
  13708. abstract="false" native="false" synchronized="false"
  13709. static="false" final="false" visibility="public"
  13710. deprecated="not deprecated">
  13711. <param name="entity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  13712. </method>
  13713. <method name="equals" return="boolean"
  13714. abstract="false" native="false" synchronized="false"
  13715. static="false" final="false" visibility="public"
  13716. deprecated="not deprecated">
  13717. <param name="obj" type="java.lang.Object"/>
  13718. <doc>
  13719. <![CDATA[Reuse the base class equals method.]]>
  13720. </doc>
  13721. </method>
  13722. <method name="hashCode" return="int"
  13723. abstract="false" native="false" synchronized="false"
  13724. static="false" final="false" visibility="public"
  13725. deprecated="not deprecated">
  13726. <doc>
  13727. <![CDATA[Reuse the base class hashCode method.]]>
  13728. </doc>
  13729. </method>
  13730. <method name="getCluster" return="java.lang.String"
  13731. abstract="false" native="false" synchronized="false"
  13732. static="false" final="false" visibility="public"
  13733. deprecated="not deprecated">
  13734. </method>
  13735. <method name="setCluster"
  13736. abstract="false" native="false" synchronized="false"
  13737. static="false" final="false" visibility="public"
  13738. deprecated="not deprecated">
  13739. <param name="cluster" type="java.lang.String"/>
  13740. </method>
  13741. <method name="getDate" return="java.util.Date"
  13742. abstract="false" native="false" synchronized="false"
  13743. static="false" final="false" visibility="public"
  13744. deprecated="not deprecated">
  13745. </method>
  13746. <method name="setDate"
  13747. abstract="false" native="false" synchronized="false"
  13748. static="false" final="false" visibility="public"
  13749. deprecated="not deprecated">
  13750. <param name="time" type="long"/>
  13751. </method>
  13752. <method name="getUser" return="java.lang.String"
  13753. abstract="false" native="false" synchronized="false"
  13754. static="false" final="false" visibility="public"
  13755. deprecated="not deprecated">
  13756. </method>
  13757. <method name="setUser"
  13758. abstract="false" native="false" synchronized="false"
  13759. static="false" final="false" visibility="public"
  13760. deprecated="not deprecated">
  13761. <param name="user" type="java.lang.String"/>
  13762. </method>
  13763. <method name="getFlowName" return="java.lang.String"
  13764. abstract="false" native="false" synchronized="false"
  13765. static="false" final="false" visibility="public"
  13766. deprecated="not deprecated">
  13767. </method>
  13768. <method name="setFlowName"
  13769. abstract="false" native="false" synchronized="false"
  13770. static="false" final="false" visibility="public"
  13771. deprecated="not deprecated">
  13772. <param name="flowName" type="java.lang.String"/>
  13773. </method>
  13774. <method name="addFlowRun"
  13775. abstract="false" native="false" synchronized="false"
  13776. static="false" final="false" visibility="public"
  13777. deprecated="not deprecated">
  13778. <param name="run" type="org.apache.hadoop.yarn.api.records.timelineservice.FlowRunEntity"/>
  13779. </method>
  13780. <method name="addFlowRuns"
  13781. abstract="false" native="false" synchronized="false"
  13782. static="false" final="false" visibility="public"
  13783. deprecated="not deprecated">
  13784. <param name="runs" type="java.util.Collection"/>
  13785. </method>
  13786. <method name="getFlowRuns" return="java.util.NavigableSet"
  13787. abstract="false" native="false" synchronized="false"
  13788. static="false" final="false" visibility="public"
  13789. deprecated="not deprecated">
  13790. </method>
  13791. <method name="getNumberOfRuns" return="int"
  13792. abstract="false" native="false" synchronized="false"
  13793. static="false" final="false" visibility="public"
  13794. deprecated="not deprecated">
  13795. </method>
  13796. <field name="CLUSTER_INFO_KEY" type="java.lang.String"
  13797. transient="false" volatile="false"
  13798. static="true" final="true" visibility="public"
  13799. deprecated="not deprecated">
  13800. </field>
  13801. <field name="DATE_INFO_KEY" type="java.lang.String"
  13802. transient="false" volatile="false"
  13803. static="true" final="true" visibility="public"
  13804. deprecated="not deprecated">
  13805. </field>
  13806. <field name="USER_INFO_KEY" type="java.lang.String"
  13807. transient="false" volatile="false"
  13808. static="true" final="true" visibility="public"
  13809. deprecated="not deprecated">
  13810. </field>
  13811. <field name="FLOW_NAME_INFO_KEY" type="java.lang.String"
  13812. transient="false" volatile="false"
  13813. static="true" final="true" visibility="public"
  13814. deprecated="not deprecated">
  13815. </field>
  13816. <doc>
  13817. <![CDATA[Entity that represents a record for flow activity. It's essentially a
  13818. container entity for flow runs with limited information.]]>
  13819. </doc>
  13820. </class>
  13821. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.FlowActivityEntity -->
  13822. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.FlowRunEntity -->
  13823. <class name="FlowRunEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  13824. abstract="false"
  13825. static="false" final="false" visibility="public"
  13826. deprecated="not deprecated">
  13827. <constructor name="FlowRunEntity"
  13828. static="false" final="false" visibility="public"
  13829. deprecated="not deprecated">
  13830. </constructor>
  13831. <constructor name="FlowRunEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  13832. static="false" final="false" visibility="public"
  13833. deprecated="not deprecated">
  13834. </constructor>
  13835. <method name="getId" return="java.lang.String"
  13836. abstract="false" native="false" synchronized="false"
  13837. static="false" final="false" visibility="public"
  13838. deprecated="not deprecated">
  13839. </method>
  13840. <method name="getUser" return="java.lang.String"
  13841. abstract="false" native="false" synchronized="false"
  13842. static="false" final="false" visibility="public"
  13843. deprecated="not deprecated">
  13844. </method>
  13845. <method name="setUser"
  13846. abstract="false" native="false" synchronized="false"
  13847. static="false" final="false" visibility="public"
  13848. deprecated="not deprecated">
  13849. <param name="user" type="java.lang.String"/>
  13850. </method>
  13851. <method name="getName" return="java.lang.String"
  13852. abstract="false" native="false" synchronized="false"
  13853. static="false" final="false" visibility="public"
  13854. deprecated="not deprecated">
  13855. </method>
  13856. <method name="setName"
  13857. abstract="false" native="false" synchronized="false"
  13858. static="false" final="false" visibility="public"
  13859. deprecated="not deprecated">
  13860. <param name="name" type="java.lang.String"/>
  13861. </method>
  13862. <method name="getVersion" return="java.lang.String"
  13863. abstract="false" native="false" synchronized="false"
  13864. static="false" final="false" visibility="public"
  13865. deprecated="not deprecated">
  13866. </method>
  13867. <method name="setVersion"
  13868. abstract="false" native="false" synchronized="false"
  13869. static="false" final="false" visibility="public"
  13870. deprecated="not deprecated">
  13871. <param name="version" type="java.lang.String"/>
  13872. </method>
  13873. <method name="getRunId" return="long"
  13874. abstract="false" native="false" synchronized="false"
  13875. static="false" final="false" visibility="public"
  13876. deprecated="not deprecated">
  13877. </method>
  13878. <method name="setRunId"
  13879. abstract="false" native="false" synchronized="false"
  13880. static="false" final="false" visibility="public"
  13881. deprecated="not deprecated">
  13882. <param name="runId" type="long"/>
  13883. </method>
  13884. <method name="getStartTime" return="long"
  13885. abstract="false" native="false" synchronized="false"
  13886. static="false" final="false" visibility="public"
  13887. deprecated="not deprecated">
  13888. </method>
  13889. <method name="setStartTime"
  13890. abstract="false" native="false" synchronized="false"
  13891. static="false" final="false" visibility="public"
  13892. deprecated="not deprecated">
  13893. <param name="startTime" type="long"/>
  13894. </method>
  13895. <method name="getMaxEndTime" return="long"
  13896. abstract="false" native="false" synchronized="false"
  13897. static="false" final="false" visibility="public"
  13898. deprecated="not deprecated">
  13899. </method>
  13900. <method name="setMaxEndTime"
  13901. abstract="false" native="false" synchronized="false"
  13902. static="false" final="false" visibility="public"
  13903. deprecated="not deprecated">
  13904. <param name="endTime" type="long"/>
  13905. </method>
  13906. <field name="USER_INFO_KEY" type="java.lang.String"
  13907. transient="false" volatile="false"
  13908. static="true" final="true" visibility="public"
  13909. deprecated="not deprecated">
  13910. </field>
  13911. <field name="FLOW_NAME_INFO_KEY" type="java.lang.String"
  13912. transient="false" volatile="false"
  13913. static="true" final="true" visibility="public"
  13914. deprecated="not deprecated">
  13915. </field>
  13916. <field name="FLOW_VERSION_INFO_KEY" type="java.lang.String"
  13917. transient="false" volatile="false"
  13918. static="true" final="true" visibility="public"
  13919. deprecated="not deprecated">
  13920. </field>
  13921. <field name="FLOW_RUN_ID_INFO_KEY" type="java.lang.String"
  13922. transient="false" volatile="false"
  13923. static="true" final="true" visibility="public"
  13924. deprecated="not deprecated">
  13925. </field>
  13926. <field name="FLOW_RUN_END_TIME" type="java.lang.String"
  13927. transient="false" volatile="false"
  13928. static="true" final="true" visibility="public"
  13929. deprecated="not deprecated">
  13930. </field>
  13931. <doc>
  13932. <![CDATA[This entity represents a flow run.]]>
  13933. </doc>
  13934. </class>
  13935. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.FlowRunEntity -->
  13936. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity -->
  13937. <class name="HierarchicalTimelineEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  13938. abstract="true"
  13939. static="false" final="false" visibility="public"
  13940. deprecated="not deprecated">
  13941. <method name="getParent" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"
  13942. abstract="false" native="false" synchronized="false"
  13943. static="false" final="false" visibility="public"
  13944. deprecated="not deprecated">
  13945. </method>
  13946. <method name="setParent"
  13947. abstract="false" native="false" synchronized="false"
  13948. static="false" final="false" visibility="public"
  13949. deprecated="not deprecated">
  13950. <param name="parent" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"/>
  13951. </method>
  13952. <method name="setParent"
  13953. abstract="false" native="false" synchronized="false"
  13954. static="false" final="false" visibility="public"
  13955. deprecated="not deprecated">
  13956. <param name="type" type="java.lang.String"/>
  13957. <param name="id" type="java.lang.String"/>
  13958. </method>
  13959. <method name="getChildren" return="java.util.Set"
  13960. abstract="false" native="false" synchronized="false"
  13961. static="false" final="false" visibility="public"
  13962. deprecated="not deprecated">
  13963. </method>
  13964. <method name="setChildren"
  13965. abstract="false" native="false" synchronized="false"
  13966. static="false" final="false" visibility="public"
  13967. deprecated="not deprecated">
  13968. <param name="children" type="java.util.Set"/>
  13969. </method>
  13970. <method name="addChildren"
  13971. abstract="false" native="false" synchronized="false"
  13972. static="false" final="false" visibility="public"
  13973. deprecated="not deprecated">
  13974. <param name="children" type="java.util.Set"/>
  13975. </method>
  13976. <method name="addChild"
  13977. abstract="false" native="false" synchronized="false"
  13978. static="false" final="false" visibility="public"
  13979. deprecated="not deprecated">
  13980. <param name="child" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"/>
  13981. </method>
  13982. <method name="addChild"
  13983. abstract="false" native="false" synchronized="false"
  13984. static="false" final="false" visibility="public"
  13985. deprecated="not deprecated">
  13986. <param name="type" type="java.lang.String"/>
  13987. <param name="id" type="java.lang.String"/>
  13988. </method>
  13989. <field name="PARENT_INFO_KEY" type="java.lang.String"
  13990. transient="false" volatile="false"
  13991. static="true" final="true" visibility="public"
  13992. deprecated="not deprecated">
  13993. </field>
  13994. <field name="CHILDREN_INFO_KEY" type="java.lang.String"
  13995. transient="false" volatile="false"
  13996. static="true" final="true" visibility="public"
  13997. deprecated="not deprecated">
  13998. </field>
  13999. <doc>
  14000. <![CDATA[This class extends timeline entity and defines parent-child relationships
  14001. with other entities.]]>
  14002. </doc>
  14003. </class>
  14004. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity -->
  14005. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.QueueEntity -->
  14006. <class name="QueueEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  14007. abstract="false"
  14008. static="false" final="false" visibility="public"
  14009. deprecated="not deprecated">
  14010. <constructor name="QueueEntity"
  14011. static="false" final="false" visibility="public"
  14012. deprecated="not deprecated">
  14013. </constructor>
  14014. <constructor name="QueueEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  14015. static="false" final="false" visibility="public"
  14016. deprecated="not deprecated">
  14017. </constructor>
  14018. <doc>
  14019. <![CDATA[This entity represents a queue.]]>
  14020. </doc>
  14021. </class>
  14022. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.QueueEntity -->
  14023. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.SubApplicationEntity -->
  14024. <class name="SubApplicationEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
  14025. abstract="false"
  14026. static="false" final="false" visibility="public"
  14027. deprecated="not deprecated">
  14028. <constructor name="SubApplicationEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  14029. static="false" final="false" visibility="public"
  14030. deprecated="not deprecated">
  14031. </constructor>
  14032. <method name="isSubApplicationEntity" return="boolean"
  14033. abstract="false" native="false" synchronized="false"
  14034. static="true" final="false" visibility="public"
  14035. deprecated="not deprecated">
  14036. <param name="te" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  14037. <doc>
  14038. <![CDATA[Checks if the input TimelineEntity object is an SubApplicationEntity.
  14039. @param te TimelineEntity object.
  14040. @return true if input is an SubApplicationEntity, false otherwise]]>
  14041. </doc>
  14042. </method>
  14043. <method name="setApplicationId"
  14044. abstract="false" native="false" synchronized="false"
  14045. static="false" final="false" visibility="public"
  14046. deprecated="not deprecated">
  14047. <param name="appId" type="java.lang.String"/>
  14048. </method>
  14049. <field name="YARN_APPLICATION_ID" type="java.lang.String"
  14050. transient="false" volatile="false"
  14051. static="true" final="true" visibility="public"
  14052. deprecated="not deprecated">
  14053. </field>
  14054. <doc>
  14055. <![CDATA[This entity represents a user defined entities to be stored under sub
  14056. application table.]]>
  14057. </doc>
  14058. </class>
  14059. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.SubApplicationEntity -->
  14060. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities -->
  14061. <class name="TimelineEntities" extends="java.lang.Object"
  14062. abstract="false"
  14063. static="false" final="false" visibility="public"
  14064. deprecated="not deprecated">
  14065. <constructor name="TimelineEntities"
  14066. static="false" final="false" visibility="public"
  14067. deprecated="not deprecated">
  14068. </constructor>
  14069. <method name="getEntities" return="java.util.List"
  14070. abstract="false" native="false" synchronized="false"
  14071. static="false" final="false" visibility="public"
  14072. deprecated="not deprecated">
  14073. </method>
  14074. <method name="setEntities"
  14075. abstract="false" native="false" synchronized="false"
  14076. static="false" final="false" visibility="public"
  14077. deprecated="not deprecated">
  14078. <param name="timelineEntities" type="java.util.List"/>
  14079. </method>
  14080. <method name="addEntities"
  14081. abstract="false" native="false" synchronized="false"
  14082. static="false" final="false" visibility="public"
  14083. deprecated="not deprecated">
  14084. <param name="timelineEntities" type="java.util.List"/>
  14085. </method>
  14086. <method name="addEntity"
  14087. abstract="false" native="false" synchronized="false"
  14088. static="false" final="false" visibility="public"
  14089. deprecated="not deprecated">
  14090. <param name="entity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  14091. </method>
  14092. <doc>
  14093. <![CDATA[This class hosts a set of timeline entities.]]>
  14094. </doc>
  14095. </class>
  14096. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities -->
  14097. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity -->
  14098. <class name="TimelineEntity" extends="java.lang.Object"
  14099. abstract="false"
  14100. static="false" final="false" visibility="public"
  14101. deprecated="not deprecated">
  14102. <implements name="java.lang.Comparable"/>
  14103. <constructor name="TimelineEntity"
  14104. static="false" final="false" visibility="public"
  14105. deprecated="not deprecated">
  14106. </constructor>
  14107. <constructor name="TimelineEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  14108. static="false" final="false" visibility="public"
  14109. deprecated="not deprecated">
  14110. <doc>
  14111. <![CDATA[<p>
  14112. The constuctor is used to construct a proxy {@link TimelineEntity} or its
  14113. subclass object from the real entity object that carries information.
  14114. </p>
  14115. <p>
  14116. It is usually used in the case where we want to recover class polymorphism
  14117. after deserializing the entity from its JSON form.
  14118. </p>
  14119. @param entity the real entity that carries information]]>
  14120. </doc>
  14121. </constructor>
  14122. <constructor name="TimelineEntity" type="java.lang.String"
  14123. static="false" final="false" visibility="protected"
  14124. deprecated="not deprecated">
  14125. </constructor>
  14126. <method name="getType" return="java.lang.String"
  14127. abstract="false" native="false" synchronized="false"
  14128. static="false" final="false" visibility="public"
  14129. deprecated="not deprecated">
  14130. </method>
  14131. <method name="setType"
  14132. abstract="false" native="false" synchronized="false"
  14133. static="false" final="false" visibility="public"
  14134. deprecated="not deprecated">
  14135. <param name="type" type="java.lang.String"/>
  14136. </method>
  14137. <method name="getId" return="java.lang.String"
  14138. abstract="false" native="false" synchronized="false"
  14139. static="false" final="false" visibility="public"
  14140. deprecated="not deprecated">
  14141. </method>
  14142. <method name="setId"
  14143. abstract="false" native="false" synchronized="false"
  14144. static="false" final="false" visibility="public"
  14145. deprecated="not deprecated">
  14146. <param name="id" type="java.lang.String"/>
  14147. </method>
  14148. <method name="getIdentifier" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"
  14149. abstract="false" native="false" synchronized="false"
  14150. static="false" final="false" visibility="public"
  14151. deprecated="not deprecated">
  14152. </method>
  14153. <method name="setIdentifier"
  14154. abstract="false" native="false" synchronized="false"
  14155. static="false" final="false" visibility="public"
  14156. deprecated="not deprecated">
  14157. <param name="entityIdentifier" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"/>
  14158. </method>
  14159. <method name="getInfo" return="java.util.Map"
  14160. abstract="false" native="false" synchronized="false"
  14161. static="false" final="false" visibility="public"
  14162. deprecated="not deprecated">
  14163. </method>
  14164. <method name="setInfo"
  14165. abstract="false" native="false" synchronized="false"
  14166. static="false" final="false" visibility="public"
  14167. deprecated="not deprecated">
  14168. <param name="entityInfos" type="java.util.Map"/>
  14169. </method>
  14170. <method name="addInfo"
  14171. abstract="false" native="false" synchronized="false"
  14172. static="false" final="false" visibility="public"
  14173. deprecated="not deprecated">
  14174. <param name="entityInfos" type="java.util.Map"/>
  14175. </method>
  14176. <method name="addInfo"
  14177. abstract="false" native="false" synchronized="false"
  14178. static="false" final="false" visibility="public"
  14179. deprecated="not deprecated">
  14180. <param name="key" type="java.lang.String"/>
  14181. <param name="value" type="java.lang.Object"/>
  14182. </method>
  14183. <method name="getConfigs" return="java.util.Map"
  14184. abstract="false" native="false" synchronized="false"
  14185. static="false" final="false" visibility="public"
  14186. deprecated="not deprecated">
  14187. </method>
  14188. <method name="setConfigs"
  14189. abstract="false" native="false" synchronized="false"
  14190. static="false" final="false" visibility="public"
  14191. deprecated="not deprecated">
  14192. <param name="entityConfigs" type="java.util.Map"/>
  14193. </method>
  14194. <method name="addConfigs"
  14195. abstract="false" native="false" synchronized="false"
  14196. static="false" final="false" visibility="public"
  14197. deprecated="not deprecated">
  14198. <param name="entityConfigs" type="java.util.Map"/>
  14199. </method>
  14200. <method name="addConfig"
  14201. abstract="false" native="false" synchronized="false"
  14202. static="false" final="false" visibility="public"
  14203. deprecated="not deprecated">
  14204. <param name="key" type="java.lang.String"/>
  14205. <param name="value" type="java.lang.String"/>
  14206. </method>
  14207. <method name="getMetrics" return="java.util.Set"
  14208. abstract="false" native="false" synchronized="false"
  14209. static="false" final="false" visibility="public"
  14210. deprecated="not deprecated">
  14211. </method>
  14212. <method name="setMetrics"
  14213. abstract="false" native="false" synchronized="false"
  14214. static="false" final="false" visibility="public"
  14215. deprecated="not deprecated">
  14216. <param name="entityMetrics" type="java.util.Set"/>
  14217. </method>
  14218. <method name="addMetrics"
  14219. abstract="false" native="false" synchronized="false"
  14220. static="false" final="false" visibility="public"
  14221. deprecated="not deprecated">
  14222. <param name="entityMetrics" type="java.util.Set"/>
  14223. </method>
  14224. <method name="addMetric"
  14225. abstract="false" native="false" synchronized="false"
  14226. static="false" final="false" visibility="public"
  14227. deprecated="not deprecated">
  14228. <param name="metric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  14229. </method>
  14230. <method name="getEvents" return="java.util.NavigableSet"
  14231. abstract="false" native="false" synchronized="false"
  14232. static="false" final="false" visibility="public"
  14233. deprecated="not deprecated">
  14234. </method>
  14235. <method name="setEvents"
  14236. abstract="false" native="false" synchronized="false"
  14237. static="false" final="false" visibility="public"
  14238. deprecated="not deprecated">
  14239. <param name="entityEvents" type="java.util.NavigableSet"/>
  14240. </method>
  14241. <method name="addEvents"
  14242. abstract="false" native="false" synchronized="false"
  14243. static="false" final="false" visibility="public"
  14244. deprecated="not deprecated">
  14245. <param name="entityEvents" type="java.util.Set"/>
  14246. </method>
  14247. <method name="addEvent"
  14248. abstract="false" native="false" synchronized="false"
  14249. static="false" final="false" visibility="public"
  14250. deprecated="not deprecated">
  14251. <param name="event" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent"/>
  14252. </method>
  14253. <method name="getIsRelatedToEntities" return="java.util.Map"
  14254. abstract="false" native="false" synchronized="false"
  14255. static="false" final="false" visibility="public"
  14256. deprecated="not deprecated">
  14257. </method>
  14258. <method name="setIsRelatedToEntities"
  14259. abstract="false" native="false" synchronized="false"
  14260. static="false" final="false" visibility="public"
  14261. deprecated="not deprecated">
  14262. <param name="isRelatedTo" type="java.util.Map"/>
  14263. </method>
  14264. <method name="addIsRelatedToEntities"
  14265. abstract="false" native="false" synchronized="false"
  14266. static="false" final="false" visibility="public"
  14267. deprecated="not deprecated">
  14268. <param name="isRelatedTo" type="java.util.Map"/>
  14269. </method>
  14270. <method name="addIsRelatedToEntity"
  14271. abstract="false" native="false" synchronized="false"
  14272. static="false" final="false" visibility="public"
  14273. deprecated="not deprecated">
  14274. <param name="type" type="java.lang.String"/>
  14275. <param name="id" type="java.lang.String"/>
  14276. </method>
  14277. <method name="getRelatesToEntities" return="java.util.Map"
  14278. abstract="false" native="false" synchronized="false"
  14279. static="false" final="false" visibility="public"
  14280. deprecated="not deprecated">
  14281. </method>
  14282. <method name="addRelatesToEntities"
  14283. abstract="false" native="false" synchronized="false"
  14284. static="false" final="false" visibility="public"
  14285. deprecated="not deprecated">
  14286. <param name="relatesTo" type="java.util.Map"/>
  14287. </method>
  14288. <method name="addRelatesToEntity"
  14289. abstract="false" native="false" synchronized="false"
  14290. static="false" final="false" visibility="public"
  14291. deprecated="not deprecated">
  14292. <param name="type" type="java.lang.String"/>
  14293. <param name="id" type="java.lang.String"/>
  14294. </method>
  14295. <method name="setRelatesToEntities"
  14296. abstract="false" native="false" synchronized="false"
  14297. static="false" final="false" visibility="public"
  14298. deprecated="not deprecated">
  14299. <param name="relatesTo" type="java.util.Map"/>
  14300. </method>
  14301. <method name="getCreatedTime" return="java.lang.Long"
  14302. abstract="false" native="false" synchronized="false"
  14303. static="false" final="false" visibility="public"
  14304. deprecated="not deprecated">
  14305. </method>
  14306. <method name="setCreatedTime"
  14307. abstract="false" native="false" synchronized="false"
  14308. static="false" final="false" visibility="public"
  14309. deprecated="not deprecated">
  14310. <param name="createdTs" type="java.lang.Long"/>
  14311. </method>
  14312. <method name="setUID"
  14313. abstract="false" native="false" synchronized="false"
  14314. static="false" final="false" visibility="public"
  14315. deprecated="not deprecated">
  14316. <param name="uidKey" type="java.lang.String"/>
  14317. <param name="uId" type="java.lang.String"/>
  14318. <doc>
  14319. <![CDATA[Set UID in info which will be then used for query by UI.
  14320. @param uidKey key for UID in info.
  14321. @param uId UID to be set for the key.]]>
  14322. </doc>
  14323. </method>
  14324. <method name="isValid" return="boolean"
  14325. abstract="false" native="false" synchronized="false"
  14326. static="false" final="false" visibility="public"
  14327. deprecated="not deprecated">
  14328. </method>
  14329. <method name="hashCode" return="int"
  14330. abstract="false" native="false" synchronized="false"
  14331. static="false" final="false" visibility="public"
  14332. deprecated="not deprecated">
  14333. </method>
  14334. <method name="equals" return="boolean"
  14335. abstract="false" native="false" synchronized="false"
  14336. static="false" final="false" visibility="public"
  14337. deprecated="not deprecated">
  14338. <param name="obj" type="java.lang.Object"/>
  14339. </method>
  14340. <method name="compareTo" return="int"
  14341. abstract="false" native="false" synchronized="false"
  14342. static="false" final="false" visibility="public"
  14343. deprecated="not deprecated">
  14344. <param name="other" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
  14345. </method>
  14346. <method name="getReal" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  14347. abstract="false" native="false" synchronized="false"
  14348. static="false" final="false" visibility="protected"
  14349. deprecated="not deprecated">
  14350. </method>
  14351. <method name="toString" return="java.lang.String"
  14352. abstract="false" native="false" synchronized="false"
  14353. static="false" final="false" visibility="public"
  14354. deprecated="not deprecated">
  14355. </method>
  14356. <method name="getIdPrefix" return="long"
  14357. abstract="false" native="false" synchronized="false"
  14358. static="false" final="false" visibility="public"
  14359. deprecated="not deprecated">
  14360. </method>
  14361. <method name="setIdPrefix"
  14362. abstract="false" native="false" synchronized="false"
  14363. static="false" final="false" visibility="public"
  14364. deprecated="not deprecated">
  14365. <param name="entityIdPrefix" type="long"/>
  14366. <doc>
  14367. <![CDATA[Sets idPrefix for an entity.
  14368. <p>
  14369. <b>Note</b>: Entities will be stored in the order of idPrefix specified.
  14370. If users decide to set idPrefix for an entity, they <b>MUST</b> provide
  14371. the same prefix for every update of this entity.
  14372. </p>
  14373. Example: <blockquote><pre>
  14374. TimelineEntity entity = new TimelineEntity();
  14375. entity.setIdPrefix(value);
  14376. </pre></blockquote>
  14377. Users can use {@link TimelineServiceHelper#invertLong(long)} to invert
  14378. the prefix if necessary.
  14379. @param entityIdPrefix prefix for an entity.]]>
  14380. </doc>
  14381. </method>
  14382. <field name="SYSTEM_INFO_KEY_PREFIX" type="java.lang.String"
  14383. transient="false" volatile="false"
  14384. static="true" final="true" visibility="protected"
  14385. deprecated="not deprecated">
  14386. </field>
  14387. <field name="DEFAULT_ENTITY_PREFIX" type="long"
  14388. transient="false" volatile="false"
  14389. static="true" final="true" visibility="public"
  14390. deprecated="not deprecated">
  14391. </field>
  14392. <doc>
  14393. <![CDATA[The basic timeline entity data structure for timeline service v2. Timeline
  14394. entity objects are not thread safe and should not be accessed concurrently.
  14395. All collection members will be initialized into empty collections. Two
  14396. timeline entities are equal iff. their type and id are identical.
  14397. All non-primitive type, non-collection members will be initialized into null.
  14398. User should set the type and id of a timeline entity to make it valid (can be
  14399. checked by using the {@link #isValid()} method). Callers to the getters
  14400. should perform null checks for non-primitive type, non-collection members.
  14401. Callers are recommended not to alter the returned collection objects from the
  14402. getters.]]>
  14403. </doc>
  14404. </class>
  14405. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity -->
  14406. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType -->
  14407. <class name="TimelineEntityType" extends="java.lang.Enum"
  14408. abstract="false"
  14409. static="false" final="true" visibility="public"
  14410. deprecated="not deprecated">
  14411. <method name="values" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType[]"
  14412. abstract="false" native="false" synchronized="false"
  14413. static="true" final="false" visibility="public"
  14414. deprecated="not deprecated">
  14415. </method>
  14416. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType"
  14417. abstract="false" native="false" synchronized="false"
  14418. static="true" final="false" visibility="public"
  14419. deprecated="not deprecated">
  14420. <param name="name" type="java.lang.String"/>
  14421. </method>
  14422. <method name="isParent" return="boolean"
  14423. abstract="false" native="false" synchronized="false"
  14424. static="false" final="false" visibility="public"
  14425. deprecated="not deprecated">
  14426. <param name="type" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType"/>
  14427. <doc>
  14428. <![CDATA[Whether the input type can be a parent of this entity.
  14429. @param type entity type.
  14430. @return true, if this entity type is parent of passed entity type, false
  14431. otherwise.]]>
  14432. </doc>
  14433. </method>
  14434. <method name="isChild" return="boolean"
  14435. abstract="false" native="false" synchronized="false"
  14436. static="false" final="false" visibility="public"
  14437. deprecated="not deprecated">
  14438. <param name="type" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType"/>
  14439. <doc>
  14440. <![CDATA[Whether the input type can be a child of this entity.
  14441. @param type entity type.
  14442. @return true, if this entity type is child of passed entity type, false
  14443. otherwise.]]>
  14444. </doc>
  14445. </method>
  14446. <method name="matches" return="boolean"
  14447. abstract="false" native="false" synchronized="false"
  14448. static="false" final="false" visibility="public"
  14449. deprecated="not deprecated">
  14450. <param name="typeString" type="java.lang.String"/>
  14451. <doc>
  14452. <![CDATA[Whether the type of this entity matches the type indicated by the input
  14453. argument.
  14454. @param typeString entity type represented as a string.
  14455. @return true, if string representation of this entity type matches the
  14456. entity type passed.]]>
  14457. </doc>
  14458. </method>
  14459. <doc>
  14460. <![CDATA[Defines type of entity.]]>
  14461. </doc>
  14462. </class>
  14463. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType -->
  14464. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent -->
  14465. <class name="TimelineEvent" extends="java.lang.Object"
  14466. abstract="false"
  14467. static="false" final="false" visibility="public"
  14468. deprecated="not deprecated">
  14469. <implements name="java.lang.Comparable"/>
  14470. <constructor name="TimelineEvent"
  14471. static="false" final="false" visibility="public"
  14472. deprecated="not deprecated">
  14473. </constructor>
  14474. <method name="getId" return="java.lang.String"
  14475. abstract="false" native="false" synchronized="false"
  14476. static="false" final="false" visibility="public"
  14477. deprecated="not deprecated">
  14478. </method>
  14479. <method name="setId"
  14480. abstract="false" native="false" synchronized="false"
  14481. static="false" final="false" visibility="public"
  14482. deprecated="not deprecated">
  14483. <param name="eventId" type="java.lang.String"/>
  14484. </method>
  14485. <method name="getInfo" return="java.util.Map"
  14486. abstract="false" native="false" synchronized="false"
  14487. static="false" final="false" visibility="public"
  14488. deprecated="not deprecated">
  14489. </method>
  14490. <method name="setInfo"
  14491. abstract="false" native="false" synchronized="false"
  14492. static="false" final="false" visibility="public"
  14493. deprecated="not deprecated">
  14494. <param name="infos" type="java.util.Map"/>
  14495. </method>
  14496. <method name="addInfo"
  14497. abstract="false" native="false" synchronized="false"
  14498. static="false" final="false" visibility="public"
  14499. deprecated="not deprecated">
  14500. <param name="infos" type="java.util.Map"/>
  14501. </method>
  14502. <method name="addInfo"
  14503. abstract="false" native="false" synchronized="false"
  14504. static="false" final="false" visibility="public"
  14505. deprecated="not deprecated">
  14506. <param name="key" type="java.lang.String"/>
  14507. <param name="value" type="java.lang.Object"/>
  14508. </method>
  14509. <method name="getTimestamp" return="long"
  14510. abstract="false" native="false" synchronized="false"
  14511. static="false" final="false" visibility="public"
  14512. deprecated="not deprecated">
  14513. </method>
  14514. <method name="setTimestamp"
  14515. abstract="false" native="false" synchronized="false"
  14516. static="false" final="false" visibility="public"
  14517. deprecated="not deprecated">
  14518. <param name="ts" type="long"/>
  14519. </method>
  14520. <method name="isValid" return="boolean"
  14521. abstract="false" native="false" synchronized="false"
  14522. static="false" final="false" visibility="public"
  14523. deprecated="not deprecated">
  14524. </method>
  14525. <method name="hashCode" return="int"
  14526. abstract="false" native="false" synchronized="false"
  14527. static="false" final="false" visibility="public"
  14528. deprecated="not deprecated">
  14529. </method>
  14530. <method name="equals" return="boolean"
  14531. abstract="false" native="false" synchronized="false"
  14532. static="false" final="false" visibility="public"
  14533. deprecated="not deprecated">
  14534. <param name="o" type="java.lang.Object"/>
  14535. </method>
  14536. <method name="compareTo" return="int"
  14537. abstract="false" native="false" synchronized="false"
  14538. static="false" final="false" visibility="public"
  14539. deprecated="not deprecated">
  14540. <param name="other" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent"/>
  14541. </method>
  14542. <field name="INVALID_TIMESTAMP" type="long"
  14543. transient="false" volatile="false"
  14544. static="true" final="true" visibility="public"
  14545. deprecated="not deprecated">
  14546. </field>
  14547. <doc>
  14548. <![CDATA[This class contains the information of an event that belongs to an entity.
  14549. Users are free to define what the event means, such as starting an
  14550. application, container being allocated, etc.]]>
  14551. </doc>
  14552. </class>
  14553. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent -->
  14554. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric -->
  14555. <class name="TimelineMetric" extends="java.lang.Object"
  14556. abstract="false"
  14557. static="false" final="false" visibility="public"
  14558. deprecated="not deprecated">
  14559. <constructor name="TimelineMetric"
  14560. static="false" final="false" visibility="public"
  14561. deprecated="not deprecated">
  14562. </constructor>
  14563. <constructor name="TimelineMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric.Type"
  14564. static="false" final="false" visibility="public"
  14565. deprecated="not deprecated">
  14566. </constructor>
  14567. <method name="getType" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric.Type"
  14568. abstract="false" native="false" synchronized="false"
  14569. static="false" final="false" visibility="public"
  14570. deprecated="not deprecated">
  14571. </method>
  14572. <method name="setType"
  14573. abstract="false" native="false" synchronized="false"
  14574. static="false" final="false" visibility="public"
  14575. deprecated="not deprecated">
  14576. <param name="metricType" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric.Type"/>
  14577. </method>
  14578. <method name="getId" return="java.lang.String"
  14579. abstract="false" native="false" synchronized="false"
  14580. static="false" final="false" visibility="public"
  14581. deprecated="not deprecated">
  14582. </method>
  14583. <method name="setId"
  14584. abstract="false" native="false" synchronized="false"
  14585. static="false" final="false" visibility="public"
  14586. deprecated="not deprecated">
  14587. <param name="metricId" type="java.lang.String"/>
  14588. </method>
  14589. <method name="getRealtimeAggregationOp" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetricOperation"
  14590. abstract="false" native="false" synchronized="false"
  14591. static="false" final="false" visibility="public"
  14592. deprecated="not deprecated">
  14593. <doc>
  14594. <![CDATA[Get the real time aggregation operation of this metric.
  14595. @return Real time aggregation operation]]>
  14596. </doc>
  14597. </method>
  14598. <method name="setRealtimeAggregationOp"
  14599. abstract="false" native="false" synchronized="false"
  14600. static="false" final="false" visibility="public"
  14601. deprecated="not deprecated">
  14602. <param name="op" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetricOperation"/>
  14603. <doc>
  14604. <![CDATA[Set the real time aggregation operation of this metric.
  14605. @param op A timeline metric operation that the metric should perform on
  14606. real time aggregations]]>
  14607. </doc>
  14608. </method>
  14609. <method name="getValues" return="java.util.Map"
  14610. abstract="false" native="false" synchronized="false"
  14611. static="false" final="false" visibility="public"
  14612. deprecated="not deprecated">
  14613. </method>
  14614. <method name="setValues"
  14615. abstract="false" native="false" synchronized="false"
  14616. static="false" final="false" visibility="public"
  14617. deprecated="not deprecated">
  14618. <param name="vals" type="java.util.Map"/>
  14619. </method>
  14620. <method name="addValues"
  14621. abstract="false" native="false" synchronized="false"
  14622. static="false" final="false" visibility="public"
  14623. deprecated="not deprecated">
  14624. <param name="vals" type="java.util.Map"/>
  14625. </method>
  14626. <method name="addValue"
  14627. abstract="false" native="false" synchronized="false"
  14628. static="false" final="false" visibility="public"
  14629. deprecated="not deprecated">
  14630. <param name="timestamp" type="long"/>
  14631. <param name="value" type="java.lang.Number"/>
  14632. </method>
  14633. <method name="isValid" return="boolean"
  14634. abstract="false" native="false" synchronized="false"
  14635. static="false" final="false" visibility="public"
  14636. deprecated="not deprecated">
  14637. </method>
  14638. <method name="hashCode" return="int"
  14639. abstract="false" native="false" synchronized="false"
  14640. static="false" final="false" visibility="public"
  14641. deprecated="not deprecated">
  14642. </method>
  14643. <method name="equals" return="boolean"
  14644. abstract="false" native="false" synchronized="false"
  14645. static="false" final="false" visibility="public"
  14646. deprecated="not deprecated">
  14647. <param name="o" type="java.lang.Object"/>
  14648. </method>
  14649. <method name="toString" return="java.lang.String"
  14650. abstract="false" native="false" synchronized="false"
  14651. static="false" final="false" visibility="public"
  14652. deprecated="not deprecated">
  14653. </method>
  14654. <method name="getLatestSingleValueMetric" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"
  14655. abstract="false" native="false" synchronized="false"
  14656. static="true" final="false" visibility="public"
  14657. deprecated="not deprecated">
  14658. <param name="metric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  14659. <doc>
  14660. <![CDATA[Get the latest timeline metric as single value type.
  14661. @param metric Incoming timeline metric
  14662. @return The latest metric in the incoming metric]]>
  14663. </doc>
  14664. </method>
  14665. <method name="getSingleDataTimestamp" return="long"
  14666. abstract="false" native="false" synchronized="false"
  14667. static="false" final="false" visibility="public"
  14668. deprecated="not deprecated">
  14669. <doc>
  14670. <![CDATA[Get single data timestamp of the metric.
  14671. @return the single data timestamp]]>
  14672. </doc>
  14673. </method>
  14674. <method name="getSingleDataValue" return="java.lang.Number"
  14675. abstract="false" native="false" synchronized="false"
  14676. static="false" final="false" visibility="public"
  14677. deprecated="not deprecated">
  14678. <doc>
  14679. <![CDATA[Get single data value of the metric.
  14680. @return the single data value]]>
  14681. </doc>
  14682. </method>
  14683. <method name="aggregateTo" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"
  14684. abstract="false" native="false" synchronized="false"
  14685. static="true" final="false" visibility="public"
  14686. deprecated="not deprecated">
  14687. <param name="incomingMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  14688. <param name="baseAggregatedMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  14689. <doc>
  14690. <![CDATA[Aggregate an incoming metric to the base aggregated metric with the given
  14691. operation state in a stateless fashion. The assumption here is
  14692. baseAggregatedMetric and latestMetric should be single value data if not
  14693. null.
  14694. @param incomingMetric Incoming timeline metric to aggregate
  14695. @param baseAggregatedMetric Base timeline metric
  14696. @return Result metric after aggregation]]>
  14697. </doc>
  14698. </method>
  14699. <method name="aggregateTo" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"
  14700. abstract="false" native="false" synchronized="false"
  14701. static="true" final="false" visibility="public"
  14702. deprecated="not deprecated">
  14703. <param name="incomingMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  14704. <param name="baseAggregatedMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
  14705. <param name="state" type="java.util.Map"/>
  14706. <doc>
  14707. <![CDATA[Aggregate an incoming metric to the base aggregated metric with the given
  14708. operation state. The assumption here is baseAggregatedMetric and
  14709. latestMetric should be single value data if not null.
  14710. @param incomingMetric Incoming timeline metric to aggregate
  14711. @param baseAggregatedMetric Base timeline metric
  14712. @param state Operation state
  14713. @return Result metric after aggregation]]>
  14714. </doc>
  14715. </method>
  14716. <doc>
  14717. <![CDATA[This class contains the information of a metric that is related to some
  14718. entity. Metric can either be a time series or single value.]]>
  14719. </doc>
  14720. </class>
  14721. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric -->
  14722. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse -->
  14723. <class name="TimelineWriteResponse" extends="java.lang.Object"
  14724. abstract="false"
  14725. static="false" final="false" visibility="public"
  14726. deprecated="not deprecated">
  14727. <constructor name="TimelineWriteResponse"
  14728. static="false" final="false" visibility="public"
  14729. deprecated="not deprecated">
  14730. </constructor>
  14731. <method name="getErrors" return="java.util.List"
  14732. abstract="false" native="false" synchronized="false"
  14733. static="false" final="false" visibility="public"
  14734. deprecated="not deprecated">
  14735. <doc>
  14736. <![CDATA[Get a list of {@link TimelineWriteError} instances.
  14737. @return a list of {@link TimelineWriteError} instances]]>
  14738. </doc>
  14739. </method>
  14740. <method name="addError"
  14741. abstract="false" native="false" synchronized="false"
  14742. static="false" final="false" visibility="public"
  14743. deprecated="not deprecated">
  14744. <param name="error" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse.TimelineWriteError"/>
  14745. <doc>
  14746. <![CDATA[Add a single {@link TimelineWriteError} instance into the existing list.
  14747. @param error
  14748. a single {@link TimelineWriteError} instance]]>
  14749. </doc>
  14750. </method>
  14751. <method name="addErrors"
  14752. abstract="false" native="false" synchronized="false"
  14753. static="false" final="false" visibility="public"
  14754. deprecated="not deprecated">
  14755. <param name="writeErrors" type="java.util.List"/>
  14756. <doc>
  14757. <![CDATA[Add a list of {@link TimelineWriteError} instances into the existing list.
  14758. @param writeErrors
  14759. a list of {@link TimelineWriteError} instances]]>
  14760. </doc>
  14761. </method>
  14762. <method name="setErrors"
  14763. abstract="false" native="false" synchronized="false"
  14764. static="false" final="false" visibility="public"
  14765. deprecated="not deprecated">
  14766. <param name="writeErrors" type="java.util.List"/>
  14767. <doc>
  14768. <![CDATA[Set the list to the given list of {@link TimelineWriteError} instances.
  14769. @param writeErrors
  14770. a list of {@link TimelineWriteError} instances]]>
  14771. </doc>
  14772. </method>
  14773. <doc>
  14774. <![CDATA[A class that holds a list of put errors. This is the response returned when a
  14775. list of {@link TimelineEntity} objects is added to the timeline. If there are
  14776. errors in storing individual entity objects, they will be indicated in the
  14777. list of errors.]]>
  14778. </doc>
  14779. </class>
  14780. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse -->
  14781. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse.TimelineWriteError -->
  14782. <class name="TimelineWriteResponse.TimelineWriteError" extends="java.lang.Object"
  14783. abstract="false"
  14784. static="true" final="false" visibility="public"
  14785. deprecated="not deprecated">
  14786. <constructor name="TimelineWriteResponse.TimelineWriteError"
  14787. static="false" final="false" visibility="public"
  14788. deprecated="not deprecated">
  14789. </constructor>
  14790. <method name="getEntityId" return="java.lang.String"
  14791. abstract="false" native="false" synchronized="false"
  14792. static="false" final="false" visibility="public"
  14793. deprecated="not deprecated">
  14794. <doc>
  14795. <![CDATA[Get the entity Id.
  14796. @return the entity Id]]>
  14797. </doc>
  14798. </method>
  14799. <method name="setEntityId"
  14800. abstract="false" native="false" synchronized="false"
  14801. static="false" final="false" visibility="public"
  14802. deprecated="not deprecated">
  14803. <param name="id" type="java.lang.String"/>
  14804. <doc>
  14805. <![CDATA[Set the entity Id.
  14806. @param id the entity Id.]]>
  14807. </doc>
  14808. </method>
  14809. <method name="getEntityType" return="java.lang.String"
  14810. abstract="false" native="false" synchronized="false"
  14811. static="false" final="false" visibility="public"
  14812. deprecated="not deprecated">
  14813. <doc>
  14814. <![CDATA[Get the entity type.
  14815. @return the entity type]]>
  14816. </doc>
  14817. </method>
  14818. <method name="setEntityType"
  14819. abstract="false" native="false" synchronized="false"
  14820. static="false" final="false" visibility="public"
  14821. deprecated="not deprecated">
  14822. <param name="type" type="java.lang.String"/>
  14823. <doc>
  14824. <![CDATA[Set the entity type.
  14825. @param type the entity type.]]>
  14826. </doc>
  14827. </method>
  14828. <method name="getErrorCode" return="int"
  14829. abstract="false" native="false" synchronized="false"
  14830. static="false" final="false" visibility="public"
  14831. deprecated="not deprecated">
  14832. <doc>
  14833. <![CDATA[Get the error code.
  14834. @return an error code]]>
  14835. </doc>
  14836. </method>
  14837. <method name="setErrorCode"
  14838. abstract="false" native="false" synchronized="false"
  14839. static="false" final="false" visibility="public"
  14840. deprecated="not deprecated">
  14841. <param name="code" type="int"/>
  14842. <doc>
  14843. <![CDATA[Set the error code to the given error code.
  14844. @param code an error code.]]>
  14845. </doc>
  14846. </method>
  14847. <field name="IO_EXCEPTION" type="int"
  14848. transient="false" volatile="false"
  14849. static="true" final="true" visibility="public"
  14850. deprecated="not deprecated">
  14851. <doc>
  14852. <![CDATA[Error code returned if an IOException is encountered when storing an
  14853. entity.]]>
  14854. </doc>
  14855. </field>
  14856. <doc>
  14857. <![CDATA[A class that holds the error code for one entity.]]>
  14858. </doc>
  14859. </class>
  14860. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse.TimelineWriteError -->
  14861. <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.UserEntity -->
  14862. <class name="UserEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  14863. abstract="false"
  14864. static="false" final="false" visibility="public"
  14865. deprecated="not deprecated">
  14866. <constructor name="UserEntity"
  14867. static="false" final="false" visibility="public"
  14868. deprecated="not deprecated">
  14869. </constructor>
  14870. <constructor name="UserEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  14871. static="false" final="false" visibility="public"
  14872. deprecated="not deprecated">
  14873. </constructor>
  14874. <doc>
  14875. <![CDATA[This entity represents a user.]]>
  14876. </doc>
  14877. </class>
  14878. <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.UserEntity -->
  14879. </package>
  14880. <package name="org.apache.hadoop.yarn.conf">
  14881. <!-- start class org.apache.hadoop.yarn.conf.YarnConfiguration -->
  14882. <class name="YarnConfiguration" extends="org.apache.hadoop.conf.Configuration"
  14883. abstract="false"
  14884. static="false" final="false" visibility="public"
  14885. deprecated="not deprecated">
  14886. <constructor name="YarnConfiguration"
  14887. static="false" final="false" visibility="public"
  14888. deprecated="not deprecated">
  14889. </constructor>
  14890. <constructor name="YarnConfiguration" type="org.apache.hadoop.conf.Configuration"
  14891. static="false" final="false" visibility="public"
  14892. deprecated="not deprecated">
  14893. </constructor>
  14894. <method name="isAclEnabled" return="boolean"
  14895. abstract="false" native="false" synchronized="false"
  14896. static="true" final="false" visibility="public"
  14897. deprecated="not deprecated">
  14898. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  14899. </method>
  14900. <method name="getSocketAddr" return="java.net.InetSocketAddress"
  14901. abstract="false" native="false" synchronized="false"
  14902. static="false" final="false" visibility="public"
  14903. deprecated="not deprecated">
  14904. <param name="name" type="java.lang.String"/>
  14905. <param name="defaultAddress" type="java.lang.String"/>
  14906. <param name="defaultPort" type="int"/>
  14907. <doc>
  14908. <![CDATA[Get the socket address for <code>name</code> property as a
  14909. <code>InetSocketAddress</code>. On an HA cluster,
  14910. this fetches the address corresponding to the RM identified by
  14911. {@link #RM_HA_ID}.
  14912. @param name property name.
  14913. @param defaultAddress the default value
  14914. @param defaultPort the default port
  14915. @return InetSocketAddress]]>
  14916. </doc>
  14917. </method>
  14918. <method name="updateConnectAddr" return="java.net.InetSocketAddress"
  14919. abstract="false" native="false" synchronized="false"
  14920. static="false" final="false" visibility="public"
  14921. deprecated="not deprecated">
  14922. <param name="name" type="java.lang.String"/>
  14923. <param name="addr" type="java.net.InetSocketAddress"/>
  14924. </method>
  14925. <method name="useHttps" return="boolean"
  14926. abstract="false" native="false" synchronized="false"
  14927. static="true" final="false" visibility="public"
  14928. deprecated="not deprecated">
  14929. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  14930. </method>
  14931. <method name="shouldRMFailFast" return="boolean"
  14932. abstract="false" native="false" synchronized="false"
  14933. static="true" final="false" visibility="public"
  14934. deprecated="not deprecated">
  14935. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  14936. </method>
  14937. <method name="isDistSchedulingEnabled" return="boolean"
  14938. abstract="false" native="false" synchronized="false"
  14939. static="true" final="false" visibility="public"
  14940. deprecated="not deprecated">
  14941. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  14942. </method>
  14943. <method name="isOpportunisticContainerAllocationEnabled" return="boolean"
  14944. abstract="false" native="false" synchronized="false"
  14945. static="true" final="false" visibility="public"
  14946. deprecated="not deprecated">
  14947. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  14948. </method>
  14949. <method name="timelineServiceEnabled" return="boolean"
  14950. abstract="false" native="false" synchronized="false"
  14951. static="true" final="false" visibility="public"
  14952. deprecated="not deprecated">
  14953. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  14954. <doc>
  14955. <![CDATA[Returns whether the timeline service is enabled via configuration.
  14956. @param conf the configuration
  14957. @return whether the timeline service is enabled.]]>
  14958. </doc>
  14959. </method>
  14960. <method name="getTimelineServiceVersion" return="float"
  14961. abstract="false" native="false" synchronized="false"
  14962. static="true" final="false" visibility="public"
  14963. deprecated="not deprecated">
  14964. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  14965. <doc>
  14966. <![CDATA[Returns the timeline service version. It does not check whether the
  14967. timeline service itself is enabled.
  14968. @param conf the configuration
  14969. @return the timeline service version as a float.]]>
  14970. </doc>
  14971. </method>
  14972. <method name="timelineServiceV2Enabled" return="boolean"
  14973. abstract="false" native="false" synchronized="false"
  14974. static="true" final="false" visibility="public"
  14975. deprecated="not deprecated">
  14976. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  14977. <doc>
  14978. <![CDATA[Returns whether the timeline service v.2 is enabled via configuration.
  14979. @param conf the configuration
  14980. @return whether the timeline service v.2 is enabled. V.2 refers to a
  14981. version greater than equal to 2 but smaller than 3.]]>
  14982. </doc>
  14983. </method>
  14984. <method name="timelineServiceV1Enabled" return="boolean"
  14985. abstract="false" native="false" synchronized="false"
  14986. static="true" final="false" visibility="public"
  14987. deprecated="not deprecated">
  14988. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  14989. <doc>
  14990. <![CDATA[Returns whether the timeline service v.1 is enabled via configuration.
  14991. @param conf the configuration
  14992. @return whether the timeline service v.1 is enabled. V.1 refers to a
  14993. version greater than equal to 1 but smaller than 2.]]>
  14994. </doc>
  14995. </method>
  14996. <method name="timelineServiceV15Enabled" return="boolean"
  14997. abstract="false" native="false" synchronized="false"
  14998. static="true" final="false" visibility="public"
  14999. deprecated="not deprecated">
  15000. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  15001. <doc>
  15002. <![CDATA[Returns whether the timeline service v.1,5 is enabled via configuration.
  15003. @param conf the configuration
  15004. @return whether the timeline service v.1.5 is enabled. V.1.5 refers to a
  15005. version equal to 1.5.]]>
  15006. </doc>
  15007. </method>
  15008. <method name="systemMetricsPublisherEnabled" return="boolean"
  15009. abstract="false" native="false" synchronized="false"
  15010. static="true" final="false" visibility="public"
  15011. deprecated="not deprecated">
  15012. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  15013. <doc>
  15014. <![CDATA[Returns whether the system publisher is enabled.
  15015. @param conf the configuration
  15016. @return whether the system publisher is enabled.]]>
  15017. </doc>
  15018. </method>
  15019. <method name="main"
  15020. abstract="false" native="false" synchronized="false"
  15021. static="true" final="false" visibility="public"
  15022. deprecated="not deprecated">
  15023. <param name="args" type="java.lang.String[]"/>
  15024. <exception name="Exception" type="java.lang.Exception"/>
  15025. </method>
  15026. <field name="DR_CONFIGURATION_FILE" type="java.lang.String"
  15027. transient="false" volatile="false"
  15028. static="true" final="true" visibility="public"
  15029. deprecated="not deprecated">
  15030. </field>
  15031. <field name="CS_CONFIGURATION_FILE" type="java.lang.String"
  15032. transient="false" volatile="false"
  15033. static="true" final="true" visibility="public"
  15034. deprecated="not deprecated">
  15035. </field>
  15036. <field name="HADOOP_POLICY_CONFIGURATION_FILE" type="java.lang.String"
  15037. transient="false" volatile="false"
  15038. static="true" final="true" visibility="public"
  15039. deprecated="not deprecated">
  15040. </field>
  15041. <field name="YARN_SITE_CONFIGURATION_FILE" type="java.lang.String"
  15042. transient="false" volatile="false"
  15043. static="true" final="true" visibility="public"
  15044. deprecated="not deprecated">
  15045. </field>
  15046. <field name="CORE_SITE_CONFIGURATION_FILE" type="java.lang.String"
  15047. transient="false" volatile="false"
  15048. static="true" final="true" visibility="public"
  15049. deprecated="not deprecated">
  15050. </field>
  15051. <field name="RESOURCE_TYPES_CONFIGURATION_FILE" type="java.lang.String"
  15052. transient="false" volatile="false"
  15053. static="true" final="true" visibility="public"
  15054. deprecated="not deprecated">
  15055. </field>
  15056. <field name="NODE_RESOURCES_CONFIGURATION_FILE" type="java.lang.String"
  15057. transient="false" volatile="false"
  15058. static="true" final="true" visibility="public"
  15059. deprecated="not deprecated">
  15060. </field>
  15061. <field name="RM_CONFIGURATION_FILES" type="java.util.List"
  15062. transient="false" volatile="false"
  15063. static="true" final="true" visibility="public"
  15064. deprecated="not deprecated">
  15065. </field>
  15066. <field name="NM_CONFIGURATION_FILES" type="java.util.List"
  15067. transient="false" volatile="false"
  15068. static="true" final="true" visibility="public"
  15069. deprecated="not deprecated">
  15070. </field>
  15071. <field name="APPLICATION_MAX_TAGS" type="int"
  15072. transient="false" volatile="false"
  15073. static="true" final="true" visibility="public"
  15074. deprecated="not deprecated">
  15075. </field>
  15076. <field name="APPLICATION_MAX_TAG_LENGTH" type="int"
  15077. transient="false" volatile="false"
  15078. static="true" final="true" visibility="public"
  15079. deprecated="not deprecated">
  15080. </field>
  15081. <field name="YARN_PREFIX" type="java.lang.String"
  15082. transient="false" volatile="false"
  15083. static="true" final="true" visibility="public"
  15084. deprecated="not deprecated">
  15085. </field>
  15086. <field name="RESOURCE_TYPES" type="java.lang.String"
  15087. transient="false" volatile="false"
  15088. static="true" final="true" visibility="public"
  15089. deprecated="not deprecated">
  15090. </field>
  15091. <field name="NM_RESOURCES_PREFIX" type="java.lang.String"
  15092. transient="false" volatile="false"
  15093. static="true" final="true" visibility="public"
  15094. deprecated="not deprecated">
  15095. </field>
  15096. <field name="DEBUG_NM_DELETE_DELAY_SEC" type="java.lang.String"
  15097. transient="false" volatile="false"
  15098. static="true" final="true" visibility="public"
  15099. deprecated="not deprecated">
  15100. <doc>
  15101. <![CDATA[Delay before deleting resource to ease debugging of NM issues]]>
  15102. </doc>
  15103. </field>
  15104. <field name="NM_LOG_CONTAINER_DEBUG_INFO" type="java.lang.String"
  15105. transient="false" volatile="false"
  15106. static="true" final="true" visibility="public"
  15107. deprecated="not deprecated">
  15108. </field>
  15109. <field name="DEFAULT_NM_LOG_CONTAINER_DEBUG_INFO" type="boolean"
  15110. transient="false" volatile="false"
  15111. static="true" final="true" visibility="public"
  15112. deprecated="not deprecated">
  15113. </field>
  15114. <field name="IPC_PREFIX" type="java.lang.String"
  15115. transient="false" volatile="false"
  15116. static="true" final="true" visibility="public"
  15117. deprecated="not deprecated">
  15118. </field>
  15119. <field name="IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
  15120. transient="false" volatile="false"
  15121. static="true" final="true" visibility="public"
  15122. deprecated="not deprecated">
  15123. <doc>
  15124. <![CDATA[Factory to create client IPC classes.]]>
  15125. </doc>
  15126. </field>
  15127. <field name="DEFAULT_IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
  15128. transient="false" volatile="false"
  15129. static="true" final="true" visibility="public"
  15130. deprecated="not deprecated">
  15131. </field>
  15132. <field name="IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
  15133. transient="false" volatile="false"
  15134. static="true" final="true" visibility="public"
  15135. deprecated="not deprecated">
  15136. <doc>
  15137. <![CDATA[Factory to create server IPC classes.]]>
  15138. </doc>
  15139. </field>
  15140. <field name="DEFAULT_IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
  15141. transient="false" volatile="false"
  15142. static="true" final="true" visibility="public"
  15143. deprecated="not deprecated">
  15144. </field>
  15145. <field name="IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
  15146. transient="false" volatile="false"
  15147. static="true" final="true" visibility="public"
  15148. deprecated="not deprecated">
  15149. <doc>
  15150. <![CDATA[Factory to create serializeable records.]]>
  15151. </doc>
  15152. </field>
  15153. <field name="DEFAULT_IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
  15154. transient="false" volatile="false"
  15155. static="true" final="true" visibility="public"
  15156. deprecated="not deprecated">
  15157. </field>
  15158. <field name="IPC_RPC_IMPL" type="java.lang.String"
  15159. transient="false" volatile="false"
  15160. static="true" final="true" visibility="public"
  15161. deprecated="not deprecated">
  15162. <doc>
  15163. <![CDATA[RPC class implementation]]>
  15164. </doc>
  15165. </field>
  15166. <field name="DEFAULT_IPC_RPC_IMPL" type="java.lang.String"
  15167. transient="false" volatile="false"
  15168. static="true" final="true" visibility="public"
  15169. deprecated="not deprecated">
  15170. </field>
  15171. <field name="RM_PREFIX" type="java.lang.String"
  15172. transient="false" volatile="false"
  15173. static="true" final="true" visibility="public"
  15174. deprecated="not deprecated">
  15175. </field>
  15176. <field name="RM_CLUSTER_ID" type="java.lang.String"
  15177. transient="false" volatile="false"
  15178. static="true" final="true" visibility="public"
  15179. deprecated="not deprecated">
  15180. </field>
  15181. <field name="DEFAULT_RM_CLUSTER_ID" type="java.lang.String"
  15182. transient="false" volatile="false"
  15183. static="true" final="true" visibility="public"
  15184. deprecated="not deprecated">
  15185. </field>
  15186. <field name="RM_HOSTNAME" type="java.lang.String"
  15187. transient="false" volatile="false"
  15188. static="true" final="true" visibility="public"
  15189. deprecated="not deprecated">
  15190. </field>
  15191. <field name="RM_EPOCH" type="java.lang.String"
  15192. transient="false" volatile="false"
  15193. static="true" final="true" visibility="public"
  15194. deprecated="not deprecated">
  15195. </field>
  15196. <field name="DEFAULT_RM_EPOCH" type="long"
  15197. transient="false" volatile="false"
  15198. static="true" final="true" visibility="public"
  15199. deprecated="not deprecated">
  15200. </field>
  15201. <field name="RM_ADDRESS" type="java.lang.String"
  15202. transient="false" volatile="false"
  15203. static="true" final="true" visibility="public"
  15204. deprecated="not deprecated">
  15205. <doc>
  15206. <![CDATA[The address of the applications manager interface in the RM.]]>
  15207. </doc>
  15208. </field>
  15209. <field name="DEFAULT_RM_PORT" type="int"
  15210. transient="false" volatile="false"
  15211. static="true" final="true" visibility="public"
  15212. deprecated="not deprecated">
  15213. </field>
  15214. <field name="DEFAULT_RM_ADDRESS" type="java.lang.String"
  15215. transient="false" volatile="false"
  15216. static="true" final="true" visibility="public"
  15217. deprecated="not deprecated">
  15218. </field>
  15219. <field name="RM_APPLICATION_MASTER_SERVICE_PROCESSORS" type="java.lang.String"
  15220. transient="false" volatile="false"
  15221. static="true" final="true" visibility="public"
  15222. deprecated="not deprecated">
  15223. </field>
  15224. <field name="RM_AUTO_UPDATE_CONTAINERS" type="java.lang.String"
  15225. transient="false" volatile="false"
  15226. static="true" final="true" visibility="public"
  15227. deprecated="not deprecated">
  15228. </field>
  15229. <field name="DEFAULT_RM_AUTO_UPDATE_CONTAINERS" type="boolean"
  15230. transient="false" volatile="false"
  15231. static="true" final="true" visibility="public"
  15232. deprecated="not deprecated">
  15233. </field>
  15234. <field name="RM_BIND_HOST" type="java.lang.String"
  15235. transient="false" volatile="false"
  15236. static="true" final="true" visibility="public"
  15237. deprecated="not deprecated">
  15238. <doc>
  15239. <![CDATA[The actual bind address for the RM.]]>
  15240. </doc>
  15241. </field>
  15242. <field name="RM_CLIENT_THREAD_COUNT" type="java.lang.String"
  15243. transient="false" volatile="false"
  15244. static="true" final="true" visibility="public"
  15245. deprecated="not deprecated">
  15246. <doc>
  15247. <![CDATA[The number of threads used to handle applications manager requests.]]>
  15248. </doc>
  15249. </field>
  15250. <field name="DEFAULT_RM_CLIENT_THREAD_COUNT" type="int"
  15251. transient="false" volatile="false"
  15252. static="true" final="true" visibility="public"
  15253. deprecated="not deprecated">
  15254. </field>
  15255. <field name="RM_AMLAUNCHER_THREAD_COUNT" type="java.lang.String"
  15256. transient="false" volatile="false"
  15257. static="true" final="true" visibility="public"
  15258. deprecated="not deprecated">
  15259. <doc>
  15260. <![CDATA[Number of threads used to launch/cleanup AM.]]>
  15261. </doc>
  15262. </field>
  15263. <field name="DEFAULT_RM_AMLAUNCHER_THREAD_COUNT" type="int"
  15264. transient="false" volatile="false"
  15265. static="true" final="true" visibility="public"
  15266. deprecated="not deprecated">
  15267. </field>
  15268. <field name="RM_NODEMANAGER_CONNECT_RETRIES" type="java.lang.String"
  15269. transient="false" volatile="false"
  15270. static="true" final="true" visibility="public"
  15271. deprecated="not deprecated">
  15272. <doc>
  15273. <![CDATA[Retry times to connect with NM.]]>
  15274. </doc>
  15275. </field>
  15276. <field name="DEFAULT_RM_NODEMANAGER_CONNECT_RETRIES" type="int"
  15277. transient="false" volatile="false"
  15278. static="true" final="true" visibility="public"
  15279. deprecated="not deprecated">
  15280. </field>
  15281. <field name="RM_PRINCIPAL" type="java.lang.String"
  15282. transient="false" volatile="false"
  15283. static="true" final="true" visibility="public"
  15284. deprecated="not deprecated">
  15285. <doc>
  15286. <![CDATA[The Kerberos principal for the resource manager.]]>
  15287. </doc>
  15288. </field>
  15289. <field name="RM_SCHEDULER_ADDRESS" type="java.lang.String"
  15290. transient="false" volatile="false"
  15291. static="true" final="true" visibility="public"
  15292. deprecated="not deprecated">
  15293. <doc>
  15294. <![CDATA[The address of the scheduler interface.]]>
  15295. </doc>
  15296. </field>
  15297. <field name="DEFAULT_RM_SCHEDULER_PORT" type="int"
  15298. transient="false" volatile="false"
  15299. static="true" final="true" visibility="public"
  15300. deprecated="not deprecated">
  15301. </field>
  15302. <field name="DEFAULT_RM_SCHEDULER_ADDRESS" type="java.lang.String"
  15303. transient="false" volatile="false"
  15304. static="true" final="true" visibility="public"
  15305. deprecated="not deprecated">
  15306. </field>
  15307. <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="java.lang.String"
  15308. transient="false" volatile="false"
  15309. static="true" final="true" visibility="public"
  15310. deprecated="not deprecated">
  15311. <doc>
  15312. <![CDATA[Miniumum request grant-able by the RM scheduler.]]>
  15313. </doc>
  15314. </field>
  15315. <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="int"
  15316. transient="false" volatile="false"
  15317. static="true" final="true" visibility="public"
  15318. deprecated="not deprecated">
  15319. </field>
  15320. <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="java.lang.String"
  15321. transient="false" volatile="false"
  15322. static="true" final="true" visibility="public"
  15323. deprecated="not deprecated">
  15324. </field>
  15325. <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="int"
  15326. transient="false" volatile="false"
  15327. static="true" final="true" visibility="public"
  15328. deprecated="not deprecated">
  15329. </field>
  15330. <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="java.lang.String"
  15331. transient="false" volatile="false"
  15332. static="true" final="true" visibility="public"
  15333. deprecated="not deprecated">
  15334. <doc>
  15335. <![CDATA[Maximum request grant-able by the RM scheduler.]]>
  15336. </doc>
  15337. </field>
  15338. <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="int"
  15339. transient="false" volatile="false"
  15340. static="true" final="true" visibility="public"
  15341. deprecated="not deprecated">
  15342. </field>
  15343. <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="java.lang.String"
  15344. transient="false" volatile="false"
  15345. static="true" final="true" visibility="public"
  15346. deprecated="not deprecated">
  15347. </field>
  15348. <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="int"
  15349. transient="false" volatile="false"
  15350. static="true" final="true" visibility="public"
  15351. deprecated="not deprecated">
  15352. </field>
  15353. <field name="RM_SCHEDULER_CLIENT_THREAD_COUNT" type="java.lang.String"
  15354. transient="false" volatile="false"
  15355. static="true" final="true" visibility="public"
  15356. deprecated="not deprecated">
  15357. <doc>
  15358. <![CDATA[Number of threads to handle scheduler interface.]]>
  15359. </doc>
  15360. </field>
  15361. <field name="DEFAULT_RM_SCHEDULER_CLIENT_THREAD_COUNT" type="int"
  15362. transient="false" volatile="false"
  15363. static="true" final="true" visibility="public"
  15364. deprecated="not deprecated">
  15365. </field>
  15366. <field name="RM_SCHEDULER_INCLUDE_PORT_IN_NODE_NAME" type="java.lang.String"
  15367. transient="false" volatile="false"
  15368. static="true" final="true" visibility="public"
  15369. deprecated="not deprecated">
  15370. <doc>
  15371. <![CDATA[If the port should be included or not in the node name. The node name
  15372. is used by the scheduler for resource requests allocation location
  15373. matching. Typically this is just the hostname, using the port is needed
  15374. when using minicluster and specific NM are required.]]>
  15375. </doc>
  15376. </field>
  15377. <field name="DEFAULT_RM_SCHEDULER_USE_PORT_FOR_NODE_NAME" type="boolean"
  15378. transient="false" volatile="false"
  15379. static="true" final="true" visibility="public"
  15380. deprecated="not deprecated">
  15381. </field>
  15382. <field name="QUEUE_PLACEMENT_RULES" type="java.lang.String"
  15383. transient="false" volatile="false"
  15384. static="true" final="true" visibility="public"
  15385. deprecated="not deprecated">
  15386. <doc>
  15387. <![CDATA[Configured scheduler queue placement rules.]]>
  15388. </doc>
  15389. </field>
  15390. <field name="USER_GROUP_PLACEMENT_RULE" type="java.lang.String"
  15391. transient="false" volatile="false"
  15392. static="true" final="true" visibility="public"
  15393. deprecated="not deprecated">
  15394. <doc>
  15395. <![CDATA[UserGroupMappingPlacementRule configuration string.]]>
  15396. </doc>
  15397. </field>
  15398. <field name="RM_WEBAPP_UI_ACTIONS_ENABLED" type="java.lang.String"
  15399. transient="false" volatile="false"
  15400. static="true" final="true" visibility="public"
  15401. deprecated="not deprecated">
  15402. <doc>
  15403. <![CDATA[Enable Resource Manager webapp ui actions]]>
  15404. </doc>
  15405. </field>
  15406. <field name="DEFAULT_RM_WEBAPP_UI_ACTIONS_ENABLED" type="boolean"
  15407. transient="false" volatile="false"
  15408. static="true" final="true" visibility="public"
  15409. deprecated="not deprecated">
  15410. </field>
  15411. <field name="RM_RESERVATION_SYSTEM_ENABLE" type="java.lang.String"
  15412. transient="false" volatile="false"
  15413. static="true" final="true" visibility="public"
  15414. deprecated="not deprecated">
  15415. <doc>
  15416. <![CDATA[Whether the RM should enable Reservation System]]>
  15417. </doc>
  15418. </field>
  15419. <field name="DEFAULT_RM_RESERVATION_SYSTEM_ENABLE" type="boolean"
  15420. transient="false" volatile="false"
  15421. static="true" final="true" visibility="public"
  15422. deprecated="not deprecated">
  15423. </field>
  15424. <field name="RM_RESERVATION_SYSTEM_CLASS" type="java.lang.String"
  15425. transient="false" volatile="false"
  15426. static="true" final="true" visibility="public"
  15427. deprecated="not deprecated">
  15428. <doc>
  15429. <![CDATA[The class to use as the Reservation System.]]>
  15430. </doc>
  15431. </field>
  15432. <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER" type="java.lang.String"
  15433. transient="false" volatile="false"
  15434. static="true" final="true" visibility="public"
  15435. deprecated="not deprecated">
  15436. <doc>
  15437. <![CDATA[The PlanFollower for the Reservation System.]]>
  15438. </doc>
  15439. </field>
  15440. <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="java.lang.String"
  15441. transient="false" volatile="false"
  15442. static="true" final="true" visibility="public"
  15443. deprecated="not deprecated">
  15444. <doc>
  15445. <![CDATA[The step size of the Reservation System.]]>
  15446. </doc>
  15447. </field>
  15448. <field name="DEFAULT_RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="long"
  15449. transient="false" volatile="false"
  15450. static="true" final="true" visibility="public"
  15451. deprecated="not deprecated">
  15452. </field>
  15453. <field name="RM_RESERVATION_SYSTEM_MAX_PERIODICITY" type="java.lang.String"
  15454. transient="false" volatile="false"
  15455. static="true" final="true" visibility="public"
  15456. deprecated="not deprecated">
  15457. <doc>
  15458. <![CDATA[The maximum periodicity for the Reservation System.]]>
  15459. </doc>
  15460. </field>
  15461. <field name="DEFAULT_RM_RESERVATION_SYSTEM_MAX_PERIODICITY" type="long"
  15462. transient="false" volatile="false"
  15463. static="true" final="true" visibility="public"
  15464. deprecated="not deprecated">
  15465. </field>
  15466. <field name="RM_SCHEDULER_ENABLE_MONITORS" type="java.lang.String"
  15467. transient="false" volatile="false"
  15468. static="true" final="true" visibility="public"
  15469. deprecated="not deprecated">
  15470. <doc>
  15471. <![CDATA[Enable periodic monitor threads.
  15472. @see #RM_SCHEDULER_MONITOR_POLICIES]]>
  15473. </doc>
  15474. </field>
  15475. <field name="DEFAULT_RM_SCHEDULER_ENABLE_MONITORS" type="boolean"
  15476. transient="false" volatile="false"
  15477. static="true" final="true" visibility="public"
  15478. deprecated="not deprecated">
  15479. </field>
  15480. <field name="RM_SCHEDULER_MONITOR_POLICIES" type="java.lang.String"
  15481. transient="false" volatile="false"
  15482. static="true" final="true" visibility="public"
  15483. deprecated="not deprecated">
  15484. <doc>
  15485. <![CDATA[List of SchedulingEditPolicy classes affecting the scheduler.]]>
  15486. </doc>
  15487. </field>
  15488. <field name="RM_WEBAPP_ADDRESS" type="java.lang.String"
  15489. transient="false" volatile="false"
  15490. static="true" final="true" visibility="public"
  15491. deprecated="not deprecated">
  15492. <doc>
  15493. <![CDATA[The address of the RM web application.]]>
  15494. </doc>
  15495. </field>
  15496. <field name="DEFAULT_RM_WEBAPP_PORT" type="int"
  15497. transient="false" volatile="false"
  15498. static="true" final="true" visibility="public"
  15499. deprecated="not deprecated">
  15500. </field>
  15501. <field name="DEFAULT_RM_WEBAPP_ADDRESS" type="java.lang.String"
  15502. transient="false" volatile="false"
  15503. static="true" final="true" visibility="public"
  15504. deprecated="not deprecated">
  15505. </field>
  15506. <field name="RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  15507. transient="false" volatile="false"
  15508. static="true" final="true" visibility="public"
  15509. deprecated="not deprecated">
  15510. <doc>
  15511. <![CDATA[The https address of the RM web application.]]>
  15512. </doc>
  15513. </field>
  15514. <field name="YARN_SSL_CLIENT_HTTPS_NEED_AUTH_DEFAULT" type="boolean"
  15515. transient="false" volatile="false"
  15516. static="true" final="true" visibility="public"
  15517. deprecated="not deprecated">
  15518. </field>
  15519. <field name="YARN_SSL_SERVER_RESOURCE_DEFAULT" type="java.lang.String"
  15520. transient="false" volatile="false"
  15521. static="true" final="true" visibility="public"
  15522. deprecated="not deprecated">
  15523. </field>
  15524. <field name="DEFAULT_RM_WEBAPP_HTTPS_PORT" type="int"
  15525. transient="false" volatile="false"
  15526. static="true" final="true" visibility="public"
  15527. deprecated="not deprecated">
  15528. </field>
  15529. <field name="DEFAULT_RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  15530. transient="false" volatile="false"
  15531. static="true" final="true" visibility="public"
  15532. deprecated="not deprecated">
  15533. </field>
  15534. <field name="YARN_WEBAPP_UI2_ENABLE" type="java.lang.String"
  15535. transient="false" volatile="false"
  15536. static="true" final="true" visibility="public"
  15537. deprecated="not deprecated">
  15538. <doc>
  15539. <![CDATA[Enable YARN WebApp V2.]]>
  15540. </doc>
  15541. </field>
  15542. <field name="DEFAULT_YARN_WEBAPP_UI2_ENABLE" type="boolean"
  15543. transient="false" volatile="false"
  15544. static="true" final="true" visibility="public"
  15545. deprecated="not deprecated">
  15546. </field>
  15547. <field name="YARN_WEBAPP_UI2_WARFILE_PATH" type="java.lang.String"
  15548. transient="false" volatile="false"
  15549. static="true" final="true" visibility="public"
  15550. deprecated="not deprecated">
  15551. </field>
  15552. <field name="RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
  15553. transient="false" volatile="false"
  15554. static="true" final="true" visibility="public"
  15555. deprecated="not deprecated">
  15556. </field>
  15557. <field name="DEFAULT_RM_RESOURCE_TRACKER_PORT" type="int"
  15558. transient="false" volatile="false"
  15559. static="true" final="true" visibility="public"
  15560. deprecated="not deprecated">
  15561. </field>
  15562. <field name="DEFAULT_RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
  15563. transient="false" volatile="false"
  15564. static="true" final="true" visibility="public"
  15565. deprecated="not deprecated">
  15566. </field>
  15567. <field name="RM_AM_EXPIRY_INTERVAL_MS" type="java.lang.String"
  15568. transient="false" volatile="false"
  15569. static="true" final="true" visibility="public"
  15570. deprecated="not deprecated">
  15571. <doc>
  15572. <![CDATA[The expiry interval for application master reporting.]]>
  15573. </doc>
  15574. </field>
  15575. <field name="DEFAULT_RM_AM_EXPIRY_INTERVAL_MS" type="int"
  15576. transient="false" volatile="false"
  15577. static="true" final="true" visibility="public"
  15578. deprecated="not deprecated">
  15579. </field>
  15580. <field name="RM_NM_EXPIRY_INTERVAL_MS" type="java.lang.String"
  15581. transient="false" volatile="false"
  15582. static="true" final="true" visibility="public"
  15583. deprecated="not deprecated">
  15584. <doc>
  15585. <![CDATA[How long to wait until a node manager is considered dead.]]>
  15586. </doc>
  15587. </field>
  15588. <field name="DEFAULT_RM_NM_EXPIRY_INTERVAL_MS" type="int"
  15589. transient="false" volatile="false"
  15590. static="true" final="true" visibility="public"
  15591. deprecated="not deprecated">
  15592. </field>
  15593. <field name="YARN_ACL_ENABLE" type="java.lang.String"
  15594. transient="false" volatile="false"
  15595. static="true" final="true" visibility="public"
  15596. deprecated="not deprecated">
  15597. <doc>
  15598. <![CDATA[Are acls enabled.]]>
  15599. </doc>
  15600. </field>
  15601. <field name="DEFAULT_YARN_ACL_ENABLE" type="boolean"
  15602. transient="false" volatile="false"
  15603. static="true" final="true" visibility="public"
  15604. deprecated="not deprecated">
  15605. </field>
  15606. <field name="YARN_RESERVATION_ACL_ENABLE" type="java.lang.String"
  15607. transient="false" volatile="false"
  15608. static="true" final="true" visibility="public"
  15609. deprecated="not deprecated">
  15610. <doc>
  15611. <![CDATA[Are reservation acls enabled.]]>
  15612. </doc>
  15613. </field>
  15614. <field name="DEFAULT_YARN_RESERVATION_ACL_ENABLE" type="boolean"
  15615. transient="false" volatile="false"
  15616. static="true" final="true" visibility="public"
  15617. deprecated="not deprecated">
  15618. </field>
  15619. <field name="YARN_ADMIN_ACL" type="java.lang.String"
  15620. transient="false" volatile="false"
  15621. static="true" final="true" visibility="public"
  15622. deprecated="not deprecated">
  15623. <doc>
  15624. <![CDATA[ACL of who can be admin of YARN cluster.]]>
  15625. </doc>
  15626. </field>
  15627. <field name="DEFAULT_YARN_ADMIN_ACL" type="java.lang.String"
  15628. transient="false" volatile="false"
  15629. static="true" final="true" visibility="public"
  15630. deprecated="not deprecated">
  15631. </field>
  15632. <field name="DEFAULT_YARN_APP_ACL" type="java.lang.String"
  15633. transient="false" volatile="false"
  15634. static="true" final="true" visibility="public"
  15635. deprecated="not deprecated">
  15636. <doc>
  15637. <![CDATA[ACL used in case none is found. Allows nothing.]]>
  15638. </doc>
  15639. </field>
  15640. <field name="OPPORTUNISTIC_CONTAINER_ALLOCATION_ENABLED" type="java.lang.String"
  15641. transient="false" volatile="false"
  15642. static="true" final="true" visibility="public"
  15643. deprecated="not deprecated">
  15644. <doc>
  15645. <![CDATA[Setting that controls whether opportunistic container allocation
  15646. is enabled or not.]]>
  15647. </doc>
  15648. </field>
  15649. <field name="DEFAULT_OPPORTUNISTIC_CONTAINER_ALLOCATION_ENABLED" type="boolean"
  15650. transient="false" volatile="false"
  15651. static="true" final="true" visibility="public"
  15652. deprecated="not deprecated">
  15653. </field>
  15654. <field name="OPP_CONTAINER_ALLOCATION_NODES_NUMBER_USED" type="java.lang.String"
  15655. transient="false" volatile="false"
  15656. static="true" final="true" visibility="public"
  15657. deprecated="not deprecated">
  15658. <doc>
  15659. <![CDATA[Number of nodes to be used by the Opportunistic Container allocator for
  15660. dispatching containers during container allocation.]]>
  15661. </doc>
  15662. </field>
  15663. <field name="DEFAULT_OPP_CONTAINER_ALLOCATION_NODES_NUMBER_USED" type="int"
  15664. transient="false" volatile="false"
  15665. static="true" final="true" visibility="public"
  15666. deprecated="not deprecated">
  15667. </field>
  15668. <field name="NM_CONTAINER_QUEUING_SORTING_NODES_INTERVAL_MS" type="java.lang.String"
  15669. transient="false" volatile="false"
  15670. static="true" final="true" visibility="public"
  15671. deprecated="not deprecated">
  15672. <doc>
  15673. <![CDATA[Frequency for computing least loaded NMs.]]>
  15674. </doc>
  15675. </field>
  15676. <field name="DEFAULT_NM_CONTAINER_QUEUING_SORTING_NODES_INTERVAL_MS" type="long"
  15677. transient="false" volatile="false"
  15678. static="true" final="true" visibility="public"
  15679. deprecated="not deprecated">
  15680. </field>
  15681. <field name="NM_CONTAINER_QUEUING_LOAD_COMPARATOR" type="java.lang.String"
  15682. transient="false" volatile="false"
  15683. static="true" final="true" visibility="public"
  15684. deprecated="not deprecated">
  15685. <doc>
  15686. <![CDATA[Comparator for determining node load for scheduling of opportunistic
  15687. containers.]]>
  15688. </doc>
  15689. </field>
  15690. <field name="DEFAULT_NM_CONTAINER_QUEUING_LOAD_COMPARATOR" type="java.lang.String"
  15691. transient="false" volatile="false"
  15692. static="true" final="true" visibility="public"
  15693. deprecated="not deprecated">
  15694. </field>
  15695. <field name="NM_CONTAINER_QUEUING_LIMIT_STDEV" type="java.lang.String"
  15696. transient="false" volatile="false"
  15697. static="true" final="true" visibility="public"
  15698. deprecated="not deprecated">
  15699. <doc>
  15700. <![CDATA[Value of standard deviation used for calculation of queue limit
  15701. thresholds.]]>
  15702. </doc>
  15703. </field>
  15704. <field name="DEFAULT_NM_CONTAINER_QUEUING_LIMIT_STDEV" type="float"
  15705. transient="false" volatile="false"
  15706. static="true" final="true" visibility="public"
  15707. deprecated="not deprecated">
  15708. </field>
  15709. <field name="NM_CONTAINER_QUEUING_MIN_QUEUE_LENGTH" type="java.lang.String"
  15710. transient="false" volatile="false"
  15711. static="true" final="true" visibility="public"
  15712. deprecated="not deprecated">
  15713. <doc>
  15714. <![CDATA[Min length of container queue at NodeManager. This is a cluster-wide
  15715. configuration that acts as the lower-bound of optimal queue length
  15716. calculated by the NodeQueueLoadMonitor]]>
  15717. </doc>
  15718. </field>
  15719. <field name="DEFAULT_NM_CONTAINER_QUEUING_MIN_QUEUE_LENGTH" type="int"
  15720. transient="false" volatile="false"
  15721. static="true" final="true" visibility="public"
  15722. deprecated="not deprecated">
  15723. </field>
  15724. <field name="NM_CONTAINER_QUEUING_MAX_QUEUE_LENGTH" type="java.lang.String"
  15725. transient="false" volatile="false"
  15726. static="true" final="true" visibility="public"
  15727. deprecated="not deprecated">
  15728. <doc>
  15729. <![CDATA[Max length of container queue at NodeManager. This is a cluster-wide
  15730. configuration that acts as the upper-bound of optimal queue length
  15731. calculated by the NodeQueueLoadMonitor]]>
  15732. </doc>
  15733. </field>
  15734. <field name="DEFAULT_NM_CONTAINER_QUEUING_MAX_QUEUE_LENGTH" type="int"
  15735. transient="false" volatile="false"
  15736. static="true" final="true" visibility="public"
  15737. deprecated="not deprecated">
  15738. </field>
  15739. <field name="NM_CONTAINER_QUEUING_MIN_QUEUE_WAIT_TIME_MS" type="java.lang.String"
  15740. transient="false" volatile="false"
  15741. static="true" final="true" visibility="public"
  15742. deprecated="not deprecated">
  15743. <doc>
  15744. <![CDATA[Min queue wait time for a container at a NodeManager.]]>
  15745. </doc>
  15746. </field>
  15747. <field name="DEFAULT_NM_CONTAINER_QUEUING_MIN_QUEUE_WAIT_TIME_MS" type="int"
  15748. transient="false" volatile="false"
  15749. static="true" final="true" visibility="public"
  15750. deprecated="not deprecated">
  15751. </field>
  15752. <field name="NM_CONTAINER_QUEUING_MAX_QUEUE_WAIT_TIME_MS" type="java.lang.String"
  15753. transient="false" volatile="false"
  15754. static="true" final="true" visibility="public"
  15755. deprecated="not deprecated">
  15756. <doc>
  15757. <![CDATA[Max queue wait time for a container queue at a NodeManager.]]>
  15758. </doc>
  15759. </field>
  15760. <field name="DEFAULT_NM_CONTAINER_QUEUING_MAX_QUEUE_WAIT_TIME_MS" type="int"
  15761. transient="false" volatile="false"
  15762. static="true" final="true" visibility="public"
  15763. deprecated="not deprecated">
  15764. </field>
  15765. <field name="YARN_INTERMEDIATE_DATA_ENCRYPTION" type="java.lang.String"
  15766. transient="false" volatile="false"
  15767. static="true" final="true" visibility="public"
  15768. deprecated="not deprecated">
  15769. <doc>
  15770. <![CDATA[Enable/disable intermediate-data encryption at YARN level. For now, this
  15771. only is used by the FileSystemRMStateStore to setup right file-system
  15772. security attributes.]]>
  15773. </doc>
  15774. </field>
  15775. <field name="DEFAULT_YARN_INTERMEDIATE_DATA_ENCRYPTION" type="boolean"
  15776. transient="false" volatile="false"
  15777. static="true" final="true" visibility="public"
  15778. deprecated="not deprecated">
  15779. </field>
  15780. <field name="RM_ADMIN_ADDRESS" type="java.lang.String"
  15781. transient="false" volatile="false"
  15782. static="true" final="true" visibility="public"
  15783. deprecated="not deprecated">
  15784. <doc>
  15785. <![CDATA[The address of the RM admin interface.]]>
  15786. </doc>
  15787. </field>
  15788. <field name="DEFAULT_RM_ADMIN_PORT" type="int"
  15789. transient="false" volatile="false"
  15790. static="true" final="true" visibility="public"
  15791. deprecated="not deprecated">
  15792. </field>
  15793. <field name="DEFAULT_RM_ADMIN_ADDRESS" type="java.lang.String"
  15794. transient="false" volatile="false"
  15795. static="true" final="true" visibility="public"
  15796. deprecated="not deprecated">
  15797. </field>
  15798. <field name="RM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
  15799. transient="false" volatile="false"
  15800. static="true" final="true" visibility="public"
  15801. deprecated="not deprecated">
  15802. <doc>
  15803. <![CDATA[Number of threads used to handle RM admin interface.]]>
  15804. </doc>
  15805. </field>
  15806. <field name="DEFAULT_RM_ADMIN_CLIENT_THREAD_COUNT" type="int"
  15807. transient="false" volatile="false"
  15808. static="true" final="true" visibility="public"
  15809. deprecated="not deprecated">
  15810. </field>
  15811. <field name="RM_AM_MAX_ATTEMPTS" type="java.lang.String"
  15812. transient="false" volatile="false"
  15813. static="true" final="true" visibility="public"
  15814. deprecated="not deprecated">
  15815. <doc>
  15816. <![CDATA[The maximum number of application attempts.
  15817. It's a global setting for all application masters.]]>
  15818. </doc>
  15819. </field>
  15820. <field name="DEFAULT_RM_AM_MAX_ATTEMPTS" type="int"
  15821. transient="false" volatile="false"
  15822. static="true" final="true" visibility="public"
  15823. deprecated="not deprecated">
  15824. </field>
  15825. <field name="RM_KEYTAB" type="java.lang.String"
  15826. transient="false" volatile="false"
  15827. static="true" final="true" visibility="public"
  15828. deprecated="not deprecated">
  15829. <doc>
  15830. <![CDATA[The keytab for the resource manager.]]>
  15831. </doc>
  15832. </field>
  15833. <field name="RM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
  15834. transient="false" volatile="false"
  15835. static="true" final="true" visibility="public"
  15836. deprecated="not deprecated">
  15837. <doc>
  15838. <![CDATA[The kerberos principal to be used for spnego filter for RM.]]>
  15839. </doc>
  15840. </field>
  15841. <field name="RM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
  15842. transient="false" volatile="false"
  15843. static="true" final="true" visibility="public"
  15844. deprecated="not deprecated">
  15845. <doc>
  15846. <![CDATA[The kerberos keytab to be used for spnego filter for RM.]]>
  15847. </doc>
  15848. </field>
  15849. <field name="RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="java.lang.String"
  15850. transient="false" volatile="false"
  15851. static="true" final="true" visibility="public"
  15852. deprecated="not deprecated">
  15853. <doc>
  15854. <![CDATA[Flag to enable override of the default kerberos authentication filter with
  15855. the RM authentication filter to allow authentication using delegation
  15856. tokens(fallback to kerberos if the tokens are missing). Only applicable
  15857. when the http authentication type is kerberos.]]>
  15858. </doc>
  15859. </field>
  15860. <field name="DEFAULT_RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="boolean"
  15861. transient="false" volatile="false"
  15862. static="true" final="true" visibility="public"
  15863. deprecated="not deprecated">
  15864. </field>
  15865. <field name="RM_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
  15866. transient="false" volatile="false"
  15867. static="true" final="true" visibility="public"
  15868. deprecated="not deprecated">
  15869. <doc>
  15870. <![CDATA[Enable cross origin (CORS) support.]]>
  15871. </doc>
  15872. </field>
  15873. <field name="DEFAULT_RM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
  15874. transient="false" volatile="false"
  15875. static="true" final="true" visibility="public"
  15876. deprecated="not deprecated">
  15877. </field>
  15878. <field name="RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="java.lang.String"
  15879. transient="false" volatile="false"
  15880. static="true" final="true" visibility="public"
  15881. deprecated="not deprecated">
  15882. <doc>
  15883. <![CDATA[How long to wait until a container is considered dead.]]>
  15884. </doc>
  15885. </field>
  15886. <field name="DEFAULT_RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="int"
  15887. transient="false" volatile="false"
  15888. static="true" final="true" visibility="public"
  15889. deprecated="not deprecated">
  15890. </field>
  15891. <field name="RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
  15892. transient="false" volatile="false"
  15893. static="true" final="true" visibility="public"
  15894. deprecated="not deprecated">
  15895. <doc>
  15896. <![CDATA[Path to file with nodes to include.]]>
  15897. </doc>
  15898. </field>
  15899. <field name="DEFAULT_RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
  15900. transient="false" volatile="false"
  15901. static="true" final="true" visibility="public"
  15902. deprecated="not deprecated">
  15903. </field>
  15904. <field name="RM_SUBMISSION_PREPROCESSOR_ENABLED" type="java.lang.String"
  15905. transient="false" volatile="false"
  15906. static="true" final="true" visibility="public"
  15907. deprecated="not deprecated">
  15908. <doc>
  15909. <![CDATA[Enable submission pre-processor.]]>
  15910. </doc>
  15911. </field>
  15912. <field name="DEFAULT_RM_SUBMISSION_PREPROCESSOR_ENABLED" type="boolean"
  15913. transient="false" volatile="false"
  15914. static="true" final="true" visibility="public"
  15915. deprecated="not deprecated">
  15916. </field>
  15917. <field name="RM_SUBMISSION_PREPROCESSOR_FILE_PATH" type="java.lang.String"
  15918. transient="false" volatile="false"
  15919. static="true" final="true" visibility="public"
  15920. deprecated="not deprecated">
  15921. <doc>
  15922. <![CDATA[Path to file with hosts for the submission processor to handle.]]>
  15923. </doc>
  15924. </field>
  15925. <field name="DEFAULT_RM_SUBMISSION_PREPROCESSOR_FILE_PATH" type="java.lang.String"
  15926. transient="false" volatile="false"
  15927. static="true" final="true" visibility="public"
  15928. deprecated="not deprecated">
  15929. </field>
  15930. <field name="RM_SUBMISSION_PREPROCESSOR_REFRESH_INTERVAL_MS" type="java.lang.String"
  15931. transient="false" volatile="false"
  15932. static="true" final="true" visibility="public"
  15933. deprecated="not deprecated">
  15934. <doc>
  15935. <![CDATA[Submission processor refresh interval.]]>
  15936. </doc>
  15937. </field>
  15938. <field name="DEFAULT_RM_SUBMISSION_PREPROCESSOR_REFRESH_INTERVAL_MS" type="int"
  15939. transient="false" volatile="false"
  15940. static="true" final="true" visibility="public"
  15941. deprecated="not deprecated">
  15942. </field>
  15943. <field name="RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
  15944. transient="false" volatile="false"
  15945. static="true" final="true" visibility="public"
  15946. deprecated="not deprecated">
  15947. <doc>
  15948. <![CDATA[Path to file with nodes to exclude.]]>
  15949. </doc>
  15950. </field>
  15951. <field name="DEFAULT_RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
  15952. transient="false" volatile="false"
  15953. static="true" final="true" visibility="public"
  15954. deprecated="not deprecated">
  15955. </field>
  15956. <field name="RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="java.lang.String"
  15957. transient="false" volatile="false"
  15958. static="true" final="true" visibility="public"
  15959. deprecated="not deprecated">
  15960. <doc>
  15961. <![CDATA[Number of threads to handle resource tracker calls.]]>
  15962. </doc>
  15963. </field>
  15964. <field name="DEFAULT_RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="int"
  15965. transient="false" volatile="false"
  15966. static="true" final="true" visibility="public"
  15967. deprecated="not deprecated">
  15968. </field>
  15969. <field name="RM_SCHEDULER" type="java.lang.String"
  15970. transient="false" volatile="false"
  15971. static="true" final="true" visibility="public"
  15972. deprecated="not deprecated">
  15973. <doc>
  15974. <![CDATA[The class to use as the resource scheduler.]]>
  15975. </doc>
  15976. </field>
  15977. <field name="DEFAULT_RM_SCHEDULER" type="java.lang.String"
  15978. transient="false" volatile="false"
  15979. static="true" final="true" visibility="public"
  15980. deprecated="not deprecated">
  15981. </field>
  15982. <field name="RM_NM_HEARTBEAT_INTERVAL_MS" type="java.lang.String"
  15983. transient="false" volatile="false"
  15984. static="true" final="true" visibility="public"
  15985. deprecated="not deprecated">
  15986. <doc>
  15987. <![CDATA[RM set next Heartbeat interval for NM]]>
  15988. </doc>
  15989. </field>
  15990. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MS" type="long"
  15991. transient="false" volatile="false"
  15992. static="true" final="true" visibility="public"
  15993. deprecated="not deprecated">
  15994. </field>
  15995. <field name="RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="java.lang.String"
  15996. transient="false" volatile="false"
  15997. static="true" final="true" visibility="public"
  15998. deprecated="not deprecated">
  15999. <doc>
  16000. <![CDATA[Number of worker threads that write the history data.]]>
  16001. </doc>
  16002. </field>
  16003. <field name="DEFAULT_RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="int"
  16004. transient="false" volatile="false"
  16005. static="true" final="true" visibility="public"
  16006. deprecated="not deprecated">
  16007. </field>
  16008. <field name="RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="java.lang.String"
  16009. transient="false" volatile="false"
  16010. static="true" final="true" visibility="public"
  16011. deprecated="not deprecated">
  16012. <doc>
  16013. <![CDATA[The setting that controls whether yarn system metrics is published on the
  16014. timeline server or not by RM. This configuration setting is for ATS V1.
  16015. This is now deprecated in favor of SYSTEM_METRICS_PUBLISHER_ENABLED.]]>
  16016. </doc>
  16017. </field>
  16018. <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="boolean"
  16019. transient="false" volatile="false"
  16020. static="true" final="true" visibility="public"
  16021. deprecated="not deprecated">
  16022. </field>
  16023. <field name="SYSTEM_METRICS_PUBLISHER_ENABLED" type="java.lang.String"
  16024. transient="false" volatile="false"
  16025. static="true" final="true" visibility="public"
  16026. deprecated="not deprecated">
  16027. <doc>
  16028. <![CDATA[The setting that controls whether yarn system metrics is published on the
  16029. timeline server or not by RM and NM. This configuration setting is for
  16030. ATS v2.]]>
  16031. </doc>
  16032. </field>
  16033. <field name="DEFAULT_SYSTEM_METRICS_PUBLISHER_ENABLED" type="boolean"
  16034. transient="false" volatile="false"
  16035. static="true" final="true" visibility="public"
  16036. deprecated="not deprecated">
  16037. </field>
  16038. <field name="RM_PUBLISH_CONTAINER_EVENTS_ENABLED" type="java.lang.String"
  16039. transient="false" volatile="false"
  16040. static="true" final="true" visibility="public"
  16041. deprecated="not deprecated">
  16042. <doc>
  16043. <![CDATA[The setting that controls whether yarn container events are published to
  16044. the timeline service or not by RM. This configuration setting is for ATS
  16045. V2]]>
  16046. </doc>
  16047. </field>
  16048. <field name="DEFAULT_RM_PUBLISH_CONTAINER_EVENTS_ENABLED" type="boolean"
  16049. transient="false" volatile="false"
  16050. static="true" final="true" visibility="public"
  16051. deprecated="not deprecated">
  16052. </field>
  16053. <field name="RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="java.lang.String"
  16054. transient="false" volatile="false"
  16055. static="true" final="true" visibility="public"
  16056. deprecated="not deprecated">
  16057. </field>
  16058. <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="int"
  16059. transient="false" volatile="false"
  16060. static="true" final="true" visibility="public"
  16061. deprecated="not deprecated">
  16062. </field>
  16063. <field name="RM_DELEGATION_KEY_UPDATE_INTERVAL_KEY" type="java.lang.String"
  16064. transient="false" volatile="false"
  16065. static="true" final="true" visibility="public"
  16066. deprecated="not deprecated">
  16067. </field>
  16068. <field name="RM_DELEGATION_KEY_UPDATE_INTERVAL_DEFAULT" type="long"
  16069. transient="false" volatile="false"
  16070. static="true" final="true" visibility="public"
  16071. deprecated="not deprecated">
  16072. </field>
  16073. <field name="RM_DELEGATION_TOKEN_RENEW_INTERVAL_KEY" type="java.lang.String"
  16074. transient="false" volatile="false"
  16075. static="true" final="true" visibility="public"
  16076. deprecated="not deprecated">
  16077. </field>
  16078. <field name="RM_DELEGATION_TOKEN_RENEW_INTERVAL_DEFAULT" type="long"
  16079. transient="false" volatile="false"
  16080. static="true" final="true" visibility="public"
  16081. deprecated="not deprecated">
  16082. </field>
  16083. <field name="RM_DELEGATION_TOKEN_MAX_LIFETIME_KEY" type="java.lang.String"
  16084. transient="false" volatile="false"
  16085. static="true" final="true" visibility="public"
  16086. deprecated="not deprecated">
  16087. </field>
  16088. <field name="RM_DELEGATION_TOKEN_MAX_LIFETIME_DEFAULT" type="long"
  16089. transient="false" volatile="false"
  16090. static="true" final="true" visibility="public"
  16091. deprecated="not deprecated">
  16092. </field>
  16093. <field name="RM_DELEGATION_TOKEN_MAX_CONF_SIZE" type="java.lang.String"
  16094. transient="false" volatile="false"
  16095. static="true" final="true" visibility="public"
  16096. deprecated="not deprecated">
  16097. </field>
  16098. <field name="DEFAULT_RM_DELEGATION_TOKEN_MAX_CONF_SIZE_BYTES" type="int"
  16099. transient="false" volatile="false"
  16100. static="true" final="true" visibility="public"
  16101. deprecated="not deprecated">
  16102. </field>
  16103. <field name="RECOVERY_ENABLED" type="java.lang.String"
  16104. transient="false" volatile="false"
  16105. static="true" final="true" visibility="public"
  16106. deprecated="not deprecated">
  16107. </field>
  16108. <field name="DEFAULT_RM_RECOVERY_ENABLED" type="boolean"
  16109. transient="false" volatile="false"
  16110. static="true" final="true" visibility="public"
  16111. deprecated="not deprecated">
  16112. </field>
  16113. <field name="YARN_FAIL_FAST" type="java.lang.String"
  16114. transient="false" volatile="false"
  16115. static="true" final="true" visibility="public"
  16116. deprecated="not deprecated">
  16117. </field>
  16118. <field name="DEFAULT_YARN_FAIL_FAST" type="boolean"
  16119. transient="false" volatile="false"
  16120. static="true" final="true" visibility="public"
  16121. deprecated="not deprecated">
  16122. </field>
  16123. <field name="RM_FAIL_FAST" type="java.lang.String"
  16124. transient="false" volatile="false"
  16125. static="true" final="true" visibility="public"
  16126. deprecated="not deprecated">
  16127. </field>
  16128. <field name="RM_WORK_PRESERVING_RECOVERY_ENABLED" type="java.lang.String"
  16129. transient="false" volatile="false"
  16130. static="true" final="true" visibility="public"
  16131. deprecated="not deprecated">
  16132. </field>
  16133. <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_ENABLED" type="boolean"
  16134. transient="false" volatile="false"
  16135. static="true" final="true" visibility="public"
  16136. deprecated="not deprecated">
  16137. </field>
  16138. <field name="RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="java.lang.String"
  16139. transient="false" volatile="false"
  16140. static="true" final="true" visibility="public"
  16141. deprecated="not deprecated">
  16142. </field>
  16143. <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="long"
  16144. transient="false" volatile="false"
  16145. static="true" final="true" visibility="public"
  16146. deprecated="not deprecated">
  16147. </field>
  16148. <field name="RM_ZK_PREFIX" type="java.lang.String"
  16149. transient="false" volatile="false"
  16150. static="true" final="true" visibility="public"
  16151. deprecated="not deprecated">
  16152. <doc>
  16153. <![CDATA[Zookeeper interaction configs]]>
  16154. </doc>
  16155. </field>
  16156. <field name="RM_ZK_ADDRESS" type="java.lang.String"
  16157. transient="false" volatile="false"
  16158. static="true" final="true" visibility="public"
  16159. deprecated="not deprecated">
  16160. </field>
  16161. <field name="RM_ZK_NUM_RETRIES" type="java.lang.String"
  16162. transient="false" volatile="false"
  16163. static="true" final="true" visibility="public"
  16164. deprecated="not deprecated">
  16165. </field>
  16166. <field name="DEFAULT_ZK_RM_NUM_RETRIES" type="int"
  16167. transient="false" volatile="false"
  16168. static="true" final="true" visibility="public"
  16169. deprecated="not deprecated">
  16170. </field>
  16171. <field name="RM_ZK_ZNODE_SIZE_LIMIT_BYTES" type="java.lang.String"
  16172. transient="false" volatile="false"
  16173. static="true" final="true" visibility="public"
  16174. deprecated="not deprecated">
  16175. <doc>
  16176. <![CDATA[Zookeeper znode limit]]>
  16177. </doc>
  16178. </field>
  16179. <field name="DEFAULT_RM_ZK_ZNODE_SIZE_LIMIT_BYTES" type="int"
  16180. transient="false" volatile="false"
  16181. static="true" final="true" visibility="public"
  16182. deprecated="not deprecated">
  16183. </field>
  16184. <field name="RM_ZK_RETRY_INTERVAL_MS" type="java.lang.String"
  16185. transient="false" volatile="false"
  16186. static="true" final="true" visibility="public"
  16187. deprecated="not deprecated">
  16188. </field>
  16189. <field name="DEFAULT_RM_ZK_RETRY_INTERVAL_MS" type="int"
  16190. transient="false" volatile="false"
  16191. static="true" final="true" visibility="public"
  16192. deprecated="not deprecated">
  16193. </field>
  16194. <field name="RM_ZK_TIMEOUT_MS" type="java.lang.String"
  16195. transient="false" volatile="false"
  16196. static="true" final="true" visibility="public"
  16197. deprecated="not deprecated">
  16198. </field>
  16199. <field name="DEFAULT_RM_ZK_TIMEOUT_MS" type="int"
  16200. transient="false" volatile="false"
  16201. static="true" final="true" visibility="public"
  16202. deprecated="not deprecated">
  16203. </field>
  16204. <field name="ZK_APPID_NODE_SPLIT_INDEX" type="java.lang.String"
  16205. transient="false" volatile="false"
  16206. static="true" final="true" visibility="public"
  16207. deprecated="not deprecated">
  16208. </field>
  16209. <field name="DEFAULT_ZK_APPID_NODE_SPLIT_INDEX" type="int"
  16210. transient="false" volatile="false"
  16211. static="true" final="true" visibility="public"
  16212. deprecated="not deprecated">
  16213. </field>
  16214. <field name="ZK_DELEGATION_TOKEN_NODE_SPLIT_INDEX" type="java.lang.String"
  16215. transient="false" volatile="false"
  16216. static="true" final="true" visibility="public"
  16217. deprecated="not deprecated">
  16218. <doc>
  16219. <![CDATA[Index at which the RM Delegation Token ids will be split so that the
  16220. delegation token znodes stored in the zookeeper RM state store will be
  16221. stored as two different znodes (parent-child).]]>
  16222. </doc>
  16223. </field>
  16224. <field name="DEFAULT_ZK_DELEGATION_TOKEN_NODE_SPLIT_INDEX" type="int"
  16225. transient="false" volatile="false"
  16226. static="true" final="true" visibility="public"
  16227. deprecated="not deprecated">
  16228. </field>
  16229. <field name="RM_ZK_ACL" type="java.lang.String"
  16230. transient="false" volatile="false"
  16231. static="true" final="true" visibility="public"
  16232. deprecated="not deprecated">
  16233. </field>
  16234. <field name="DEFAULT_RM_ZK_ACL" type="java.lang.String"
  16235. transient="false" volatile="false"
  16236. static="true" final="true" visibility="public"
  16237. deprecated="not deprecated">
  16238. </field>
  16239. <field name="RM_ZK_AUTH" type="java.lang.String"
  16240. transient="false" volatile="false"
  16241. static="true" final="true" visibility="public"
  16242. deprecated="not deprecated">
  16243. </field>
  16244. <field name="ZK_STATE_STORE_PREFIX" type="java.lang.String"
  16245. transient="false" volatile="false"
  16246. static="true" final="true" visibility="public"
  16247. deprecated="not deprecated">
  16248. </field>
  16249. <field name="ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
  16250. transient="false" volatile="false"
  16251. static="true" final="true" visibility="public"
  16252. deprecated="not deprecated">
  16253. <doc>
  16254. <![CDATA[Parent znode path under which ZKRMStateStore will create znodes]]>
  16255. </doc>
  16256. </field>
  16257. <field name="DEFAULT_ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
  16258. transient="false" volatile="false"
  16259. static="true" final="true" visibility="public"
  16260. deprecated="not deprecated">
  16261. </field>
  16262. <field name="ZK_RM_STATE_STORE_ROOT_NODE_ACL" type="java.lang.String"
  16263. transient="false" volatile="false"
  16264. static="true" final="true" visibility="public"
  16265. deprecated="not deprecated">
  16266. <doc>
  16267. <![CDATA[Root node ACLs for fencing]]>
  16268. </doc>
  16269. </field>
  16270. <field name="RM_HA_PREFIX" type="java.lang.String"
  16271. transient="false" volatile="false"
  16272. static="true" final="true" visibility="public"
  16273. deprecated="not deprecated">
  16274. <doc>
  16275. <![CDATA[HA related configs]]>
  16276. </doc>
  16277. </field>
  16278. <field name="RM_HA_ENABLED" type="java.lang.String"
  16279. transient="false" volatile="false"
  16280. static="true" final="true" visibility="public"
  16281. deprecated="not deprecated">
  16282. </field>
  16283. <field name="DEFAULT_RM_HA_ENABLED" type="boolean"
  16284. transient="false" volatile="false"
  16285. static="true" final="true" visibility="public"
  16286. deprecated="not deprecated">
  16287. </field>
  16288. <field name="RM_HA_IDS" type="java.lang.String"
  16289. transient="false" volatile="false"
  16290. static="true" final="true" visibility="public"
  16291. deprecated="not deprecated">
  16292. </field>
  16293. <field name="RM_HA_ID" type="java.lang.String"
  16294. transient="false" volatile="false"
  16295. static="true" final="true" visibility="public"
  16296. deprecated="not deprecated">
  16297. </field>
  16298. <field name="FS_BASED_RM_CONF_STORE" type="java.lang.String"
  16299. transient="false" volatile="false"
  16300. static="true" final="true" visibility="public"
  16301. deprecated="not deprecated">
  16302. <doc>
  16303. <![CDATA[Store the related configuration files in File System]]>
  16304. </doc>
  16305. </field>
  16306. <field name="DEFAULT_FS_BASED_RM_CONF_STORE" type="java.lang.String"
  16307. transient="false" volatile="false"
  16308. static="true" final="true" visibility="public"
  16309. deprecated="not deprecated">
  16310. </field>
  16311. <field name="RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
  16312. transient="false" volatile="false"
  16313. static="true" final="true" visibility="public"
  16314. deprecated="not deprecated">
  16315. </field>
  16316. <field name="DEFAULT_RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
  16317. transient="false" volatile="false"
  16318. static="true" final="true" visibility="public"
  16319. deprecated="not deprecated">
  16320. </field>
  16321. <field name="SCHEDULER_CONFIGURATION_STORE_CLASS" type="java.lang.String"
  16322. transient="false" volatile="false"
  16323. static="true" final="true" visibility="public"
  16324. deprecated="not deprecated">
  16325. </field>
  16326. <field name="FILE_CONFIGURATION_STORE" type="java.lang.String"
  16327. transient="false" volatile="false"
  16328. static="true" final="true" visibility="public"
  16329. deprecated="not deprecated">
  16330. </field>
  16331. <field name="MEMORY_CONFIGURATION_STORE" type="java.lang.String"
  16332. transient="false" volatile="false"
  16333. static="true" final="true" visibility="public"
  16334. deprecated="not deprecated">
  16335. </field>
  16336. <field name="LEVELDB_CONFIGURATION_STORE" type="java.lang.String"
  16337. transient="false" volatile="false"
  16338. static="true" final="true" visibility="public"
  16339. deprecated="not deprecated">
  16340. </field>
  16341. <field name="ZK_CONFIGURATION_STORE" type="java.lang.String"
  16342. transient="false" volatile="false"
  16343. static="true" final="true" visibility="public"
  16344. deprecated="not deprecated">
  16345. </field>
  16346. <field name="DEFAULT_CONFIGURATION_STORE" type="java.lang.String"
  16347. transient="false" volatile="false"
  16348. static="true" final="true" visibility="public"
  16349. deprecated="not deprecated">
  16350. </field>
  16351. <field name="RM_SCHEDCONF_STORE_PATH" type="java.lang.String"
  16352. transient="false" volatile="false"
  16353. static="true" final="true" visibility="public"
  16354. deprecated="not deprecated">
  16355. </field>
  16356. <field name="RM_SCHEDCONF_LEVELDB_COMPACTION_INTERVAL_SECS" type="java.lang.String"
  16357. transient="false" volatile="false"
  16358. static="true" final="true" visibility="public"
  16359. deprecated="not deprecated">
  16360. </field>
  16361. <field name="DEFAULT_RM_SCHEDCONF_LEVELDB_COMPACTION_INTERVAL_SECS" type="long"
  16362. transient="false" volatile="false"
  16363. static="true" final="true" visibility="public"
  16364. deprecated="not deprecated">
  16365. </field>
  16366. <field name="RM_SCHEDCONF_MAX_LOGS" type="java.lang.String"
  16367. transient="false" volatile="false"
  16368. static="true" final="true" visibility="public"
  16369. deprecated="not deprecated">
  16370. </field>
  16371. <field name="DEFAULT_RM_SCHEDCONF_LEVELDB_MAX_LOGS" type="long"
  16372. transient="false" volatile="false"
  16373. static="true" final="true" visibility="public"
  16374. deprecated="not deprecated">
  16375. </field>
  16376. <field name="DEFAULT_RM_SCHEDCONF_ZK_MAX_LOGS" type="long"
  16377. transient="false" volatile="false"
  16378. static="true" final="true" visibility="public"
  16379. deprecated="not deprecated">
  16380. </field>
  16381. <field name="RM_SCHEDCONF_STORE_ZK_PARENT_PATH" type="java.lang.String"
  16382. transient="false" volatile="false"
  16383. static="true" final="true" visibility="public"
  16384. deprecated="not deprecated">
  16385. <doc>
  16386. <![CDATA[Parent znode path under which ZKConfigurationStore will create znodes.]]>
  16387. </doc>
  16388. </field>
  16389. <field name="DEFAULT_RM_SCHEDCONF_STORE_ZK_PARENT_PATH" type="java.lang.String"
  16390. transient="false" volatile="false"
  16391. static="true" final="true" visibility="public"
  16392. deprecated="not deprecated">
  16393. </field>
  16394. <field name="RM_SCHEDULER_MUTATION_ACL_POLICY_CLASS" type="java.lang.String"
  16395. transient="false" volatile="false"
  16396. static="true" final="true" visibility="public"
  16397. deprecated="not deprecated">
  16398. </field>
  16399. <field name="YARN_AUTHORIZATION_PROVIDER" type="java.lang.String"
  16400. transient="false" volatile="false"
  16401. static="true" final="true" visibility="public"
  16402. deprecated="not deprecated">
  16403. </field>
  16404. <field name="AUTO_FAILOVER_PREFIX" type="java.lang.String"
  16405. transient="false" volatile="false"
  16406. static="true" final="true" visibility="public"
  16407. deprecated="not deprecated">
  16408. </field>
  16409. <field name="AUTO_FAILOVER_ENABLED" type="java.lang.String"
  16410. transient="false" volatile="false"
  16411. static="true" final="true" visibility="public"
  16412. deprecated="not deprecated">
  16413. </field>
  16414. <field name="DEFAULT_AUTO_FAILOVER_ENABLED" type="boolean"
  16415. transient="false" volatile="false"
  16416. static="true" final="true" visibility="public"
  16417. deprecated="not deprecated">
  16418. </field>
  16419. <field name="AUTO_FAILOVER_EMBEDDED" type="java.lang.String"
  16420. transient="false" volatile="false"
  16421. static="true" final="true" visibility="public"
  16422. deprecated="This property should never be set to {@code false}.">
  16423. <doc>
  16424. <![CDATA[This property controls whether {@link ActiveStandbyElector} leader
  16425. election should be used when {@link #CURATOR_LEADER_ELECTOR} is
  16426. {@code false}.
  16427. @deprecated This property should never be set to {@code false}.]]>
  16428. </doc>
  16429. </field>
  16430. <field name="DEFAULT_AUTO_FAILOVER_EMBEDDED" type="boolean"
  16431. transient="false" volatile="false"
  16432. static="true" final="true" visibility="public"
  16433. deprecated="The {@link #AUTO_FAILOVER_EMBEDDED} property is deprecated.">
  16434. <doc>
  16435. <![CDATA[The default value for {@link #AUTO_FAILOVER_EMBEDDED}.
  16436. @deprecated The {@link #AUTO_FAILOVER_EMBEDDED} property is deprecated.]]>
  16437. </doc>
  16438. </field>
  16439. <field name="AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
  16440. transient="false" volatile="false"
  16441. static="true" final="true" visibility="public"
  16442. deprecated="not deprecated">
  16443. </field>
  16444. <field name="DEFAULT_AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
  16445. transient="false" volatile="false"
  16446. static="true" final="true" visibility="public"
  16447. deprecated="not deprecated">
  16448. </field>
  16449. <field name="CLIENT_FAILOVER_PREFIX" type="java.lang.String"
  16450. transient="false" volatile="false"
  16451. static="true" final="true" visibility="public"
  16452. deprecated="not deprecated">
  16453. </field>
  16454. <field name="CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
  16455. transient="false" volatile="false"
  16456. static="true" final="true" visibility="public"
  16457. deprecated="not deprecated">
  16458. </field>
  16459. <field name="DEFAULT_CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
  16460. transient="false" volatile="false"
  16461. static="true" final="true" visibility="public"
  16462. deprecated="not deprecated">
  16463. </field>
  16464. <field name="CLIENT_FAILOVER_MAX_ATTEMPTS" type="java.lang.String"
  16465. transient="false" volatile="false"
  16466. static="true" final="true" visibility="public"
  16467. deprecated="not deprecated">
  16468. </field>
  16469. <field name="CLIENT_FAILOVER_SLEEPTIME_BASE_MS" type="java.lang.String"
  16470. transient="false" volatile="false"
  16471. static="true" final="true" visibility="public"
  16472. deprecated="not deprecated">
  16473. </field>
  16474. <field name="CLIENT_FAILOVER_SLEEPTIME_MAX_MS" type="java.lang.String"
  16475. transient="false" volatile="false"
  16476. static="true" final="true" visibility="public"
  16477. deprecated="not deprecated">
  16478. </field>
  16479. <field name="CLIENT_FAILOVER_RETRIES" type="java.lang.String"
  16480. transient="false" volatile="false"
  16481. static="true" final="true" visibility="public"
  16482. deprecated="not deprecated">
  16483. </field>
  16484. <field name="DEFAULT_CLIENT_FAILOVER_RETRIES" type="int"
  16485. transient="false" volatile="false"
  16486. static="true" final="true" visibility="public"
  16487. deprecated="not deprecated">
  16488. </field>
  16489. <field name="CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="java.lang.String"
  16490. transient="false" volatile="false"
  16491. static="true" final="true" visibility="public"
  16492. deprecated="not deprecated">
  16493. </field>
  16494. <field name="DEFAULT_CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="int"
  16495. transient="false" volatile="false"
  16496. static="true" final="true" visibility="public"
  16497. deprecated="not deprecated">
  16498. </field>
  16499. <field name="RM_HA_FC_ELECTOR_ZK_RETRIES_KEY" type="java.lang.String"
  16500. transient="false" volatile="false"
  16501. static="true" final="true" visibility="public"
  16502. deprecated="not deprecated">
  16503. <doc>
  16504. <![CDATA[number of zookeeper operation retry times in ActiveStandbyElector]]>
  16505. </doc>
  16506. </field>
  16507. <field name="CURATOR_LEADER_ELECTOR" type="java.lang.String"
  16508. transient="false" volatile="false"
  16509. static="true" final="true" visibility="public"
  16510. deprecated="Eventually, we want to default to the curator-based
  16511. implementation and remove the {@link ActiveStandbyElector} based
  16512. implementation. We should remove this config then.">
  16513. <doc>
  16514. <![CDATA[Whether to use the Curator-based elector for leader election.
  16515. @deprecated Eventually, we want to default to the curator-based
  16516. implementation and remove the {@link ActiveStandbyElector} based
  16517. implementation. We should remove this config then.]]>
  16518. </doc>
  16519. </field>
  16520. <field name="DEFAULT_CURATOR_LEADER_ELECTOR_ENABLED" type="boolean"
  16521. transient="false" volatile="false"
  16522. static="true" final="true" visibility="public"
  16523. deprecated="not deprecated">
  16524. </field>
  16525. <field name="RM_STORE" type="java.lang.String"
  16526. transient="false" volatile="false"
  16527. static="true" final="true" visibility="public"
  16528. deprecated="not deprecated">
  16529. <doc>
  16530. <![CDATA[The class to use as the persistent store.]]>
  16531. </doc>
  16532. </field>
  16533. <field name="FS_RM_STATE_STORE_URI" type="java.lang.String"
  16534. transient="false" volatile="false"
  16535. static="true" final="true" visibility="public"
  16536. deprecated="not deprecated">
  16537. <doc>
  16538. <![CDATA[URI for FileSystemRMStateStore]]>
  16539. </doc>
  16540. </field>
  16541. <field name="FS_RM_STATE_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  16542. transient="false" volatile="false"
  16543. static="true" final="true" visibility="public"
  16544. deprecated="not deprecated">
  16545. </field>
  16546. <field name="DEFAULT_FS_RM_STATE_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  16547. transient="false" volatile="false"
  16548. static="true" final="true" visibility="public"
  16549. deprecated="not deprecated">
  16550. </field>
  16551. <field name="FS_RM_STATE_STORE_NUM_RETRIES" type="java.lang.String"
  16552. transient="false" volatile="false"
  16553. static="true" final="true" visibility="public"
  16554. deprecated="not deprecated">
  16555. </field>
  16556. <field name="DEFAULT_FS_RM_STATE_STORE_NUM_RETRIES" type="int"
  16557. transient="false" volatile="false"
  16558. static="true" final="true" visibility="public"
  16559. deprecated="not deprecated">
  16560. </field>
  16561. <field name="FS_RM_STATE_STORE_RETRY_INTERVAL_MS" type="java.lang.String"
  16562. transient="false" volatile="false"
  16563. static="true" final="true" visibility="public"
  16564. deprecated="not deprecated">
  16565. </field>
  16566. <field name="DEFAULT_FS_RM_STATE_STORE_RETRY_INTERVAL_MS" type="long"
  16567. transient="false" volatile="false"
  16568. static="true" final="true" visibility="public"
  16569. deprecated="not deprecated">
  16570. </field>
  16571. <field name="RM_LEVELDB_STORE_PATH" type="java.lang.String"
  16572. transient="false" volatile="false"
  16573. static="true" final="true" visibility="public"
  16574. deprecated="not deprecated">
  16575. </field>
  16576. <field name="RM_LEVELDB_COMPACTION_INTERVAL_SECS" type="java.lang.String"
  16577. transient="false" volatile="false"
  16578. static="true" final="true" visibility="public"
  16579. deprecated="not deprecated">
  16580. <doc>
  16581. <![CDATA[The time in seconds between full compactions of the leveldb database.
  16582. Setting the interval to zero disables the full compaction cycles.]]>
  16583. </doc>
  16584. </field>
  16585. <field name="DEFAULT_RM_LEVELDB_COMPACTION_INTERVAL_SECS" type="long"
  16586. transient="false" volatile="false"
  16587. static="true" final="true" visibility="public"
  16588. deprecated="not deprecated">
  16589. </field>
  16590. <field name="RM_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
  16591. transient="false" volatile="false"
  16592. static="true" final="true" visibility="public"
  16593. deprecated="not deprecated">
  16594. <doc>
  16595. <![CDATA[The maximum number of completed applications RM keeps.]]>
  16596. </doc>
  16597. </field>
  16598. <field name="DEFAULT_RM_MAX_COMPLETED_APPLICATIONS" type="int"
  16599. transient="false" volatile="false"
  16600. static="true" final="true" visibility="public"
  16601. deprecated="not deprecated">
  16602. </field>
  16603. <field name="RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
  16604. transient="false" volatile="false"
  16605. static="true" final="true" visibility="public"
  16606. deprecated="not deprecated">
  16607. <doc>
  16608. <![CDATA[The maximum number of completed applications RM state store keeps, by
  16609. default equals to DEFAULT_RM_MAX_COMPLETED_APPLICATIONS]]>
  16610. </doc>
  16611. </field>
  16612. <field name="DEFAULT_RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="int"
  16613. transient="false" volatile="false"
  16614. static="true" final="true" visibility="public"
  16615. deprecated="not deprecated">
  16616. </field>
  16617. <field name="DEFAULT_APPLICATION_NAME" type="java.lang.String"
  16618. transient="false" volatile="false"
  16619. static="true" final="true" visibility="public"
  16620. deprecated="not deprecated">
  16621. <doc>
  16622. <![CDATA[Default application name]]>
  16623. </doc>
  16624. </field>
  16625. <field name="DEFAULT_APPLICATION_TYPE" type="java.lang.String"
  16626. transient="false" volatile="false"
  16627. static="true" final="true" visibility="public"
  16628. deprecated="not deprecated">
  16629. <doc>
  16630. <![CDATA[Default application type]]>
  16631. </doc>
  16632. </field>
  16633. <field name="APPLICATION_TYPE_LENGTH" type="int"
  16634. transient="false" volatile="false"
  16635. static="true" final="true" visibility="public"
  16636. deprecated="not deprecated">
  16637. <doc>
  16638. <![CDATA[Default application type length]]>
  16639. </doc>
  16640. </field>
  16641. <field name="DEFAULT_QUEUE_NAME" type="java.lang.String"
  16642. transient="false" volatile="false"
  16643. static="true" final="true" visibility="public"
  16644. deprecated="not deprecated">
  16645. <doc>
  16646. <![CDATA[Default queue name]]>
  16647. </doc>
  16648. </field>
  16649. <field name="RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
  16650. transient="false" volatile="false"
  16651. static="true" final="true" visibility="public"
  16652. deprecated="not deprecated">
  16653. <doc>
  16654. <![CDATA[Buckets (in minutes) for the number of apps running in each queue.]]>
  16655. </doc>
  16656. </field>
  16657. <field name="DEFAULT_RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
  16658. transient="false" volatile="false"
  16659. static="true" final="true" visibility="public"
  16660. deprecated="not deprecated">
  16661. <doc>
  16662. <![CDATA[Default sizes of the runtime metric buckets in minutes.]]>
  16663. </doc>
  16664. </field>
  16665. <field name="RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  16666. transient="false" volatile="false"
  16667. static="true" final="true" visibility="public"
  16668. deprecated="not deprecated">
  16669. </field>
  16670. <field name="DEFAULT_RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  16671. transient="false" volatile="false"
  16672. static="true" final="true" visibility="public"
  16673. deprecated="not deprecated">
  16674. </field>
  16675. <field name="RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  16676. transient="false" volatile="false"
  16677. static="true" final="true" visibility="public"
  16678. deprecated="not deprecated">
  16679. </field>
  16680. <field name="DEFAULT_RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  16681. transient="false" volatile="false"
  16682. static="true" final="true" visibility="public"
  16683. deprecated="not deprecated">
  16684. </field>
  16685. <field name="RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  16686. transient="false" volatile="false"
  16687. static="true" final="true" visibility="public"
  16688. deprecated="not deprecated">
  16689. </field>
  16690. <field name="DEFAULT_RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  16691. transient="false" volatile="false"
  16692. static="true" final="true" visibility="public"
  16693. deprecated="not deprecated">
  16694. </field>
  16695. <field name="RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  16696. transient="false" volatile="false"
  16697. static="true" final="true" visibility="public"
  16698. deprecated="not deprecated">
  16699. </field>
  16700. <field name="DEFAULT_RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  16701. transient="false" volatile="false"
  16702. static="true" final="true" visibility="public"
  16703. deprecated="not deprecated">
  16704. </field>
  16705. <field name="RM_NODEMANAGER_UNTRACKED_REMOVAL_TIMEOUT_MSEC" type="java.lang.String"
  16706. transient="false" volatile="false"
  16707. static="true" final="true" visibility="public"
  16708. deprecated="not deprecated">
  16709. <doc>
  16710. <![CDATA[Timeout(msec) for an untracked node to remain in shutdown or decommissioned
  16711. state.]]>
  16712. </doc>
  16713. </field>
  16714. <field name="DEFAULT_RM_NODEMANAGER_UNTRACKED_REMOVAL_TIMEOUT_MSEC" type="int"
  16715. transient="false" volatile="false"
  16716. static="true" final="true" visibility="public"
  16717. deprecated="not deprecated">
  16718. </field>
  16719. <field name="RM_PROXY_USER_PREFIX" type="java.lang.String"
  16720. transient="false" volatile="false"
  16721. static="true" final="true" visibility="public"
  16722. deprecated="not deprecated">
  16723. <doc>
  16724. <![CDATA[RM proxy users' prefix]]>
  16725. </doc>
  16726. </field>
  16727. <field name="RM_NODE_GRACEFUL_DECOMMISSION_TIMEOUT" type="java.lang.String"
  16728. transient="false" volatile="false"
  16729. static="true" final="true" visibility="public"
  16730. deprecated="not deprecated">
  16731. <doc>
  16732. <![CDATA[Timeout in seconds for YARN node graceful decommission.
  16733. This is the maximal time to wait for running containers and applications
  16734. to complete before transition a DECOMMISSIONING node into DECOMMISSIONED.]]>
  16735. </doc>
  16736. </field>
  16737. <field name="DEFAULT_RM_NODE_GRACEFUL_DECOMMISSION_TIMEOUT" type="int"
  16738. transient="false" volatile="false"
  16739. static="true" final="true" visibility="public"
  16740. deprecated="not deprecated">
  16741. </field>
  16742. <field name="RM_DECOMMISSIONING_NODES_WATCHER_POLL_INTERVAL" type="java.lang.String"
  16743. transient="false" volatile="false"
  16744. static="true" final="true" visibility="public"
  16745. deprecated="not deprecated">
  16746. <doc>
  16747. <![CDATA[Period in seconds of the poll timer task inside DecommissioningNodesWatcher
  16748. to identify and take care of DECOMMISSIONING nodes missing regular heart beat.]]>
  16749. </doc>
  16750. </field>
  16751. <field name="DEFAULT_RM_DECOMMISSIONING_NODES_WATCHER_POLL_INTERVAL" type="int"
  16752. transient="false" volatile="false"
  16753. static="true" final="true" visibility="public"
  16754. deprecated="not deprecated">
  16755. </field>
  16756. <field name="NM_PREFIX" type="java.lang.String"
  16757. transient="false" volatile="false"
  16758. static="true" final="true" visibility="public"
  16759. deprecated="not deprecated">
  16760. <doc>
  16761. <![CDATA[Prefix for all node manager configs.]]>
  16762. </doc>
  16763. </field>
  16764. <field name="NM_OPPORTUNISTIC_CONTAINERS_MAX_QUEUE_LENGTH" type="java.lang.String"
  16765. transient="false" volatile="false"
  16766. static="true" final="true" visibility="public"
  16767. deprecated="not deprecated">
  16768. <doc>
  16769. <![CDATA[Max Queue length of <code>OPPORTUNISTIC</code> containers on the NM.]]>
  16770. </doc>
  16771. </field>
  16772. <field name="DEFAULT_NM_OPPORTUNISTIC_CONTAINERS_MAX_QUEUE_LENGTH" type="int"
  16773. transient="false" volatile="false"
  16774. static="true" final="true" visibility="public"
  16775. deprecated="not deprecated">
  16776. </field>
  16777. <field name="DIST_SCHEDULING_ENABLED" type="java.lang.String"
  16778. transient="false" volatile="false"
  16779. static="true" final="true" visibility="public"
  16780. deprecated="not deprecated">
  16781. <doc>
  16782. <![CDATA[Setting that controls whether distributed scheduling is enabled or not.]]>
  16783. </doc>
  16784. </field>
  16785. <field name="DEFAULT_DIST_SCHEDULING_ENABLED" type="boolean"
  16786. transient="false" volatile="false"
  16787. static="true" final="true" visibility="public"
  16788. deprecated="not deprecated">
  16789. </field>
  16790. <field name="NM_ADMIN_USER_ENV" type="java.lang.String"
  16791. transient="false" volatile="false"
  16792. static="true" final="true" visibility="public"
  16793. deprecated="not deprecated">
  16794. <doc>
  16795. <![CDATA[Environment variables that will be sent to containers.]]>
  16796. </doc>
  16797. </field>
  16798. <field name="DEFAULT_NM_ADMIN_USER_ENV" type="java.lang.String"
  16799. transient="false" volatile="false"
  16800. static="true" final="true" visibility="public"
  16801. deprecated="not deprecated">
  16802. </field>
  16803. <field name="NM_ENV_WHITELIST" type="java.lang.String"
  16804. transient="false" volatile="false"
  16805. static="true" final="true" visibility="public"
  16806. deprecated="not deprecated">
  16807. <doc>
  16808. <![CDATA[Environment variables that containers may override rather than use NodeManager's default.]]>
  16809. </doc>
  16810. </field>
  16811. <field name="DEFAULT_NM_ENV_WHITELIST" type="java.lang.String"
  16812. transient="false" volatile="false"
  16813. static="true" final="true" visibility="public"
  16814. deprecated="not deprecated">
  16815. </field>
  16816. <field name="NM_ADDRESS" type="java.lang.String"
  16817. transient="false" volatile="false"
  16818. static="true" final="true" visibility="public"
  16819. deprecated="not deprecated">
  16820. <doc>
  16821. <![CDATA[address of node manager IPC.]]>
  16822. </doc>
  16823. </field>
  16824. <field name="DEFAULT_NM_PORT" type="int"
  16825. transient="false" volatile="false"
  16826. static="true" final="true" visibility="public"
  16827. deprecated="not deprecated">
  16828. </field>
  16829. <field name="DEFAULT_NM_ADDRESS" type="java.lang.String"
  16830. transient="false" volatile="false"
  16831. static="true" final="true" visibility="public"
  16832. deprecated="not deprecated">
  16833. </field>
  16834. <field name="NM_BIND_HOST" type="java.lang.String"
  16835. transient="false" volatile="false"
  16836. static="true" final="true" visibility="public"
  16837. deprecated="not deprecated">
  16838. <doc>
  16839. <![CDATA[The actual bind address or the NM.]]>
  16840. </doc>
  16841. </field>
  16842. <field name="NM_CONTAINER_EXECUTOR" type="java.lang.String"
  16843. transient="false" volatile="false"
  16844. static="true" final="true" visibility="public"
  16845. deprecated="not deprecated">
  16846. <doc>
  16847. <![CDATA[who will execute(launch) the containers.]]>
  16848. </doc>
  16849. </field>
  16850. <field name="NM_CONTAINER_STATE_TRANSITION_LISTENERS" type="java.lang.String"
  16851. transient="false" volatile="false"
  16852. static="true" final="true" visibility="public"
  16853. deprecated="not deprecated">
  16854. <doc>
  16855. <![CDATA[List of container state transition listeners.]]>
  16856. </doc>
  16857. </field>
  16858. <field name="NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="java.lang.String"
  16859. transient="false" volatile="false"
  16860. static="true" final="true" visibility="public"
  16861. deprecated="not deprecated">
  16862. <doc>
  16863. <![CDATA[Adjustment to make to the container os scheduling priority.
  16864. The valid values for this could vary depending on the platform.
  16865. On Linux, higher values mean run the containers at a less
  16866. favorable priority than the NM.
  16867. The value specified is an int.]]>
  16868. </doc>
  16869. </field>
  16870. <field name="DEFAULT_NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="int"
  16871. transient="false" volatile="false"
  16872. static="true" final="true" visibility="public"
  16873. deprecated="not deprecated">
  16874. </field>
  16875. <field name="NM_CONTAINER_MGR_THREAD_COUNT" type="java.lang.String"
  16876. transient="false" volatile="false"
  16877. static="true" final="true" visibility="public"
  16878. deprecated="not deprecated">
  16879. <doc>
  16880. <![CDATA[Number of threads container manager uses.]]>
  16881. </doc>
  16882. </field>
  16883. <field name="DEFAULT_NM_CONTAINER_MGR_THREAD_COUNT" type="int"
  16884. transient="false" volatile="false"
  16885. static="true" final="true" visibility="public"
  16886. deprecated="not deprecated">
  16887. </field>
  16888. <field name="NM_COLLECTOR_SERVICE_THREAD_COUNT" type="java.lang.String"
  16889. transient="false" volatile="false"
  16890. static="true" final="true" visibility="public"
  16891. deprecated="not deprecated">
  16892. <doc>
  16893. <![CDATA[Number of threads container manager uses.]]>
  16894. </doc>
  16895. </field>
  16896. <field name="DEFAULT_NM_COLLECTOR_SERVICE_THREAD_COUNT" type="int"
  16897. transient="false" volatile="false"
  16898. static="true" final="true" visibility="public"
  16899. deprecated="not deprecated">
  16900. </field>
  16901. <field name="NM_DELETE_THREAD_COUNT" type="java.lang.String"
  16902. transient="false" volatile="false"
  16903. static="true" final="true" visibility="public"
  16904. deprecated="not deprecated">
  16905. <doc>
  16906. <![CDATA[Number of threads used in cleanup.]]>
  16907. </doc>
  16908. </field>
  16909. <field name="DEFAULT_NM_DELETE_THREAD_COUNT" type="int"
  16910. transient="false" volatile="false"
  16911. static="true" final="true" visibility="public"
  16912. deprecated="not deprecated">
  16913. </field>
  16914. <field name="NM_KEYTAB" type="java.lang.String"
  16915. transient="false" volatile="false"
  16916. static="true" final="true" visibility="public"
  16917. deprecated="not deprecated">
  16918. <doc>
  16919. <![CDATA[Keytab for NM.]]>
  16920. </doc>
  16921. </field>
  16922. <field name="NM_LOCAL_DIRS" type="java.lang.String"
  16923. transient="false" volatile="false"
  16924. static="true" final="true" visibility="public"
  16925. deprecated="not deprecated">
  16926. <doc>
  16927. <![CDATA[List of directories to store localized files in.]]>
  16928. </doc>
  16929. </field>
  16930. <field name="DEFAULT_NM_LOCAL_DIRS" type="java.lang.String"
  16931. transient="false" volatile="false"
  16932. static="true" final="true" visibility="public"
  16933. deprecated="not deprecated">
  16934. </field>
  16935. <field name="NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="java.lang.String"
  16936. transient="false" volatile="false"
  16937. static="true" final="true" visibility="public"
  16938. deprecated="not deprecated">
  16939. <doc>
  16940. <![CDATA[Number of files in each localized directories
  16941. Avoid tuning this too low.]]>
  16942. </doc>
  16943. </field>
  16944. <field name="DEFAULT_NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="int"
  16945. transient="false" volatile="false"
  16946. static="true" final="true" visibility="public"
  16947. deprecated="not deprecated">
  16948. </field>
  16949. <field name="NM_LOCALIZER_ADDRESS" type="java.lang.String"
  16950. transient="false" volatile="false"
  16951. static="true" final="true" visibility="public"
  16952. deprecated="not deprecated">
  16953. <doc>
  16954. <![CDATA[Address where the localizer IPC is.]]>
  16955. </doc>
  16956. </field>
  16957. <field name="DEFAULT_NM_LOCALIZER_PORT" type="int"
  16958. transient="false" volatile="false"
  16959. static="true" final="true" visibility="public"
  16960. deprecated="not deprecated">
  16961. </field>
  16962. <field name="DEFAULT_NM_LOCALIZER_ADDRESS" type="java.lang.String"
  16963. transient="false" volatile="false"
  16964. static="true" final="true" visibility="public"
  16965. deprecated="not deprecated">
  16966. </field>
  16967. <field name="NM_COLLECTOR_SERVICE_ADDRESS" type="java.lang.String"
  16968. transient="false" volatile="false"
  16969. static="true" final="true" visibility="public"
  16970. deprecated="not deprecated">
  16971. <doc>
  16972. <![CDATA[Address where the collector service IPC is.]]>
  16973. </doc>
  16974. </field>
  16975. <field name="DEFAULT_NM_COLLECTOR_SERVICE_PORT" type="int"
  16976. transient="false" volatile="false"
  16977. static="true" final="true" visibility="public"
  16978. deprecated="not deprecated">
  16979. </field>
  16980. <field name="DEFAULT_NM_COLLECTOR_SERVICE_ADDRESS" type="java.lang.String"
  16981. transient="false" volatile="false"
  16982. static="true" final="true" visibility="public"
  16983. deprecated="not deprecated">
  16984. </field>
  16985. <field name="NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="java.lang.String"
  16986. transient="false" volatile="false"
  16987. static="true" final="true" visibility="public"
  16988. deprecated="not deprecated">
  16989. <doc>
  16990. <![CDATA[Interval in between cache cleanups.]]>
  16991. </doc>
  16992. </field>
  16993. <field name="DEFAULT_NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="long"
  16994. transient="false" volatile="false"
  16995. static="true" final="true" visibility="public"
  16996. deprecated="not deprecated">
  16997. </field>
  16998. <field name="NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="java.lang.String"
  16999. transient="false" volatile="false"
  17000. static="true" final="true" visibility="public"
  17001. deprecated="not deprecated">
  17002. <doc>
  17003. <![CDATA[Target size of localizer cache in MB, per nodemanager. It is a target
  17004. retention size that only includes resources with PUBLIC and PRIVATE
  17005. visibility and excludes resources with APPLICATION visibility]]>
  17006. </doc>
  17007. </field>
  17008. <field name="DEFAULT_NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="long"
  17009. transient="false" volatile="false"
  17010. static="true" final="true" visibility="public"
  17011. deprecated="not deprecated">
  17012. </field>
  17013. <field name="NM_LOCALIZER_CLIENT_THREAD_COUNT" type="java.lang.String"
  17014. transient="false" volatile="false"
  17015. static="true" final="true" visibility="public"
  17016. deprecated="not deprecated">
  17017. <doc>
  17018. <![CDATA[Number of threads to handle localization requests.]]>
  17019. </doc>
  17020. </field>
  17021. <field name="DEFAULT_NM_LOCALIZER_CLIENT_THREAD_COUNT" type="int"
  17022. transient="false" volatile="false"
  17023. static="true" final="true" visibility="public"
  17024. deprecated="not deprecated">
  17025. </field>
  17026. <field name="NM_LOCALIZER_FETCH_THREAD_COUNT" type="java.lang.String"
  17027. transient="false" volatile="false"
  17028. static="true" final="true" visibility="public"
  17029. deprecated="not deprecated">
  17030. <doc>
  17031. <![CDATA[Number of threads to use for localization fetching.]]>
  17032. </doc>
  17033. </field>
  17034. <field name="DEFAULT_NM_LOCALIZER_FETCH_THREAD_COUNT" type="int"
  17035. transient="false" volatile="false"
  17036. static="true" final="true" visibility="public"
  17037. deprecated="not deprecated">
  17038. </field>
  17039. <field name="NM_LOG_DIRS" type="java.lang.String"
  17040. transient="false" volatile="false"
  17041. static="true" final="true" visibility="public"
  17042. deprecated="not deprecated">
  17043. <doc>
  17044. <![CDATA[Where to store container logs.]]>
  17045. </doc>
  17046. </field>
  17047. <field name="DEFAULT_NM_LOG_DIRS" type="java.lang.String"
  17048. transient="false" volatile="false"
  17049. static="true" final="true" visibility="public"
  17050. deprecated="not deprecated">
  17051. </field>
  17052. <field name="NM_LOG_AGGREGATION_THREAD_POOL_SIZE" type="java.lang.String"
  17053. transient="false" volatile="false"
  17054. static="true" final="true" visibility="public"
  17055. deprecated="not deprecated">
  17056. <doc>
  17057. <![CDATA[The number of threads to handle log aggregation in node manager.]]>
  17058. </doc>
  17059. </field>
  17060. <field name="DEFAULT_NM_LOG_AGGREGATION_THREAD_POOL_SIZE" type="int"
  17061. transient="false" volatile="false"
  17062. static="true" final="true" visibility="public"
  17063. deprecated="not deprecated">
  17064. </field>
  17065. <field name="NM_DEFAULT_CONTAINER_EXECUTOR_PREFIX" type="java.lang.String"
  17066. transient="false" volatile="false"
  17067. static="true" final="true" visibility="public"
  17068. deprecated="not deprecated">
  17069. <doc>
  17070. <![CDATA[Default permissions for container logs.]]>
  17071. </doc>
  17072. </field>
  17073. <field name="NM_DEFAULT_CONTAINER_EXECUTOR_LOG_DIRS_PERMISSIONS" type="java.lang.String"
  17074. transient="false" volatile="false"
  17075. static="true" final="true" visibility="public"
  17076. deprecated="not deprecated">
  17077. </field>
  17078. <field name="NM_DEFAULT_CONTAINER_EXECUTOR_LOG_DIRS_PERMISSIONS_DEFAULT" type="java.lang.String"
  17079. transient="false" volatile="false"
  17080. static="true" final="true" visibility="public"
  17081. deprecated="not deprecated">
  17082. </field>
  17083. <field name="NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  17084. transient="false" volatile="false"
  17085. static="true" final="true" visibility="public"
  17086. deprecated="not deprecated">
  17087. </field>
  17088. <field name="DEFAULT_NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  17089. transient="false" volatile="false"
  17090. static="true" final="true" visibility="public"
  17091. deprecated="not deprecated">
  17092. </field>
  17093. <field name="DISK_VALIDATOR" type="java.lang.String"
  17094. transient="false" volatile="false"
  17095. static="true" final="true" visibility="public"
  17096. deprecated="not deprecated">
  17097. <doc>
  17098. <![CDATA[Disk Validator.]]>
  17099. </doc>
  17100. </field>
  17101. <field name="DEFAULT_DISK_VALIDATOR" type="java.lang.String"
  17102. transient="false" volatile="false"
  17103. static="true" final="true" visibility="public"
  17104. deprecated="not deprecated">
  17105. </field>
  17106. <field name="NM_CONTAINER_DIAGNOSTICS_MAXIMUM_SIZE" type="java.lang.String"
  17107. transient="false" volatile="false"
  17108. static="true" final="true" visibility="public"
  17109. deprecated="not deprecated">
  17110. <doc>
  17111. <![CDATA[Maximum size of contain's diagnostics to keep for relaunching container
  17112. case.]]>
  17113. </doc>
  17114. </field>
  17115. <field name="DEFAULT_NM_CONTAINER_DIAGNOSTICS_MAXIMUM_SIZE" type="int"
  17116. transient="false" volatile="false"
  17117. static="true" final="true" visibility="public"
  17118. deprecated="not deprecated">
  17119. </field>
  17120. <field name="NM_CONTAINER_RETRY_MINIMUM_INTERVAL_MS" type="java.lang.String"
  17121. transient="false" volatile="false"
  17122. static="true" final="true" visibility="public"
  17123. deprecated="not deprecated">
  17124. <doc>
  17125. <![CDATA[Minimum container restart interval.]]>
  17126. </doc>
  17127. </field>
  17128. <field name="DEFAULT_NM_CONTAINER_RETRY_MINIMUM_INTERVAL_MS" type="int"
  17129. transient="false" volatile="false"
  17130. static="true" final="true" visibility="public"
  17131. deprecated="not deprecated">
  17132. </field>
  17133. <field name="NM_CONTAINER_QUEUING_USE_PAUSE_FOR_PREEMPTION" type="java.lang.String"
  17134. transient="false" volatile="false"
  17135. static="true" final="true" visibility="public"
  17136. deprecated="not deprecated">
  17137. <doc>
  17138. <![CDATA[Use container pause as the preemption policy over kill in the container
  17139. queue at a NodeManager.]]>
  17140. </doc>
  17141. </field>
  17142. <field name="DEFAULT_NM_CONTAINER_QUEUING_USE_PAUSE_FOR_PREEMPTION" type="boolean"
  17143. transient="false" volatile="false"
  17144. static="true" final="true" visibility="public"
  17145. deprecated="not deprecated">
  17146. </field>
  17147. <field name="RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="java.lang.String"
  17148. transient="false" volatile="false"
  17149. static="true" final="true" visibility="public"
  17150. deprecated="not deprecated">
  17151. <doc>
  17152. <![CDATA[Interval at which the delayed token removal thread runs]]>
  17153. </doc>
  17154. </field>
  17155. <field name="DEFAULT_RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="long"
  17156. transient="false" volatile="false"
  17157. static="true" final="true" visibility="public"
  17158. deprecated="not deprecated">
  17159. </field>
  17160. <field name="RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="java.lang.String"
  17161. transient="false" volatile="false"
  17162. static="true" final="true" visibility="public"
  17163. deprecated="not deprecated">
  17164. <doc>
  17165. <![CDATA[Delegation Token renewer thread count]]>
  17166. </doc>
  17167. </field>
  17168. <field name="DEFAULT_RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="int"
  17169. transient="false" volatile="false"
  17170. static="true" final="true" visibility="public"
  17171. deprecated="not deprecated">
  17172. </field>
  17173. <field name="RM_PROXY_USER_PRIVILEGES_ENABLED" type="java.lang.String"
  17174. transient="false" volatile="false"
  17175. static="true" final="true" visibility="public"
  17176. deprecated="not deprecated">
  17177. </field>
  17178. <field name="DEFAULT_RM_PROXY_USER_PRIVILEGES_ENABLED" type="boolean"
  17179. transient="false" volatile="false"
  17180. static="true" final="true" visibility="public"
  17181. deprecated="not deprecated">
  17182. </field>
  17183. <field name="RM_NODE_IP_CACHE_EXPIRY_INTERVAL_SECS" type="java.lang.String"
  17184. transient="false" volatile="false"
  17185. static="true" final="true" visibility="public"
  17186. deprecated="not deprecated">
  17187. <doc>
  17188. <![CDATA[The expiry interval for node IP caching. -1 disables the caching]]>
  17189. </doc>
  17190. </field>
  17191. <field name="DEFAULT_RM_NODE_IP_CACHE_EXPIRY_INTERVAL_SECS" type="int"
  17192. transient="false" volatile="false"
  17193. static="true" final="true" visibility="public"
  17194. deprecated="not deprecated">
  17195. </field>
  17196. <field name="RM_MAX_LOG_AGGREGATION_DIAGNOSTICS_IN_MEMORY" type="java.lang.String"
  17197. transient="false" volatile="false"
  17198. static="true" final="true" visibility="public"
  17199. deprecated="not deprecated">
  17200. <doc>
  17201. <![CDATA[How many diagnostics/failure messages can be saved in RM for
  17202. log aggregation. It also defines the number of diagnostics/failure
  17203. messages can be shown in log aggregation web ui.]]>
  17204. </doc>
  17205. </field>
  17206. <field name="DEFAULT_RM_MAX_LOG_AGGREGATION_DIAGNOSTICS_IN_MEMORY" type="int"
  17207. transient="false" volatile="false"
  17208. static="true" final="true" visibility="public"
  17209. deprecated="not deprecated">
  17210. </field>
  17211. <field name="LOG_AGGREGATION_ENABLED" type="java.lang.String"
  17212. transient="false" volatile="false"
  17213. static="true" final="true" visibility="public"
  17214. deprecated="not deprecated">
  17215. <doc>
  17216. <![CDATA[Whether to enable log aggregation]]>
  17217. </doc>
  17218. </field>
  17219. <field name="DEFAULT_LOG_AGGREGATION_ENABLED" type="boolean"
  17220. transient="false" volatile="false"
  17221. static="true" final="true" visibility="public"
  17222. deprecated="not deprecated">
  17223. </field>
  17224. <field name="LOG_AGGREGATION_FILE_FORMATS" type="java.lang.String"
  17225. transient="false" volatile="false"
  17226. static="true" final="true" visibility="public"
  17227. deprecated="not deprecated">
  17228. </field>
  17229. <field name="LOG_AGGREGATION_FILE_CONTROLLER_FMT" type="java.lang.String"
  17230. transient="false" volatile="false"
  17231. static="true" final="true" visibility="public"
  17232. deprecated="not deprecated">
  17233. </field>
  17234. <field name="LOG_AGGREGATION_REMOTE_APP_LOG_DIR_FMT" type="java.lang.String"
  17235. transient="false" volatile="false"
  17236. static="true" final="true" visibility="public"
  17237. deprecated="not deprecated">
  17238. </field>
  17239. <field name="LOG_AGGREGATION_REMOTE_APP_LOG_DIR_SUFFIX_FMT" type="java.lang.String"
  17240. transient="false" volatile="false"
  17241. static="true" final="true" visibility="public"
  17242. deprecated="not deprecated">
  17243. </field>
  17244. <field name="LOG_AGGREGATION_RETAIN_SECONDS" type="java.lang.String"
  17245. transient="false" volatile="false"
  17246. static="true" final="true" visibility="public"
  17247. deprecated="not deprecated">
  17248. <doc>
  17249. <![CDATA[How long to wait before deleting aggregated logs, -1 disables.
  17250. Be careful set this too small and you will spam the name node.]]>
  17251. </doc>
  17252. </field>
  17253. <field name="DEFAULT_LOG_AGGREGATION_RETAIN_SECONDS" type="long"
  17254. transient="false" volatile="false"
  17255. static="true" final="true" visibility="public"
  17256. deprecated="not deprecated">
  17257. </field>
  17258. <field name="LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="java.lang.String"
  17259. transient="false" volatile="false"
  17260. static="true" final="true" visibility="public"
  17261. deprecated="not deprecated">
  17262. <doc>
  17263. <![CDATA[How long to wait between aggregated log retention checks. If set to
  17264. a value {@literal <=} 0 then the value is computed as one-tenth of the
  17265. log retention setting. Be careful set this too small and you will spam
  17266. the name node.]]>
  17267. </doc>
  17268. </field>
  17269. <field name="DEFAULT_LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="long"
  17270. transient="false" volatile="false"
  17271. static="true" final="true" visibility="public"
  17272. deprecated="not deprecated">
  17273. </field>
  17274. <field name="LOG_AGGREGATION_STATUS_TIME_OUT_MS" type="java.lang.String"
  17275. transient="false" volatile="false"
  17276. static="true" final="true" visibility="public"
  17277. deprecated="not deprecated">
  17278. <doc>
  17279. <![CDATA[How long for ResourceManager to wait for NodeManager to report its
  17280. log aggregation status. If waiting time of which the log aggregation status
  17281. is reported from NodeManager exceeds the configured value, RM will report
  17282. log aggregation status for this NodeManager as TIME_OUT]]>
  17283. </doc>
  17284. </field>
  17285. <field name="DEFAULT_LOG_AGGREGATION_STATUS_TIME_OUT_MS" type="long"
  17286. transient="false" volatile="false"
  17287. static="true" final="true" visibility="public"
  17288. deprecated="not deprecated">
  17289. </field>
  17290. <field name="NM_LOG_RETAIN_SECONDS" type="java.lang.String"
  17291. transient="false" volatile="false"
  17292. static="true" final="true" visibility="public"
  17293. deprecated="not deprecated">
  17294. <doc>
  17295. <![CDATA[Number of seconds to retain logs on the NodeManager. Only applicable if Log
  17296. aggregation is disabled]]>
  17297. </doc>
  17298. </field>
  17299. <field name="DEFAULT_NM_LOG_RETAIN_SECONDS" type="long"
  17300. transient="false" volatile="false"
  17301. static="true" final="true" visibility="public"
  17302. deprecated="not deprecated">
  17303. </field>
  17304. <field name="NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="java.lang.String"
  17305. transient="false" volatile="false"
  17306. static="true" final="true" visibility="public"
  17307. deprecated="not deprecated">
  17308. <doc>
  17309. <![CDATA[Define how often NMs wake up and upload log files]]>
  17310. </doc>
  17311. </field>
  17312. <field name="DEFAULT_NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="long"
  17313. transient="false" volatile="false"
  17314. static="true" final="true" visibility="public"
  17315. deprecated="not deprecated">
  17316. </field>
  17317. <field name="NM_LOG_DELETION_THREADS_COUNT" type="java.lang.String"
  17318. transient="false" volatile="false"
  17319. static="true" final="true" visibility="public"
  17320. deprecated="not deprecated">
  17321. <doc>
  17322. <![CDATA[Number of threads used in log cleanup. Only applicable if Log aggregation
  17323. is disabled]]>
  17324. </doc>
  17325. </field>
  17326. <field name="DEFAULT_NM_LOG_DELETE_THREAD_COUNT" type="int"
  17327. transient="false" volatile="false"
  17328. static="true" final="true" visibility="public"
  17329. deprecated="not deprecated">
  17330. </field>
  17331. <field name="NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
  17332. transient="false" volatile="false"
  17333. static="true" final="true" visibility="public"
  17334. deprecated="not deprecated">
  17335. <doc>
  17336. <![CDATA[Where to aggregate logs to.]]>
  17337. </doc>
  17338. </field>
  17339. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
  17340. transient="false" volatile="false"
  17341. static="true" final="true" visibility="public"
  17342. deprecated="not deprecated">
  17343. </field>
  17344. <field name="NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
  17345. transient="false" volatile="false"
  17346. static="true" final="true" visibility="public"
  17347. deprecated="not deprecated">
  17348. <doc>
  17349. <![CDATA[The remote log dir will be created at
  17350. NM_REMOTE_APP_LOG_DIR/${user}/NM_REMOTE_APP_LOG_DIR_SUFFIX/${appId}]]>
  17351. </doc>
  17352. </field>
  17353. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
  17354. transient="false" volatile="false"
  17355. static="true" final="true" visibility="public"
  17356. deprecated="not deprecated">
  17357. </field>
  17358. <field name="YARN_LOG_SERVER_URL" type="java.lang.String"
  17359. transient="false" volatile="false"
  17360. static="true" final="true" visibility="public"
  17361. deprecated="not deprecated">
  17362. </field>
  17363. <field name="YARN_LOG_SERVER_WEBSERVICE_URL" type="java.lang.String"
  17364. transient="false" volatile="false"
  17365. static="true" final="true" visibility="public"
  17366. deprecated="not deprecated">
  17367. </field>
  17368. <field name="YARN_TRACKING_URL_GENERATOR" type="java.lang.String"
  17369. transient="false" volatile="false"
  17370. static="true" final="true" visibility="public"
  17371. deprecated="not deprecated">
  17372. </field>
  17373. <field name="NM_PMEM_MB" type="java.lang.String"
  17374. transient="false" volatile="false"
  17375. static="true" final="true" visibility="public"
  17376. deprecated="not deprecated">
  17377. <doc>
  17378. <![CDATA[Amount of memory in MB that can be allocated for containers.]]>
  17379. </doc>
  17380. </field>
  17381. <field name="DEFAULT_NM_PMEM_MB" type="int"
  17382. transient="false" volatile="false"
  17383. static="true" final="true" visibility="public"
  17384. deprecated="not deprecated">
  17385. </field>
  17386. <field name="NM_SYSTEM_RESERVED_PMEM_MB" type="java.lang.String"
  17387. transient="false" volatile="false"
  17388. static="true" final="true" visibility="public"
  17389. deprecated="not deprecated">
  17390. <doc>
  17391. <![CDATA[Amount of memory in MB that has been reserved for non-yarn use.]]>
  17392. </doc>
  17393. </field>
  17394. <field name="NM_PMEM_CHECK_ENABLED" type="java.lang.String"
  17395. transient="false" volatile="false"
  17396. static="true" final="true" visibility="public"
  17397. deprecated="not deprecated">
  17398. <doc>
  17399. <![CDATA[Specifies whether physical memory check is enabled.]]>
  17400. </doc>
  17401. </field>
  17402. <field name="DEFAULT_NM_PMEM_CHECK_ENABLED" type="boolean"
  17403. transient="false" volatile="false"
  17404. static="true" final="true" visibility="public"
  17405. deprecated="not deprecated">
  17406. </field>
  17407. <field name="NM_VMEM_CHECK_ENABLED" type="java.lang.String"
  17408. transient="false" volatile="false"
  17409. static="true" final="true" visibility="public"
  17410. deprecated="not deprecated">
  17411. <doc>
  17412. <![CDATA[Specifies whether physical memory check is enabled.]]>
  17413. </doc>
  17414. </field>
  17415. <field name="DEFAULT_NM_VMEM_CHECK_ENABLED" type="boolean"
  17416. transient="false" volatile="false"
  17417. static="true" final="true" visibility="public"
  17418. deprecated="not deprecated">
  17419. </field>
  17420. <field name="NM_VMEM_PMEM_RATIO" type="java.lang.String"
  17421. transient="false" volatile="false"
  17422. static="true" final="true" visibility="public"
  17423. deprecated="not deprecated">
  17424. <doc>
  17425. <![CDATA[Conversion ratio for physical memory to virtual memory.]]>
  17426. </doc>
  17427. </field>
  17428. <field name="DEFAULT_NM_VMEM_PMEM_RATIO" type="float"
  17429. transient="false" volatile="false"
  17430. static="true" final="true" visibility="public"
  17431. deprecated="not deprecated">
  17432. </field>
  17433. <field name="NM_VCORES" type="java.lang.String"
  17434. transient="false" volatile="false"
  17435. static="true" final="true" visibility="public"
  17436. deprecated="not deprecated">
  17437. <doc>
  17438. <![CDATA[Number of Virtual CPU Cores which can be allocated for containers.]]>
  17439. </doc>
  17440. </field>
  17441. <field name="DEFAULT_NM_VCORES" type="int"
  17442. transient="false" volatile="false"
  17443. static="true" final="true" visibility="public"
  17444. deprecated="not deprecated">
  17445. </field>
  17446. <field name="NM_COUNT_LOGICAL_PROCESSORS_AS_CORES" type="java.lang.String"
  17447. transient="false" volatile="false"
  17448. static="true" final="true" visibility="public"
  17449. deprecated="not deprecated">
  17450. <doc>
  17451. <![CDATA[Count logical processors(like hyperthreads) as cores.]]>
  17452. </doc>
  17453. </field>
  17454. <field name="DEFAULT_NM_COUNT_LOGICAL_PROCESSORS_AS_CORES" type="boolean"
  17455. transient="false" volatile="false"
  17456. static="true" final="true" visibility="public"
  17457. deprecated="not deprecated">
  17458. </field>
  17459. <field name="NM_PCORES_VCORES_MULTIPLIER" type="java.lang.String"
  17460. transient="false" volatile="false"
  17461. static="true" final="true" visibility="public"
  17462. deprecated="not deprecated">
  17463. <doc>
  17464. <![CDATA[Multiplier to convert physical cores to vcores.]]>
  17465. </doc>
  17466. </field>
  17467. <field name="DEFAULT_NM_PCORES_VCORES_MULTIPLIER" type="float"
  17468. transient="false" volatile="false"
  17469. static="true" final="true" visibility="public"
  17470. deprecated="not deprecated">
  17471. </field>
  17472. <field name="NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="java.lang.String"
  17473. transient="false" volatile="false"
  17474. static="true" final="true" visibility="public"
  17475. deprecated="not deprecated">
  17476. <doc>
  17477. <![CDATA[Percentage of overall CPU which can be allocated for containers.]]>
  17478. </doc>
  17479. </field>
  17480. <field name="DEFAULT_NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="int"
  17481. transient="false" volatile="false"
  17482. static="true" final="true" visibility="public"
  17483. deprecated="not deprecated">
  17484. </field>
  17485. <field name="NM_ENABLE_HARDWARE_CAPABILITY_DETECTION" type="java.lang.String"
  17486. transient="false" volatile="false"
  17487. static="true" final="true" visibility="public"
  17488. deprecated="not deprecated">
  17489. <doc>
  17490. <![CDATA[Enable or disable node hardware capability detection.]]>
  17491. </doc>
  17492. </field>
  17493. <field name="DEFAULT_NM_ENABLE_HARDWARE_CAPABILITY_DETECTION" type="boolean"
  17494. transient="false" volatile="false"
  17495. static="true" final="true" visibility="public"
  17496. deprecated="not deprecated">
  17497. </field>
  17498. <field name="NM_MEMORY_RESOURCE_PREFIX" type="java.lang.String"
  17499. transient="false" volatile="false"
  17500. static="true" final="true" visibility="public"
  17501. deprecated="not deprecated">
  17502. </field>
  17503. <field name="NM_MEMORY_RESOURCE_ENABLED" type="java.lang.String"
  17504. transient="false" volatile="false"
  17505. static="true" final="true" visibility="public"
  17506. deprecated="not deprecated">
  17507. </field>
  17508. <field name="DEFAULT_NM_MEMORY_RESOURCE_ENABLED" type="boolean"
  17509. transient="false" volatile="false"
  17510. static="true" final="true" visibility="public"
  17511. deprecated="not deprecated">
  17512. </field>
  17513. <field name="NM_MEMORY_RESOURCE_CGROUPS_SWAPPINESS" type="java.lang.String"
  17514. transient="false" volatile="false"
  17515. static="true" final="true" visibility="public"
  17516. deprecated="not deprecated">
  17517. </field>
  17518. <field name="DEFAULT_NM_MEMORY_RESOURCE_CGROUPS_SWAPPINESS" type="int"
  17519. transient="false" volatile="false"
  17520. static="true" final="true" visibility="public"
  17521. deprecated="not deprecated">
  17522. </field>
  17523. <field name="NM_MEMORY_RESOURCE_CGROUPS_SOFT_LIMIT_PERCENTAGE" type="java.lang.String"
  17524. transient="false" volatile="false"
  17525. static="true" final="true" visibility="public"
  17526. deprecated="not deprecated">
  17527. </field>
  17528. <field name="DEFAULT_NM_MEMORY_RESOURCE_CGROUPS_SOFT_LIMIT_PERCENTAGE" type="float"
  17529. transient="false" volatile="false"
  17530. static="true" final="true" visibility="public"
  17531. deprecated="not deprecated">
  17532. </field>
  17533. <field name="NM_CPU_RESOURCE_PREFIX" type="java.lang.String"
  17534. transient="false" volatile="false"
  17535. static="true" final="true" visibility="public"
  17536. deprecated="not deprecated">
  17537. </field>
  17538. <field name="NM_CPU_RESOURCE_ENABLED" type="java.lang.String"
  17539. transient="false" volatile="false"
  17540. static="true" final="true" visibility="public"
  17541. deprecated="not deprecated">
  17542. <doc>
  17543. <![CDATA[Enable cpu isolation.]]>
  17544. </doc>
  17545. </field>
  17546. <field name="DEFAULT_NM_CPU_RESOURCE_ENABLED" type="boolean"
  17547. transient="false" volatile="false"
  17548. static="true" final="true" visibility="public"
  17549. deprecated="not deprecated">
  17550. </field>
  17551. <field name="NM_DISK_RESOURCE_PREFIX" type="java.lang.String"
  17552. transient="false" volatile="false"
  17553. static="true" final="true" visibility="public"
  17554. deprecated="not deprecated">
  17555. <doc>
  17556. <![CDATA[Prefix for disk configurations. Work in progress: This configuration
  17557. parameter may be changed/removed in the future.]]>
  17558. </doc>
  17559. </field>
  17560. <field name="NM_DISK_RESOURCE_ENABLED" type="java.lang.String"
  17561. transient="false" volatile="false"
  17562. static="true" final="true" visibility="public"
  17563. deprecated="not deprecated">
  17564. <doc>
  17565. <![CDATA[This setting controls if resource handling for disk operations is enabled.
  17566. Work in progress: This configuration parameter may be changed/removed in
  17567. the future]]>
  17568. </doc>
  17569. </field>
  17570. <field name="DEFAULT_NM_DISK_RESOURCE_ENABLED" type="boolean"
  17571. transient="false" volatile="false"
  17572. static="true" final="true" visibility="public"
  17573. deprecated="not deprecated">
  17574. <doc>
  17575. <![CDATA[Disk as a resource is disabled by default.]]>
  17576. </doc>
  17577. </field>
  17578. <field name="NM_NETWORK_RESOURCE_PREFIX" type="java.lang.String"
  17579. transient="false" volatile="false"
  17580. static="true" final="true" visibility="public"
  17581. deprecated="not deprecated">
  17582. </field>
  17583. <field name="NM_NETWORK_RESOURCE_ENABLED" type="java.lang.String"
  17584. transient="false" volatile="false"
  17585. static="true" final="true" visibility="public"
  17586. deprecated="not deprecated">
  17587. <doc>
  17588. <![CDATA[This setting controls if resource handling for network bandwidth is
  17589. enabled. Work in progress: This configuration parameter may be
  17590. changed/removed in the future]]>
  17591. </doc>
  17592. </field>
  17593. <field name="DEFAULT_NM_NETWORK_RESOURCE_ENABLED" type="boolean"
  17594. transient="false" volatile="false"
  17595. static="true" final="true" visibility="public"
  17596. deprecated="not deprecated">
  17597. <doc>
  17598. <![CDATA[Network as a resource is disabled by default.]]>
  17599. </doc>
  17600. </field>
  17601. <field name="NM_NETWORK_RESOURCE_INTERFACE" type="java.lang.String"
  17602. transient="false" volatile="false"
  17603. static="true" final="true" visibility="public"
  17604. deprecated="not deprecated">
  17605. <doc>
  17606. <![CDATA[Specifies the interface to be used for applying network throttling rules.
  17607. Work in progress: This configuration parameter may be changed/removed in
  17608. the future]]>
  17609. </doc>
  17610. </field>
  17611. <field name="DEFAULT_NM_NETWORK_RESOURCE_INTERFACE" type="java.lang.String"
  17612. transient="false" volatile="false"
  17613. static="true" final="true" visibility="public"
  17614. deprecated="not deprecated">
  17615. </field>
  17616. <field name="NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT" type="java.lang.String"
  17617. transient="false" volatile="false"
  17618. static="true" final="true" visibility="public"
  17619. deprecated="not deprecated">
  17620. <doc>
  17621. <![CDATA[Specifies the total available outbound bandwidth on the node. Work in
  17622. progress: This configuration parameter may be changed/removed in the future]]>
  17623. </doc>
  17624. </field>
  17625. <field name="DEFAULT_NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT" type="int"
  17626. transient="false" volatile="false"
  17627. static="true" final="true" visibility="public"
  17628. deprecated="not deprecated">
  17629. </field>
  17630. <field name="NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_YARN_MBIT" type="java.lang.String"
  17631. transient="false" volatile="false"
  17632. static="true" final="true" visibility="public"
  17633. deprecated="not deprecated">
  17634. <doc>
  17635. <![CDATA[Specifies the total outbound bandwidth available to YARN containers.
  17636. defaults to NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT if not specified.
  17637. Work in progress: This configuration parameter may be changed/removed in
  17638. the future]]>
  17639. </doc>
  17640. </field>
  17641. <field name="NM_RESOURCE_PLUGINS" type="java.lang.String"
  17642. transient="false" volatile="false"
  17643. static="true" final="true" visibility="public"
  17644. deprecated="not deprecated">
  17645. <doc>
  17646. <![CDATA[Prefix for computation resources, example of computation resources like
  17647. GPU / FPGA / TPU, etc.]]>
  17648. </doc>
  17649. </field>
  17650. <field name="NM_GPU_RESOURCE_PREFIX" type="java.lang.String"
  17651. transient="false" volatile="false"
  17652. static="true" final="true" visibility="public"
  17653. deprecated="not deprecated">
  17654. <doc>
  17655. <![CDATA[Prefix for gpu configurations. Work in progress: This configuration
  17656. parameter may be changed/removed in the future.]]>
  17657. </doc>
  17658. </field>
  17659. <field name="NM_GPU_ALLOWED_DEVICES" type="java.lang.String"
  17660. transient="false" volatile="false"
  17661. static="true" final="true" visibility="public"
  17662. deprecated="not deprecated">
  17663. </field>
  17664. <field name="AUTOMATICALLY_DISCOVER_GPU_DEVICES" type="java.lang.String"
  17665. transient="false" volatile="false"
  17666. static="true" final="true" visibility="public"
  17667. deprecated="not deprecated">
  17668. </field>
  17669. <field name="NM_GPU_PATH_TO_EXEC" type="java.lang.String"
  17670. transient="false" volatile="false"
  17671. static="true" final="true" visibility="public"
  17672. deprecated="not deprecated">
  17673. <doc>
  17674. <![CDATA[This setting controls where to how to invoke GPU binaries]]>
  17675. </doc>
  17676. </field>
  17677. <field name="DEFAULT_NM_GPU_PATH_TO_EXEC" type="java.lang.String"
  17678. transient="false" volatile="false"
  17679. static="true" final="true" visibility="public"
  17680. deprecated="not deprecated">
  17681. </field>
  17682. <field name="NM_WEBAPP_ADDRESS" type="java.lang.String"
  17683. transient="false" volatile="false"
  17684. static="true" final="true" visibility="public"
  17685. deprecated="not deprecated">
  17686. <doc>
  17687. <![CDATA[NM Webapp address.]]>
  17688. </doc>
  17689. </field>
  17690. <field name="DEFAULT_NM_WEBAPP_PORT" type="int"
  17691. transient="false" volatile="false"
  17692. static="true" final="true" visibility="public"
  17693. deprecated="not deprecated">
  17694. </field>
  17695. <field name="DEFAULT_NM_WEBAPP_ADDRESS" type="java.lang.String"
  17696. transient="false" volatile="false"
  17697. static="true" final="true" visibility="public"
  17698. deprecated="not deprecated">
  17699. </field>
  17700. <field name="NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  17701. transient="false" volatile="false"
  17702. static="true" final="true" visibility="public"
  17703. deprecated="not deprecated">
  17704. <doc>
  17705. <![CDATA[NM Webapp https address.]]>
  17706. </doc>
  17707. </field>
  17708. <field name="DEFAULT_NM_WEBAPP_HTTPS_PORT" type="int"
  17709. transient="false" volatile="false"
  17710. static="true" final="true" visibility="public"
  17711. deprecated="not deprecated">
  17712. </field>
  17713. <field name="DEFAULT_NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  17714. transient="false" volatile="false"
  17715. static="true" final="true" visibility="public"
  17716. deprecated="not deprecated">
  17717. </field>
  17718. <field name="NM_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
  17719. transient="false" volatile="false"
  17720. static="true" final="true" visibility="public"
  17721. deprecated="not deprecated">
  17722. <doc>
  17723. <![CDATA[Enable/disable CORS filter.]]>
  17724. </doc>
  17725. </field>
  17726. <field name="DEFAULT_NM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
  17727. transient="false" volatile="false"
  17728. static="true" final="true" visibility="public"
  17729. deprecated="not deprecated">
  17730. </field>
  17731. <field name="NM_RESOURCE_MON_INTERVAL_MS" type="java.lang.String"
  17732. transient="false" volatile="false"
  17733. static="true" final="true" visibility="public"
  17734. deprecated="not deprecated">
  17735. <doc>
  17736. <![CDATA[How often to monitor resource in a node.]]>
  17737. </doc>
  17738. </field>
  17739. <field name="DEFAULT_NM_RESOURCE_MON_INTERVAL_MS" type="int"
  17740. transient="false" volatile="false"
  17741. static="true" final="true" visibility="public"
  17742. deprecated="not deprecated">
  17743. </field>
  17744. <field name="NM_CONTAINER_MONITOR_ENABLED" type="java.lang.String"
  17745. transient="false" volatile="false"
  17746. static="true" final="true" visibility="public"
  17747. deprecated="not deprecated">
  17748. </field>
  17749. <field name="DEFAULT_NM_CONTAINER_MONITOR_ENABLED" type="boolean"
  17750. transient="false" volatile="false"
  17751. static="true" final="true" visibility="public"
  17752. deprecated="not deprecated">
  17753. </field>
  17754. <field name="NM_CONTAINER_MON_INTERVAL_MS" type="java.lang.String"
  17755. transient="false" volatile="false"
  17756. static="true" final="true" visibility="public"
  17757. deprecated="not deprecated">
  17758. <doc>
  17759. <![CDATA[How often to monitor containers.]]>
  17760. </doc>
  17761. </field>
  17762. <field name="DEFAULT_NM_CONTAINER_MON_INTERVAL_MS" type="int"
  17763. transient="false" volatile="false"
  17764. static="true" final="true" visibility="public"
  17765. deprecated="not deprecated">
  17766. </field>
  17767. <field name="NM_MON_RESOURCE_CALCULATOR" type="java.lang.String"
  17768. transient="false" volatile="false"
  17769. static="true" final="true" visibility="public"
  17770. deprecated="not deprecated">
  17771. <doc>
  17772. <![CDATA[Class that calculates current resource utilization.]]>
  17773. </doc>
  17774. </field>
  17775. <field name="NM_CONTAINER_MON_RESOURCE_CALCULATOR" type="java.lang.String"
  17776. transient="false" volatile="false"
  17777. static="true" final="true" visibility="public"
  17778. deprecated="not deprecated">
  17779. <doc>
  17780. <![CDATA[Class that calculates containers current resource utilization.]]>
  17781. </doc>
  17782. </field>
  17783. <field name="NM_CONTAINER_MON_PROCESS_TREE" type="java.lang.String"
  17784. transient="false" volatile="false"
  17785. static="true" final="true" visibility="public"
  17786. deprecated="not deprecated">
  17787. <doc>
  17788. <![CDATA[Class that calculates process tree resource utilization.]]>
  17789. </doc>
  17790. </field>
  17791. <field name="PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="java.lang.String"
  17792. transient="false" volatile="false"
  17793. static="true" final="true" visibility="public"
  17794. deprecated="not deprecated">
  17795. </field>
  17796. <field name="DEFAULT_PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="boolean"
  17797. transient="false" volatile="false"
  17798. static="true" final="true" visibility="public"
  17799. deprecated="not deprecated">
  17800. </field>
  17801. <field name="NM_CONTAINER_METRICS_ENABLE" type="java.lang.String"
  17802. transient="false" volatile="false"
  17803. static="true" final="true" visibility="public"
  17804. deprecated="not deprecated">
  17805. <doc>
  17806. <![CDATA[Enable/disable container metrics.]]>
  17807. </doc>
  17808. </field>
  17809. <field name="DEFAULT_NM_CONTAINER_METRICS_ENABLE" type="boolean"
  17810. transient="false" volatile="false"
  17811. static="true" final="true" visibility="public"
  17812. deprecated="not deprecated">
  17813. </field>
  17814. <field name="NM_CONTAINER_METRICS_PERIOD_MS" type="java.lang.String"
  17815. transient="false" volatile="false"
  17816. static="true" final="true" visibility="public"
  17817. deprecated="not deprecated">
  17818. <doc>
  17819. <![CDATA[Container metrics flush period. -1 for flush on completion.]]>
  17820. </doc>
  17821. </field>
  17822. <field name="DEFAULT_NM_CONTAINER_METRICS_PERIOD_MS" type="int"
  17823. transient="false" volatile="false"
  17824. static="true" final="true" visibility="public"
  17825. deprecated="not deprecated">
  17826. </field>
  17827. <field name="NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="java.lang.String"
  17828. transient="false" volatile="false"
  17829. static="true" final="true" visibility="public"
  17830. deprecated="not deprecated">
  17831. <doc>
  17832. <![CDATA[The delay time ms to unregister container metrics after completion.]]>
  17833. </doc>
  17834. </field>
  17835. <field name="DEFAULT_NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="int"
  17836. transient="false" volatile="false"
  17837. static="true" final="true" visibility="public"
  17838. deprecated="not deprecated">
  17839. </field>
  17840. <field name="NM_DISK_HEALTH_CHECK_ENABLE" type="java.lang.String"
  17841. transient="false" volatile="false"
  17842. static="true" final="true" visibility="public"
  17843. deprecated="not deprecated">
  17844. <doc>
  17845. <![CDATA[Enable/Disable disks' health checker. Default is true. An expert level
  17846. configuration property.]]>
  17847. </doc>
  17848. </field>
  17849. <field name="NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
  17850. transient="false" volatile="false"
  17851. static="true" final="true" visibility="public"
  17852. deprecated="not deprecated">
  17853. <doc>
  17854. <![CDATA[Frequency of running disks' health checker.]]>
  17855. </doc>
  17856. </field>
  17857. <field name="DEFAULT_NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="long"
  17858. transient="false" volatile="false"
  17859. static="true" final="true" visibility="public"
  17860. deprecated="not deprecated">
  17861. <doc>
  17862. <![CDATA[By default, disks' health is checked every 2 minutes.]]>
  17863. </doc>
  17864. </field>
  17865. <field name="NM_MIN_HEALTHY_DISKS_FRACTION" type="java.lang.String"
  17866. transient="false" volatile="false"
  17867. static="true" final="true" visibility="public"
  17868. deprecated="not deprecated">
  17869. <doc>
  17870. <![CDATA[The minimum fraction of number of disks to be healthy for the nodemanager
  17871. to launch new containers. This applies to nm-local-dirs and nm-log-dirs.]]>
  17872. </doc>
  17873. </field>
  17874. <field name="DEFAULT_NM_MIN_HEALTHY_DISKS_FRACTION" type="float"
  17875. transient="false" volatile="false"
  17876. static="true" final="true" visibility="public"
  17877. deprecated="not deprecated">
  17878. <doc>
  17879. <![CDATA[By default, at least 25% of disks are to be healthy to say that the node is
  17880. healthy in terms of disks.]]>
  17881. </doc>
  17882. </field>
  17883. <field name="NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="java.lang.String"
  17884. transient="false" volatile="false"
  17885. static="true" final="true" visibility="public"
  17886. deprecated="not deprecated">
  17887. <doc>
  17888. <![CDATA[The maximum percentage of disk space that can be used after which a disk is
  17889. marked as offline. Values can range from 0.0 to 100.0. If the value is
  17890. greater than or equal to 100, NM will check for full disk. This applies to
  17891. nm-local-dirs and nm-log-dirs.]]>
  17892. </doc>
  17893. </field>
  17894. <field name="DEFAULT_NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="float"
  17895. transient="false" volatile="false"
  17896. static="true" final="true" visibility="public"
  17897. deprecated="not deprecated">
  17898. <doc>
  17899. <![CDATA[By default, 90% of the disk can be used before it is marked as offline.]]>
  17900. </doc>
  17901. </field>
  17902. <field name="NM_WM_LOW_PER_DISK_UTILIZATION_PERCENTAGE" type="java.lang.String"
  17903. transient="false" volatile="false"
  17904. static="true" final="true" visibility="public"
  17905. deprecated="not deprecated">
  17906. <doc>
  17907. <![CDATA[The low threshold percentage of disk space used when an offline disk is
  17908. marked as online. Values can range from 0.0 to 100.0. The value shouldn't
  17909. be more than NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE. If its value is
  17910. more than NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE or not set, it will be
  17911. set to the same value as NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE.
  17912. This applies to nm-local-dirs and nm-log-dirs.]]>
  17913. </doc>
  17914. </field>
  17915. <field name="NM_MIN_PER_DISK_FREE_SPACE_MB" type="java.lang.String"
  17916. transient="false" volatile="false"
  17917. static="true" final="true" visibility="public"
  17918. deprecated="not deprecated">
  17919. <doc>
  17920. <![CDATA[The minimum space that must be available on a local dir for it to be used.
  17921. This applies to nm-local-dirs and nm-log-dirs.]]>
  17922. </doc>
  17923. </field>
  17924. <field name="DEFAULT_NM_MIN_PER_DISK_FREE_SPACE_MB" type="long"
  17925. transient="false" volatile="false"
  17926. static="true" final="true" visibility="public"
  17927. deprecated="not deprecated">
  17928. <doc>
  17929. <![CDATA[By default, all of the disk can be used before it is marked as offline.]]>
  17930. </doc>
  17931. </field>
  17932. <field name="NM_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
  17933. transient="false" volatile="false"
  17934. static="true" final="true" visibility="public"
  17935. deprecated="not deprecated">
  17936. <doc>
  17937. <![CDATA[Frequency of running node health script.]]>
  17938. </doc>
  17939. </field>
  17940. <field name="DEFAULT_NM_HEALTH_CHECK_INTERVAL_MS" type="long"
  17941. transient="false" volatile="false"
  17942. static="true" final="true" visibility="public"
  17943. deprecated="not deprecated">
  17944. </field>
  17945. <field name="NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="java.lang.String"
  17946. transient="false" volatile="false"
  17947. static="true" final="true" visibility="public"
  17948. deprecated="not deprecated">
  17949. <doc>
  17950. <![CDATA[Health check script time out period.]]>
  17951. </doc>
  17952. </field>
  17953. <field name="DEFAULT_NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="long"
  17954. transient="false" volatile="false"
  17955. static="true" final="true" visibility="public"
  17956. deprecated="not deprecated">
  17957. </field>
  17958. <field name="NM_HEALTH_CHECK_SCRIPT_PATH" type="java.lang.String"
  17959. transient="false" volatile="false"
  17960. static="true" final="true" visibility="public"
  17961. deprecated="not deprecated">
  17962. <doc>
  17963. <![CDATA[The health check script to run.]]>
  17964. </doc>
  17965. </field>
  17966. <field name="NM_HEALTH_CHECK_SCRIPT_OPTS" type="java.lang.String"
  17967. transient="false" volatile="false"
  17968. static="true" final="true" visibility="public"
  17969. deprecated="not deprecated">
  17970. <doc>
  17971. <![CDATA[The arguments to pass to the health check script.]]>
  17972. </doc>
  17973. </field>
  17974. <field name="NM_CONTAINER_LOCALIZER_JAVA_OPTS_KEY" type="java.lang.String"
  17975. transient="false" volatile="false"
  17976. static="true" final="true" visibility="public"
  17977. deprecated="not deprecated">
  17978. <doc>
  17979. <![CDATA[The JVM options used on forking ContainerLocalizer process
  17980. by container executor.]]>
  17981. </doc>
  17982. </field>
  17983. <field name="NM_CONTAINER_LOCALIZER_JAVA_OPTS_DEFAULT" type="java.lang.String"
  17984. transient="false" volatile="false"
  17985. static="true" final="true" visibility="public"
  17986. deprecated="not deprecated">
  17987. </field>
  17988. <field name="NM_CONTAINER_LOCALIZER_LOG_LEVEL" type="java.lang.String"
  17989. transient="false" volatile="false"
  17990. static="true" final="true" visibility="public"
  17991. deprecated="not deprecated">
  17992. <doc>
  17993. <![CDATA[The log level of container localizer process.]]>
  17994. </doc>
  17995. </field>
  17996. <field name="NM_CONTAINER_LOCALIZER_LOG_LEVEL_DEFAULT" type="java.lang.String"
  17997. transient="false" volatile="false"
  17998. static="true" final="true" visibility="public"
  17999. deprecated="not deprecated">
  18000. </field>
  18001. <field name="NM_DOCKER_CONTAINER_EXECUTOR_IMAGE_NAME" type="java.lang.String"
  18002. transient="false" volatile="false"
  18003. static="true" final="true" visibility="public"
  18004. deprecated="not deprecated">
  18005. <doc>
  18006. <![CDATA[The Docker image name(For DockerContainerExecutor).]]>
  18007. </doc>
  18008. </field>
  18009. <field name="NM_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME" type="java.lang.String"
  18010. transient="false" volatile="false"
  18011. static="true" final="true" visibility="public"
  18012. deprecated="not deprecated">
  18013. <doc>
  18014. <![CDATA[The name of the docker executor (For DockerContainerExecutor).]]>
  18015. </doc>
  18016. </field>
  18017. <field name="NM_DEFAULT_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME" type="java.lang.String"
  18018. transient="false" volatile="false"
  18019. static="true" final="true" visibility="public"
  18020. deprecated="not deprecated">
  18021. <doc>
  18022. <![CDATA[The default docker executor (For DockerContainerExecutor).]]>
  18023. </doc>
  18024. </field>
  18025. <field name="LINUX_CONTAINER_RUNTIME_PREFIX" type="java.lang.String"
  18026. transient="false" volatile="false"
  18027. static="true" final="true" visibility="public"
  18028. deprecated="not deprecated">
  18029. <doc>
  18030. <![CDATA[Prefix for runtime configuration constants.]]>
  18031. </doc>
  18032. </field>
  18033. <field name="LINUX_CONTAINER_RUNTIME_ALLOWED_RUNTIMES" type="java.lang.String"
  18034. transient="false" volatile="false"
  18035. static="true" final="true" visibility="public"
  18036. deprecated="not deprecated">
  18037. <doc>
  18038. <![CDATA[Comma separated list of runtimes that are allowed when using
  18039. LinuxContainerExecutor. The allowed values are:
  18040. <ul>
  18041. <li>default</li>
  18042. <li>docker</li>
  18043. </ul>]]>
  18044. </doc>
  18045. </field>
  18046. <field name="DEFAULT_LINUX_CONTAINER_RUNTIME_ALLOWED_RUNTIMES" type="java.lang.String[]"
  18047. transient="false" volatile="false"
  18048. static="true" final="true" visibility="public"
  18049. deprecated="not deprecated">
  18050. <doc>
  18051. <![CDATA[The default list of allowed runtimes when using LinuxContainerExecutor.]]>
  18052. </doc>
  18053. </field>
  18054. <field name="DOCKER_CONTAINER_RUNTIME_PREFIX" type="java.lang.String"
  18055. transient="false" volatile="false"
  18056. static="true" final="true" visibility="public"
  18057. deprecated="not deprecated">
  18058. </field>
  18059. <field name="NM_DOCKER_CONTAINER_CAPABILITIES" type="java.lang.String"
  18060. transient="false" volatile="false"
  18061. static="true" final="true" visibility="public"
  18062. deprecated="not deprecated">
  18063. <doc>
  18064. <![CDATA[Capabilities allowed (and added by default) for docker containers.]]>
  18065. </doc>
  18066. </field>
  18067. <field name="DEFAULT_NM_DOCKER_CONTAINER_CAPABILITIES" type="java.lang.String[]"
  18068. transient="false" volatile="false"
  18069. static="true" final="true" visibility="public"
  18070. deprecated="not deprecated">
  18071. <doc>
  18072. <![CDATA[These are the default capabilities added by docker. We'll use the same
  18073. set here. While these may not be case-sensitive from a docker
  18074. perspective, it is best to keep these uppercase.]]>
  18075. </doc>
  18076. </field>
  18077. <field name="NM_DOCKER_ALLOW_PRIVILEGED_CONTAINERS" type="java.lang.String"
  18078. transient="false" volatile="false"
  18079. static="true" final="true" visibility="public"
  18080. deprecated="not deprecated">
  18081. <doc>
  18082. <![CDATA[Allow privileged containers. Use with extreme care.]]>
  18083. </doc>
  18084. </field>
  18085. <field name="DEFAULT_NM_DOCKER_ALLOW_PRIVILEGED_CONTAINERS" type="boolean"
  18086. transient="false" volatile="false"
  18087. static="true" final="true" visibility="public"
  18088. deprecated="not deprecated">
  18089. <doc>
  18090. <![CDATA[Privileged containers are disabled by default.]]>
  18091. </doc>
  18092. </field>
  18093. <field name="NM_DOCKER_ENABLE_USER_REMAPPING" type="java.lang.String"
  18094. transient="false" volatile="false"
  18095. static="true" final="true" visibility="public"
  18096. deprecated="not deprecated">
  18097. <doc>
  18098. <![CDATA[enable user remapping.]]>
  18099. </doc>
  18100. </field>
  18101. <field name="DEFAULT_NM_DOCKER_ENABLE_USER_REMAPPING" type="boolean"
  18102. transient="false" volatile="false"
  18103. static="true" final="true" visibility="public"
  18104. deprecated="not deprecated">
  18105. <doc>
  18106. <![CDATA[Set enable user remapping as false by default.]]>
  18107. </doc>
  18108. </field>
  18109. <field name="NM_DOCKER_USER_REMAPPING_UID_THRESHOLD" type="java.lang.String"
  18110. transient="false" volatile="false"
  18111. static="true" final="true" visibility="public"
  18112. deprecated="not deprecated">
  18113. <doc>
  18114. <![CDATA[lower limit for acceptable uids of user remapped user.]]>
  18115. </doc>
  18116. </field>
  18117. <field name="DEFAULT_NM_DOCKER_USER_REMAPPING_UID_THRESHOLD" type="int"
  18118. transient="false" volatile="false"
  18119. static="true" final="true" visibility="public"
  18120. deprecated="not deprecated">
  18121. <doc>
  18122. <![CDATA[Set user remapping lower uid limit to 1 by default.]]>
  18123. </doc>
  18124. </field>
  18125. <field name="NM_DOCKER_USER_REMAPPING_GID_THRESHOLD" type="java.lang.String"
  18126. transient="false" volatile="false"
  18127. static="true" final="true" visibility="public"
  18128. deprecated="not deprecated">
  18129. <doc>
  18130. <![CDATA[lower limit for acceptable gids of user remapped user.]]>
  18131. </doc>
  18132. </field>
  18133. <field name="DEFAULT_NM_DOCKER_USER_REMAPPING_GID_THRESHOLD" type="int"
  18134. transient="false" volatile="false"
  18135. static="true" final="true" visibility="public"
  18136. deprecated="not deprecated">
  18137. <doc>
  18138. <![CDATA[Set user remapping lower gid limit to 1 by default.]]>
  18139. </doc>
  18140. </field>
  18141. <field name="NM_DOCKER_PRIVILEGED_CONTAINERS_ACL" type="java.lang.String"
  18142. transient="false" volatile="false"
  18143. static="true" final="true" visibility="public"
  18144. deprecated="not deprecated">
  18145. <doc>
  18146. <![CDATA[ACL list for users allowed to run privileged containers.]]>
  18147. </doc>
  18148. </field>
  18149. <field name="DEFAULT_NM_DOCKER_PRIVILEGED_CONTAINERS_ACL" type="java.lang.String"
  18150. transient="false" volatile="false"
  18151. static="true" final="true" visibility="public"
  18152. deprecated="not deprecated">
  18153. <doc>
  18154. <![CDATA[Default list for users allowed to run privileged containers is empty.]]>
  18155. </doc>
  18156. </field>
  18157. <field name="NM_DOCKER_ALLOWED_CONTAINER_NETWORKS" type="java.lang.String"
  18158. transient="false" volatile="false"
  18159. static="true" final="true" visibility="public"
  18160. deprecated="not deprecated">
  18161. <doc>
  18162. <![CDATA[The set of networks allowed when launching containers using the
  18163. DockerContainerRuntime.]]>
  18164. </doc>
  18165. </field>
  18166. <field name="DEFAULT_NM_DOCKER_ALLOWED_CONTAINER_NETWORKS" type="java.lang.String[]"
  18167. transient="false" volatile="false"
  18168. static="true" final="true" visibility="public"
  18169. deprecated="not deprecated">
  18170. <doc>
  18171. <![CDATA[The set of networks allowed when launching containers using the
  18172. DockerContainerRuntime.]]>
  18173. </doc>
  18174. </field>
  18175. <field name="NM_DOCKER_DEFAULT_CONTAINER_NETWORK" type="java.lang.String"
  18176. transient="false" volatile="false"
  18177. static="true" final="true" visibility="public"
  18178. deprecated="not deprecated">
  18179. <doc>
  18180. <![CDATA[The network used when launching containers using the
  18181. DockerContainerRuntime when no network is specified in the request. This
  18182. network must be one of the (configurable) set of allowed container
  18183. networks.]]>
  18184. </doc>
  18185. </field>
  18186. <field name="DEFAULT_NM_DOCKER_DEFAULT_CONTAINER_NETWORK" type="java.lang.String"
  18187. transient="false" volatile="false"
  18188. static="true" final="true" visibility="public"
  18189. deprecated="not deprecated">
  18190. <doc>
  18191. <![CDATA[The network used when launching containers using the
  18192. DockerContainerRuntime when no network is specified in the request and
  18193. no default network is configured.
  18194. .]]>
  18195. </doc>
  18196. </field>
  18197. <field name="NM_LINUX_CONTAINER_EXECUTOR_PATH" type="java.lang.String"
  18198. transient="false" volatile="false"
  18199. static="true" final="true" visibility="public"
  18200. deprecated="not deprecated">
  18201. <doc>
  18202. <![CDATA[The path to the Linux container executor.]]>
  18203. </doc>
  18204. </field>
  18205. <field name="NM_LINUX_CONTAINER_GROUP" type="java.lang.String"
  18206. transient="false" volatile="false"
  18207. static="true" final="true" visibility="public"
  18208. deprecated="not deprecated">
  18209. <doc>
  18210. <![CDATA[The UNIX group that the linux-container-executor should run as.
  18211. This is intended to be set as part of container-executor.cfg.]]>
  18212. </doc>
  18213. </field>
  18214. <field name="NM_NONSECURE_MODE_LIMIT_USERS" type="java.lang.String"
  18215. transient="false" volatile="false"
  18216. static="true" final="true" visibility="public"
  18217. deprecated="not deprecated">
  18218. <doc>
  18219. <![CDATA[If linux-container-executor should limit itself to one user
  18220. when running in non-secure mode.]]>
  18221. </doc>
  18222. </field>
  18223. <field name="DEFAULT_NM_NONSECURE_MODE_LIMIT_USERS" type="boolean"
  18224. transient="false" volatile="false"
  18225. static="true" final="true" visibility="public"
  18226. deprecated="not deprecated">
  18227. </field>
  18228. <field name="NM_NONSECURE_MODE_LOCAL_USER_KEY" type="java.lang.String"
  18229. transient="false" volatile="false"
  18230. static="true" final="true" visibility="public"
  18231. deprecated="not deprecated">
  18232. <doc>
  18233. <![CDATA[The UNIX user that containers will run as when Linux-container-executor
  18234. is used in nonsecure mode (a use case for this is using cgroups).]]>
  18235. </doc>
  18236. </field>
  18237. <field name="DEFAULT_NM_NONSECURE_MODE_LOCAL_USER" type="java.lang.String"
  18238. transient="false" volatile="false"
  18239. static="true" final="true" visibility="public"
  18240. deprecated="not deprecated">
  18241. </field>
  18242. <field name="NM_NONSECURE_MODE_USER_PATTERN_KEY" type="java.lang.String"
  18243. transient="false" volatile="false"
  18244. static="true" final="true" visibility="public"
  18245. deprecated="not deprecated">
  18246. <doc>
  18247. <![CDATA[The allowed pattern for UNIX user names enforced by
  18248. Linux-container-executor when used in nonsecure mode (use case for this
  18249. is using cgroups). The default value is taken from /usr/sbin/adduser]]>
  18250. </doc>
  18251. </field>
  18252. <field name="DEFAULT_NM_NONSECURE_MODE_USER_PATTERN" type="java.lang.String"
  18253. transient="false" volatile="false"
  18254. static="true" final="true" visibility="public"
  18255. deprecated="not deprecated">
  18256. </field>
  18257. <field name="NM_LINUX_CONTAINER_RESOURCES_HANDLER" type="java.lang.String"
  18258. transient="false" volatile="false"
  18259. static="true" final="true" visibility="public"
  18260. deprecated="not deprecated">
  18261. <doc>
  18262. <![CDATA[The type of resource enforcement to use with the
  18263. linux container executor.]]>
  18264. </doc>
  18265. </field>
  18266. <field name="NM_LINUX_CONTAINER_CGROUPS_HIERARCHY" type="java.lang.String"
  18267. transient="false" volatile="false"
  18268. static="true" final="true" visibility="public"
  18269. deprecated="not deprecated">
  18270. <doc>
  18271. <![CDATA[The path the linux container executor should use for cgroups]]>
  18272. </doc>
  18273. </field>
  18274. <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT" type="java.lang.String"
  18275. transient="false" volatile="false"
  18276. static="true" final="true" visibility="public"
  18277. deprecated="not deprecated">
  18278. <doc>
  18279. <![CDATA[Whether the linux container executor should mount cgroups if not found]]>
  18280. </doc>
  18281. </field>
  18282. <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT_PATH" type="java.lang.String"
  18283. transient="false" volatile="false"
  18284. static="true" final="true" visibility="public"
  18285. deprecated="not deprecated">
  18286. <doc>
  18287. <![CDATA[Where the linux container executor should mount cgroups if not found]]>
  18288. </doc>
  18289. </field>
  18290. <field name="NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="java.lang.String"
  18291. transient="false" volatile="false"
  18292. static="true" final="true" visibility="public"
  18293. deprecated="not deprecated">
  18294. <doc>
  18295. <![CDATA[Whether the apps should run in strict resource usage mode(not allowed to
  18296. use spare CPU)]]>
  18297. </doc>
  18298. </field>
  18299. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="boolean"
  18300. transient="false" volatile="false"
  18301. static="true" final="true" visibility="public"
  18302. deprecated="not deprecated">
  18303. </field>
  18304. <field name="RM_APPLICATION_MONITOR_INTERVAL_MS" type="java.lang.String"
  18305. transient="false" volatile="false"
  18306. static="true" final="true" visibility="public"
  18307. deprecated="not deprecated">
  18308. </field>
  18309. <field name="DEFAULT_RM_APPLICATION_MONITOR_INTERVAL_MS" type="long"
  18310. transient="false" volatile="false"
  18311. static="true" final="true" visibility="public"
  18312. deprecated="not deprecated">
  18313. </field>
  18314. <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="java.lang.String"
  18315. transient="false" volatile="false"
  18316. static="true" final="true" visibility="public"
  18317. deprecated="not deprecated">
  18318. <doc>
  18319. <![CDATA[Interval of time the linux container executor should try cleaning up
  18320. cgroups entry when cleaning up a container. This is required due to what
  18321. it seems a race condition because the SIGTERM/SIGKILL is asynch.]]>
  18322. </doc>
  18323. </field>
  18324. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="long"
  18325. transient="false" volatile="false"
  18326. static="true" final="true" visibility="public"
  18327. deprecated="not deprecated">
  18328. </field>
  18329. <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="java.lang.String"
  18330. transient="false" volatile="false"
  18331. static="true" final="true" visibility="public"
  18332. deprecated="not deprecated">
  18333. <doc>
  18334. <![CDATA[Delay between attempts to remove linux cgroup.]]>
  18335. </doc>
  18336. </field>
  18337. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="long"
  18338. transient="false" volatile="false"
  18339. static="true" final="true" visibility="public"
  18340. deprecated="not deprecated">
  18341. </field>
  18342. <field name="NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="java.lang.String"
  18343. transient="false" volatile="false"
  18344. static="true" final="true" visibility="public"
  18345. deprecated="not deprecated">
  18346. <doc>
  18347. <![CDATA[Indicates if memory and CPU limits will be set for the Windows Job
  18348. Object for the containers launched by the default container executor.]]>
  18349. </doc>
  18350. </field>
  18351. <field name="DEFAULT_NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="boolean"
  18352. transient="false" volatile="false"
  18353. static="true" final="true" visibility="public"
  18354. deprecated="not deprecated">
  18355. </field>
  18356. <field name="NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="java.lang.String"
  18357. transient="false" volatile="false"
  18358. static="true" final="true" visibility="public"
  18359. deprecated="not deprecated">
  18360. </field>
  18361. <field name="DEFAULT_NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="boolean"
  18362. transient="false" volatile="false"
  18363. static="true" final="true" visibility="public"
  18364. deprecated="not deprecated">
  18365. </field>
  18366. <field name="NM_WINDOWS_SECURE_CONTAINER_GROUP" type="java.lang.String"
  18367. transient="false" volatile="false"
  18368. static="true" final="true" visibility="public"
  18369. deprecated="not deprecated">
  18370. <doc>
  18371. <![CDATA[/* The Windows group that the windows-secure-container-executor should run as.]]>
  18372. </doc>
  18373. </field>
  18374. <field name="NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
  18375. transient="false" volatile="false"
  18376. static="true" final="true" visibility="public"
  18377. deprecated="not deprecated">
  18378. <doc>
  18379. <![CDATA[T-file compression types used to compress aggregated logs.]]>
  18380. </doc>
  18381. </field>
  18382. <field name="DEFAULT_NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
  18383. transient="false" volatile="false"
  18384. static="true" final="true" visibility="public"
  18385. deprecated="not deprecated">
  18386. </field>
  18387. <field name="NM_PRINCIPAL" type="java.lang.String"
  18388. transient="false" volatile="false"
  18389. static="true" final="true" visibility="public"
  18390. deprecated="not deprecated">
  18391. <doc>
  18392. <![CDATA[The kerberos principal for the node manager.]]>
  18393. </doc>
  18394. </field>
  18395. <field name="NM_AUX_SERVICES" type="java.lang.String"
  18396. transient="false" volatile="false"
  18397. static="true" final="true" visibility="public"
  18398. deprecated="not deprecated">
  18399. </field>
  18400. <field name="NM_AUX_SERVICE_FMT" type="java.lang.String"
  18401. transient="false" volatile="false"
  18402. static="true" final="true" visibility="public"
  18403. deprecated="not deprecated">
  18404. </field>
  18405. <field name="NM_AUX_SERVICES_CLASSPATH" type="java.lang.String"
  18406. transient="false" volatile="false"
  18407. static="true" final="true" visibility="public"
  18408. deprecated="not deprecated">
  18409. </field>
  18410. <field name="NM_AUX_SERVICES_SYSTEM_CLASSES" type="java.lang.String"
  18411. transient="false" volatile="false"
  18412. static="true" final="true" visibility="public"
  18413. deprecated="not deprecated">
  18414. </field>
  18415. <field name="NM_USER_HOME_DIR" type="java.lang.String"
  18416. transient="false" volatile="false"
  18417. static="true" final="true" visibility="public"
  18418. deprecated="not deprecated">
  18419. </field>
  18420. <field name="NM_CONTAINER_STDERR_PATTERN" type="java.lang.String"
  18421. transient="false" volatile="false"
  18422. static="true" final="true" visibility="public"
  18423. deprecated="not deprecated">
  18424. </field>
  18425. <field name="DEFAULT_NM_CONTAINER_STDERR_PATTERN" type="java.lang.String"
  18426. transient="false" volatile="false"
  18427. static="true" final="true" visibility="public"
  18428. deprecated="not deprecated">
  18429. </field>
  18430. <field name="NM_CONTAINER_STDERR_BYTES" type="java.lang.String"
  18431. transient="false" volatile="false"
  18432. static="true" final="true" visibility="public"
  18433. deprecated="not deprecated">
  18434. </field>
  18435. <field name="DEFAULT_NM_CONTAINER_STDERR_BYTES" type="long"
  18436. transient="false" volatile="false"
  18437. static="true" final="true" visibility="public"
  18438. deprecated="not deprecated">
  18439. </field>
  18440. <field name="NM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
  18441. transient="false" volatile="false"
  18442. static="true" final="true" visibility="public"
  18443. deprecated="not deprecated">
  18444. <doc>
  18445. <![CDATA[The kerberos principal to be used for spnego filter for NM.]]>
  18446. </doc>
  18447. </field>
  18448. <field name="NM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
  18449. transient="false" volatile="false"
  18450. static="true" final="true" visibility="public"
  18451. deprecated="not deprecated">
  18452. <doc>
  18453. <![CDATA[The kerberos keytab to be used for spnego filter for NM.]]>
  18454. </doc>
  18455. </field>
  18456. <field name="DEFAULT_NM_USER_HOME_DIR" type="java.lang.String"
  18457. transient="false" volatile="false"
  18458. static="true" final="true" visibility="public"
  18459. deprecated="not deprecated">
  18460. </field>
  18461. <field name="NM_RECOVERY_PREFIX" type="java.lang.String"
  18462. transient="false" volatile="false"
  18463. static="true" final="true" visibility="public"
  18464. deprecated="not deprecated">
  18465. </field>
  18466. <field name="NM_RECOVERY_ENABLED" type="java.lang.String"
  18467. transient="false" volatile="false"
  18468. static="true" final="true" visibility="public"
  18469. deprecated="not deprecated">
  18470. </field>
  18471. <field name="DEFAULT_NM_RECOVERY_ENABLED" type="boolean"
  18472. transient="false" volatile="false"
  18473. static="true" final="true" visibility="public"
  18474. deprecated="not deprecated">
  18475. </field>
  18476. <field name="NM_RECOVERY_DIR" type="java.lang.String"
  18477. transient="false" volatile="false"
  18478. static="true" final="true" visibility="public"
  18479. deprecated="not deprecated">
  18480. </field>
  18481. <field name="NM_RECOVERY_COMPACTION_INTERVAL_SECS" type="java.lang.String"
  18482. transient="false" volatile="false"
  18483. static="true" final="true" visibility="public"
  18484. deprecated="not deprecated">
  18485. <doc>
  18486. <![CDATA[The time in seconds between full compactions of the NM state database.
  18487. Setting the interval to zero disables the full compaction cycles.]]>
  18488. </doc>
  18489. </field>
  18490. <field name="DEFAULT_NM_RECOVERY_COMPACTION_INTERVAL_SECS" type="int"
  18491. transient="false" volatile="false"
  18492. static="true" final="true" visibility="public"
  18493. deprecated="not deprecated">
  18494. </field>
  18495. <field name="NM_RECOVERY_SUPERVISED" type="java.lang.String"
  18496. transient="false" volatile="false"
  18497. static="true" final="true" visibility="public"
  18498. deprecated="not deprecated">
  18499. </field>
  18500. <field name="DEFAULT_NM_RECOVERY_SUPERVISED" type="boolean"
  18501. transient="false" volatile="false"
  18502. static="true" final="true" visibility="public"
  18503. deprecated="not deprecated">
  18504. </field>
  18505. <field name="NM_LOG_AGG_POLICY_CLASS" type="java.lang.String"
  18506. transient="false" volatile="false"
  18507. static="true" final="true" visibility="public"
  18508. deprecated="not deprecated">
  18509. </field>
  18510. <field name="NM_LOG_AGG_POLICY_CLASS_PARAMETERS" type="java.lang.String"
  18511. transient="false" volatile="false"
  18512. static="true" final="true" visibility="public"
  18513. deprecated="not deprecated">
  18514. </field>
  18515. <field name="PROXY_PREFIX" type="java.lang.String"
  18516. transient="false" volatile="false"
  18517. static="true" final="true" visibility="public"
  18518. deprecated="not deprecated">
  18519. </field>
  18520. <field name="PROXY_PRINCIPAL" type="java.lang.String"
  18521. transient="false" volatile="false"
  18522. static="true" final="true" visibility="public"
  18523. deprecated="not deprecated">
  18524. <doc>
  18525. <![CDATA[The kerberos principal for the proxy.]]>
  18526. </doc>
  18527. </field>
  18528. <field name="PROXY_KEYTAB" type="java.lang.String"
  18529. transient="false" volatile="false"
  18530. static="true" final="true" visibility="public"
  18531. deprecated="not deprecated">
  18532. <doc>
  18533. <![CDATA[Keytab for Proxy.]]>
  18534. </doc>
  18535. </field>
  18536. <field name="PROXY_ADDRESS" type="java.lang.String"
  18537. transient="false" volatile="false"
  18538. static="true" final="true" visibility="public"
  18539. deprecated="not deprecated">
  18540. <doc>
  18541. <![CDATA[The address for the web proxy.]]>
  18542. </doc>
  18543. </field>
  18544. <field name="DEFAULT_PROXY_PORT" type="int"
  18545. transient="false" volatile="false"
  18546. static="true" final="true" visibility="public"
  18547. deprecated="not deprecated">
  18548. </field>
  18549. <field name="DEFAULT_PROXY_ADDRESS" type="java.lang.String"
  18550. transient="false" volatile="false"
  18551. static="true" final="true" visibility="public"
  18552. deprecated="not deprecated">
  18553. </field>
  18554. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCETRACKER_PROTOCOL" type="java.lang.String"
  18555. transient="false" volatile="false"
  18556. static="true" final="true" visibility="public"
  18557. deprecated="not deprecated">
  18558. <doc>
  18559. <![CDATA[YARN Service Level Authorization]]>
  18560. </doc>
  18561. </field>
  18562. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONCLIENT_PROTOCOL" type="java.lang.String"
  18563. transient="false" volatile="false"
  18564. static="true" final="true" visibility="public"
  18565. deprecated="not deprecated">
  18566. </field>
  18567. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCEMANAGER_ADMINISTRATION_PROTOCOL" type="java.lang.String"
  18568. transient="false" volatile="false"
  18569. static="true" final="true" visibility="public"
  18570. deprecated="not deprecated">
  18571. </field>
  18572. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONMASTER_PROTOCOL" type="java.lang.String"
  18573. transient="false" volatile="false"
  18574. static="true" final="true" visibility="public"
  18575. deprecated="not deprecated">
  18576. </field>
  18577. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_CONTAINER_MANAGEMENT_PROTOCOL" type="java.lang.String"
  18578. transient="false" volatile="false"
  18579. static="true" final="true" visibility="public"
  18580. deprecated="not deprecated">
  18581. </field>
  18582. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCE_LOCALIZER" type="java.lang.String"
  18583. transient="false" volatile="false"
  18584. static="true" final="true" visibility="public"
  18585. deprecated="not deprecated">
  18586. </field>
  18587. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONHISTORY_PROTOCOL" type="java.lang.String"
  18588. transient="false" volatile="false"
  18589. static="true" final="true" visibility="public"
  18590. deprecated="not deprecated">
  18591. </field>
  18592. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_COLLECTOR_NODEMANAGER_PROTOCOL" type="java.lang.String"
  18593. transient="false" volatile="false"
  18594. static="true" final="true" visibility="public"
  18595. deprecated="not deprecated">
  18596. </field>
  18597. <field name="NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="java.lang.String"
  18598. transient="false" volatile="false"
  18599. static="true" final="true" visibility="public"
  18600. deprecated="not deprecated">
  18601. <doc>
  18602. <![CDATA[No. of milliseconds to wait between sending a SIGTERM and SIGKILL
  18603. to a running container]]>
  18604. </doc>
  18605. </field>
  18606. <field name="DEFAULT_NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="long"
  18607. transient="false" volatile="false"
  18608. static="true" final="true" visibility="public"
  18609. deprecated="not deprecated">
  18610. </field>
  18611. <field name="NM_PROCESS_KILL_WAIT_MS" type="java.lang.String"
  18612. transient="false" volatile="false"
  18613. static="true" final="true" visibility="public"
  18614. deprecated="not deprecated">
  18615. <doc>
  18616. <![CDATA[Max time to wait for a process to come up when trying to cleanup
  18617. container resources]]>
  18618. </doc>
  18619. </field>
  18620. <field name="DEFAULT_NM_PROCESS_KILL_WAIT_MS" type="long"
  18621. transient="false" volatile="false"
  18622. static="true" final="true" visibility="public"
  18623. deprecated="not deprecated">
  18624. </field>
  18625. <field name="RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  18626. transient="false" volatile="false"
  18627. static="true" final="true" visibility="public"
  18628. deprecated="not deprecated">
  18629. <doc>
  18630. <![CDATA[Max time to wait to establish a connection to RM]]>
  18631. </doc>
  18632. </field>
  18633. <field name="DEFAULT_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="long"
  18634. transient="false" volatile="false"
  18635. static="true" final="true" visibility="public"
  18636. deprecated="not deprecated">
  18637. </field>
  18638. <field name="RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  18639. transient="false" volatile="false"
  18640. static="true" final="true" visibility="public"
  18641. deprecated="not deprecated">
  18642. <doc>
  18643. <![CDATA[Time interval between each attempt to connect to RM]]>
  18644. </doc>
  18645. </field>
  18646. <field name="DEFAULT_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="long"
  18647. transient="false" volatile="false"
  18648. static="true" final="true" visibility="public"
  18649. deprecated="not deprecated">
  18650. </field>
  18651. <field name="DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="java.lang.String"
  18652. transient="false" volatile="false"
  18653. static="true" final="true" visibility="public"
  18654. deprecated="not deprecated">
  18655. </field>
  18656. <field name="DEFAULT_DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="long"
  18657. transient="false" volatile="false"
  18658. static="true" final="true" visibility="public"
  18659. deprecated="not deprecated">
  18660. </field>
  18661. <field name="YARN_APPLICATION_CLASSPATH" type="java.lang.String"
  18662. transient="false" volatile="false"
  18663. static="true" final="true" visibility="public"
  18664. deprecated="not deprecated">
  18665. <doc>
  18666. <![CDATA[CLASSPATH for YARN applications. A comma-separated list of CLASSPATH
  18667. entries]]>
  18668. </doc>
  18669. </field>
  18670. <field name="AMRM_PROXY_ENABLED" type="java.lang.String"
  18671. transient="false" volatile="false"
  18672. static="true" final="true" visibility="public"
  18673. deprecated="not deprecated">
  18674. <doc>
  18675. <![CDATA[The setting that controls whether AMRMProxy is enabled or not.]]>
  18676. </doc>
  18677. </field>
  18678. <field name="DEFAULT_AMRM_PROXY_ENABLED" type="boolean"
  18679. transient="false" volatile="false"
  18680. static="true" final="true" visibility="public"
  18681. deprecated="not deprecated">
  18682. </field>
  18683. <field name="AMRM_PROXY_ADDRESS" type="java.lang.String"
  18684. transient="false" volatile="false"
  18685. static="true" final="true" visibility="public"
  18686. deprecated="not deprecated">
  18687. </field>
  18688. <field name="DEFAULT_AMRM_PROXY_PORT" type="int"
  18689. transient="false" volatile="false"
  18690. static="true" final="true" visibility="public"
  18691. deprecated="not deprecated">
  18692. </field>
  18693. <field name="DEFAULT_AMRM_PROXY_ADDRESS" type="java.lang.String"
  18694. transient="false" volatile="false"
  18695. static="true" final="true" visibility="public"
  18696. deprecated="not deprecated">
  18697. </field>
  18698. <field name="AMRM_PROXY_CLIENT_THREAD_COUNT" type="java.lang.String"
  18699. transient="false" volatile="false"
  18700. static="true" final="true" visibility="public"
  18701. deprecated="not deprecated">
  18702. </field>
  18703. <field name="DEFAULT_AMRM_PROXY_CLIENT_THREAD_COUNT" type="int"
  18704. transient="false" volatile="false"
  18705. static="true" final="true" visibility="public"
  18706. deprecated="not deprecated">
  18707. </field>
  18708. <field name="AMRM_PROXY_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  18709. transient="false" volatile="false"
  18710. static="true" final="true" visibility="public"
  18711. deprecated="not deprecated">
  18712. </field>
  18713. <field name="DEFAULT_AMRM_PROXY_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  18714. transient="false" volatile="false"
  18715. static="true" final="true" visibility="public"
  18716. deprecated="not deprecated">
  18717. </field>
  18718. <field name="AMRM_PROXY_HA_ENABLED" type="java.lang.String"
  18719. transient="false" volatile="false"
  18720. static="true" final="true" visibility="public"
  18721. deprecated="not deprecated">
  18722. </field>
  18723. <field name="DEFAULT_AMRM_PROXY_HA_ENABLED" type="boolean"
  18724. transient="false" volatile="false"
  18725. static="true" final="true" visibility="public"
  18726. deprecated="not deprecated">
  18727. </field>
  18728. <field name="DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH" type="java.lang.String[]"
  18729. transient="false" volatile="false"
  18730. static="true" final="true" visibility="public"
  18731. deprecated="not deprecated">
  18732. <doc>
  18733. <![CDATA[Default platform-agnostic CLASSPATH for YARN applications. A
  18734. comma-separated list of CLASSPATH entries. The parameter expansion marker
  18735. will be replaced with real parameter expansion marker ('%' for Windows and
  18736. '$' for Linux) by NodeManager on container launch. For example: {{VAR}}
  18737. will be replaced as $VAR on Linux, and %VAR% on Windows.]]>
  18738. </doc>
  18739. </field>
  18740. <field name="DEFAULT_YARN_APPLICATION_CLASSPATH" type="java.lang.String[]"
  18741. transient="false" volatile="false"
  18742. static="true" final="true" visibility="public"
  18743. deprecated="not deprecated">
  18744. <doc>
  18745. <![CDATA[<p>
  18746. Default platform-specific CLASSPATH for YARN applications. A
  18747. comma-separated list of CLASSPATH entries constructed based on the client
  18748. OS environment expansion syntax.
  18749. </p>
  18750. <p>
  18751. Note: Use {@link #DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH} for
  18752. cross-platform practice i.e. submit an application from a Windows client to
  18753. a Linux/Unix server or vice versa.
  18754. </p>]]>
  18755. </doc>
  18756. </field>
  18757. <field name="DEFAULT_CONTAINER_TEMP_DIR" type="java.lang.String"
  18758. transient="false" volatile="false"
  18759. static="true" final="true" visibility="public"
  18760. deprecated="not deprecated">
  18761. <doc>
  18762. <![CDATA[Container temp directory]]>
  18763. </doc>
  18764. </field>
  18765. <field name="IS_MINI_YARN_CLUSTER" type="java.lang.String"
  18766. transient="false" volatile="false"
  18767. static="true" final="true" visibility="public"
  18768. deprecated="not deprecated">
  18769. </field>
  18770. <field name="YARN_MC_PREFIX" type="java.lang.String"
  18771. transient="false" volatile="false"
  18772. static="true" final="true" visibility="public"
  18773. deprecated="not deprecated">
  18774. </field>
  18775. <field name="YARN_MINICLUSTER_FIXED_PORTS" type="java.lang.String"
  18776. transient="false" volatile="false"
  18777. static="true" final="true" visibility="public"
  18778. deprecated="not deprecated">
  18779. <doc>
  18780. <![CDATA[Whether to use fixed ports with the minicluster.]]>
  18781. </doc>
  18782. </field>
  18783. <field name="DEFAULT_YARN_MINICLUSTER_FIXED_PORTS" type="boolean"
  18784. transient="false" volatile="false"
  18785. static="true" final="true" visibility="public"
  18786. deprecated="not deprecated">
  18787. <doc>
  18788. <![CDATA[Default is false to be able to run tests concurrently without port
  18789. conflicts.]]>
  18790. </doc>
  18791. </field>
  18792. <field name="YARN_MINICLUSTER_USE_RPC" type="java.lang.String"
  18793. transient="false" volatile="false"
  18794. static="true" final="true" visibility="public"
  18795. deprecated="not deprecated">
  18796. <doc>
  18797. <![CDATA[Whether the NM should use RPC to connect to the RM. Default is false.
  18798. Can be set to true only when using fixed ports.]]>
  18799. </doc>
  18800. </field>
  18801. <field name="DEFAULT_YARN_MINICLUSTER_USE_RPC" type="boolean"
  18802. transient="false" volatile="false"
  18803. static="true" final="true" visibility="public"
  18804. deprecated="not deprecated">
  18805. </field>
  18806. <field name="YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="java.lang.String"
  18807. transient="false" volatile="false"
  18808. static="true" final="true" visibility="public"
  18809. deprecated="not deprecated">
  18810. <doc>
  18811. <![CDATA[Whether users are explicitly trying to control resource monitoring
  18812. configuration for the MiniYARNCluster. Disabled by default.]]>
  18813. </doc>
  18814. </field>
  18815. <field name="DEFAULT_YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="boolean"
  18816. transient="false" volatile="false"
  18817. static="true" final="true" visibility="public"
  18818. deprecated="not deprecated">
  18819. </field>
  18820. <field name="YARN_MINICLUSTER_NM_PMEM_MB" type="java.lang.String"
  18821. transient="false" volatile="false"
  18822. static="true" final="true" visibility="public"
  18823. deprecated="not deprecated">
  18824. <doc>
  18825. <![CDATA[Allow changing the memory for the NodeManager in the MiniYARNCluster]]>
  18826. </doc>
  18827. </field>
  18828. <field name="DEFAULT_YARN_MINICLUSTER_NM_PMEM_MB" type="int"
  18829. transient="false" volatile="false"
  18830. static="true" final="true" visibility="public"
  18831. deprecated="not deprecated">
  18832. </field>
  18833. <field name="YARN_APP_CONTAINER_LOG_DIR" type="java.lang.String"
  18834. transient="false" volatile="false"
  18835. static="true" final="true" visibility="public"
  18836. deprecated="not deprecated">
  18837. <doc>
  18838. <![CDATA[The log directory for the containers]]>
  18839. </doc>
  18840. </field>
  18841. <field name="YARN_APP_CONTAINER_LOG_SIZE" type="java.lang.String"
  18842. transient="false" volatile="false"
  18843. static="true" final="true" visibility="public"
  18844. deprecated="not deprecated">
  18845. </field>
  18846. <field name="YARN_APP_CONTAINER_LOG_BACKUPS" type="java.lang.String"
  18847. transient="false" volatile="false"
  18848. static="true" final="true" visibility="public"
  18849. deprecated="not deprecated">
  18850. </field>
  18851. <field name="TIMELINE_SERVICE_PREFIX" type="java.lang.String"
  18852. transient="false" volatile="false"
  18853. static="true" final="true" visibility="public"
  18854. deprecated="not deprecated">
  18855. </field>
  18856. <field name="TIMELINE_SERVICE_VERSION" type="java.lang.String"
  18857. transient="false" volatile="false"
  18858. static="true" final="true" visibility="public"
  18859. deprecated="not deprecated">
  18860. </field>
  18861. <field name="DEFAULT_TIMELINE_SERVICE_VERSION" type="float"
  18862. transient="false" volatile="false"
  18863. static="true" final="true" visibility="public"
  18864. deprecated="not deprecated">
  18865. </field>
  18866. <field name="TIMELINE_SERVICE_VERSIONS" type="java.lang.String"
  18867. transient="false" volatile="false"
  18868. static="true" final="true" visibility="public"
  18869. deprecated="not deprecated">
  18870. </field>
  18871. <field name="TIMELINE_SERVICE_UI_NAMES" type="java.lang.String"
  18872. transient="false" volatile="false"
  18873. static="true" final="true" visibility="public"
  18874. deprecated="not deprecated">
  18875. <doc>
  18876. <![CDATA[Comma seperated list of names for UIs hosted in the timeline server
  18877. (For pluggable UIs).]]>
  18878. </doc>
  18879. </field>
  18880. <field name="TIMELINE_SERVICE_UI_WEB_PATH_PREFIX" type="java.lang.String"
  18881. transient="false" volatile="false"
  18882. static="true" final="true" visibility="public"
  18883. deprecated="not deprecated">
  18884. <doc>
  18885. <![CDATA[Relative web path that will serve up this UI (For pluggable UIs).]]>
  18886. </doc>
  18887. </field>
  18888. <field name="TIMELINE_SERVICE_CLIENT_PREFIX" type="java.lang.String"
  18889. transient="false" volatile="false"
  18890. static="true" final="true" visibility="public"
  18891. deprecated="not deprecated">
  18892. <doc>
  18893. <![CDATA[Timeline client settings.]]>
  18894. </doc>
  18895. </field>
  18896. <field name="TIMELINE_SERVICE_UI_ON_DISK_PATH_PREFIX" type="java.lang.String"
  18897. transient="false" volatile="false"
  18898. static="true" final="true" visibility="public"
  18899. deprecated="not deprecated">
  18900. <doc>
  18901. <![CDATA[Path to war file or static content directory for this UI
  18902. (For pluggable UIs).]]>
  18903. </doc>
  18904. </field>
  18905. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX" type="java.lang.String"
  18906. transient="false" volatile="false"
  18907. static="true" final="true" visibility="public"
  18908. deprecated="not deprecated">
  18909. <doc>
  18910. <![CDATA[The setting for timeline service v1.5]]>
  18911. </doc>
  18912. </field>
  18913. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CACHE_STORE" type="java.lang.String"
  18914. transient="false" volatile="false"
  18915. static="true" final="true" visibility="public"
  18916. deprecated="not deprecated">
  18917. </field>
  18918. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_ACTIVE_DIR" type="java.lang.String"
  18919. transient="false" volatile="false"
  18920. static="true" final="true" visibility="public"
  18921. deprecated="not deprecated">
  18922. </field>
  18923. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_ACTIVE_DIR_DEFAULT" type="java.lang.String"
  18924. transient="false" volatile="false"
  18925. static="true" final="true" visibility="public"
  18926. deprecated="not deprecated">
  18927. </field>
  18928. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_DONE_DIR" type="java.lang.String"
  18929. transient="false" volatile="false"
  18930. static="true" final="true" visibility="public"
  18931. deprecated="not deprecated">
  18932. </field>
  18933. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_DONE_DIR_DEFAULT" type="java.lang.String"
  18934. transient="false" volatile="false"
  18935. static="true" final="true" visibility="public"
  18936. deprecated="not deprecated">
  18937. </field>
  18938. <field name="TIMELINE_SERVICE_ENTITY_GROUP_PLUGIN_CLASSES" type="java.lang.String"
  18939. transient="false" volatile="false"
  18940. static="true" final="true" visibility="public"
  18941. deprecated="not deprecated">
  18942. </field>
  18943. <field name="TIMELINE_SERVICE_ENTITY_GROUP_PLUGIN_CLASSPATH" type="java.lang.String"
  18944. transient="false" volatile="false"
  18945. static="true" final="true" visibility="public"
  18946. deprecated="not deprecated">
  18947. </field>
  18948. <field name="TIMELINE_SERVICE_ENTITY_GROUP_PLUGIN_SYSTEM_CLASSES" type="java.lang.String"
  18949. transient="false" volatile="false"
  18950. static="true" final="true" visibility="public"
  18951. deprecated="not deprecated">
  18952. </field>
  18953. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SUMMARY_STORE" type="java.lang.String"
  18954. transient="false" volatile="false"
  18955. static="true" final="true" visibility="public"
  18956. deprecated="not deprecated">
  18957. </field>
  18958. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SUMMARY_ENTITY_TYPES" type="java.lang.String"
  18959. transient="false" volatile="false"
  18960. static="true" final="true" visibility="public"
  18961. deprecated="not deprecated">
  18962. </field>
  18963. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SCAN_INTERVAL_SECONDS" type="java.lang.String"
  18964. transient="false" volatile="false"
  18965. static="true" final="true" visibility="public"
  18966. deprecated="not deprecated">
  18967. </field>
  18968. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SCAN_INTERVAL_SECONDS_DEFAULT" type="long"
  18969. transient="false" volatile="false"
  18970. static="true" final="true" visibility="public"
  18971. deprecated="not deprecated">
  18972. </field>
  18973. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_THREADS" type="java.lang.String"
  18974. transient="false" volatile="false"
  18975. static="true" final="true" visibility="public"
  18976. deprecated="not deprecated">
  18977. </field>
  18978. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_THREADS_DEFAULT" type="int"
  18979. transient="false" volatile="false"
  18980. static="true" final="true" visibility="public"
  18981. deprecated="not deprecated">
  18982. </field>
  18983. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_APP_CACHE_SIZE" type="java.lang.String"
  18984. transient="false" volatile="false"
  18985. static="true" final="true" visibility="public"
  18986. deprecated="not deprecated">
  18987. </field>
  18988. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_APP_CACHE_SIZE_DEFAULT" type="int"
  18989. transient="false" volatile="false"
  18990. static="true" final="true" visibility="public"
  18991. deprecated="not deprecated">
  18992. </field>
  18993. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CLEANER_INTERVAL_SECONDS" type="java.lang.String"
  18994. transient="false" volatile="false"
  18995. static="true" final="true" visibility="public"
  18996. deprecated="not deprecated">
  18997. </field>
  18998. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CLEANER_INTERVAL_SECONDS_DEFAULT" type="int"
  18999. transient="false" volatile="false"
  19000. static="true" final="true" visibility="public"
  19001. deprecated="not deprecated">
  19002. </field>
  19003. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETAIN_SECONDS" type="java.lang.String"
  19004. transient="false" volatile="false"
  19005. static="true" final="true" visibility="public"
  19006. deprecated="not deprecated">
  19007. </field>
  19008. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETAIN_SECONDS_DEFAULT" type="int"
  19009. transient="false" volatile="false"
  19010. static="true" final="true" visibility="public"
  19011. deprecated="not deprecated">
  19012. </field>
  19013. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_UNKNOWN_ACTIVE_SECONDS" type="java.lang.String"
  19014. transient="false" volatile="false"
  19015. static="true" final="true" visibility="public"
  19016. deprecated="not deprecated">
  19017. </field>
  19018. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_UNKNOWN_ACTIVE_SECONDS_DEFAULT" type="int"
  19019. transient="false" volatile="false"
  19020. static="true" final="true" visibility="public"
  19021. deprecated="not deprecated">
  19022. </field>
  19023. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  19024. transient="false" volatile="false"
  19025. static="true" final="true" visibility="public"
  19026. deprecated="not deprecated">
  19027. </field>
  19028. <field name="DEFAULT_TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  19029. transient="false" volatile="false"
  19030. static="true" final="true" visibility="public"
  19031. deprecated="not deprecated">
  19032. </field>
  19033. <field name="TIMELINE_SERVICE_LEVELDB_CACHE_READ_CACHE_SIZE" type="java.lang.String"
  19034. transient="false" volatile="false"
  19035. static="true" final="true" visibility="public"
  19036. deprecated="not deprecated">
  19037. </field>
  19038. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_CACHE_READ_CACHE_SIZE" type="long"
  19039. transient="false" volatile="false"
  19040. static="true" final="true" visibility="public"
  19041. deprecated="not deprecated">
  19042. </field>
  19043. <field name="TIMELINE_SERVICE_CLIENT_FD_FLUSH_INTERVAL_SECS" type="java.lang.String"
  19044. transient="false" volatile="false"
  19045. static="true" final="true" visibility="public"
  19046. deprecated="not deprecated">
  19047. </field>
  19048. <field name="TIMELINE_SERVICE_CLIENT_FD_FLUSH_INTERVAL_SECS_DEFAULT" type="long"
  19049. transient="false" volatile="false"
  19050. static="true" final="true" visibility="public"
  19051. deprecated="not deprecated">
  19052. </field>
  19053. <field name="TIMELINE_SERVICE_CLIENT_FD_CLEAN_INTERVAL_SECS" type="java.lang.String"
  19054. transient="false" volatile="false"
  19055. static="true" final="true" visibility="public"
  19056. deprecated="not deprecated">
  19057. </field>
  19058. <field name="TIMELINE_SERVICE_CLIENT_FD_CLEAN_INTERVAL_SECS_DEFAULT" type="long"
  19059. transient="false" volatile="false"
  19060. static="true" final="true" visibility="public"
  19061. deprecated="not deprecated">
  19062. </field>
  19063. <field name="TIMELINE_SERVICE_CLIENT_FD_RETAIN_SECS" type="java.lang.String"
  19064. transient="false" volatile="false"
  19065. static="true" final="true" visibility="public"
  19066. deprecated="not deprecated">
  19067. </field>
  19068. <field name="TIMELINE_SERVICE_CLIENT_FD_RETAIN_SECS_DEFAULT" type="long"
  19069. transient="false" volatile="false"
  19070. static="true" final="true" visibility="public"
  19071. deprecated="not deprecated">
  19072. </field>
  19073. <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_TIMERS_TTL_SECS" type="java.lang.String"
  19074. transient="false" volatile="false"
  19075. static="true" final="true" visibility="public"
  19076. deprecated="not deprecated">
  19077. </field>
  19078. <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_TIMERS_TTL_SECS_DEFAULT" type="long"
  19079. transient="false" volatile="false"
  19080. static="true" final="true" visibility="public"
  19081. deprecated="not deprecated">
  19082. </field>
  19083. <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_ATTEMPT_DIR_CACHE_SIZE" type="java.lang.String"
  19084. transient="false" volatile="false"
  19085. static="true" final="true" visibility="public"
  19086. deprecated="not deprecated">
  19087. </field>
  19088. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_INTERNAL_ATTEMPT_DIR_CACHE_SIZE" type="int"
  19089. transient="false" volatile="false"
  19090. static="true" final="true" visibility="public"
  19091. deprecated="not deprecated">
  19092. </field>
  19093. <field name="TIMELINE_SERVICE_ENTITYFILE_FS_SUPPORT_APPEND" type="java.lang.String"
  19094. transient="false" volatile="false"
  19095. static="true" final="true" visibility="public"
  19096. deprecated="not deprecated">
  19097. </field>
  19098. <field name="TIMELINE_SERVICE_READER_PREFIX" type="java.lang.String"
  19099. transient="false" volatile="false"
  19100. static="true" final="true" visibility="public"
  19101. deprecated="not deprecated">
  19102. <doc>
  19103. <![CDATA[Settings for timeline service v2.0.]]>
  19104. </doc>
  19105. </field>
  19106. <field name="TIMELINE_SERVICE_WRITER_CLASS" type="java.lang.String"
  19107. transient="false" volatile="false"
  19108. static="true" final="true" visibility="public"
  19109. deprecated="not deprecated">
  19110. </field>
  19111. <field name="DEFAULT_TIMELINE_SERVICE_WRITER_CLASS" type="java.lang.String"
  19112. transient="false" volatile="false"
  19113. static="true" final="true" visibility="public"
  19114. deprecated="not deprecated">
  19115. </field>
  19116. <field name="TIMELINE_SERVICE_READER_CLASS" type="java.lang.String"
  19117. transient="false" volatile="false"
  19118. static="true" final="true" visibility="public"
  19119. deprecated="not deprecated">
  19120. </field>
  19121. <field name="DEFAULT_TIMELINE_SERVICE_READER_CLASS" type="java.lang.String"
  19122. transient="false" volatile="false"
  19123. static="true" final="true" visibility="public"
  19124. deprecated="not deprecated">
  19125. </field>
  19126. <field name="TIMELINE_SERVICE_SCHEMA_CREATOR_CLASS" type="java.lang.String"
  19127. transient="false" volatile="false"
  19128. static="true" final="true" visibility="public"
  19129. deprecated="not deprecated">
  19130. </field>
  19131. <field name="DEFAULT_TIMELINE_SERVICE_SCHEMA_CREATOR_CLASS" type="java.lang.String"
  19132. transient="false" volatile="false"
  19133. static="true" final="true" visibility="public"
  19134. deprecated="not deprecated">
  19135. </field>
  19136. <field name="DEFAULT_TIMELINE_SERVICE_HBASE_SCHEMA_PREFIX" type="java.lang.String"
  19137. transient="false" volatile="false"
  19138. static="true" final="true" visibility="public"
  19139. deprecated="not deprecated">
  19140. <doc>
  19141. <![CDATA[default schema prefix for hbase tables.]]>
  19142. </doc>
  19143. </field>
  19144. <field name="TIMELINE_SERVICE_HBASE_SCHEMA_PREFIX_NAME" type="java.lang.String"
  19145. transient="false" volatile="false"
  19146. static="true" final="true" visibility="public"
  19147. deprecated="not deprecated">
  19148. <doc>
  19149. <![CDATA[config param name to override schema prefix.]]>
  19150. </doc>
  19151. </field>
  19152. <field name="TIMELINE_SERVICE_WRITER_FLUSH_INTERVAL_SECONDS" type="java.lang.String"
  19153. transient="false" volatile="false"
  19154. static="true" final="true" visibility="public"
  19155. deprecated="not deprecated">
  19156. <doc>
  19157. <![CDATA[The setting that controls how often the timeline collector flushes the
  19158. timeline writer.]]>
  19159. </doc>
  19160. </field>
  19161. <field name="DEFAULT_TIMELINE_SERVICE_WRITER_FLUSH_INTERVAL_SECONDS" type="int"
  19162. transient="false" volatile="false"
  19163. static="true" final="true" visibility="public"
  19164. deprecated="not deprecated">
  19165. </field>
  19166. <field name="APP_FINAL_VALUE_RETENTION_THRESHOLD" type="java.lang.String"
  19167. transient="false" volatile="false"
  19168. static="true" final="true" visibility="public"
  19169. deprecated="not deprecated">
  19170. <doc>
  19171. <![CDATA[The name for setting that controls how long the final value of
  19172. a metric of a completed app is retained before merging
  19173. into the flow sum.]]>
  19174. </doc>
  19175. </field>
  19176. <field name="FLOW_RUN_COPROCESSOR_JAR_HDFS_LOCATION" type="java.lang.String"
  19177. transient="false" volatile="false"
  19178. static="true" final="true" visibility="public"
  19179. deprecated="not deprecated">
  19180. <doc>
  19181. <![CDATA[The name of the setting for the location of the coprocessor
  19182. jar on hdfs.]]>
  19183. </doc>
  19184. </field>
  19185. <field name="DEFAULT_HDFS_LOCATION_FLOW_RUN_COPROCESSOR_JAR" type="java.lang.String"
  19186. transient="false" volatile="false"
  19187. static="true" final="true" visibility="public"
  19188. deprecated="not deprecated">
  19189. <doc>
  19190. <![CDATA[default hdfs location for flowrun coprocessor jar.]]>
  19191. </doc>
  19192. </field>
  19193. <field name="TIMELINE_SERVICE_HBASE_CONFIGURATION_FILE" type="java.lang.String"
  19194. transient="false" volatile="false"
  19195. static="true" final="true" visibility="public"
  19196. deprecated="not deprecated">
  19197. <doc>
  19198. <![CDATA[The name for setting that points to an optional HBase configuration
  19199. (hbase-site.xml file) with settings that will override the ones found on
  19200. the classpath.]]>
  19201. </doc>
  19202. </field>
  19203. <field name="TIMELINE_SERVICE_READ_AUTH_ENABLED" type="java.lang.String"
  19204. transient="false" volatile="false"
  19205. static="true" final="true" visibility="public"
  19206. deprecated="not deprecated">
  19207. <doc>
  19208. <![CDATA[The name for setting that enables or disables authentication checks
  19209. for reading timeline service v2 data.]]>
  19210. </doc>
  19211. </field>
  19212. <field name="DEFAULT_TIMELINE_SERVICE_READ_AUTH_ENABLED" type="java.lang.Boolean"
  19213. transient="false" volatile="false"
  19214. static="true" final="true" visibility="public"
  19215. deprecated="not deprecated">
  19216. <doc>
  19217. <![CDATA[The default setting for authentication checks for reading timeline
  19218. service v2 data.]]>
  19219. </doc>
  19220. </field>
  19221. <field name="TIMELINE_SERVICE_READ_ALLOWED_USERS" type="java.lang.String"
  19222. transient="false" volatile="false"
  19223. static="true" final="true" visibility="public"
  19224. deprecated="not deprecated">
  19225. <doc>
  19226. <![CDATA[The name for setting that lists the users and groups who are allowed
  19227. to read timeline service v2 data. It is a comma separated list of
  19228. user, followed by space, then comma separated list of groups.
  19229. It will allow this list of users and groups to read the data
  19230. and reject everyone else.]]>
  19231. </doc>
  19232. </field>
  19233. <field name="DEFAULT_TIMELINE_SERVICE_READ_ALLOWED_USERS" type="java.lang.String"
  19234. transient="false" volatile="false"
  19235. static="true" final="true" visibility="public"
  19236. deprecated="not deprecated">
  19237. <doc>
  19238. <![CDATA[The default value for list of the users who are allowed to read
  19239. timeline service v2 data.]]>
  19240. </doc>
  19241. </field>
  19242. <field name="DEFAULT_APP_FINAL_VALUE_RETENTION_THRESHOLD" type="long"
  19243. transient="false" volatile="false"
  19244. static="true" final="true" visibility="public"
  19245. deprecated="not deprecated">
  19246. <doc>
  19247. <![CDATA[The setting that controls how long the final value of a metric of a
  19248. completed app is retained before merging into the flow sum. Up to this time
  19249. after an application is completed out-of-order values that arrive can be
  19250. recognized and discarded at the cost of increased storage.]]>
  19251. </doc>
  19252. </field>
  19253. <field name="ATS_APP_COLLECTOR_LINGER_PERIOD_IN_MS" type="java.lang.String"
  19254. transient="false" volatile="false"
  19255. static="true" final="true" visibility="public"
  19256. deprecated="not deprecated">
  19257. </field>
  19258. <field name="DEFAULT_ATS_APP_COLLECTOR_LINGER_PERIOD_IN_MS" type="int"
  19259. transient="false" volatile="false"
  19260. static="true" final="true" visibility="public"
  19261. deprecated="not deprecated">
  19262. </field>
  19263. <field name="NUMBER_OF_ASYNC_ENTITIES_TO_MERGE" type="java.lang.String"
  19264. transient="false" volatile="false"
  19265. static="true" final="true" visibility="public"
  19266. deprecated="not deprecated">
  19267. </field>
  19268. <field name="DEFAULT_NUMBER_OF_ASYNC_ENTITIES_TO_MERGE" type="int"
  19269. transient="false" volatile="false"
  19270. static="true" final="true" visibility="public"
  19271. deprecated="not deprecated">
  19272. </field>
  19273. <field name="DEFAULT_FLOW_VERSION" type="java.lang.String"
  19274. transient="false" volatile="false"
  19275. static="true" final="true" visibility="public"
  19276. deprecated="not deprecated">
  19277. <doc>
  19278. <![CDATA[default version for any flow.]]>
  19279. </doc>
  19280. </field>
  19281. <field name="TIMELINE_V2_CLIENT_DRAIN_TIME_MILLIS" type="java.lang.String"
  19282. transient="false" volatile="false"
  19283. static="true" final="true" visibility="public"
  19284. deprecated="not deprecated">
  19285. <doc>
  19286. <![CDATA[The time period for which timeline v2 client will wait for draining
  19287. leftover entities after stop.]]>
  19288. </doc>
  19289. </field>
  19290. <field name="DEFAULT_TIMELINE_V2_CLIENT_DRAIN_TIME_MILLIS" type="long"
  19291. transient="false" volatile="false"
  19292. static="true" final="true" visibility="public"
  19293. deprecated="not deprecated">
  19294. </field>
  19295. <field name="APPLICATION_HISTORY_PREFIX" type="java.lang.String"
  19296. transient="false" volatile="false"
  19297. static="true" final="true" visibility="public"
  19298. deprecated="not deprecated">
  19299. </field>
  19300. <field name="APPLICATION_HISTORY_ENABLED" type="java.lang.String"
  19301. transient="false" volatile="false"
  19302. static="true" final="true" visibility="public"
  19303. deprecated="not deprecated">
  19304. <doc>
  19305. <![CDATA[The setting that controls whether application history service is
  19306. enabled or not.]]>
  19307. </doc>
  19308. </field>
  19309. <field name="DEFAULT_APPLICATION_HISTORY_ENABLED" type="boolean"
  19310. transient="false" volatile="false"
  19311. static="true" final="true" visibility="public"
  19312. deprecated="not deprecated">
  19313. </field>
  19314. <field name="APPLICATION_HISTORY_STORE" type="java.lang.String"
  19315. transient="false" volatile="false"
  19316. static="true" final="true" visibility="public"
  19317. deprecated="not deprecated">
  19318. <doc>
  19319. <![CDATA[Application history store class]]>
  19320. </doc>
  19321. </field>
  19322. <field name="APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="java.lang.String"
  19323. transient="false" volatile="false"
  19324. static="true" final="true" visibility="public"
  19325. deprecated="not deprecated">
  19326. <doc>
  19327. <![CDATA[Save container meta-info in the application history store.]]>
  19328. </doc>
  19329. </field>
  19330. <field name="DEFAULT_APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="boolean"
  19331. transient="false" volatile="false"
  19332. static="true" final="true" visibility="public"
  19333. deprecated="not deprecated">
  19334. </field>
  19335. <field name="FS_APPLICATION_HISTORY_STORE_URI" type="java.lang.String"
  19336. transient="false" volatile="false"
  19337. static="true" final="true" visibility="public"
  19338. deprecated="not deprecated">
  19339. <doc>
  19340. <![CDATA[URI for FileSystemApplicationHistoryStore]]>
  19341. </doc>
  19342. </field>
  19343. <field name="FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
  19344. transient="false" volatile="false"
  19345. static="true" final="true" visibility="public"
  19346. deprecated="not deprecated">
  19347. <doc>
  19348. <![CDATA[T-file compression types used to compress history data.]]>
  19349. </doc>
  19350. </field>
  19351. <field name="DEFAULT_FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
  19352. transient="false" volatile="false"
  19353. static="true" final="true" visibility="public"
  19354. deprecated="not deprecated">
  19355. </field>
  19356. <field name="TIMELINE_SERVICE_ENABLED" type="java.lang.String"
  19357. transient="false" volatile="false"
  19358. static="true" final="true" visibility="public"
  19359. deprecated="not deprecated">
  19360. <doc>
  19361. <![CDATA[The setting that controls whether timeline service is enabled or not.]]>
  19362. </doc>
  19363. </field>
  19364. <field name="DEFAULT_TIMELINE_SERVICE_ENABLED" type="boolean"
  19365. transient="false" volatile="false"
  19366. static="true" final="true" visibility="public"
  19367. deprecated="not deprecated">
  19368. </field>
  19369. <field name="TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
  19370. transient="false" volatile="false"
  19371. static="true" final="true" visibility="public"
  19372. deprecated="not deprecated">
  19373. <doc>
  19374. <![CDATA[host:port address for timeline service RPC APIs.]]>
  19375. </doc>
  19376. </field>
  19377. <field name="DEFAULT_TIMELINE_SERVICE_PORT" type="int"
  19378. transient="false" volatile="false"
  19379. static="true" final="true" visibility="public"
  19380. deprecated="not deprecated">
  19381. </field>
  19382. <field name="DEFAULT_TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
  19383. transient="false" volatile="false"
  19384. static="true" final="true" visibility="public"
  19385. deprecated="not deprecated">
  19386. </field>
  19387. <field name="TIMELINE_SERVICE_BIND_HOST" type="java.lang.String"
  19388. transient="false" volatile="false"
  19389. static="true" final="true" visibility="public"
  19390. deprecated="not deprecated">
  19391. <doc>
  19392. <![CDATA[The listening endpoint for the timeline service application.]]>
  19393. </doc>
  19394. </field>
  19395. <field name="DEFAULT_TIMELINE_SERVICE_BIND_HOST" type="java.lang.String"
  19396. transient="false" volatile="false"
  19397. static="true" final="true" visibility="public"
  19398. deprecated="not deprecated">
  19399. </field>
  19400. <field name="TIMELINE_SERVICE_HANDLER_THREAD_COUNT" type="java.lang.String"
  19401. transient="false" volatile="false"
  19402. static="true" final="true" visibility="public"
  19403. deprecated="not deprecated">
  19404. <doc>
  19405. <![CDATA[The number of threads to handle client RPC API requests.]]>
  19406. </doc>
  19407. </field>
  19408. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_THREAD_COUNT" type="int"
  19409. transient="false" volatile="false"
  19410. static="true" final="true" visibility="public"
  19411. deprecated="not deprecated">
  19412. </field>
  19413. <field name="TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
  19414. transient="false" volatile="false"
  19415. static="true" final="true" visibility="public"
  19416. deprecated="not deprecated">
  19417. <doc>
  19418. <![CDATA[The address of the timeline service web application.]]>
  19419. </doc>
  19420. </field>
  19421. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_PORT" type="int"
  19422. transient="false" volatile="false"
  19423. static="true" final="true" visibility="public"
  19424. deprecated="not deprecated">
  19425. </field>
  19426. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
  19427. transient="false" volatile="false"
  19428. static="true" final="true" visibility="public"
  19429. deprecated="not deprecated">
  19430. </field>
  19431. <field name="TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  19432. transient="false" volatile="false"
  19433. static="true" final="true" visibility="public"
  19434. deprecated="not deprecated">
  19435. <doc>
  19436. <![CDATA[The https address of the timeline service web application.]]>
  19437. </doc>
  19438. </field>
  19439. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_PORT" type="int"
  19440. transient="false" volatile="false"
  19441. static="true" final="true" visibility="public"
  19442. deprecated="not deprecated">
  19443. </field>
  19444. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  19445. transient="false" volatile="false"
  19446. static="true" final="true" visibility="public"
  19447. deprecated="not deprecated">
  19448. </field>
  19449. <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_WITH_USER_DIR" type="java.lang.String"
  19450. transient="false" volatile="false"
  19451. static="true" final="true" visibility="public"
  19452. deprecated="not deprecated">
  19453. </field>
  19454. <field name="APPLICATION_HISTORY_MAX_APPS" type="java.lang.String"
  19455. transient="false" volatile="false"
  19456. static="true" final="true" visibility="public"
  19457. deprecated="not deprecated">
  19458. <doc>
  19459. <![CDATA[Defines the max number of applications could be fetched using
  19460. REST API or application history protocol and shown in timeline
  19461. server web ui.]]>
  19462. </doc>
  19463. </field>
  19464. <field name="DEFAULT_APPLICATION_HISTORY_MAX_APPS" type="long"
  19465. transient="false" volatile="false"
  19466. static="true" final="true" visibility="public"
  19467. deprecated="not deprecated">
  19468. </field>
  19469. <field name="TIMELINE_SERVICE_STORE" type="java.lang.String"
  19470. transient="false" volatile="false"
  19471. static="true" final="true" visibility="public"
  19472. deprecated="not deprecated">
  19473. <doc>
  19474. <![CDATA[Timeline service store class.]]>
  19475. </doc>
  19476. </field>
  19477. <field name="TIMELINE_SERVICE_TTL_ENABLE" type="java.lang.String"
  19478. transient="false" volatile="false"
  19479. static="true" final="true" visibility="public"
  19480. deprecated="not deprecated">
  19481. <doc>
  19482. <![CDATA[Timeline service enable data age off]]>
  19483. </doc>
  19484. </field>
  19485. <field name="TIMELINE_SERVICE_TTL_MS" type="java.lang.String"
  19486. transient="false" volatile="false"
  19487. static="true" final="true" visibility="public"
  19488. deprecated="not deprecated">
  19489. <doc>
  19490. <![CDATA[Timeline service length of time to retain data]]>
  19491. </doc>
  19492. </field>
  19493. <field name="DEFAULT_TIMELINE_SERVICE_TTL_MS" type="long"
  19494. transient="false" volatile="false"
  19495. static="true" final="true" visibility="public"
  19496. deprecated="not deprecated">
  19497. </field>
  19498. <field name="TIMELINE_SERVICE_ROLLING_PERIOD" type="java.lang.String"
  19499. transient="false" volatile="false"
  19500. static="true" final="true" visibility="public"
  19501. deprecated="not deprecated">
  19502. <doc>
  19503. <![CDATA[Timeline service rolling period. Valid values are daily, half_daily,
  19504. quarter_daily, and hourly.]]>
  19505. </doc>
  19506. </field>
  19507. <field name="DEFAULT_TIMELINE_SERVICE_ROLLING_PERIOD" type="java.lang.String"
  19508. transient="false" volatile="false"
  19509. static="true" final="true" visibility="public"
  19510. deprecated="not deprecated">
  19511. <doc>
  19512. <![CDATA[Roll a new database each hour.]]>
  19513. </doc>
  19514. </field>
  19515. <field name="TIMELINE_SERVICE_LEVELDB_PREFIX" type="java.lang.String"
  19516. transient="false" volatile="false"
  19517. static="true" final="true" visibility="public"
  19518. deprecated="not deprecated">
  19519. <doc>
  19520. <![CDATA[Implementation specific configuration prefix for Timeline Service
  19521. leveldb.]]>
  19522. </doc>
  19523. </field>
  19524. <field name="TIMELINE_SERVICE_LEVELDB_PATH" type="java.lang.String"
  19525. transient="false" volatile="false"
  19526. static="true" final="true" visibility="public"
  19527. deprecated="not deprecated">
  19528. <doc>
  19529. <![CDATA[Timeline service leveldb path]]>
  19530. </doc>
  19531. </field>
  19532. <field name="TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="java.lang.String"
  19533. transient="false" volatile="false"
  19534. static="true" final="true" visibility="public"
  19535. deprecated="not deprecated">
  19536. <doc>
  19537. <![CDATA[Timeline service leveldb read cache (uncompressed blocks). This is
  19538. per rolling instance so should be tuned if using rolling leveldb
  19539. timeline store]]>
  19540. </doc>
  19541. </field>
  19542. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="long"
  19543. transient="false" volatile="false"
  19544. static="true" final="true" visibility="public"
  19545. deprecated="not deprecated">
  19546. <doc>
  19547. <![CDATA[Default leveldb read cache size if no configuration is specified.]]>
  19548. </doc>
  19549. </field>
  19550. <field name="TIMELINE_SERVICE_LEVELDB_WRITE_BUFFER_SIZE" type="java.lang.String"
  19551. transient="false" volatile="false"
  19552. static="true" final="true" visibility="public"
  19553. deprecated="not deprecated">
  19554. <doc>
  19555. <![CDATA[Timeline service leveldb write buffer size.]]>
  19556. </doc>
  19557. </field>
  19558. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_WRITE_BUFFER_SIZE" type="int"
  19559. transient="false" volatile="false"
  19560. static="true" final="true" visibility="public"
  19561. deprecated="not deprecated">
  19562. <doc>
  19563. <![CDATA[Default leveldb write buffer size if no configuration is specified. This
  19564. is per rolling instance so should be tuned if using rolling leveldb
  19565. timeline store.]]>
  19566. </doc>
  19567. </field>
  19568. <field name="TIMELINE_SERVICE_LEVELDB_WRITE_BATCH_SIZE" type="java.lang.String"
  19569. transient="false" volatile="false"
  19570. static="true" final="true" visibility="public"
  19571. deprecated="not deprecated">
  19572. <doc>
  19573. <![CDATA[Timeline service leveldb write batch size. This value can be tuned down
  19574. to reduce lock time for ttl eviction.]]>
  19575. </doc>
  19576. </field>
  19577. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_WRITE_BATCH_SIZE" type="int"
  19578. transient="false" volatile="false"
  19579. static="true" final="true" visibility="public"
  19580. deprecated="not deprecated">
  19581. <doc>
  19582. <![CDATA[Default leveldb write batch size is no configuration is specified]]>
  19583. </doc>
  19584. </field>
  19585. <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="java.lang.String"
  19586. transient="false" volatile="false"
  19587. static="true" final="true" visibility="public"
  19588. deprecated="not deprecated">
  19589. <doc>
  19590. <![CDATA[Timeline service leveldb start time read cache (number of entities)]]>
  19591. </doc>
  19592. </field>
  19593. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="int"
  19594. transient="false" volatile="false"
  19595. static="true" final="true" visibility="public"
  19596. deprecated="not deprecated">
  19597. </field>
  19598. <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="java.lang.String"
  19599. transient="false" volatile="false"
  19600. static="true" final="true" visibility="public"
  19601. deprecated="not deprecated">
  19602. <doc>
  19603. <![CDATA[Timeline service leveldb start time write cache (number of entities)]]>
  19604. </doc>
  19605. </field>
  19606. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="int"
  19607. transient="false" volatile="false"
  19608. static="true" final="true" visibility="public"
  19609. deprecated="not deprecated">
  19610. </field>
  19611. <field name="TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="java.lang.String"
  19612. transient="false" volatile="false"
  19613. static="true" final="true" visibility="public"
  19614. deprecated="not deprecated">
  19615. <doc>
  19616. <![CDATA[Timeline service leveldb interval to wait between deletion rounds]]>
  19617. </doc>
  19618. </field>
  19619. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="long"
  19620. transient="false" volatile="false"
  19621. static="true" final="true" visibility="public"
  19622. deprecated="not deprecated">
  19623. </field>
  19624. <field name="TIMELINE_SERVICE_LEVELDB_MAX_OPEN_FILES" type="java.lang.String"
  19625. transient="false" volatile="false"
  19626. static="true" final="true" visibility="public"
  19627. deprecated="not deprecated">
  19628. <doc>
  19629. <![CDATA[Timeline service leveldb number of concurrent open files. Tuned this
  19630. configuration to stay within system limits. This is per rolling instance
  19631. so should be tuned if using rolling leveldb timeline store.]]>
  19632. </doc>
  19633. </field>
  19634. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_MAX_OPEN_FILES" type="int"
  19635. transient="false" volatile="false"
  19636. static="true" final="true" visibility="public"
  19637. deprecated="not deprecated">
  19638. <doc>
  19639. <![CDATA[Default leveldb max open files if no configuration is specified.]]>
  19640. </doc>
  19641. </field>
  19642. <field name="TIMELINE_SERVICE_PRINCIPAL" type="java.lang.String"
  19643. transient="false" volatile="false"
  19644. static="true" final="true" visibility="public"
  19645. deprecated="not deprecated">
  19646. <doc>
  19647. <![CDATA[The Kerberos principal for the timeline server.]]>
  19648. </doc>
  19649. </field>
  19650. <field name="TIMELINE_SERVICE_KEYTAB" type="java.lang.String"
  19651. transient="false" volatile="false"
  19652. static="true" final="true" visibility="public"
  19653. deprecated="not deprecated">
  19654. <doc>
  19655. <![CDATA[The Kerberos keytab for the timeline server.]]>
  19656. </doc>
  19657. </field>
  19658. <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED" type="java.lang.String"
  19659. transient="false" volatile="false"
  19660. static="true" final="true" visibility="public"
  19661. deprecated="not deprecated">
  19662. <doc>
  19663. <![CDATA[Enables cross origin support for timeline server.]]>
  19664. </doc>
  19665. </field>
  19666. <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED_DEFAULT" type="boolean"
  19667. transient="false" volatile="false"
  19668. static="true" final="true" visibility="public"
  19669. deprecated="not deprecated">
  19670. <doc>
  19671. <![CDATA[Default value for cross origin support for timeline server.]]>
  19672. </doc>
  19673. </field>
  19674. <field name="TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="java.lang.String"
  19675. transient="false" volatile="false"
  19676. static="true" final="true" visibility="public"
  19677. deprecated="not deprecated">
  19678. <doc>
  19679. <![CDATA[Timeline client call, max retries (-1 means no limit)]]>
  19680. </doc>
  19681. </field>
  19682. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="int"
  19683. transient="false" volatile="false"
  19684. static="true" final="true" visibility="public"
  19685. deprecated="not deprecated">
  19686. </field>
  19687. <field name="TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="java.lang.String"
  19688. transient="false" volatile="false"
  19689. static="true" final="true" visibility="public"
  19690. deprecated="not deprecated">
  19691. <doc>
  19692. <![CDATA[Timeline client call, retry interval]]>
  19693. </doc>
  19694. </field>
  19695. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="long"
  19696. transient="false" volatile="false"
  19697. static="true" final="true" visibility="public"
  19698. deprecated="not deprecated">
  19699. </field>
  19700. <field name="TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="java.lang.String"
  19701. transient="false" volatile="false"
  19702. static="true" final="true" visibility="public"
  19703. deprecated="not deprecated">
  19704. <doc>
  19705. <![CDATA[Timeline client policy for whether connections are fatal]]>
  19706. </doc>
  19707. </field>
  19708. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="boolean"
  19709. transient="false" volatile="false"
  19710. static="true" final="true" visibility="public"
  19711. deprecated="not deprecated">
  19712. </field>
  19713. <field name="TIMELINE_SERVICE_RECOVERY_ENABLED" type="java.lang.String"
  19714. transient="false" volatile="false"
  19715. static="true" final="true" visibility="public"
  19716. deprecated="not deprecated">
  19717. <doc>
  19718. <![CDATA[Flag to enable recovery of timeline service]]>
  19719. </doc>
  19720. </field>
  19721. <field name="DEFAULT_TIMELINE_SERVICE_RECOVERY_ENABLED" type="boolean"
  19722. transient="false" volatile="false"
  19723. static="true" final="true" visibility="public"
  19724. deprecated="not deprecated">
  19725. </field>
  19726. <field name="TIMELINE_SERVICE_STATE_STORE_CLASS" type="java.lang.String"
  19727. transient="false" volatile="false"
  19728. static="true" final="true" visibility="public"
  19729. deprecated="not deprecated">
  19730. <doc>
  19731. <![CDATA[Timeline service state store class]]>
  19732. </doc>
  19733. </field>
  19734. <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PREFIX" type="java.lang.String"
  19735. transient="false" volatile="false"
  19736. static="true" final="true" visibility="public"
  19737. deprecated="not deprecated">
  19738. </field>
  19739. <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PATH" type="java.lang.String"
  19740. transient="false" volatile="false"
  19741. static="true" final="true" visibility="public"
  19742. deprecated="not deprecated">
  19743. <doc>
  19744. <![CDATA[Timeline service state store leveldb path]]>
  19745. </doc>
  19746. </field>
  19747. <field name="TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="java.lang.String"
  19748. transient="false" volatile="false"
  19749. static="true" final="true" visibility="public"
  19750. deprecated="not deprecated">
  19751. </field>
  19752. <field name="DEFAULT_TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="long"
  19753. transient="false" volatile="false"
  19754. static="true" final="true" visibility="public"
  19755. deprecated="not deprecated">
  19756. </field>
  19757. <field name="TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="java.lang.String"
  19758. transient="false" volatile="false"
  19759. static="true" final="true" visibility="public"
  19760. deprecated="not deprecated">
  19761. </field>
  19762. <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="long"
  19763. transient="false" volatile="false"
  19764. static="true" final="true" visibility="public"
  19765. deprecated="not deprecated">
  19766. </field>
  19767. <field name="TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="java.lang.String"
  19768. transient="false" volatile="false"
  19769. static="true" final="true" visibility="public"
  19770. deprecated="not deprecated">
  19771. </field>
  19772. <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="long"
  19773. transient="false" volatile="false"
  19774. static="true" final="true" visibility="public"
  19775. deprecated="not deprecated">
  19776. </field>
  19777. <field name="TIMELINE_OFFLINE_AGGREGATION_PREFIX" type="java.lang.String"
  19778. transient="false" volatile="false"
  19779. static="true" final="true" visibility="public"
  19780. deprecated="not deprecated">
  19781. </field>
  19782. <field name="PHOENIX_OFFLINE_STORAGE_CONN_STR" type="java.lang.String"
  19783. transient="false" volatile="false"
  19784. static="true" final="true" visibility="public"
  19785. deprecated="not deprecated">
  19786. </field>
  19787. <field name="PHOENIX_OFFLINE_STORAGE_CONN_STR_DEFAULT" type="java.lang.String"
  19788. transient="false" volatile="false"
  19789. static="true" final="true" visibility="public"
  19790. deprecated="not deprecated">
  19791. </field>
  19792. <field name="SHARED_CACHE_PREFIX" type="java.lang.String"
  19793. transient="false" volatile="false"
  19794. static="true" final="true" visibility="public"
  19795. deprecated="not deprecated">
  19796. </field>
  19797. <field name="SHARED_CACHE_ENABLED" type="java.lang.String"
  19798. transient="false" volatile="false"
  19799. static="true" final="true" visibility="public"
  19800. deprecated="not deprecated">
  19801. <doc>
  19802. <![CDATA[whether the shared cache is enabled/disabled]]>
  19803. </doc>
  19804. </field>
  19805. <field name="DEFAULT_SHARED_CACHE_ENABLED" type="boolean"
  19806. transient="false" volatile="false"
  19807. static="true" final="true" visibility="public"
  19808. deprecated="not deprecated">
  19809. </field>
  19810. <field name="SHARED_CACHE_ROOT" type="java.lang.String"
  19811. transient="false" volatile="false"
  19812. static="true" final="true" visibility="public"
  19813. deprecated="not deprecated">
  19814. <doc>
  19815. <![CDATA[The config key for the shared cache root directory.]]>
  19816. </doc>
  19817. </field>
  19818. <field name="DEFAULT_SHARED_CACHE_ROOT" type="java.lang.String"
  19819. transient="false" volatile="false"
  19820. static="true" final="true" visibility="public"
  19821. deprecated="not deprecated">
  19822. </field>
  19823. <field name="SHARED_CACHE_NESTED_LEVEL" type="java.lang.String"
  19824. transient="false" volatile="false"
  19825. static="true" final="true" visibility="public"
  19826. deprecated="not deprecated">
  19827. <doc>
  19828. <![CDATA[The config key for the level of nested directories before getting to the
  19829. checksum directory.]]>
  19830. </doc>
  19831. </field>
  19832. <field name="DEFAULT_SHARED_CACHE_NESTED_LEVEL" type="int"
  19833. transient="false" volatile="false"
  19834. static="true" final="true" visibility="public"
  19835. deprecated="not deprecated">
  19836. </field>
  19837. <field name="SCM_STORE_PREFIX" type="java.lang.String"
  19838. transient="false" volatile="false"
  19839. static="true" final="true" visibility="public"
  19840. deprecated="not deprecated">
  19841. </field>
  19842. <field name="SCM_STORE_CLASS" type="java.lang.String"
  19843. transient="false" volatile="false"
  19844. static="true" final="true" visibility="public"
  19845. deprecated="not deprecated">
  19846. </field>
  19847. <field name="DEFAULT_SCM_STORE_CLASS" type="java.lang.String"
  19848. transient="false" volatile="false"
  19849. static="true" final="true" visibility="public"
  19850. deprecated="not deprecated">
  19851. </field>
  19852. <field name="SCM_APP_CHECKER_CLASS" type="java.lang.String"
  19853. transient="false" volatile="false"
  19854. static="true" final="true" visibility="public"
  19855. deprecated="not deprecated">
  19856. </field>
  19857. <field name="DEFAULT_SCM_APP_CHECKER_CLASS" type="java.lang.String"
  19858. transient="false" volatile="false"
  19859. static="true" final="true" visibility="public"
  19860. deprecated="not deprecated">
  19861. </field>
  19862. <field name="SCM_ADMIN_ADDRESS" type="java.lang.String"
  19863. transient="false" volatile="false"
  19864. static="true" final="true" visibility="public"
  19865. deprecated="not deprecated">
  19866. <doc>
  19867. <![CDATA[The address of the SCM admin interface.]]>
  19868. </doc>
  19869. </field>
  19870. <field name="DEFAULT_SCM_ADMIN_PORT" type="int"
  19871. transient="false" volatile="false"
  19872. static="true" final="true" visibility="public"
  19873. deprecated="not deprecated">
  19874. </field>
  19875. <field name="DEFAULT_SCM_ADMIN_ADDRESS" type="java.lang.String"
  19876. transient="false" volatile="false"
  19877. static="true" final="true" visibility="public"
  19878. deprecated="not deprecated">
  19879. </field>
  19880. <field name="SCM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
  19881. transient="false" volatile="false"
  19882. static="true" final="true" visibility="public"
  19883. deprecated="not deprecated">
  19884. <doc>
  19885. <![CDATA[Number of threads used to handle SCM admin interface.]]>
  19886. </doc>
  19887. </field>
  19888. <field name="DEFAULT_SCM_ADMIN_CLIENT_THREAD_COUNT" type="int"
  19889. transient="false" volatile="false"
  19890. static="true" final="true" visibility="public"
  19891. deprecated="not deprecated">
  19892. </field>
  19893. <field name="SCM_WEBAPP_ADDRESS" type="java.lang.String"
  19894. transient="false" volatile="false"
  19895. static="true" final="true" visibility="public"
  19896. deprecated="not deprecated">
  19897. <doc>
  19898. <![CDATA[The address of the SCM web application.]]>
  19899. </doc>
  19900. </field>
  19901. <field name="DEFAULT_SCM_WEBAPP_PORT" type="int"
  19902. transient="false" volatile="false"
  19903. static="true" final="true" visibility="public"
  19904. deprecated="not deprecated">
  19905. </field>
  19906. <field name="DEFAULT_SCM_WEBAPP_ADDRESS" type="java.lang.String"
  19907. transient="false" volatile="false"
  19908. static="true" final="true" visibility="public"
  19909. deprecated="not deprecated">
  19910. </field>
  19911. <field name="IN_MEMORY_STORE_PREFIX" type="java.lang.String"
  19912. transient="false" volatile="false"
  19913. static="true" final="true" visibility="public"
  19914. deprecated="not deprecated">
  19915. </field>
  19916. <field name="IN_MEMORY_STALENESS_PERIOD_MINS" type="java.lang.String"
  19917. transient="false" volatile="false"
  19918. static="true" final="true" visibility="public"
  19919. deprecated="not deprecated">
  19920. <doc>
  19921. <![CDATA[A resource in the InMemorySCMStore is considered stale if the time since
  19922. the last reference exceeds the staleness period. This value is specified in
  19923. minutes.]]>
  19924. </doc>
  19925. </field>
  19926. <field name="DEFAULT_IN_MEMORY_STALENESS_PERIOD_MINS" type="int"
  19927. transient="false" volatile="false"
  19928. static="true" final="true" visibility="public"
  19929. deprecated="not deprecated">
  19930. </field>
  19931. <field name="IN_MEMORY_INITIAL_DELAY_MINS" type="java.lang.String"
  19932. transient="false" volatile="false"
  19933. static="true" final="true" visibility="public"
  19934. deprecated="not deprecated">
  19935. <doc>
  19936. <![CDATA[Initial delay before the in-memory store runs its first check to remove
  19937. dead initial applications. Specified in minutes.]]>
  19938. </doc>
  19939. </field>
  19940. <field name="DEFAULT_IN_MEMORY_INITIAL_DELAY_MINS" type="int"
  19941. transient="false" volatile="false"
  19942. static="true" final="true" visibility="public"
  19943. deprecated="not deprecated">
  19944. </field>
  19945. <field name="IN_MEMORY_CHECK_PERIOD_MINS" type="java.lang.String"
  19946. transient="false" volatile="false"
  19947. static="true" final="true" visibility="public"
  19948. deprecated="not deprecated">
  19949. <doc>
  19950. <![CDATA[The frequency at which the in-memory store checks to remove dead initial
  19951. applications. Specified in minutes.]]>
  19952. </doc>
  19953. </field>
  19954. <field name="DEFAULT_IN_MEMORY_CHECK_PERIOD_MINS" type="int"
  19955. transient="false" volatile="false"
  19956. static="true" final="true" visibility="public"
  19957. deprecated="not deprecated">
  19958. </field>
  19959. <field name="SCM_CLEANER_PERIOD_MINS" type="java.lang.String"
  19960. transient="false" volatile="false"
  19961. static="true" final="true" visibility="public"
  19962. deprecated="not deprecated">
  19963. <doc>
  19964. <![CDATA[The frequency at which a cleaner task runs. Specified in minutes.]]>
  19965. </doc>
  19966. </field>
  19967. <field name="DEFAULT_SCM_CLEANER_PERIOD_MINS" type="int"
  19968. transient="false" volatile="false"
  19969. static="true" final="true" visibility="public"
  19970. deprecated="not deprecated">
  19971. </field>
  19972. <field name="SCM_CLEANER_INITIAL_DELAY_MINS" type="java.lang.String"
  19973. transient="false" volatile="false"
  19974. static="true" final="true" visibility="public"
  19975. deprecated="not deprecated">
  19976. <doc>
  19977. <![CDATA[Initial delay before the first cleaner task is scheduled. Specified in
  19978. minutes.]]>
  19979. </doc>
  19980. </field>
  19981. <field name="DEFAULT_SCM_CLEANER_INITIAL_DELAY_MINS" type="int"
  19982. transient="false" volatile="false"
  19983. static="true" final="true" visibility="public"
  19984. deprecated="not deprecated">
  19985. </field>
  19986. <field name="SCM_CLEANER_RESOURCE_SLEEP_MS" type="java.lang.String"
  19987. transient="false" volatile="false"
  19988. static="true" final="true" visibility="public"
  19989. deprecated="not deprecated">
  19990. <doc>
  19991. <![CDATA[The time to sleep between processing each shared cache resource. Specified
  19992. in milliseconds.]]>
  19993. </doc>
  19994. </field>
  19995. <field name="DEFAULT_SCM_CLEANER_RESOURCE_SLEEP_MS" type="long"
  19996. transient="false" volatile="false"
  19997. static="true" final="true" visibility="public"
  19998. deprecated="not deprecated">
  19999. </field>
  20000. <field name="SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
  20001. transient="false" volatile="false"
  20002. static="true" final="true" visibility="public"
  20003. deprecated="not deprecated">
  20004. <doc>
  20005. <![CDATA[The address of the node manager interface in the SCM.]]>
  20006. </doc>
  20007. </field>
  20008. <field name="DEFAULT_SCM_UPLOADER_SERVER_PORT" type="int"
  20009. transient="false" volatile="false"
  20010. static="true" final="true" visibility="public"
  20011. deprecated="not deprecated">
  20012. </field>
  20013. <field name="DEFAULT_SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
  20014. transient="false" volatile="false"
  20015. static="true" final="true" visibility="public"
  20016. deprecated="not deprecated">
  20017. </field>
  20018. <field name="SCM_UPLOADER_SERVER_THREAD_COUNT" type="java.lang.String"
  20019. transient="false" volatile="false"
  20020. static="true" final="true" visibility="public"
  20021. deprecated="not deprecated">
  20022. <doc>
  20023. <![CDATA[The number of SCM threads used to handle notify requests from the node
  20024. manager.]]>
  20025. </doc>
  20026. </field>
  20027. <field name="DEFAULT_SCM_UPLOADER_SERVER_THREAD_COUNT" type="int"
  20028. transient="false" volatile="false"
  20029. static="true" final="true" visibility="public"
  20030. deprecated="not deprecated">
  20031. </field>
  20032. <field name="SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
  20033. transient="false" volatile="false"
  20034. static="true" final="true" visibility="public"
  20035. deprecated="not deprecated">
  20036. <doc>
  20037. <![CDATA[The address of the client interface in the SCM.]]>
  20038. </doc>
  20039. </field>
  20040. <field name="DEFAULT_SCM_CLIENT_SERVER_PORT" type="int"
  20041. transient="false" volatile="false"
  20042. static="true" final="true" visibility="public"
  20043. deprecated="not deprecated">
  20044. </field>
  20045. <field name="DEFAULT_SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
  20046. transient="false" volatile="false"
  20047. static="true" final="true" visibility="public"
  20048. deprecated="not deprecated">
  20049. </field>
  20050. <field name="SCM_CLIENT_SERVER_THREAD_COUNT" type="java.lang.String"
  20051. transient="false" volatile="false"
  20052. static="true" final="true" visibility="public"
  20053. deprecated="not deprecated">
  20054. <doc>
  20055. <![CDATA[The number of threads used to handle shared cache manager requests.]]>
  20056. </doc>
  20057. </field>
  20058. <field name="DEFAULT_SCM_CLIENT_SERVER_THREAD_COUNT" type="int"
  20059. transient="false" volatile="false"
  20060. static="true" final="true" visibility="public"
  20061. deprecated="not deprecated">
  20062. </field>
  20063. <field name="SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
  20064. transient="false" volatile="false"
  20065. static="true" final="true" visibility="public"
  20066. deprecated="not deprecated">
  20067. <doc>
  20068. <![CDATA[the checksum algorithm implementation]]>
  20069. </doc>
  20070. </field>
  20071. <field name="DEFAULT_SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
  20072. transient="false" volatile="false"
  20073. static="true" final="true" visibility="public"
  20074. deprecated="not deprecated">
  20075. </field>
  20076. <field name="SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="java.lang.String"
  20077. transient="false" volatile="false"
  20078. static="true" final="true" visibility="public"
  20079. deprecated="not deprecated">
  20080. <doc>
  20081. <![CDATA[The replication factor for the node manager uploader for the shared cache.]]>
  20082. </doc>
  20083. </field>
  20084. <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="int"
  20085. transient="false" volatile="false"
  20086. static="true" final="true" visibility="public"
  20087. deprecated="not deprecated">
  20088. </field>
  20089. <field name="SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="java.lang.String"
  20090. transient="false" volatile="false"
  20091. static="true" final="true" visibility="public"
  20092. deprecated="not deprecated">
  20093. </field>
  20094. <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="int"
  20095. transient="false" volatile="false"
  20096. static="true" final="true" visibility="public"
  20097. deprecated="not deprecated">
  20098. </field>
  20099. <field name="FEDERATION_PREFIX" type="java.lang.String"
  20100. transient="false" volatile="false"
  20101. static="true" final="true" visibility="public"
  20102. deprecated="not deprecated">
  20103. </field>
  20104. <field name="FEDERATION_ENABLED" type="java.lang.String"
  20105. transient="false" volatile="false"
  20106. static="true" final="true" visibility="public"
  20107. deprecated="not deprecated">
  20108. </field>
  20109. <field name="DEFAULT_FEDERATION_ENABLED" type="boolean"
  20110. transient="false" volatile="false"
  20111. static="true" final="true" visibility="public"
  20112. deprecated="not deprecated">
  20113. </field>
  20114. <field name="FEDERATION_FAILOVER_ENABLED" type="java.lang.String"
  20115. transient="false" volatile="false"
  20116. static="true" final="true" visibility="public"
  20117. deprecated="not deprecated">
  20118. </field>
  20119. <field name="DEFAULT_FEDERATION_FAILOVER_ENABLED" type="boolean"
  20120. transient="false" volatile="false"
  20121. static="true" final="true" visibility="public"
  20122. deprecated="not deprecated">
  20123. </field>
  20124. <field name="FEDERATION_STATESTORE_CLIENT_CLASS" type="java.lang.String"
  20125. transient="false" volatile="false"
  20126. static="true" final="true" visibility="public"
  20127. deprecated="not deprecated">
  20128. </field>
  20129. <field name="DEFAULT_FEDERATION_STATESTORE_CLIENT_CLASS" type="java.lang.String"
  20130. transient="false" volatile="false"
  20131. static="true" final="true" visibility="public"
  20132. deprecated="not deprecated">
  20133. </field>
  20134. <field name="FEDERATION_CACHE_TIME_TO_LIVE_SECS" type="java.lang.String"
  20135. transient="false" volatile="false"
  20136. static="true" final="true" visibility="public"
  20137. deprecated="not deprecated">
  20138. </field>
  20139. <field name="DEFAULT_FEDERATION_CACHE_TIME_TO_LIVE_SECS" type="int"
  20140. transient="false" volatile="false"
  20141. static="true" final="true" visibility="public"
  20142. deprecated="not deprecated">
  20143. </field>
  20144. <field name="FEDERATION_FLUSH_CACHE_FOR_RM_ADDR" type="java.lang.String"
  20145. transient="false" volatile="false"
  20146. static="true" final="true" visibility="public"
  20147. deprecated="not deprecated">
  20148. </field>
  20149. <field name="DEFAULT_FEDERATION_FLUSH_CACHE_FOR_RM_ADDR" type="boolean"
  20150. transient="false" volatile="false"
  20151. static="true" final="true" visibility="public"
  20152. deprecated="not deprecated">
  20153. </field>
  20154. <field name="FEDERATION_REGISTRY_BASE_KEY" type="java.lang.String"
  20155. transient="false" volatile="false"
  20156. static="true" final="true" visibility="public"
  20157. deprecated="not deprecated">
  20158. </field>
  20159. <field name="DEFAULT_FEDERATION_REGISTRY_BASE_KEY" type="java.lang.String"
  20160. transient="false" volatile="false"
  20161. static="true" final="true" visibility="public"
  20162. deprecated="not deprecated">
  20163. </field>
  20164. <field name="FEDERATION_STATESTORE_HEARTBEAT_INTERVAL_SECS" type="java.lang.String"
  20165. transient="false" volatile="false"
  20166. static="true" final="true" visibility="public"
  20167. deprecated="not deprecated">
  20168. </field>
  20169. <field name="DEFAULT_FEDERATION_STATESTORE_HEARTBEAT_INTERVAL_SECS" type="int"
  20170. transient="false" volatile="false"
  20171. static="true" final="true" visibility="public"
  20172. deprecated="not deprecated">
  20173. </field>
  20174. <field name="FEDERATION_MACHINE_LIST" type="java.lang.String"
  20175. transient="false" volatile="false"
  20176. static="true" final="true" visibility="public"
  20177. deprecated="not deprecated">
  20178. </field>
  20179. <field name="FEDERATION_CLUSTER_RESOLVER_CLASS" type="java.lang.String"
  20180. transient="false" volatile="false"
  20181. static="true" final="true" visibility="public"
  20182. deprecated="not deprecated">
  20183. </field>
  20184. <field name="DEFAULT_FEDERATION_CLUSTER_RESOLVER_CLASS" type="java.lang.String"
  20185. transient="false" volatile="false"
  20186. static="true" final="true" visibility="public"
  20187. deprecated="not deprecated">
  20188. </field>
  20189. <field name="FEDERATION_AMRMPROXY_HB_MAX_WAIT_MS" type="java.lang.String"
  20190. transient="false" volatile="false"
  20191. static="true" final="true" visibility="public"
  20192. deprecated="not deprecated">
  20193. </field>
  20194. <field name="DEFAULT_FEDERATION_AMRMPROXY_HB_MAX_WAIT_MS" type="long"
  20195. transient="false" volatile="false"
  20196. static="true" final="true" visibility="public"
  20197. deprecated="not deprecated">
  20198. </field>
  20199. <field name="FEDERATION_AMRMPROXY_SUBCLUSTER_TIMEOUT" type="java.lang.String"
  20200. transient="false" volatile="false"
  20201. static="true" final="true" visibility="public"
  20202. deprecated="not deprecated">
  20203. </field>
  20204. <field name="DEFAULT_FEDERATION_AMRMPROXY_SUBCLUSTER_TIMEOUT" type="long"
  20205. transient="false" volatile="false"
  20206. static="true" final="true" visibility="public"
  20207. deprecated="not deprecated">
  20208. </field>
  20209. <field name="DEFAULT_FEDERATION_POLICY_KEY" type="java.lang.String"
  20210. transient="false" volatile="false"
  20211. static="true" final="true" visibility="public"
  20212. deprecated="not deprecated">
  20213. </field>
  20214. <field name="FEDERATION_POLICY_MANAGER" type="java.lang.String"
  20215. transient="false" volatile="false"
  20216. static="true" final="true" visibility="public"
  20217. deprecated="not deprecated">
  20218. </field>
  20219. <field name="DEFAULT_FEDERATION_POLICY_MANAGER" type="java.lang.String"
  20220. transient="false" volatile="false"
  20221. static="true" final="true" visibility="public"
  20222. deprecated="not deprecated">
  20223. </field>
  20224. <field name="FEDERATION_POLICY_MANAGER_PARAMS" type="java.lang.String"
  20225. transient="false" volatile="false"
  20226. static="true" final="true" visibility="public"
  20227. deprecated="not deprecated">
  20228. </field>
  20229. <field name="DEFAULT_FEDERATION_POLICY_MANAGER_PARAMS" type="java.lang.String"
  20230. transient="false" volatile="false"
  20231. static="true" final="true" visibility="public"
  20232. deprecated="not deprecated">
  20233. </field>
  20234. <field name="FEDERATION_STATESTORE_ZK_PREFIX" type="java.lang.String"
  20235. transient="false" volatile="false"
  20236. static="true" final="true" visibility="public"
  20237. deprecated="not deprecated">
  20238. </field>
  20239. <field name="FEDERATION_STATESTORE_ZK_PARENT_PATH" type="java.lang.String"
  20240. transient="false" volatile="false"
  20241. static="true" final="true" visibility="public"
  20242. deprecated="not deprecated">
  20243. <doc>
  20244. <![CDATA[Parent znode path under which ZKRMStateStore will create znodes.]]>
  20245. </doc>
  20246. </field>
  20247. <field name="DEFAULT_FEDERATION_STATESTORE_ZK_PARENT_PATH" type="java.lang.String"
  20248. transient="false" volatile="false"
  20249. static="true" final="true" visibility="public"
  20250. deprecated="not deprecated">
  20251. </field>
  20252. <field name="FEDERATION_STATESTORE_SQL_USERNAME" type="java.lang.String"
  20253. transient="false" volatile="false"
  20254. static="true" final="true" visibility="public"
  20255. deprecated="not deprecated">
  20256. </field>
  20257. <field name="FEDERATION_STATESTORE_SQL_PASSWORD" type="java.lang.String"
  20258. transient="false" volatile="false"
  20259. static="true" final="true" visibility="public"
  20260. deprecated="not deprecated">
  20261. </field>
  20262. <field name="FEDERATION_STATESTORE_SQL_URL" type="java.lang.String"
  20263. transient="false" volatile="false"
  20264. static="true" final="true" visibility="public"
  20265. deprecated="not deprecated">
  20266. </field>
  20267. <field name="FEDERATION_STATESTORE_SQL_JDBC_CLASS" type="java.lang.String"
  20268. transient="false" volatile="false"
  20269. static="true" final="true" visibility="public"
  20270. deprecated="not deprecated">
  20271. </field>
  20272. <field name="DEFAULT_FEDERATION_STATESTORE_SQL_JDBC_CLASS" type="java.lang.String"
  20273. transient="false" volatile="false"
  20274. static="true" final="true" visibility="public"
  20275. deprecated="not deprecated">
  20276. </field>
  20277. <field name="FEDERATION_STATESTORE_SQL_MAXCONNECTIONS" type="java.lang.String"
  20278. transient="false" volatile="false"
  20279. static="true" final="true" visibility="public"
  20280. deprecated="not deprecated">
  20281. </field>
  20282. <field name="DEFAULT_FEDERATION_STATESTORE_SQL_MAXCONNECTIONS" type="int"
  20283. transient="false" volatile="false"
  20284. static="true" final="true" visibility="public"
  20285. deprecated="not deprecated">
  20286. </field>
  20287. <field name="ROUTER_PREFIX" type="java.lang.String"
  20288. transient="false" volatile="false"
  20289. static="true" final="true" visibility="public"
  20290. deprecated="not deprecated">
  20291. </field>
  20292. <field name="ROUTER_BIND_HOST" type="java.lang.String"
  20293. transient="false" volatile="false"
  20294. static="true" final="true" visibility="public"
  20295. deprecated="not deprecated">
  20296. </field>
  20297. <field name="ROUTER_CLIENTRM_PREFIX" type="java.lang.String"
  20298. transient="false" volatile="false"
  20299. static="true" final="true" visibility="public"
  20300. deprecated="not deprecated">
  20301. </field>
  20302. <field name="ROUTER_CLIENTRM_ADDRESS" type="java.lang.String"
  20303. transient="false" volatile="false"
  20304. static="true" final="true" visibility="public"
  20305. deprecated="not deprecated">
  20306. </field>
  20307. <field name="DEFAULT_ROUTER_CLIENTRM_PORT" type="int"
  20308. transient="false" volatile="false"
  20309. static="true" final="true" visibility="public"
  20310. deprecated="not deprecated">
  20311. </field>
  20312. <field name="DEFAULT_ROUTER_CLIENTRM_ADDRESS" type="java.lang.String"
  20313. transient="false" volatile="false"
  20314. static="true" final="true" visibility="public"
  20315. deprecated="not deprecated">
  20316. </field>
  20317. <field name="ROUTER_CLIENTRM_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  20318. transient="false" volatile="false"
  20319. static="true" final="true" visibility="public"
  20320. deprecated="not deprecated">
  20321. </field>
  20322. <field name="DEFAULT_ROUTER_CLIENTRM_INTERCEPTOR_CLASS" type="java.lang.String"
  20323. transient="false" volatile="false"
  20324. static="true" final="true" visibility="public"
  20325. deprecated="not deprecated">
  20326. </field>
  20327. <field name="ROUTER_PIPELINE_CACHE_MAX_SIZE" type="java.lang.String"
  20328. transient="false" volatile="false"
  20329. static="true" final="true" visibility="public"
  20330. deprecated="not deprecated">
  20331. </field>
  20332. <field name="DEFAULT_ROUTER_PIPELINE_CACHE_MAX_SIZE" type="int"
  20333. transient="false" volatile="false"
  20334. static="true" final="true" visibility="public"
  20335. deprecated="not deprecated">
  20336. </field>
  20337. <field name="ROUTER_RMADMIN_PREFIX" type="java.lang.String"
  20338. transient="false" volatile="false"
  20339. static="true" final="true" visibility="public"
  20340. deprecated="not deprecated">
  20341. </field>
  20342. <field name="ROUTER_RMADMIN_ADDRESS" type="java.lang.String"
  20343. transient="false" volatile="false"
  20344. static="true" final="true" visibility="public"
  20345. deprecated="not deprecated">
  20346. </field>
  20347. <field name="DEFAULT_ROUTER_RMADMIN_PORT" type="int"
  20348. transient="false" volatile="false"
  20349. static="true" final="true" visibility="public"
  20350. deprecated="not deprecated">
  20351. </field>
  20352. <field name="DEFAULT_ROUTER_RMADMIN_ADDRESS" type="java.lang.String"
  20353. transient="false" volatile="false"
  20354. static="true" final="true" visibility="public"
  20355. deprecated="not deprecated">
  20356. </field>
  20357. <field name="ROUTER_RMADMIN_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  20358. transient="false" volatile="false"
  20359. static="true" final="true" visibility="public"
  20360. deprecated="not deprecated">
  20361. </field>
  20362. <field name="DEFAULT_ROUTER_RMADMIN_INTERCEPTOR_CLASS" type="java.lang.String"
  20363. transient="false" volatile="false"
  20364. static="true" final="true" visibility="public"
  20365. deprecated="not deprecated">
  20366. </field>
  20367. <field name="ROUTER_CLIENTRM_SUBMIT_RETRY" type="java.lang.String"
  20368. transient="false" volatile="false"
  20369. static="true" final="true" visibility="public"
  20370. deprecated="not deprecated">
  20371. <doc>
  20372. <![CDATA[The number of retries for GetNewApplication and SubmitApplication in
  20373. {@code FederationClientInterceptor}.]]>
  20374. </doc>
  20375. </field>
  20376. <field name="DEFAULT_ROUTER_CLIENTRM_SUBMIT_RETRY" type="int"
  20377. transient="false" volatile="false"
  20378. static="true" final="true" visibility="public"
  20379. deprecated="not deprecated">
  20380. </field>
  20381. <field name="ROUTER_WEBAPP_PREFIX" type="java.lang.String"
  20382. transient="false" volatile="false"
  20383. static="true" final="true" visibility="public"
  20384. deprecated="not deprecated">
  20385. </field>
  20386. <field name="ROUTER_WEBAPP_ADDRESS" type="java.lang.String"
  20387. transient="false" volatile="false"
  20388. static="true" final="true" visibility="public"
  20389. deprecated="not deprecated">
  20390. <doc>
  20391. <![CDATA[The address of the Router web application.]]>
  20392. </doc>
  20393. </field>
  20394. <field name="DEFAULT_ROUTER_WEBAPP_PORT" type="int"
  20395. transient="false" volatile="false"
  20396. static="true" final="true" visibility="public"
  20397. deprecated="not deprecated">
  20398. </field>
  20399. <field name="DEFAULT_ROUTER_WEBAPP_ADDRESS" type="java.lang.String"
  20400. transient="false" volatile="false"
  20401. static="true" final="true" visibility="public"
  20402. deprecated="not deprecated">
  20403. </field>
  20404. <field name="ROUTER_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  20405. transient="false" volatile="false"
  20406. static="true" final="true" visibility="public"
  20407. deprecated="not deprecated">
  20408. <doc>
  20409. <![CDATA[The https address of the Router web application.]]>
  20410. </doc>
  20411. </field>
  20412. <field name="DEFAULT_ROUTER_WEBAPP_HTTPS_PORT" type="int"
  20413. transient="false" volatile="false"
  20414. static="true" final="true" visibility="public"
  20415. deprecated="not deprecated">
  20416. </field>
  20417. <field name="DEFAULT_ROUTER_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  20418. transient="false" volatile="false"
  20419. static="true" final="true" visibility="public"
  20420. deprecated="not deprecated">
  20421. </field>
  20422. <field name="ROUTER_WEBAPP_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
  20423. transient="false" volatile="false"
  20424. static="true" final="true" visibility="public"
  20425. deprecated="not deprecated">
  20426. </field>
  20427. <field name="DEFAULT_ROUTER_WEBAPP_INTERCEPTOR_CLASS" type="java.lang.String"
  20428. transient="false" volatile="false"
  20429. static="true" final="true" visibility="public"
  20430. deprecated="not deprecated">
  20431. </field>
  20432. <field name="ROUTER_WEBAPP_DEFAULT_INTERCEPTOR_CLASS" type="java.lang.String"
  20433. transient="false" volatile="false"
  20434. static="true" final="true" visibility="public"
  20435. deprecated="not deprecated">
  20436. <doc>
  20437. <![CDATA[The interceptor class used in FederationInterceptorREST to communicate with
  20438. each SubCluster.]]>
  20439. </doc>
  20440. </field>
  20441. <field name="DEFAULT_ROUTER_WEBAPP_DEFAULT_INTERCEPTOR_CLASS" type="java.lang.String"
  20442. transient="false" volatile="false"
  20443. static="true" final="true" visibility="public"
  20444. deprecated="not deprecated">
  20445. </field>
  20446. <field name="ROUTER_WEBAPP_PARTIAL_RESULTS_ENABLED" type="java.lang.String"
  20447. transient="false" volatile="false"
  20448. static="true" final="true" visibility="public"
  20449. deprecated="not deprecated">
  20450. <doc>
  20451. <![CDATA[The interceptor class used in FederationInterceptorREST should return
  20452. partial AppReports.]]>
  20453. </doc>
  20454. </field>
  20455. <field name="DEFAULT_ROUTER_WEBAPP_PARTIAL_RESULTS_ENABLED" type="boolean"
  20456. transient="false" volatile="false"
  20457. static="true" final="true" visibility="public"
  20458. deprecated="not deprecated">
  20459. </field>
  20460. <field name="YARN_REGISTRY_CLASS" type="java.lang.String"
  20461. transient="false" volatile="false"
  20462. static="true" final="true" visibility="public"
  20463. deprecated="not deprecated">
  20464. </field>
  20465. <field name="DEFAULT_YARN_REGISTRY_CLASS" type="java.lang.String"
  20466. transient="false" volatile="false"
  20467. static="true" final="true" visibility="public"
  20468. deprecated="not deprecated">
  20469. </field>
  20470. <field name="YARN_CLIENT_APP_SUBMISSION_POLL_INTERVAL_MS" type="java.lang.String"
  20471. transient="false" volatile="false"
  20472. static="true" final="true" visibility="public"
  20473. deprecated="not deprecated">
  20474. <doc>
  20475. <![CDATA[Use YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS instead.
  20476. The interval of the yarn client's querying application state after
  20477. application submission. The unit is millisecond.]]>
  20478. </doc>
  20479. </field>
  20480. <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="java.lang.String"
  20481. transient="false" volatile="false"
  20482. static="true" final="true" visibility="public"
  20483. deprecated="not deprecated">
  20484. <doc>
  20485. <![CDATA[The interval that the yarn client library uses to poll the completion
  20486. status of the asynchronous API of application client protocol.]]>
  20487. </doc>
  20488. </field>
  20489. <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="long"
  20490. transient="false" volatile="false"
  20491. static="true" final="true" visibility="public"
  20492. deprecated="not deprecated">
  20493. </field>
  20494. <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="java.lang.String"
  20495. transient="false" volatile="false"
  20496. static="true" final="true" visibility="public"
  20497. deprecated="not deprecated">
  20498. <doc>
  20499. <![CDATA[The duration that the yarn client library waits, cumulatively across polls,
  20500. for an expected state change to occur. Defaults to -1, which indicates no
  20501. limit.]]>
  20502. </doc>
  20503. </field>
  20504. <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="long"
  20505. transient="false" volatile="false"
  20506. static="true" final="true" visibility="public"
  20507. deprecated="not deprecated">
  20508. </field>
  20509. <field name="NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="java.lang.String"
  20510. transient="false" volatile="false"
  20511. static="true" final="true" visibility="public"
  20512. deprecated="not deprecated">
  20513. <doc>
  20514. <![CDATA[Max number of threads in NMClientAsync to process container management
  20515. events]]>
  20516. </doc>
  20517. </field>
  20518. <field name="DEFAULT_NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="int"
  20519. transient="false" volatile="false"
  20520. static="true" final="true" visibility="public"
  20521. deprecated="not deprecated">
  20522. </field>
  20523. <field name="NM_CLIENT_MAX_NM_PROXIES" type="java.lang.String"
  20524. transient="false" volatile="false"
  20525. static="true" final="true" visibility="public"
  20526. deprecated="not deprecated">
  20527. <doc>
  20528. <![CDATA[Maximum number of proxy connections to cache for node managers. If set
  20529. to a value greater than zero then the cache is enabled and the NMClient
  20530. and MRAppMaster will cache the specified number of node manager proxies.
  20531. There will be at max one proxy per node manager. Ex. configuring it to a
  20532. value of 5 will make sure that client will at max have 5 proxies cached
  20533. with 5 different node managers. These connections for these proxies will
  20534. be timed out if idle for more than the system wide idle timeout period.
  20535. Note that this could cause issues on large clusters as many connections
  20536. could linger simultaneously and lead to a large number of connection
  20537. threads. The token used for authentication will be used only at
  20538. connection creation time. If a new token is received then the earlier
  20539. connection should be closed in order to use the new token. This and
  20540. {@link YarnConfiguration#NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE} are related
  20541. and should be in sync (no need for them to be equal).
  20542. If the value of this property is zero then the connection cache is
  20543. disabled and connections will use a zero idle timeout to prevent too
  20544. many connection threads on large clusters.]]>
  20545. </doc>
  20546. </field>
  20547. <field name="DEFAULT_NM_CLIENT_MAX_NM_PROXIES" type="int"
  20548. transient="false" volatile="false"
  20549. static="true" final="true" visibility="public"
  20550. deprecated="not deprecated">
  20551. </field>
  20552. <field name="CLIENT_NM_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  20553. transient="false" volatile="false"
  20554. static="true" final="true" visibility="public"
  20555. deprecated="not deprecated">
  20556. <doc>
  20557. <![CDATA[Max time to wait to establish a connection to NM]]>
  20558. </doc>
  20559. </field>
  20560. <field name="DEFAULT_CLIENT_NM_CONNECT_MAX_WAIT_MS" type="long"
  20561. transient="false" volatile="false"
  20562. static="true" final="true" visibility="public"
  20563. deprecated="not deprecated">
  20564. </field>
  20565. <field name="CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  20566. transient="false" volatile="false"
  20567. static="true" final="true" visibility="public"
  20568. deprecated="not deprecated">
  20569. <doc>
  20570. <![CDATA[Time interval between each attempt to connect to NM]]>
  20571. </doc>
  20572. </field>
  20573. <field name="DEFAULT_CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="long"
  20574. transient="false" volatile="false"
  20575. static="true" final="true" visibility="public"
  20576. deprecated="not deprecated">
  20577. </field>
  20578. <field name="YARN_HTTP_POLICY_KEY" type="java.lang.String"
  20579. transient="false" volatile="false"
  20580. static="true" final="true" visibility="public"
  20581. deprecated="not deprecated">
  20582. </field>
  20583. <field name="YARN_HTTP_POLICY_DEFAULT" type="java.lang.String"
  20584. transient="false" volatile="false"
  20585. static="true" final="true" visibility="public"
  20586. deprecated="not deprecated">
  20587. </field>
  20588. <field name="NM_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  20589. transient="false" volatile="false"
  20590. static="true" final="true" visibility="public"
  20591. deprecated="not deprecated">
  20592. <doc>
  20593. <![CDATA[Max time to wait for NM to connection to RM.
  20594. When not set, proxy will fall back to use value of
  20595. RESOURCEMANAGER_CONNECT_MAX_WAIT_MS.]]>
  20596. </doc>
  20597. </field>
  20598. <field name="NM_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  20599. transient="false" volatile="false"
  20600. static="true" final="true" visibility="public"
  20601. deprecated="not deprecated">
  20602. <doc>
  20603. <![CDATA[Time interval between each NM attempt to connection to RM.
  20604. When not set, proxy will fall back to use value of
  20605. RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS.]]>
  20606. </doc>
  20607. </field>
  20608. <field name="NODE_LABELS_PREFIX" type="java.lang.String"
  20609. transient="false" volatile="false"
  20610. static="true" final="true" visibility="public"
  20611. deprecated="not deprecated">
  20612. <doc>
  20613. <![CDATA[Node-labels configurations]]>
  20614. </doc>
  20615. </field>
  20616. <field name="FS_NODE_LABELS_STORE_IMPL_CLASS" type="java.lang.String"
  20617. transient="false" volatile="false"
  20618. static="true" final="true" visibility="public"
  20619. deprecated="not deprecated">
  20620. <doc>
  20621. <![CDATA[Node label store implementation class]]>
  20622. </doc>
  20623. </field>
  20624. <field name="DEFAULT_FS_NODE_LABELS_STORE_IMPL_CLASS" type="java.lang.String"
  20625. transient="false" volatile="false"
  20626. static="true" final="true" visibility="public"
  20627. deprecated="not deprecated">
  20628. </field>
  20629. <field name="FS_NODE_LABELS_STORE_ROOT_DIR" type="java.lang.String"
  20630. transient="false" volatile="false"
  20631. static="true" final="true" visibility="public"
  20632. deprecated="not deprecated">
  20633. <doc>
  20634. <![CDATA[URI for NodeLabelManager]]>
  20635. </doc>
  20636. </field>
  20637. <field name="FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  20638. transient="false" volatile="false"
  20639. static="true" final="true" visibility="public"
  20640. deprecated="not deprecated">
  20641. </field>
  20642. <field name="DEFAULT_FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  20643. transient="false" volatile="false"
  20644. static="true" final="true" visibility="public"
  20645. deprecated="not deprecated">
  20646. </field>
  20647. <field name="NODE_LABELS_ENABLED" type="java.lang.String"
  20648. transient="false" volatile="false"
  20649. static="true" final="true" visibility="public"
  20650. deprecated="not deprecated">
  20651. <doc>
  20652. <![CDATA[Flag to indicate if the node labels feature enabled, by default it's
  20653. disabled]]>
  20654. </doc>
  20655. </field>
  20656. <field name="DEFAULT_NODE_LABELS_ENABLED" type="boolean"
  20657. transient="false" volatile="false"
  20658. static="true" final="true" visibility="public"
  20659. deprecated="not deprecated">
  20660. </field>
  20661. <field name="NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  20662. transient="false" volatile="false"
  20663. static="true" final="true" visibility="public"
  20664. deprecated="not deprecated">
  20665. </field>
  20666. <field name="CENTRALIZED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  20667. transient="false" volatile="false"
  20668. static="true" final="true" visibility="public"
  20669. deprecated="not deprecated">
  20670. </field>
  20671. <field name="DELEGATED_CENTALIZED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  20672. transient="false" volatile="false"
  20673. static="true" final="true" visibility="public"
  20674. deprecated="not deprecated">
  20675. </field>
  20676. <field name="DISTRIBUTED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  20677. transient="false" volatile="false"
  20678. static="true" final="true" visibility="public"
  20679. deprecated="not deprecated">
  20680. </field>
  20681. <field name="DEFAULT_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
  20682. transient="false" volatile="false"
  20683. static="true" final="true" visibility="public"
  20684. deprecated="not deprecated">
  20685. </field>
  20686. <field name="EXCLUSIVE_ENFORCED_PARTITIONS_SUFFIX" type="java.lang.String"
  20687. transient="false" volatile="false"
  20688. static="true" final="true" visibility="public"
  20689. deprecated="not deprecated">
  20690. </field>
  20691. <field name="EXCLUSIVE_ENFORCED_PARTITIONS" type="java.lang.String"
  20692. transient="false" volatile="false"
  20693. static="true" final="true" visibility="public"
  20694. deprecated="not deprecated">
  20695. </field>
  20696. <field name="MAX_CLUSTER_LEVEL_APPLICATION_PRIORITY" type="java.lang.String"
  20697. transient="false" volatile="false"
  20698. static="true" final="true" visibility="public"
  20699. deprecated="not deprecated">
  20700. </field>
  20701. <field name="DEFAULT_CLUSTER_LEVEL_APPLICATION_PRIORITY" type="int"
  20702. transient="false" volatile="false"
  20703. static="true" final="true" visibility="public"
  20704. deprecated="not deprecated">
  20705. </field>
  20706. <field name="APP_ATTEMPT_DIAGNOSTICS_LIMIT_KC" type="java.lang.String"
  20707. transient="false" volatile="false"
  20708. static="true" final="true" visibility="public"
  20709. deprecated="not deprecated">
  20710. </field>
  20711. <field name="DEFAULT_APP_ATTEMPT_DIAGNOSTICS_LIMIT_KC" type="int"
  20712. transient="false" volatile="false"
  20713. static="true" final="true" visibility="public"
  20714. deprecated="not deprecated">
  20715. </field>
  20716. <field name="NM_NODE_LABELS_PROVIDER_CONFIG" type="java.lang.String"
  20717. transient="false" volatile="false"
  20718. static="true" final="true" visibility="public"
  20719. deprecated="not deprecated">
  20720. </field>
  20721. <field name="CONFIG_NODE_LABELS_PROVIDER" type="java.lang.String"
  20722. transient="false" volatile="false"
  20723. static="true" final="true" visibility="public"
  20724. deprecated="not deprecated">
  20725. </field>
  20726. <field name="SCRIPT_NODE_LABELS_PROVIDER" type="java.lang.String"
  20727. transient="false" volatile="false"
  20728. static="true" final="true" visibility="public"
  20729. deprecated="not deprecated">
  20730. </field>
  20731. <field name="NM_NODE_LABELS_RESYNC_INTERVAL" type="java.lang.String"
  20732. transient="false" volatile="false"
  20733. static="true" final="true" visibility="public"
  20734. deprecated="not deprecated">
  20735. </field>
  20736. <field name="DEFAULT_NM_NODE_LABELS_RESYNC_INTERVAL" type="long"
  20737. transient="false" volatile="false"
  20738. static="true" final="true" visibility="public"
  20739. deprecated="not deprecated">
  20740. </field>
  20741. <field name="NM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="java.lang.String"
  20742. transient="false" volatile="false"
  20743. static="true" final="true" visibility="public"
  20744. deprecated="not deprecated">
  20745. </field>
  20746. <field name="NM_NODE_LABELS_PROVIDER_FETCH_TIMEOUT_MS" type="java.lang.String"
  20747. transient="false" volatile="false"
  20748. static="true" final="true" visibility="public"
  20749. deprecated="not deprecated">
  20750. </field>
  20751. <field name="DEFAULT_NM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="long"
  20752. transient="false" volatile="false"
  20753. static="true" final="true" visibility="public"
  20754. deprecated="not deprecated">
  20755. </field>
  20756. <field name="DEFAULT_NM_NODE_LABELS_PROVIDER_FETCH_TIMEOUT_MS" type="long"
  20757. transient="false" volatile="false"
  20758. static="true" final="true" visibility="public"
  20759. deprecated="not deprecated">
  20760. </field>
  20761. <field name="NM_PROVIDER_CONFIGURED_NODE_PARTITION" type="java.lang.String"
  20762. transient="false" volatile="false"
  20763. static="true" final="true" visibility="public"
  20764. deprecated="not deprecated">
  20765. </field>
  20766. <field name="RM_NODE_LABELS_PROVIDER_CONFIG" type="java.lang.String"
  20767. transient="false" volatile="false"
  20768. static="true" final="true" visibility="public"
  20769. deprecated="not deprecated">
  20770. </field>
  20771. <field name="RM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="java.lang.String"
  20772. transient="false" volatile="false"
  20773. static="true" final="true" visibility="public"
  20774. deprecated="not deprecated">
  20775. </field>
  20776. <field name="DEFAULT_RM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="long"
  20777. transient="false" volatile="false"
  20778. static="true" final="true" visibility="public"
  20779. deprecated="not deprecated">
  20780. </field>
  20781. <field name="AM_SCHEDULING_NODE_BLACKLISTING_ENABLED" type="java.lang.String"
  20782. transient="false" volatile="false"
  20783. static="true" final="true" visibility="public"
  20784. deprecated="not deprecated">
  20785. </field>
  20786. <field name="DEFAULT_AM_SCHEDULING_NODE_BLACKLISTING_ENABLED" type="boolean"
  20787. transient="false" volatile="false"
  20788. static="true" final="true" visibility="public"
  20789. deprecated="not deprecated">
  20790. </field>
  20791. <field name="AM_SCHEDULING_NODE_BLACKLISTING_DISABLE_THRESHOLD" type="java.lang.String"
  20792. transient="false" volatile="false"
  20793. static="true" final="true" visibility="public"
  20794. deprecated="not deprecated">
  20795. </field>
  20796. <field name="DEFAULT_AM_SCHEDULING_NODE_BLACKLISTING_DISABLE_THRESHOLD" type="float"
  20797. transient="false" volatile="false"
  20798. static="true" final="true" visibility="public"
  20799. deprecated="not deprecated">
  20800. </field>
  20801. <field name="NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_PATH" type="java.lang.String"
  20802. transient="false" volatile="false"
  20803. static="true" final="true" visibility="public"
  20804. deprecated="not deprecated">
  20805. </field>
  20806. <field name="NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_SCRIPT_OPTS" type="java.lang.String"
  20807. transient="false" volatile="false"
  20808. static="true" final="true" visibility="public"
  20809. deprecated="not deprecated">
  20810. </field>
  20811. <field name="DISPLAY_APPS_FOR_LOGGED_IN_USER" type="java.lang.String"
  20812. transient="false" volatile="false"
  20813. static="true" final="true" visibility="public"
  20814. deprecated="not deprecated">
  20815. </field>
  20816. <field name="DEFAULT_DISPLAY_APPS_FOR_LOGGED_IN_USER" type="boolean"
  20817. transient="false" volatile="false"
  20818. static="true" final="true" visibility="public"
  20819. deprecated="not deprecated">
  20820. </field>
  20821. <field name="REST_CSRF" type="java.lang.String"
  20822. transient="false" volatile="false"
  20823. static="true" final="true" visibility="public"
  20824. deprecated="not deprecated">
  20825. </field>
  20826. <field name="RM_CSRF_PREFIX" type="java.lang.String"
  20827. transient="false" volatile="false"
  20828. static="true" final="true" visibility="public"
  20829. deprecated="not deprecated">
  20830. </field>
  20831. <field name="NM_CSRF_PREFIX" type="java.lang.String"
  20832. transient="false" volatile="false"
  20833. static="true" final="true" visibility="public"
  20834. deprecated="not deprecated">
  20835. </field>
  20836. <field name="TIMELINE_CSRF_PREFIX" type="java.lang.String"
  20837. transient="false" volatile="false"
  20838. static="true" final="true" visibility="public"
  20839. deprecated="not deprecated">
  20840. </field>
  20841. <field name="RM_CSRF_ENABLED" type="java.lang.String"
  20842. transient="false" volatile="false"
  20843. static="true" final="true" visibility="public"
  20844. deprecated="not deprecated">
  20845. </field>
  20846. <field name="NM_CSRF_ENABLED" type="java.lang.String"
  20847. transient="false" volatile="false"
  20848. static="true" final="true" visibility="public"
  20849. deprecated="not deprecated">
  20850. </field>
  20851. <field name="TIMELINE_CSRF_ENABLED" type="java.lang.String"
  20852. transient="false" volatile="false"
  20853. static="true" final="true" visibility="public"
  20854. deprecated="not deprecated">
  20855. </field>
  20856. <field name="RM_CSRF_CUSTOM_HEADER" type="java.lang.String"
  20857. transient="false" volatile="false"
  20858. static="true" final="true" visibility="public"
  20859. deprecated="not deprecated">
  20860. </field>
  20861. <field name="NM_CSRF_CUSTOM_HEADER" type="java.lang.String"
  20862. transient="false" volatile="false"
  20863. static="true" final="true" visibility="public"
  20864. deprecated="not deprecated">
  20865. </field>
  20866. <field name="TIMELINE_CSRF_CUSTOM_HEADER" type="java.lang.String"
  20867. transient="false" volatile="false"
  20868. static="true" final="true" visibility="public"
  20869. deprecated="not deprecated">
  20870. </field>
  20871. <field name="RM_CSRF_METHODS_TO_IGNORE" type="java.lang.String"
  20872. transient="false" volatile="false"
  20873. static="true" final="true" visibility="public"
  20874. deprecated="not deprecated">
  20875. </field>
  20876. <field name="NM_CSRF_METHODS_TO_IGNORE" type="java.lang.String"
  20877. transient="false" volatile="false"
  20878. static="true" final="true" visibility="public"
  20879. deprecated="not deprecated">
  20880. </field>
  20881. <field name="TIMELINE_CSRF_METHODS_TO_IGNORE" type="java.lang.String"
  20882. transient="false" volatile="false"
  20883. static="true" final="true" visibility="public"
  20884. deprecated="not deprecated">
  20885. </field>
  20886. <field name="XFS" type="java.lang.String"
  20887. transient="false" volatile="false"
  20888. static="true" final="true" visibility="public"
  20889. deprecated="not deprecated">
  20890. </field>
  20891. <field name="YARN_XFS_ENABLED" type="java.lang.String"
  20892. transient="false" volatile="false"
  20893. static="true" final="true" visibility="public"
  20894. deprecated="not deprecated">
  20895. </field>
  20896. <field name="RM_XFS_PREFIX" type="java.lang.String"
  20897. transient="false" volatile="false"
  20898. static="true" final="true" visibility="public"
  20899. deprecated="not deprecated">
  20900. </field>
  20901. <field name="NM_XFS_PREFIX" type="java.lang.String"
  20902. transient="false" volatile="false"
  20903. static="true" final="true" visibility="public"
  20904. deprecated="not deprecated">
  20905. </field>
  20906. <field name="TIMELINE_XFS_PREFIX" type="java.lang.String"
  20907. transient="false" volatile="false"
  20908. static="true" final="true" visibility="public"
  20909. deprecated="not deprecated">
  20910. </field>
  20911. <field name="RM_XFS_OPTIONS" type="java.lang.String"
  20912. transient="false" volatile="false"
  20913. static="true" final="true" visibility="public"
  20914. deprecated="not deprecated">
  20915. </field>
  20916. <field name="NM_XFS_OPTIONS" type="java.lang.String"
  20917. transient="false" volatile="false"
  20918. static="true" final="true" visibility="public"
  20919. deprecated="not deprecated">
  20920. </field>
  20921. <field name="TIMELINE_XFS_OPTIONS" type="java.lang.String"
  20922. transient="false" volatile="false"
  20923. static="true" final="true" visibility="public"
  20924. deprecated="not deprecated">
  20925. </field>
  20926. <field name="TIMELINE_SERVICE_READER_BIND_HOST" type="java.lang.String"
  20927. transient="false" volatile="false"
  20928. static="true" final="true" visibility="public"
  20929. deprecated="not deprecated">
  20930. <doc>
  20931. <![CDATA[Settings for timeline reader.]]>
  20932. </doc>
  20933. </field>
  20934. <field name="TIMELINE_SERVICE_READER_WEBAPP_ADDRESS" type="java.lang.String"
  20935. transient="false" volatile="false"
  20936. static="true" final="true" visibility="public"
  20937. deprecated="not deprecated">
  20938. </field>
  20939. <field name="DEFAULT_TIMELINE_SERVICE_READER_WEBAPP_ADDRESS" type="java.lang.String"
  20940. transient="false" volatile="false"
  20941. static="true" final="true" visibility="public"
  20942. deprecated="not deprecated">
  20943. </field>
  20944. <field name="TIMELINE_SERVICE_READER_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  20945. transient="false" volatile="false"
  20946. static="true" final="true" visibility="public"
  20947. deprecated="not deprecated">
  20948. </field>
  20949. <field name="DEFAULT_TIMELINE_SERVICE_READER_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  20950. transient="false" volatile="false"
  20951. static="true" final="true" visibility="public"
  20952. deprecated="not deprecated">
  20953. </field>
  20954. <field name="TIMELINE_SERVICE_COLLECTOR_PREFIX" type="java.lang.String"
  20955. transient="false" volatile="false"
  20956. static="true" final="true" visibility="public"
  20957. deprecated="not deprecated">
  20958. <doc>
  20959. <![CDATA[Marked collector properties as Private since it run as auxillary service.]]>
  20960. </doc>
  20961. </field>
  20962. <field name="TIMELINE_SERVICE_COLLECTOR_BIND_HOST" type="java.lang.String"
  20963. transient="false" volatile="false"
  20964. static="true" final="true" visibility="public"
  20965. deprecated="not deprecated">
  20966. </field>
  20967. <field name="TIMELINE_SERVICE_COLLECTOR_WEBAPP_ADDRESS" type="java.lang.String"
  20968. transient="false" volatile="false"
  20969. static="true" final="true" visibility="public"
  20970. deprecated="not deprecated">
  20971. </field>
  20972. <field name="DEFAULT_TIMELINE_SERVICE_COLLECTOR_WEBAPP_ADDRESS" type="java.lang.String"
  20973. transient="false" volatile="false"
  20974. static="true" final="true" visibility="public"
  20975. deprecated="not deprecated">
  20976. </field>
  20977. <field name="TIMELINE_SERVICE_COLLECTOR_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  20978. transient="false" volatile="false"
  20979. static="true" final="true" visibility="public"
  20980. deprecated="not deprecated">
  20981. </field>
  20982. <field name="DEFAULT_TIMELINE_SERVICE_COLLECTOR_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  20983. transient="false" volatile="false"
  20984. static="true" final="true" visibility="public"
  20985. deprecated="not deprecated">
  20986. </field>
  20987. <field name="NM_CONTAINERS_LAUNCHER_CLASS" type="java.lang.String"
  20988. transient="false" volatile="false"
  20989. static="true" final="true" visibility="public"
  20990. deprecated="not deprecated">
  20991. <doc>
  20992. <![CDATA[Containers launcher implementation to use.]]>
  20993. </doc>
  20994. </field>
  20995. <field name="YARN_WORKFLOW_ID_TAG_PREFIX" type="java.lang.String"
  20996. transient="false" volatile="false"
  20997. static="true" final="true" visibility="public"
  20998. deprecated="not deprecated">
  20999. </field>
  21000. <field name="DEFAULT_YARN_WORKFLOW_ID_TAG_PREFIX" type="java.lang.String"
  21001. transient="false" volatile="false"
  21002. static="true" final="true" visibility="public"
  21003. deprecated="not deprecated">
  21004. </field>
  21005. </class>
  21006. <!-- end class org.apache.hadoop.yarn.conf.YarnConfiguration -->
  21007. </package>
  21008. <package name="org.apache.hadoop.yarn.exceptions">
  21009. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
  21010. <class name="ApplicationAttemptNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  21011. abstract="false"
  21012. static="false" final="false" visibility="public"
  21013. deprecated="not deprecated">
  21014. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.Throwable"
  21015. static="false" final="false" visibility="public"
  21016. deprecated="not deprecated">
  21017. </constructor>
  21018. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String"
  21019. static="false" final="false" visibility="public"
  21020. deprecated="not deprecated">
  21021. </constructor>
  21022. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String, java.lang.Throwable"
  21023. static="false" final="false" visibility="public"
  21024. deprecated="not deprecated">
  21025. </constructor>
  21026. <doc>
  21027. <![CDATA[This exception is thrown on
  21028. {@link ApplicationHistoryProtocol#getApplicationAttemptReport (GetApplicationAttemptReportRequest)}
  21029. API when the Application Attempt doesn't exist in Application History Server or
  21030. {@link ApplicationMasterProtocol#allocate(AllocateRequest)} if application
  21031. doesn't exist in RM.]]>
  21032. </doc>
  21033. </class>
  21034. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
  21035. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
  21036. <class name="ApplicationIdNotProvidedException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  21037. abstract="false"
  21038. static="false" final="false" visibility="public"
  21039. deprecated="not deprecated">
  21040. <constructor name="ApplicationIdNotProvidedException" type="java.lang.Throwable"
  21041. static="false" final="false" visibility="public"
  21042. deprecated="not deprecated">
  21043. </constructor>
  21044. <constructor name="ApplicationIdNotProvidedException" type="java.lang.String"
  21045. static="false" final="false" visibility="public"
  21046. deprecated="not deprecated">
  21047. </constructor>
  21048. <constructor name="ApplicationIdNotProvidedException" type="java.lang.String, java.lang.Throwable"
  21049. static="false" final="false" visibility="public"
  21050. deprecated="not deprecated">
  21051. </constructor>
  21052. <doc>
  21053. <![CDATA[Exception to be thrown when Client submit an application without
  21054. providing {@link ApplicationId} in {@link ApplicationSubmissionContext}.]]>
  21055. </doc>
  21056. </class>
  21057. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
  21058. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
  21059. <class name="ApplicationNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  21060. abstract="false"
  21061. static="false" final="false" visibility="public"
  21062. deprecated="not deprecated">
  21063. <constructor name="ApplicationNotFoundException" type="java.lang.Throwable"
  21064. static="false" final="false" visibility="public"
  21065. deprecated="not deprecated">
  21066. </constructor>
  21067. <constructor name="ApplicationNotFoundException" type="java.lang.String"
  21068. static="false" final="false" visibility="public"
  21069. deprecated="not deprecated">
  21070. </constructor>
  21071. <constructor name="ApplicationNotFoundException" type="java.lang.String, java.lang.Throwable"
  21072. static="false" final="false" visibility="public"
  21073. deprecated="not deprecated">
  21074. </constructor>
  21075. <doc>
  21076. <![CDATA[This exception is thrown on
  21077. {@link ApplicationClientProtocol#getApplicationReport
  21078. (GetApplicationReportRequest)} API
  21079. when the Application doesn't exist in RM and AHS]]>
  21080. </doc>
  21081. </class>
  21082. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
  21083. <!-- start class org.apache.hadoop.yarn.exceptions.ConfigurationException -->
  21084. <class name="ConfigurationException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  21085. abstract="false"
  21086. static="false" final="false" visibility="public"
  21087. deprecated="not deprecated">
  21088. <constructor name="ConfigurationException" type="java.lang.Throwable"
  21089. static="false" final="false" visibility="public"
  21090. deprecated="not deprecated">
  21091. </constructor>
  21092. <constructor name="ConfigurationException" type="java.lang.String"
  21093. static="false" final="false" visibility="public"
  21094. deprecated="not deprecated">
  21095. </constructor>
  21096. <constructor name="ConfigurationException" type="java.lang.String, java.lang.Throwable"
  21097. static="false" final="false" visibility="public"
  21098. deprecated="not deprecated">
  21099. </constructor>
  21100. <doc>
  21101. <![CDATA[This exception is thrown on unrecoverable configuration errors.
  21102. An example is container launch error due to configuration.]]>
  21103. </doc>
  21104. </class>
  21105. <!-- end class org.apache.hadoop.yarn.exceptions.ConfigurationException -->
  21106. <!-- start class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
  21107. <class name="ContainerNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  21108. abstract="false"
  21109. static="false" final="false" visibility="public"
  21110. deprecated="not deprecated">
  21111. <constructor name="ContainerNotFoundException" type="java.lang.Throwable"
  21112. static="false" final="false" visibility="public"
  21113. deprecated="not deprecated">
  21114. </constructor>
  21115. <constructor name="ContainerNotFoundException" type="java.lang.String"
  21116. static="false" final="false" visibility="public"
  21117. deprecated="not deprecated">
  21118. </constructor>
  21119. <constructor name="ContainerNotFoundException" type="java.lang.String, java.lang.Throwable"
  21120. static="false" final="false" visibility="public"
  21121. deprecated="not deprecated">
  21122. </constructor>
  21123. <doc>
  21124. <![CDATA[This exception is thrown on
  21125. {@link ApplicationHistoryProtocol#getContainerReport (GetContainerReportRequest)}
  21126. API when the container doesn't exist in AHS]]>
  21127. </doc>
  21128. </class>
  21129. <!-- end class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
  21130. <!-- start class org.apache.hadoop.yarn.exceptions.ResourceNotFoundException -->
  21131. <class name="ResourceNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnRuntimeException"
  21132. abstract="false"
  21133. static="false" final="false" visibility="public"
  21134. deprecated="not deprecated">
  21135. <constructor name="ResourceNotFoundException" type="java.lang.String"
  21136. static="false" final="false" visibility="public"
  21137. deprecated="not deprecated">
  21138. </constructor>
  21139. <constructor name="ResourceNotFoundException" type="java.lang.Throwable"
  21140. static="false" final="false" visibility="public"
  21141. deprecated="not deprecated">
  21142. </constructor>
  21143. <constructor name="ResourceNotFoundException" type="java.lang.String, java.lang.Throwable"
  21144. static="false" final="false" visibility="public"
  21145. deprecated="not deprecated">
  21146. </constructor>
  21147. <doc>
  21148. <![CDATA[This exception is thrown when details of an unknown resource type
  21149. are requested.]]>
  21150. </doc>
  21151. </class>
  21152. <!-- end class org.apache.hadoop.yarn.exceptions.ResourceNotFoundException -->
  21153. <!-- start class org.apache.hadoop.yarn.exceptions.YarnException -->
  21154. <class name="YarnException" extends="java.lang.Exception"
  21155. abstract="false"
  21156. static="false" final="false" visibility="public"
  21157. deprecated="not deprecated">
  21158. <constructor name="YarnException"
  21159. static="false" final="false" visibility="public"
  21160. deprecated="not deprecated">
  21161. </constructor>
  21162. <constructor name="YarnException" type="java.lang.String"
  21163. static="false" final="false" visibility="public"
  21164. deprecated="not deprecated">
  21165. </constructor>
  21166. <constructor name="YarnException" type="java.lang.Throwable"
  21167. static="false" final="false" visibility="public"
  21168. deprecated="not deprecated">
  21169. </constructor>
  21170. <constructor name="YarnException" type="java.lang.String, java.lang.Throwable"
  21171. static="false" final="false" visibility="public"
  21172. deprecated="not deprecated">
  21173. </constructor>
  21174. <doc>
  21175. <![CDATA[YarnException indicates exceptions from yarn servers. On the other hand,
  21176. IOExceptions indicates exceptions from RPC layer.]]>
  21177. </doc>
  21178. </class>
  21179. <!-- end class org.apache.hadoop.yarn.exceptions.YarnException -->
  21180. <!-- start class org.apache.hadoop.yarn.exceptions.YARNFeatureNotEnabledException -->
  21181. <class name="YARNFeatureNotEnabledException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  21182. abstract="false"
  21183. static="false" final="false" visibility="public"
  21184. deprecated="not deprecated">
  21185. <constructor name="YARNFeatureNotEnabledException" type="java.lang.Throwable"
  21186. static="false" final="false" visibility="public"
  21187. deprecated="not deprecated">
  21188. </constructor>
  21189. <constructor name="YARNFeatureNotEnabledException" type="java.lang.String"
  21190. static="false" final="false" visibility="public"
  21191. deprecated="not deprecated">
  21192. </constructor>
  21193. <constructor name="YARNFeatureNotEnabledException" type="java.lang.String, java.lang.Throwable"
  21194. static="false" final="false" visibility="public"
  21195. deprecated="not deprecated">
  21196. </constructor>
  21197. <doc>
  21198. <![CDATA[This exception is thrown when a feature is being used which is not enabled
  21199. yet.]]>
  21200. </doc>
  21201. </class>
  21202. <!-- end class org.apache.hadoop.yarn.exceptions.YARNFeatureNotEnabledException -->
  21203. </package>
  21204. <package name="org.apache.hadoop.yarn.server.api">
  21205. <!-- start class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
  21206. <class name="ApplicationInitializationContext" extends="java.lang.Object"
  21207. abstract="false"
  21208. static="false" final="false" visibility="public"
  21209. deprecated="not deprecated">
  21210. <constructor name="ApplicationInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ApplicationId, java.nio.ByteBuffer"
  21211. static="false" final="false" visibility="public"
  21212. deprecated="not deprecated">
  21213. </constructor>
  21214. <method name="getUser" return="java.lang.String"
  21215. abstract="false" native="false" synchronized="false"
  21216. static="false" final="false" visibility="public"
  21217. deprecated="not deprecated">
  21218. <doc>
  21219. <![CDATA[Get the user-name of the application-submitter
  21220. @return user-name]]>
  21221. </doc>
  21222. </method>
  21223. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  21224. abstract="false" native="false" synchronized="false"
  21225. static="false" final="false" visibility="public"
  21226. deprecated="not deprecated">
  21227. <doc>
  21228. <![CDATA[Get {@link ApplicationId} of the application
  21229. @return applications ID]]>
  21230. </doc>
  21231. </method>
  21232. <method name="getApplicationDataForService" return="java.nio.ByteBuffer"
  21233. abstract="false" native="false" synchronized="false"
  21234. static="false" final="false" visibility="public"
  21235. deprecated="not deprecated">
  21236. <doc>
  21237. <![CDATA[Get the data sent to the NodeManager via
  21238. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  21239. as part of {@link ContainerLaunchContext#getServiceData()}
  21240. @return the servicesData for this application.]]>
  21241. </doc>
  21242. </method>
  21243. <doc>
  21244. <![CDATA[Initialization context for {@link AuxiliaryService} when starting an
  21245. application.]]>
  21246. </doc>
  21247. </class>
  21248. <!-- end class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
  21249. <!-- start class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
  21250. <class name="ApplicationTerminationContext" extends="java.lang.Object"
  21251. abstract="false"
  21252. static="false" final="false" visibility="public"
  21253. deprecated="not deprecated">
  21254. <constructor name="ApplicationTerminationContext" type="org.apache.hadoop.yarn.api.records.ApplicationId"
  21255. static="false" final="false" visibility="public"
  21256. deprecated="not deprecated">
  21257. </constructor>
  21258. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  21259. abstract="false" native="false" synchronized="false"
  21260. static="false" final="false" visibility="public"
  21261. deprecated="not deprecated">
  21262. <doc>
  21263. <![CDATA[Get {@link ApplicationId} of the application being stopped.
  21264. @return applications ID]]>
  21265. </doc>
  21266. </method>
  21267. <doc>
  21268. <![CDATA[Initialization context for {@link AuxiliaryService} when stopping an
  21269. application.]]>
  21270. </doc>
  21271. </class>
  21272. <!-- end class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
  21273. <!-- start interface org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler -->
  21274. <interface name="AuxiliaryLocalPathHandler" abstract="true"
  21275. static="false" final="false" visibility="public"
  21276. deprecated="not deprecated">
  21277. <method name="getLocalPathForRead" return="org.apache.hadoop.fs.Path"
  21278. abstract="false" native="false" synchronized="false"
  21279. static="false" final="false" visibility="public"
  21280. deprecated="not deprecated">
  21281. <param name="path" type="java.lang.String"/>
  21282. <exception name="IOException" type="java.io.IOException"/>
  21283. <doc>
  21284. <![CDATA[Get a path from the local FS for reading for a given Auxiliary Service.
  21285. @param path the requested path
  21286. @return the complete path to the file on a local disk
  21287. @throws IOException if the file read encounters a problem]]>
  21288. </doc>
  21289. </method>
  21290. <method name="getLocalPathForWrite" return="org.apache.hadoop.fs.Path"
  21291. abstract="false" native="false" synchronized="false"
  21292. static="false" final="false" visibility="public"
  21293. deprecated="not deprecated">
  21294. <param name="path" type="java.lang.String"/>
  21295. <exception name="IOException" type="java.io.IOException"/>
  21296. <doc>
  21297. <![CDATA[Get a path from the local FS for writing for a given Auxiliary Service.
  21298. @param path the requested path
  21299. @return the complete path to the file on a local disk
  21300. @throws IOException if the path creations fails]]>
  21301. </doc>
  21302. </method>
  21303. <method name="getLocalPathForWrite" return="org.apache.hadoop.fs.Path"
  21304. abstract="false" native="false" synchronized="false"
  21305. static="false" final="false" visibility="public"
  21306. deprecated="not deprecated">
  21307. <param name="path" type="java.lang.String"/>
  21308. <param name="size" type="long"/>
  21309. <exception name="IOException" type="java.io.IOException"/>
  21310. <doc>
  21311. <![CDATA[Get a path from the local FS for writing a file of an estimated size
  21312. for a given Auxiliary Service.
  21313. @param path the requested path
  21314. @param size the size of the file that is going to be written
  21315. @return the complete path to the file on a local disk
  21316. @throws IOException if the path creations fails]]>
  21317. </doc>
  21318. </method>
  21319. <doc>
  21320. <![CDATA[An Interface that can retrieve local directories to read from or write to.
  21321. Components can implement this interface to link it to
  21322. their own Directory Handler Service]]>
  21323. </doc>
  21324. </interface>
  21325. <!-- end interface org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler -->
  21326. <!-- start class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
  21327. <class name="AuxiliaryService" extends="org.apache.hadoop.service.AbstractService"
  21328. abstract="true"
  21329. static="false" final="false" visibility="public"
  21330. deprecated="not deprecated">
  21331. <constructor name="AuxiliaryService" type="java.lang.String"
  21332. static="false" final="false" visibility="protected"
  21333. deprecated="not deprecated">
  21334. </constructor>
  21335. <method name="getRecoveryPath" return="org.apache.hadoop.fs.Path"
  21336. abstract="false" native="false" synchronized="false"
  21337. static="false" final="false" visibility="protected"
  21338. deprecated="not deprecated">
  21339. <doc>
  21340. <![CDATA[Get the path specific to this auxiliary service to use for recovery.
  21341. @return state storage path or null if recovery is not enabled]]>
  21342. </doc>
  21343. </method>
  21344. <method name="initializeApplication"
  21345. abstract="true" native="false" synchronized="false"
  21346. static="false" final="false" visibility="public"
  21347. deprecated="not deprecated">
  21348. <param name="initAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationInitializationContext"/>
  21349. <doc>
  21350. <![CDATA[A new application is started on this NodeManager. This is a signal to
  21351. this {@link AuxiliaryService} about the application initialization.
  21352. @param initAppContext context for the application's initialization]]>
  21353. </doc>
  21354. </method>
  21355. <method name="stopApplication"
  21356. abstract="true" native="false" synchronized="false"
  21357. static="false" final="false" visibility="public"
  21358. deprecated="not deprecated">
  21359. <param name="stopAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationTerminationContext"/>
  21360. <doc>
  21361. <![CDATA[An application is finishing on this NodeManager. This is a signal to this
  21362. {@link AuxiliaryService} about the same.
  21363. @param stopAppContext context for the application termination]]>
  21364. </doc>
  21365. </method>
  21366. <method name="getMetaData" return="java.nio.ByteBuffer"
  21367. abstract="true" native="false" synchronized="false"
  21368. static="false" final="false" visibility="public"
  21369. deprecated="not deprecated">
  21370. <doc>
  21371. <![CDATA[Retrieve meta-data for this {@link AuxiliaryService}. Applications using
  21372. this {@link AuxiliaryService} SHOULD know the format of the meta-data -
  21373. ideally each service should provide a method to parse out the information
  21374. to the applications. One example of meta-data is contact information so
  21375. that applications can access the service remotely. This will only be called
  21376. after the service's {@link #start()} method has finished. the result may be
  21377. cached.
  21378. <p>
  21379. The information is passed along to applications via
  21380. {@link StartContainersResponse#getAllServicesMetaData()} that is returned by
  21381. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  21382. </p>
  21383. @return meta-data for this service that should be made available to
  21384. applications.]]>
  21385. </doc>
  21386. </method>
  21387. <method name="initializeContainer"
  21388. abstract="false" native="false" synchronized="false"
  21389. static="false" final="false" visibility="public"
  21390. deprecated="not deprecated">
  21391. <param name="initContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerInitializationContext"/>
  21392. <doc>
  21393. <![CDATA[A new container is started on this NodeManager. This is a signal to
  21394. this {@link AuxiliaryService} about the container initialization.
  21395. This method is called when the NodeManager receives the container launch
  21396. command from the ApplicationMaster and before the container process is
  21397. launched.
  21398. @param initContainerContext context for the container's initialization]]>
  21399. </doc>
  21400. </method>
  21401. <method name="stopContainer"
  21402. abstract="false" native="false" synchronized="false"
  21403. static="false" final="false" visibility="public"
  21404. deprecated="not deprecated">
  21405. <param name="stopContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerTerminationContext"/>
  21406. <doc>
  21407. <![CDATA[A container is finishing on this NodeManager. This is a signal to this
  21408. {@link AuxiliaryService} about the same.
  21409. @param stopContainerContext context for the container termination]]>
  21410. </doc>
  21411. </method>
  21412. <method name="setRecoveryPath"
  21413. abstract="false" native="false" synchronized="false"
  21414. static="false" final="false" visibility="public"
  21415. deprecated="not deprecated">
  21416. <param name="recoveryPath" type="org.apache.hadoop.fs.Path"/>
  21417. <doc>
  21418. <![CDATA[Set the path for this auxiliary service to use for storing state
  21419. that will be used during recovery.
  21420. @param recoveryPath where recoverable state should be stored]]>
  21421. </doc>
  21422. </method>
  21423. <method name="getAuxiliaryLocalPathHandler" return="org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler"
  21424. abstract="false" native="false" synchronized="false"
  21425. static="false" final="false" visibility="public"
  21426. deprecated="not deprecated">
  21427. <doc>
  21428. <![CDATA[Method that gets the local dirs path handler for this Auxiliary Service.
  21429. @return auxiliaryPathHandler object that is used to read from and write to
  21430. valid local Dirs.]]>
  21431. </doc>
  21432. </method>
  21433. <method name="setAuxiliaryLocalPathHandler"
  21434. abstract="false" native="false" synchronized="false"
  21435. static="false" final="false" visibility="public"
  21436. deprecated="not deprecated">
  21437. <param name="auxiliaryLocalPathHandler" type="org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler"/>
  21438. <doc>
  21439. <![CDATA[Method that sets the local dirs path handler for this Auxiliary Service.
  21440. @param auxiliaryLocalPathHandler the pathHandler for this auxiliary service]]>
  21441. </doc>
  21442. </method>
  21443. <doc>
  21444. <![CDATA[A generic service that will be started by the NodeManager. This is a service
  21445. that administrators have to configure on each node by setting
  21446. {@link YarnConfiguration#NM_AUX_SERVICES}.]]>
  21447. </doc>
  21448. </class>
  21449. <!-- end class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
  21450. <!-- start class org.apache.hadoop.yarn.server.api.ContainerContext -->
  21451. <class name="ContainerContext" extends="java.lang.Object"
  21452. abstract="false"
  21453. static="false" final="false" visibility="public"
  21454. deprecated="not deprecated">
  21455. <constructor name="ContainerContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  21456. static="false" final="false" visibility="public"
  21457. deprecated="not deprecated">
  21458. </constructor>
  21459. <constructor name="ContainerContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource, org.apache.hadoop.yarn.server.api.ContainerType"
  21460. static="false" final="false" visibility="public"
  21461. deprecated="not deprecated">
  21462. </constructor>
  21463. <constructor name="ContainerContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource, org.apache.hadoop.yarn.server.api.ContainerType, org.apache.hadoop.yarn.api.records.ExecutionType"
  21464. static="false" final="false" visibility="public"
  21465. deprecated="not deprecated">
  21466. </constructor>
  21467. <method name="getUser" return="java.lang.String"
  21468. abstract="false" native="false" synchronized="false"
  21469. static="false" final="false" visibility="public"
  21470. deprecated="not deprecated">
  21471. <doc>
  21472. <![CDATA[Get user of the container being initialized or stopped.
  21473. @return the user]]>
  21474. </doc>
  21475. </method>
  21476. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  21477. abstract="false" native="false" synchronized="false"
  21478. static="false" final="false" visibility="public"
  21479. deprecated="not deprecated">
  21480. <doc>
  21481. <![CDATA[Get {@link ContainerId} of the container being initialized or stopped.
  21482. @return the container ID]]>
  21483. </doc>
  21484. </method>
  21485. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  21486. abstract="false" native="false" synchronized="false"
  21487. static="false" final="false" visibility="public"
  21488. deprecated="not deprecated">
  21489. <doc>
  21490. <![CDATA[Get {@link Resource} the resource capability allocated to the container
  21491. being initialized or stopped.
  21492. @return the resource capability.]]>
  21493. </doc>
  21494. </method>
  21495. <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
  21496. abstract="false" native="false" synchronized="false"
  21497. static="false" final="false" visibility="public"
  21498. deprecated="not deprecated">
  21499. <doc>
  21500. <![CDATA[Get {@link ContainerType} the type of the container
  21501. being initialized or stopped.
  21502. @return the type of the container]]>
  21503. </doc>
  21504. </method>
  21505. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  21506. abstract="false" native="false" synchronized="false"
  21507. static="false" final="false" visibility="public"
  21508. deprecated="not deprecated">
  21509. <doc>
  21510. <![CDATA[Get {@link ExecutionType} the execution type of the container
  21511. being initialized or stopped.
  21512. @return the execution type of the container]]>
  21513. </doc>
  21514. </method>
  21515. <doc>
  21516. <![CDATA[Base context class for {@link AuxiliaryService} initializing and stopping a
  21517. container.]]>
  21518. </doc>
  21519. </class>
  21520. <!-- end class org.apache.hadoop.yarn.server.api.ContainerContext -->
  21521. <!-- start class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
  21522. <class name="ContainerInitializationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
  21523. abstract="false"
  21524. static="false" final="false" visibility="public"
  21525. deprecated="not deprecated">
  21526. <constructor name="ContainerInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  21527. static="false" final="false" visibility="public"
  21528. deprecated="not deprecated">
  21529. </constructor>
  21530. <constructor name="ContainerInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource, org.apache.hadoop.yarn.server.api.ContainerType"
  21531. static="false" final="false" visibility="public"
  21532. deprecated="not deprecated">
  21533. </constructor>
  21534. <doc>
  21535. <![CDATA[Initialization context for {@link AuxiliaryService} when starting a
  21536. container.]]>
  21537. </doc>
  21538. </class>
  21539. <!-- end class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
  21540. <!-- start interface org.apache.hadoop.yarn.server.api.ContainerLogAggregationPolicy -->
  21541. <interface name="ContainerLogAggregationPolicy" abstract="true"
  21542. static="false" final="false" visibility="public"
  21543. deprecated="not deprecated">
  21544. <method name="parseParameters"
  21545. abstract="false" native="false" synchronized="false"
  21546. static="false" final="false" visibility="public"
  21547. deprecated="not deprecated">
  21548. <param name="parameters" type="java.lang.String"/>
  21549. <doc>
  21550. <![CDATA[<p>
  21551. The method used by the NodeManager log aggregation service
  21552. to initial the policy object with parameters specified by the application
  21553. or the cluster-wide setting.
  21554. </p>
  21555. @param parameters parameters with scheme defined by the policy class.]]>
  21556. </doc>
  21557. </method>
  21558. <method name="shouldDoLogAggregation" return="boolean"
  21559. abstract="false" native="false" synchronized="false"
  21560. static="false" final="false" visibility="public"
  21561. deprecated="not deprecated">
  21562. <param name="logContext" type="org.apache.hadoop.yarn.server.api.ContainerLogContext"/>
  21563. <doc>
  21564. <![CDATA[<p>
  21565. The method used by the NodeManager log aggregation service
  21566. to ask the policy object if a given container's logs should be aggregated.
  21567. </p>
  21568. @param logContext ContainerLogContext
  21569. @return Whether or not the container's logs should be aggregated.]]>
  21570. </doc>
  21571. </method>
  21572. <doc>
  21573. <![CDATA[This API is used by NodeManager to decide if a given container's logs
  21574. should be aggregated at run time.]]>
  21575. </doc>
  21576. </interface>
  21577. <!-- end interface org.apache.hadoop.yarn.server.api.ContainerLogAggregationPolicy -->
  21578. <!-- start class org.apache.hadoop.yarn.server.api.ContainerLogContext -->
  21579. <class name="ContainerLogContext" extends="java.lang.Object"
  21580. abstract="false"
  21581. static="false" final="false" visibility="public"
  21582. deprecated="not deprecated">
  21583. <constructor name="ContainerLogContext" type="org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.server.api.ContainerType, int"
  21584. static="false" final="false" visibility="public"
  21585. deprecated="not deprecated">
  21586. </constructor>
  21587. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  21588. abstract="false" native="false" synchronized="false"
  21589. static="false" final="false" visibility="public"
  21590. deprecated="not deprecated">
  21591. <doc>
  21592. <![CDATA[Get {@link ContainerId} of the container.
  21593. @return the container ID]]>
  21594. </doc>
  21595. </method>
  21596. <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
  21597. abstract="false" native="false" synchronized="false"
  21598. static="false" final="false" visibility="public"
  21599. deprecated="not deprecated">
  21600. <doc>
  21601. <![CDATA[Get {@link ContainerType} the type of the container.
  21602. @return the type of the container]]>
  21603. </doc>
  21604. </method>
  21605. <method name="getExitCode" return="int"
  21606. abstract="false" native="false" synchronized="false"
  21607. static="false" final="false" visibility="public"
  21608. deprecated="not deprecated">
  21609. <doc>
  21610. <![CDATA[Get the exit code of the container.
  21611. @return the exit code]]>
  21612. </doc>
  21613. </method>
  21614. <doc>
  21615. <![CDATA[Context class for {@link ContainerLogAggregationPolicy}.]]>
  21616. </doc>
  21617. </class>
  21618. <!-- end class org.apache.hadoop.yarn.server.api.ContainerLogContext -->
  21619. <!-- start class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
  21620. <class name="ContainerTerminationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
  21621. abstract="false"
  21622. static="false" final="false" visibility="public"
  21623. deprecated="not deprecated">
  21624. <constructor name="ContainerTerminationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  21625. static="false" final="false" visibility="public"
  21626. deprecated="not deprecated">
  21627. </constructor>
  21628. <constructor name="ContainerTerminationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource, org.apache.hadoop.yarn.server.api.ContainerType"
  21629. static="false" final="false" visibility="public"
  21630. deprecated="not deprecated">
  21631. </constructor>
  21632. <doc>
  21633. <![CDATA[Termination context for {@link AuxiliaryService} when stopping a
  21634. container.]]>
  21635. </doc>
  21636. </class>
  21637. <!-- end class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
  21638. <!-- start interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
  21639. <interface name="SCMAdminProtocol" abstract="true"
  21640. static="false" final="false" visibility="public"
  21641. deprecated="not deprecated">
  21642. <method name="runCleanerTask" return="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskResponse"
  21643. abstract="false" native="false" synchronized="false"
  21644. static="false" final="false" visibility="public"
  21645. deprecated="not deprecated">
  21646. <param name="request" type="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskRequest"/>
  21647. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  21648. <exception name="IOException" type="java.io.IOException"/>
  21649. <doc>
  21650. <![CDATA[<p>
  21651. The method used by administrators to ask SCM to run cleaner task right away
  21652. </p>
  21653. @param request request <code>SharedCacheManager</code> to run a cleaner task
  21654. @return <code>SharedCacheManager</code> returns an empty response
  21655. on success and throws an exception on rejecting the request
  21656. @throws YarnException
  21657. @throws IOException]]>
  21658. </doc>
  21659. </method>
  21660. <doc>
  21661. <![CDATA[<p>
  21662. The protocol between administrators and the <code>SharedCacheManager</code>
  21663. </p>]]>
  21664. </doc>
  21665. </interface>
  21666. <!-- end interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
  21667. </package>
  21668. <package name="org.apache.hadoop.yarn.util">
  21669. </package>
  21670. <package name="org.apache.hadoop.yarn.util.resource">
  21671. </package>
  21672. </api>